Access point
Method POST
UAT URI [Link]
PROD URI [Link]
Request Header
Parameter Name Description Field Specification Sample Value
accessToken Authentication token Mandatory s5gaGvGc2cvundAJVeqvJWAaj
apiaccesskey Unique key shared by EY for accessing the APIS Mandatory dsdkfj324kjskckj2343rdmdsadadsaakjk4
Content-Type Mandatory application/json
Request Payload
M/ CM/ O
(Mandatory /
Attribute related Error
SL No. Attribute Name Field Specification Description Conditional Error Codes Description
Code
Mandatory /
Optional )
1 STRING (LENGTH:64) Either IRN has to be provided or
Irn The IRN number CM suppgstin,docNo,docttype,docdate
2 suppGstin ALPHA-NUMERIC (15) SupplierGSTIN M ER008 Invalid SupplierGSTIN
3 docNo STRING (Max Length:16) Document Number CM ER006 Invalid Document Number
STRING (MAX LENGTH:10)
4 YYYY-MM-DD OR
docDate DD-MM-YYYY OR YYYY/MM/DD OR DD/MM/YYYY The document date CM ER164 Invalid Document Date
5 doctype STRING (LENGTH:5) As per master CM
6 transporterID ALPHA-NUMERIC (15) TransporterID CM
STRING
7 transporterName (MIN LENGTH: 3 & MAX LENGTH:100)
TransporterName O
8 transportMode STRING (MAX LENGTH 10) TransportMode CM
9 transportDocNo STRING (MIN: 1 & MAX LENGTH:15) TransportDocNo CM
STRING (MAX LENGTH : 10)
10 transportDocDate DD/MM/YYYY
TransportDocDate CM
11 distance NUMBER (MIN LENGTH: 1 & MAX LENGTH:4) Distance M
12 vehicleNo STRING (MIN LENGTH: 4 & MAX LENGTH:20) VehicleNo CM
13 vehicleType STRING (MAXLENGTH:1) VehicleType CM
14 dispatcherTradeName STRING (MIN LENGTH: 3 & MAX LENGTH:100) DispatcherTradeName CM New attriutes added
15 dispatcherBuildingNo STRING (MIN LENGTH: 3 & MAX LENGTH:120) DispatcherAddress1 CM New attriutes added
16 dispatcherBuildingName STRING (MIN LENGTH: 3 & MAX LENGTH:120) DispatcherAddress2 O New attriutes added
17 dispatcherLocation STRING (MIN LENGTH: 3 & MAX LENGTH:100) DispatcherLocation CM New attriutes added
NUMBER (MIN LENGTH 6 & MAX LENGTH:6)
18 dispatcherPincode DispatcherPincode CM New attriutes added
Minimum Value expected is 100000
19 dispatcherStateCode NUMBER (MIN LENGTH 2 & MAX LENGTH:2) DispatcherStateCode CM New attriutes added
20 shipToBuildingNo STRING (MIN LENGTH: 3 & MAX LENGTH:120) ShipToAddress1 CM New attriutes added
21 shipToBuildingName STRING (MIN LENGTH: 3 & MAX LENGTH:120) ShipToAddress2 O New attriutes added
22 shipToLocation STRING (MIN LENGTH: 3 & MAX LENGTH:100) ShipToLocation CM New attriutes added
NUMBER (MIN LENGTH 6 & MAX LENGTH:6)
23 shipToPincode ShipToPincode CM New attriutes added
Minimum Value expected is 100000
24 shipToState NUMBER (MIN LENGTH 2 & MAX LENGTH:2) ShipToStateCode CM New attriutes added
Request Payload sample Json
{
"Irn": "d12301375bccbeb4927eecfa75e1764d5f7cfec8a85b189be8479a40e4811ae6",
"suppGs n": "27xxxxx5343E1Z1",
"docNo": "KJDJKA",
"docDate": "2020-02-13",
"doctype": "INV",
"transporterID": "123456789101112",
"transporterName": "volvo",
"transportMode": "ROAD",
"transportDocNo": "1234",
"transportDocDate": "09/03/2020",
"distance": "1.1",
"vehicleNo": "KA53MD4170",
"vehicleType": "a",
"dispatcherTradeName":"BCCL",
"dispatcherBuildingNo":"Times Building",
"dispatcherBuildingName":"TOI",
"dispatcherLocation":"Delhi",
"dispatcherPincode":110001,
"dispatcherStateCode":"07",
"shipToBuildingNo":"PAZA CARDINAL GRACIAS ROAD ",
"shipToBuildingName":"CHAKALA ANDHERI (E) ",
"shipToLocation":"PAZA CARDINAL GRACIAS ANDHERI",
"shipToPincode":"110001",
"shipToState":"07"
}
Response Payload sample Json
M/ CM/ O
SL No. Attribute Name Data Type Description (Mandatory / Conditional Remarks
Mandatory / Optional )
1 X_REQUEST_ID UUID UUID Received in the request M
2 suppGstin ALPHA-NUMERIC (15) SupplierGSTIN M
3 docNo STRING (Max Length:16) Document Number M
STRING (MAX LENGTH:10)
YYYY-MM-DD OR
4 docDate DD-MM-YYYY OR YYYY/MM/DD OR DD/MM/YYYY The document date as per input payloadM
5 doctype STRING (LENGTH:5) As per master M
6 status STRING 1/0 - Success/ Failure M
Status of IRN generation Success or Failure
8 Irn STRING (Length:64) The IRN Number M Vlaue is null if any error is encountered
9 SignedQRCode Base64 encoded CLOB Base 64 encoded QR Code M Vlaue is null if any error is encountered
10 SignedInvoice Base64 encoded CLOB Base 64 encoded Invoice M Vlaue is null if any error is encountered
11 AckNo STRING (LENGTH:30) M Vlaue is null if any error is encountered
STRING
12 AckDt YYYY-MM-DD HH:MM:SS M Vlaue is null if any error is encountered
13 EwbNo STRING(LENGTH:12) M Vlaue is 0
STRING
14 EwbDt YYYY-MM-DD HH:MM:SS M Vlaue is null if any error is encountered
STRING
15 EwbValidTill YYYY-MM-DD HH:MM:SS M Vlaue is null if any error is encountered
errorDetails Array Object M Vlaue is null if any error is encountered
16 errorCode STRING (Length:15) The Error Code O Optional if no errors are encountered
17 errorDesc STRING (Length:250) The Error Description O Optional if no errors are encountered
18 errorField STRING (Length:250) The Error Field O Optional if no errors are encountered
19 errorSource STRING (Length:250) The error source O Optional if no errors are encountered
additional message to be
20 InfoDtls STRING (max) conveyed would be passed M Vlaue is null if any error is encountered
21 infoCode STRING(length :max) The Info Code O
22 infoDesc STRING(length :max) The Info Description O
Response error codes
Error
ErrorDesc
Code
ER00001 IRN does not exist for given combination
ER008 Invalid Supplier GSTIN
ER006 Invalid Document Number
ER164 Invalid Document Date
Response Payload sample Json
{
"docNo": "SEP2802",
"suppGstin": "29AAAPH9357H000",
"docDate": "28-09-2020",
"docType": "INV",
"status": "1",
"X_REQUEST_ID": "d74c19df-d190-4602-a479-0e3a99f06864",
"AckNo": "112010010300508",
"AckDt": "2020-09-28 11:06:00",
"Irn": "e54215350411eaad2ce019ddd2ef33a23e798b2c5afa0aadf140a26d634aa412",
"SignedQRCode": null,
"SignedInvoice": null,
"EwbNo": "101008734497",
"EwbDt": "2020-09-28 19:12:00",
"EwbValidTill": "2020-09-29 23:59:00",
"errorDetails": null,
"InfoDtls": {
"infoCode": "ALL",
"infoDesc": "Document considered for E-Invoice, E-Waybill, Returns"
}
}
OR
{
"docNo": "SEP2802",
"suppGstin": "",
"docDate": "28-09-2020",
"docType": "INV",
"status": "0",
"X_REQUEST_ID": "bf132d5d-8363-4026-a9f1-bf72c4884510",
"AckNo": "",
"AckDt": "",
"Irn": "e54215350411eaad2ce019ddd2ef33a23e798b2c5afa0aadf140a26d634aa412",
"SignedQRCode": "",
"SignedInvoice": "",
"EwbNo": null,
"EwbDt": null,
"EwbValidTill": null,
"errorDetails": [
{
"errorCode": "ER008",
"errorDesc": "Invalid Supplier GSTIN",
"errorField": "SupplierGSTIN",
"errorSource": "EY"
}
],
"InfoDtls": {
"infoCode": "ALL",
"infoDesc": "Document considered for E-Invoice, E-Waybill, Returns"
}
}