Production (Generate PCSID)

This Production CSID is used to sign einvoice documents and authenticate einvoicing api calls. Specifically, it is sent via the authentication header for those api calls.

Request Method

POST

Request URL

{{BASE_URL}}/api/v1/onboarding/GeneratePCSID

Replace the {{BASE_URL}} with the one mentioned here based on whether you are using sandbox or production.

Request Headers

Parameter	Data Type	Validations and Example	Description
x-evs-auth-token	String		Mandatory. User auth token.
vat	String		Mandatory. VAT or Group VAT of the entity.

Request Body

Parameter	Data Type	Validations and Example	Description
InvoiceType	String		Mandatory. InvoiceType
requestID	Long		Mandatory. requestID
binarySecurityToken	String		Mandatory. binarySecurityToken
secret	String		Mandatory. secret
PrivateKey	String		Mandatory. PrivateKey
Vat	String		Mandatory. Vat

Sample Request

{
  "InvoiceType": "1000",
  "requestID": 1684405353760,
  "binarySecurityToken": "TUlJQ0p6Q0NBY3lnQXdJQkFnSUdBWWd...",
  "secret": "kXvSM4RvSA0entlh8+xe9dpsgXkIAYdVBp2286BnMD4=",
  "PrivateKey": "MHcCAQEEII3KUh2IpR3havAeiwRs73smlq6CC...",
  "Vat": "311133710900003"
}

Response Status Codes

HTTP Status Code	Description
200	For a successful PCSID/Production generation.
400	For any kind of validation issues.
401	If the user is not authenticated for the operation.
403	If the user is not authorized for the operation.
500	HTTP Internal Server Error. Returned when the service faces internal errors.

Response Schema

Parameter	Data Type	Description
requestID	long	requestID for PCSID
dispositionMessage	String	Status
binarySecurityToken	String	Use as Username for authentication
secret	String	Use as Password for authentication
errors	Object	Error list
ExpiryDate	DateTime	PCSID Expiry Date
GeneratedDate	DateTime	PCSID Generated Date

Sample Response

Success - HTTP Status Code - 200

{
  "requestID": 1684405353760,
  "dispositionMessage": "Abc",
  "binarySecurityToken": "TUlJQ0p6Q0NBY3lnQXdJQkFnSUdBWWd1WWYw...",
  "secret": "kXvSM4RvSA0entlh8",
  "errors": [],
  "ExpiryDate": "27-05-2023",
  "GeneratedDate": "28-05-2025"
}

Error - HTTP Status Code - 400

{
    "ErrorCode": "",
    "ErrorMessage": "Invalid country code name, please provide a valid country code name",
    "ErrorSource": "Engine Error"
}

Error - HTTP Status Code - 401

{
    "ErrorCode": "100401",
    "ErrorMessage": "Authentication Failed",
    "ErrorSource": "EVS_Engine"
}

Error - HTTP Status Code - 403

{
  "ErrorCode": "100403",
  "ErrorMessage": "Authorization Failed",
  "ErrorSource": "EVS_Engine"
}

Error - HTTP Status Code - 500

{
    "ErrorCode": "",
    "ErrorMessage": "Invalid country code name, please provide a valid country code name",
    "ErrorSource": "Engine Error"
}

API Validations

1. The VAT for which the device is being registered needs to be already present in Evs Engine before making this API request.

API Constraints

1. This API needs to be authenticated with a valid user authentication token. If the auth token is not present or is invalid, the API will return HTTP Status Code 401.

2. If the auth token is valid, but the user does not have the authorization to generate the device ID, then the API will return HTTP Status Code 403. The user, whose auth token is used, should have an Admin role for the particular VAT used in the request.