Eway - Sandbox V - 2.7
Eway - Sandbox V - 2.7
(SANDBOX)
1|P age
Table of Contents
1. Guidelines 3
2. E-Way Bill Generation 4
3. Generate Ewaybill By IRN 13
4. Update Vehicle Number 16
5. Cancel E-Way Bill 19
6. Reject E-Way Bill 21
7. Generate Consolidated E-Way Bill 23
8. Get E-Way Bill Detail 26
9. Get Consolidated E-Way Bill Detail 29
10. Update Transporter Id 31
11. Extend Validity 33
12. Regenerate Consolidated EWB 36
13. Get E-Way Bill for Transporter 39
14. Get E-Way by GSTIN and Date 41
15. Get E-Way Bills Generated by Other Party 43
16. Get Distance 45
17. Initiate Multiple Vehicle movement 47
18. Add Vehicle Detail In Multiple Vehicle Movement 50
19. Change Vehicle Detail In Multiple Vehicle Movement 52
20. Get GSTIN Status 54
21. Get E-Way Bill By Date 56
22. Appendix 1 58
23. Appendix 2 59
24. Appendix 3 60
25. Appendix 4 60
26. Appendix 5 60
27. Appendix 6 62
28. Appendix 7 62
29. Appendix 8 63
30. Appendix 9 71
31. Appendix 10 72
32. Appendix 11 72
33. Appendix 12 72
34. Appendix 13 73
35. Dummy Credentials 74
2|P age
Guidelines
APIs has been developed to integrate third party software to process e-Way bill. Document will technically
help third party vendor to consume API and understand its validation process.
How to Use This Document: This document contains different detailed section for each API. In each
detailed section there are certain sub section which have specific meaning. Here is the description of each
sub sections.
1. Points to Notice: Every API may have some pre or post requisites or it may have some specific
functional or technical conditions. User need to understand these points before making call to
API.
2. Allowed Method: This section define all allowed request method for the particular API. Only use
the method, defined in Allowed Method section, to request any API. Commonly used methods
are GET, POST, PUT & OPTION
3. URI: Full URl of API. In the URI section there is an expression <Domain Name> which denote as
the custom URL of client’ where API is hosted.
4. URI Parameters: This section defines the parameters which need to be supplied with the URL.
URI Parameter is commonly used in GET method.
5. Body Parameters: This section contains the detail of parameters which has to be pass in body as
payload. In body parameter contains any complex or user defines data type, you will must get
the detail of that parameter in Body Parameter section itself.
6. Request Header: This section further contains some sub sections
Authorization: Each API call required authorization through valid username and password. User
Name and Password should be concatenated with three colon (:::).
Content-Type: It must be either application/json or text/json.
Payload: Payload is the complete data required to push to API. This data must in JSON format
only.
7. Response Information: This section contains information regarding the response. This section
also have further sub sections
Resource Description: Response will be in JSON formatted string in most of the cases. You can
check this section for detail of any particular API.
Sample: This section contains the response sample which help you to easily understand the
response message.
3|P age
E-Way Bill Generation
Points to Notice:
1. For Supply/CKD/SKD/Lots of Export consignment, the ‘Bill To’ Party will be URP or GSTIN of SEZ
Unit with state as ‘Other Country’ and shipping address and PIN code will be of the location
(airport/shipping yard/border check post) from where the consignment is moving out from the
country. For CKD/SKD/Lots of Import consignment, the ‘Bill From’ Party will be URP or GSTIN of
SEZ Unit with state as ‘Other Country’ and dispatching address and PIN code will be of the
location (airport/shipping yard/border check post) from where the consignment is entered the
country.
2. For Export supply type, the ‘Bill To’ Party will be URP or GSTIN of SEZ Unit with state as ‘Other
Country’ and shipping address and PIN code will be of the location (airport/shipping yard/border
check post) from where the consignment is moving out from the country. For Import supply, the
‘Bill From’ Party will be URP or GSTIN of SEZ Unit with state as ‘Other Country’ and dispatching
address and PIN code will be of the location (airport/shipping yard/border check post) from
where the consignment is entered the country.
URI : http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/GenEWB
Body Parameters:
GST_Eway
4|P age
DocType String Required,
Document Type code. Refer Appendix – 3
DocNo String Required, max 16 digit. e.g. 1234
DocDate String Required, e.g. 20170801
SupGSTIN String Required, in case of inward supplies.
GSTIN of the Supplier
SupName String Required, if supplier is unregistered.
Name of the supplier
SupAdd1 String Address of Supplier- Line 1(Dispatch from)
5|P age
HSNCode String Required, HSN Code of the Product.eg- 7615
Quantity Decimal Quantity of Product in Numbers.eg-100.000
QtyUnit String Unit of the Product. Refer Appendix-1.
TaxableValue Decimal Required, Total Amount/ Taxable Amount.eg-
10000.000
SGSTRate Decimal Required, eg-12.000
SGSTValue Decimal Required, SGST Amount.eg-12000.000
CGSTRate Decimal Required,eg-5.000
CGSTValue Decimal Required ,CGST Amount.eg-18000.000
IGSTRate Decimal Required,eg-10.000
IGSTValue Decimal Required, IGST Amount.eg-15000.000
CessRate Decimal Required,eg-2.000
CessNonAdvol Decimal Eg-400.00 CessNonAdvol of the line Item.
CessValue Decimal Required ,Cess Amounteg-5000.000
EWBUserName String Required Govt. e-Way bill API user name
EWBPassword String Required, Govt. e-Way bill API password
SubSupplyDesc String Required, Sub Supply Description if selected
“Others” in SubType
ShipFromStateCode String Required, State of Supply
ShipToStateCode String Required, State of Supply
TotalInvoiceValue Decimal Total Invoice Value of the Invoice.
OtherValue Decimal Other charges of the invoice.
CessNonAdvolValue Decimal CessNonAdvol value of the line Item.
shipToGSTIN String GSTIN of Ship-To
shipToTradeName String Trade Name of Ship-To
dispatchFromGSTIN String GSTIN of Dispatch-From
dispatchFromTradeName String Trade Name of Dispatch-From
IsBillFromShipFromSame String Required,
0 for Different BillFrom and ShipFrom,
1 for Same BillFrom and ShipFrom
IsBillToShipToSame String Required,
0 for Different BillTo and ShipTo,
1 for Same BillTo and ShipTo
IsGSTINSEZ Integer Required,
In case of Outward supply if RecGSTIN is of
SEZ then 1 else 0.
In Case of Inward supply if SupGSTIN is of SEZ
then 1 else 0.
IRN String Invoice Reference Number.
1. Note : In view of the fact that if the assesse is required to generate Eway bills through IRN then
in such case one can’t generate e-waybill (E-WayBill for B2B, EXPORT Tax Invoices) using existing
e-waybill API. Keeping this in view Webtel can visualize that this will require additional effort on
the part of our partners & clients, Webtel has incorporated the functionality wherein you can
send IRN in the existing request and Webtel will handle the same in its API and generate the E-
Waybill number through IRN.
6|P age
2. Please note that in this case Webtel will be utilizing IRN, TransMode, TransporterId,
TransporterName, TransDistance, TransDocNo, TransDocDate, VehicleType and VehicleNo. Only
and rest of the Invoice data will not be sent to the NIC.
3. If in case one wants to send the limited data for that a new method(GenEWaybyIRN) has also
been provided for the same.
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
7|P age
"TransMode": "1",
"TransporterId": "05AAACN1283H1ZQ",
"TransporterName": "",
"TransDistance": "51",
"TransDocNo": "444468",
"TransDocDate": "20181008",
"VehicleType": "R",
"VehicleNo": "",
"ProductName": "Paint",
"ProductDesc": "Paint",
"HSNCode": "8538",
"Quantity": 100,
"QtyUnit": "NOS",
"TaxableValue": 10000,
"TotalValue": 0,
"SGSTRate": 6,
"SGSTValue": 600,
"CGSTRate": 6,
"CGSTValue": 600,
"IGSTRate": 0,
"IGSTValue": 0,
"CessRate": 0,
"CessValue": 0,
"EWBUserName": "05AAACW3775F012",
"EWBPassword": "Admin!23",
"CessNonAdvol": 4006,
"SubSupplyDesc": "TestDescription",
"ShipFromStateCode": "05",
"ShipToStateCode": "05",
"TotalInvoiceValue": "0",
"CessNonAdvolValue": 100,
"OtherValue": 100,
"dispatchFromGSTIN ": "05AAACW3775F012",
"dispatchFromTradeName": "WEBTEL",
"ShipToGSTIN": "07AAACW3775F006",
"ShipToTradeName": "xyz limited",
"IsBillFromShipFromSame": "1",
"IsBillToShipToSame": "1",
"IsGSTINSEZ": 0
},
{
"GSTIN": "05AAACW3775F012",
"Year": 2018,
"Month": 4,
"SupplyType": "O",
"SubType": "1",
"DocType": "INV",
"DocNo": "3333AAAA1",
8|P age
"DocDate": "20181008",
"SupGSTIN": "05AAACW3775F012",
"SupName": "WEBTEL",
"SupAdd1": "110-114 RATAN JYOTI",
"SupAdd2": "BUILDING",
"SupCity": "DELHI",
"SupState": "05",
"SupPincode": "262542",
"RecGSTIN": "07AAACW3775F006",
"RecName": "AMIT",
"RecAdd1": "110-114 RATAN JYOTI",
"RecAdd2": "",
"Reccity": "Amritsar",
"RecState": "05",
"Recpincode": "263640",
"TransMode": "1",
"TransporterId": "05AAACN1283H1ZQ",
"TransporterName": "",
"TransDistance": "51",
"TransDocNo": "444468",
"TransDocDate": "20181008",
"VehicleType": "R",
"VehicleNo": "",
"ProductName": "Paint",
"ProductDesc": "Paint",
"HSNCode": "8538",
"Quantity": 100,
"QtyUnit": "NOS",
"TaxableValue": 10000,
"TotalValue": 0,
"SGSTRate": 6,
"SGSTValue": 600,
"CGSTRate": 6,
"CGSTValue": 600,
"IGSTRate": 0,
"IGSTValue": 0,
"CessRate": 0,
"CessValue": 0,
"EWBUserName": "05AAACW3775F012",
"EWBPassword": "Admin!23",
"CessNonAdvol": 4006,
"SubSupplyDesc": "TestDescription",
"ShipFromStateCode": "05",
"ShipToStateCode": "05",
"TotalInvoiceValue": "0",
"CessNonAdvolValue": 100,
"OtherValue": 100,
"dispatchFromGSTIN ": "05AAACW3775F012",
9|P age
"dispatchFromTradeName": "WEBTEL",
"ShipToGSTIN": "07AAACW3775F006",
"ShipToTradeName": "xyz limited",
"IsBillFromShipFromSame": "1",
"IsBillToShipToSame": "1",
"IsGSTINSEZ": 0
}
],
"Year": 2018,
"Month": 10,
"EFUserName": "29AAACW3775F000",
"EFPassword": "Admin!23..",
"CDKey": "1000687"
}
Response Information
Resource Description: string
Sample:
Success =>
"[{\"ErrorMessage\":\"\",\"GSTIN\":\"05AAACW3775F012\",\"DocNo\":\"3333AAAA1\",\"Date\":\"16/1
2/2020 12:03:00 PM\",\"Old_EWayBill\":0,\"EWayBill\":361008896199,\"ValidUpTo\":null,\"IsSucce
ss\":\"true\",\"ErrorCode\":\"\",\"VehicleNo\":null,\"SupplierState\":null,\"EWBDetails\":null
,\"Alert\":\"This 05AAACN1283H1ZQ will be blocked shortly for e-
waybill generation as GST Returns have not been filed for past 2 months. If these returns have
been filed, Update Block Status API option to update the status.\"}]"
Validations:
1. In case of tax payer generating as supplier, the GSTIN of the requesting tax payer should be
SupGSTIN.
2. In case of tax payer generating as recipient, the GSTIN of the requesting tax payer should be
RecGSTIN.
3. In case of transporter (enrolled transporter / GSTIN updated as transporter in e-way bill portal)
generating e-way bill, the GSTIN/TRANSIN of the requesting person should be transporterId.
10 | P a g e
4. Enrolled transporter (TRANSIN) cannot be supplier (SupGSTIN) or buyer (RecGSTIN).
5. The following fields should have the one of the values given in the master codes
a. Supply Type
b. Sub Supply Type
c. Document Type
d. Transportation Mode
e. Unit Quantity Code
6. The Document Date should be less than or equal to current date.
7. The Transport document Date should be greater than equal to document date.
8. SupGSTINand RecGSTIN should be valid GSTIN number of the supplier and recipient. In case of
unregistered person involved in the transaction, pass URP in these fields.
9. In case of ‘Bill to – ship to’ transaction, RecGSTIN,RecNameand RecStateshould be passed with
‘Bill To’ party and -RecAdd1, RecAdd2, RecPlace, RecPincodeand ShipToStateCodeshould be
passed with ‘Ship To’ party.
10. In case of ‘Bill From – Dispatch From’ transaction, SupGSTIN, SupNameand SupStateshould be
passed with ‘Bill From’ party and SupAdd1, SupAdd2, SupPlace, SupPincode and
ShipFromStateCode values should be passed with ‘Dispatch from’ party.
11. HSN Code should be valid as per the GST master
12. In case of intra-state transaction, where both SupGSTINand RecGSTINbelong to same state, the
SGST and CGST tax rate and value has to be passed
13. In case of inter-state transaction, where both SupGSTINand RecGSTINbelong to different states,
the IGST tax rate and value has to be passed
14. In case of one of the party is SEZ unit, then IGST tax rate and value has to be passed
15. In case of road is a transportation mode , the vehicle number should be passed and transport
document number is optional
16. In case of rail, air or ship is a transportation mode, the transport document number is must
17. In case of export, the state and pin of shipping address has to be ‘Other Country’ pin code of
dispatching state.
18. In case of import, the state and pin of shipping address has to be ‘Other Country’ and pin code
of dispatching state.
19. If PART-B (transportation mode, vehicle number or transport document number) is not passed,
the system generate unique number and return without validity period
20. If the transportation is done through the transporter, transporterId field should have valid
TRANSID or GSTIN
21. In case of road transportation, if the vehicle is ‘over dimension cargo’, pass O, otherwise R
(regular).
22. If vehicle number is passed, the format of the vehicle should be valid and as per the format
23. In case of sub supply type is others, and then pass the SubSupplyDesc accordingly.
24. In case of import or export, the actual distance being travelled in the country has to be passed.
25. The actual distance from source to destination cannot be greater than 4000.
26. The Tax Rates and Cess (CGSTRate, IGSTRate, SGSTRate, CESSRate and CESSNonAdvol) should
be valid tax Rates as per the Appendix-12.
11 | P a g e
27. GSTR1 fields (cgstValue, sgstValue, igstValue, cessValue, totalValue, otherValue and totInvValue
in main object and cgstRate, sgstRate, igstRate, cessRate, cessNonAdvol, taxableAmount) are
mandatory as per the intrastate or interstate transaction.
28. The combination of supplyType, subSupplyType, docType, fromGstin, toGstin are validated as
per the Appendix 13.
29. PinCodes are Validated against the State They Belong to ShipFromStateCode - SupPincode and
ShipToStateCode – RecPincode.
30. If Consignor generates EWay Bill, System will check whether there is any active E-way Bill for the
given document number, if exists, will throw error. If Consignee or Transporter generates the E
Way Bill system will check if there is any E-Way Bill for the given document number, if exists, a
E-way Bill will be generated and the response will have a warning message in a new parameter
‘alert’ provided the consigner has not generated E-way Bill using the same document number.
31. Additional fields for cessNonAdvolValue and otherValue have been introduced to enter CESS
Non Advol Amount and any other charges (+/-) written in invoice.
32. Sum of TotalValue, cgstValue, sgstValue, igstValue, cessValue, otherValue and
cessNonAdvolValue should be equal or less than totalInvValue. A grace Value of Rs. 2.00 is
allowed.
33. Passing TransporterID is mandatory for generating Part-A slip and transDocNo, transMode and
vehicleNo should be blank.
34. CessNonAdvolValue is added to the main JSON and cessAdvol is changed to
cessNonAdvolinitemList.
12 | P a g e
Generate Ewaybill By IRN
Overview
This API is used for generation of Ewaybill by passing the IRN.
URI : http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/GenEWaybyIRN
Body Parameters:
Optional
ShipFrom_Pin string 6 6 Pincode
13 | P a g e
Address1 of the entity to whom
Conditional the supplies are shipped to.
ShipTo_Addr1 string 3 100 Mandatory (Building/Flat no., Road/Street
etc.)
Address 2 of the entity to whom
the supplies are shipped to.
Conditional
(Floor no., Name of the
ShipTo_Addr2 string 3 100 Mandatory
premises/building).
Conditional Place (City,Town,Village) entity
ShipTo_Loc string 3 100 Mandatory to whom the supplies are
shipped to.
Conditional
ShipTo_Pin string 6 6 Pincode
Mandatory
Conditional State Code to which supplies are
ShipTo_Stcd string 1 2 Mandatory shipped to. : Refer to Appendix –
7
[0-
GSTIN string 15 15 Mandatory 9]{2 GSTIN of generator
Will be provided by WEBTEL
CDKEY string Mandatory
Will be provided by WEBTEL
EFUSERNAME string Mandatory
Will be provided by WEBTEL
EFPASSWORD string Mandatory
Will be generated by client on
EWBUSERNAME string Mandatory NIC portal
Will be generated by client on
EWBPASSWORD string Mandatory NIC portal
Note :
{
"Push_Data_List": [
{
"Irn": "c182124d7ae5756bc05f6912678357fe42cc276865624f73dab5e7c3ecfbaa20",
"TransMode": "1",
"Transid": "29AAACW3775F000",
"Transname": "",
"Distance": 0,
14 | P a g e
"Transdocno": "10765",
"TransdocDt": "20201031",
"Vehno": "DL041212",
"Vehtype": "R",
"ShipFrom_Addr1": "",
"ShipFrom_Addr2": "",
"ShipFrom_Loc": "",
"ShipFrom_Pin": 0,
"ShipFrom_Stcd": "",
"ShipTo_Addr1": "xgvvcg",
"ShipTo_Addr2": "",
"ShipTo_Loc": "hbvhhf",
"ShipTo_Pin": 110008,
"ShipTo_Stcd": "07",
"GSTIN": "29AAACW3775F000",
"CDKey": "1000687",
"EWbUserName": "29AAACW3775F000",
"EWbPassword": "Admin!23..",
"EFUserName": "29AAACW3775F000",
"EFPassword": "Admin!23.."
}
]
}
Response Format:
[
{
"IsSuccess": "True",
"ErrorMessage": "",
"ErrorCode": "",
"GSTIN": "29AAACW3775F000",
"Irn": "c182124d7ae5756bc05f6912678357fe42cc276865624f73dab5e7c3ecfbaa20",
"EwbNo": 181009069529,
"EwbDt": "2020-12-03 17:29:00",
"EwbValidTill": "2020-12-26 23:59:00"
}
]
15 | P a g e
Update Vehicle Number API
URI : http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/UpdateVehicle
Body Parameters:
Update_Vehicle
16 | P a g e
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
{
"Push_Data_List": [
{
"GSTIN": "05AAACW3775F012",
"SupPlace": "DELHI",
"SupState": "07",
"EWBNumber": 361008896199,
"TransMode": "1",
"TransDocNo": "444468",
"TransDocDate": "20180314",
"VehicleNumber": "HR26CQ4111",
"ReasonCode": "1",
"ReasonRem": "vehicle broke down",
"VehicleType": "R",
"EWBUserName": "05AAACW3775F012",
"EWBPassword": "Admin!23"
}
],
"Year": 2018,
"Month": 10,
"EFUserName": "29AAACW3775F000",
"EFPassword": "Admin!23..",
"CDKey": "1000687"
}
17 | P a g e
Response Information
Resource Description: string
Success =>
"[{\"ErrorMessage\":\"\",\"GSTIN\":\"05AAACW3775F012\",\"DocNo\":null,\"Date\":\"16/12/2020 01
:15:00 PM\",\"Old_EWayBill\":0,\"EWayBill\":361008896199,\"ValidUpTo\":\"17/12/2020 11:59:00 P
M\",\"IsSuccess\":\"true\",\"ErrorCode\":\"\",\"VehicleNo\":\"HR26CQ4111\",\"SupplierState\":n
ull,\"EWBDetails\":null,\"Alert\":null}]"
Validations:
1. Part-B can be updated by the generator of the e-way bill, if there is no transporter, or by the
assigned transporter
2. Part-B can be updated only if the e-way bill is active, that is, not cancelled
3. Part-B can be updated only if the e-way bill is within validity period, that is, validity is not
expired if validity is already set
4. If only Part A is available, Validity will be set
5. If vehicle is passed, the format of the vehicle number should be valid and as per the format
6. In case of road as a transportation mode , the vehicle number should be passed and
transport document number is optional
7. In case of rail, air or ship as a transportation mode, the transport document number is must
8. If validity has been calculated already for the E Way Bill, then vehicle type value will be
ignored.
9. If validity has not been calculated and vehicle type value has not been passed, the system
will take the vehicle type ‘R’ as default and process the request
18 | P a g e
Cancel E-WAY BILL API
URI : http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/CancelEWB
Body Parameters:
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
"Push_Data_List": [
{
"GSTIN": "05AAACW3775F012",
"EWBNumber": 361008896199,
"CancelReasonCode": "1",
19 | P a g e
"CancelRemark": "vehicle broke down",
"EWBUserName": "05AAACW3775F012",
"EWBPassword": "Admin!23"
}
],
"Year": 2018,
"Month": 10,
"EFUserName": "29AAACW3775F000",
"EFPassword": "Admin!23..",
"CDKey": "1000687"
}
Response Information
Resource Description: string
Success =>
"[{\"ErrorMessage\":\"\",\"GSTIN\":\"05AAACW3775F012\",\"DocNo\":null,\"Date\":\"16/12/2020 02
:29:00 PM\",\"Old_EWayBill\":0,\"EWayBill\":361008896199,\"ValidUpTo\":\"\",\"IsSuccess\":\"tr
ue\",\"ErrorCode\":\"\",\"VehicleNo\":null,\"SupplierState\":null,\"EWBDetails\":null,\"Alert\
":null}]"
Validations:
1. E-way bill can be cancelled by the generator of the e-way bill only.
2. E-way bill can be cancelled within 24 hours of generation of e-way bill
20 | P a g e
Reject E-WAY BILL API
URI : http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/RejectEWB
Body Parameters:
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
21 | P a g e
"Month": 3,
"EFUserName": "05AAACD8069K1ZF",
"EFPassword": "abc123@@",
"CDKey": "1000687"
}
Response Information
Resource Description: string
Success =>
[
{
"ErrorMessage": "",
"GSTIN": "05AAACD8069K1ZF",
"DocNo": null,
"Date": "14/03/2018 11:27:00 AM",
"Old_EWayBill": 0,
"EWayBill": 311000798533,
"IsSuccess": "true",
"ErrorCode": "",
"VehicleNo": null,
"SupplierState": "07",
"EWBDetails": null,
"ValidUpTo": ""
}
]
Validations:
1. E-way bill can be rejected by the other party involved in the e-waybill, if generated by the
supplier/recipient.
2. E-way bill can be rejected by supplier or recipient, if it is generated by the transporter.
3. E-way bill can be rejected within 72 hours of generation of e-way bill
22 | P a g e
Generate Consolidated E-Way Bill API
URI : http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/GenConsolidatedEWB
Body Parameters:
23 | P a g e
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
{
"Push_Data_List": [
{
"GSTIN": "05AAACD8069K1ZF",
"EWBNumber": 361001030611,
"VehicleNumber": "HR26CQ4111",
"SupPlace": "DELHI",
"SupState": "05",
"TransDocNo": "444468",
"TransDocDate": "20170705",
"TransMode": "1",
"EWBUserName": "05AAACD8069K1ZF",
"EWBPassword": "abc123@@"
},
{
"GSTIN": "05AAACD8069K1ZF",
"EWBNumber": 331001030612,
"VehicleNumber": "HR26CQ4111",
"SupPlace": "DELHI",
"SupState": "05",
"TransDocNo": "444468",
"TransDocDate": "20170705",
"TransMode": "1",
"EWBUserName": "05AAACD8069K1ZF",
"EWBPassword": "abc123@@"
}
],
"Year": 2017,
"Month": 5,
"EFUserName": "05AAACD8069K1ZF",
"EFPassword": "abc123@@",
"CDKey": "1000687"
}
24 | P a g e
Response Information
Resource Description: string
Success =>
[
{
"ErrorMessage": "",
"GSTIN": "05AAACD8069K1ZF",
"DocNo": null,
"Date": "05/05/2018 11:55:00 AM",
"Old_EWayBill": 0,
"EWayBill": 3710006434,
"ValidUpTo": "",
"IsSuccess": "true",
"ErrorCode": "",
"VehicleNo": "HR26CQ4111",
"SupplierState": "05",
"EWBDetails": "[361001030611,331001030612]"
}
]
Validations:
1. EWB can be added to the CEWB if the generator of CEWB is a generator or the assigned
transporter of the e-way bill.
2. EWB can be added to the CEWB only if the e-way bill is active, that is, not cancelled
3. EWB can be added to the CEWB only if the e-way bill is within validity period, that is validity
is not expired.
4. If vehicle number is passed, the format of the vehicle number should be valid and as per the
format
5. In case of road as a transportation mode , the vehicle number should be passed and
transport document number is optional
6. In case of rail, air or ship as a transportation mode, the transport document number is must
25 | P a g e
Get E-WAY BILL Detail API
URI: http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/GetEWB
Body Parameters:
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
{
"GSTIN": "05AAACD5767E1ZT",
"ewbNo": 341000798954,
"EWBUserName": "05AAACD5767E1ZT",
"EWBPassword": "abc123@@",
"Year": 2017,
"Month": 1,
"EFUserName": "05AAACD5767E1ZT",
"EFPassword": "abc123@@",
"CDKey": "1000685"
}
26 | P a g e
Response Information
Resource Description: string
Success =>
[
{
"ErrorMessage": null,
"GSTIN": "05AAACD8069K1ZF",
"DocNo": null,
"Date": "11/10/2018 10:15:25 AM",
"Old_EWayBill": 0,
"EWayBill": 351001537784,
"ValidUpTo": "",
"IsSuccess": "true",
"ErrorCode": null,
"VehicleNo": null,
"SupplierState": null,
"EWBDetails": "{\"cessNonAdvolValue\":200.0,\"otherValue\":0.0,\"transactionType\":1.0
,\"actToStateCode\":5.0,\"actFromStateCode\":5.0,\"vehicleType\":\"R\",\"rejectStatus\":\"N\",
\"extendedTimes\":0.0,\"totInvValue\":22700.0,\"validUpto\":\"\",\"resstatus\":\"1\",\"errorCo
des\":null,\"errorDesc\":null,\"actualDist\":200.0,\"cessValue\":0.0,\"cgstValue\":1200.0,\"do
cDate\":\"08/10/2018\",\"docNo\":\"340050\",\"docType\":\"INV\",\"fromAddr1\":\"110-
114 RATAN JYOTI\",\"fromAddr2\":\"BUILDING\",\"fromGstin\":\"05AAACD8069K1ZF\",\"fromPincode\"
:262542.0,\"fromPlace\":\"DELHI\",\"fromStateCode\":5.0,\"fromTrdName\":\"WEBTEL\",\"genMode\"
:\"API\",\"igstValue\":0.0,\"noValidDays\":2.0,\"sgstValue\":1200.0,\"status\":\"ACT\",\"subSu
pplyType\":\"1 \",\"supplyType\":\"O\",\"toAddr1\":\"110-
114 RATAN JYOTI\",\"toAddr2\":\"\",\"toGstin\":\"05AAACD5767E1ZT\",\"toPincode\":263640.0,\"to
Place\":\"Amritsar\",\"toStateCode\":5.0,\"toTrdName\":\"AMIT\",\"totalValue\":20000.0,\"trans
DocDate\":null,\"transDocNo\":null,\"transMode\":null,\"transporterId\":\"05AAACN1283H1ZQ\",\"
transporterName\":\"NISA INDUSTRIAL SERVICES PRIVATE LIMITED\",\"userGstin\":\"05AAACD8069K1ZF
\",\"ewbNo\":351001537784,\"ewayBillDate\":\"09/10/2018 06:05:00 PM\",\"itemList\":[{\"cessNon
Advol\":4006.0,\"productDesc\":\"Paint\",\"cessRate\":0.0,\"cgstRate\":6.0,\"hsnCode\":8538.0,
\"igstRate\":0.0,\"productId\":0.0,\"productName\":\"Paint\",\"qtyUnit\":\"NOS\",\"quantity\":
100.0,\"sgstRate\":6.0,\"taxableAmount\":10000.0,\"itemNo\":1.0,\"cessAdvol\":0.0},{\"cessNonA
dvol\":4006.0,\"productDesc\":\"Paint\",\"cessRate\":0.0,\"cgstRate\":6.0,\"hsnCode\":8538.0,\
"igstRate\":0.0,\"productId\":0.0,\"productName\":\"Paint\",\"qtyUnit\":\"NOS\",\"quantity\":1
00.0,\"sgstRate\":6.0,\"taxableAmount\":10000.0,\"itemNo\":2.0,\"cessAdvol\":0.0}],\"VehiclLis
tDetails\":[]}"
}
]
27 | P a g e
Validations:
28 | P a g e
Get Consolidated E-WAY BILL API
URI : http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/GetConsolidatedEWB
Body Parameters:
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
{
"GSTIN": "05AAACD8069K1ZF",
"tripSheetNo": "3910001828",
"EWBUserName": "05AAACD8069K1ZF",
"EWBPassword": "abc123@@",
"Year": 2017,
"Month": 1,
"EFUserName": "05AAACD8069K1ZF",
"EFPassword": "abc123@@",
"CDKey": "1000687"
}
29 | P a g e
Response Information
Resource Description: string
Success =>
[
{
"ErrorMessage": null,
"GSTIN": "05AAACD8069K1ZF",
"DocNo": null,
"Date": "",
"EWayBill": 3910001828,
"ValidUpTo": null,
"IsSuccess": "true",
"ErrorCode": null,
"VehicleNo": null,
"SupplierState": null,
"Old_EWayBill": 0,
"EWBDetails": "{\"Data\":{\"status\":\"1\",\"errorCodes\":null,\"errorDesc\":null,\"tr
ipSheetNo\":3910001828.0,\"fromPlace\":\"DELHI\",\"fromState\":\"7\",\"vehicleNo\":\"HR26CQ411
1\",\"transMode\":\"1 \",\"userGstin\":\"05AAACD8069K1ZF\",\"enteredDate\":\"19/03/2018 02:21
:00 PM\",\"transDocNo\":\"444468\",\"transDocDate\":\"05/07/2017\",\"tripSheetEwbBills\":[{\"e
wbNo\":301000800637,\"ewbDate\":\"19/03/2018\",\"userGstin\":\"05AAACD8069K1ZF\",\"docNo\":\"A
00005\",\"docDate\":\"03/07/2018\",\"assessValue\":4668.0,\"cgstValue\":279.0,\"sgstValue\":27
9.0,\"igstValue\":0.0,\"cessValue\":0.0},{\"ewbNo\":341000800639,\"ewbDate\":\"19/03/2018\",\"
userGstin\":\"05AAACD8069K1ZF\",\"docNo\":\"A00005\",\"docDate\":\"03/07/2018\",\"assessValue\
":4668.0,\"cgstValue\":279.0,\"sgstValue\":279.0,\"igstValue\":0.0,\"cessValue\":0.0}]},\"Mess
age\":null,\"Status\":\"1\",\"errorCodes\":null,\"errorDesc\":null}"
}
]
30 | P a g e
Update Transporter Id API
URI : http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/UpdateTransporter
Body Parameters:
Update Transporter
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
{
"Push_Data_List": [
{
"GSTIN": "05AAACW3775F012",
"EWBNumber": 361008896199,
"TransporterId": "05AAACN1283H1ZQ",
"EWBUserName": "05AAACW3775F012",
"EWBPassword": "Admin!23"
}
31 | P a g e
],
"Year": 2018,
"Month": 10,
"EFUserName": "29AAACW3775F000",
"EFPassword": "Admin!23..",
"CDKey": "1000687"
}
Response Information
Resource Description: string
Success =>
"[{\"ErrorMessage\":\"\",\"GSTIN\":\"05AAACW3775F012\",\"DocNo\":null,\"Date\":\"16/12/2020 02
:15:00 PM\",\"Old_EWayBill\":0,\"EWayBill\":361008896199,\"ValidUpTo\":\"\",\"IsSuccess\":\"tr
ue\",\"ErrorCode\":\"\",\"VehicleNo\":null,\"SupplierState\":null,\"EWBDetails\":null,\"Alert\
":null}]"
Validations:
1. The transporter can be updated for the e-way bill only by the current transporter. If transporter
is not assigned, then the generator can update
2. Transporter ID should be valid GSTIN or TRANSIN
3. Transporter can be updated only if the e-way bill is active, that is, not cancelled
4. Transporter can be updated only if the e-way bill is within validity period, that is, validity is not
expired.
32 | P a g e
Extend Validity API
URI : http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/ExtendValidity
Body Parameters:
Extend Validity
33 | P a g e
EWBUserName String RequiredGovt. e-Way bill API user name
EWBPassword String Required, Govt. e-Way bill API password
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
{
"Push_Data_List": [
{
"GSTIN": "05AAACD8069K1ZF",
"SupPlace": "NEW DELHI",
"EWBNumber": 361002201430,
"SupState": "05",
"TransMode": "1",
"TransDocNo": "444468",
"TransDocDate": "20180411",
"VehicleNumber": "DL06AX1365",
"ExtnReasonCode": "1",
"RemainingDistance": 5,
"ExtnRemark": "Due to Flood",
"EWBUSERNAME": "05AAACD8069K1ZF",
"EWBPASSWORD": "abc123@@",
"fromPincode": "248001",
"transitType": "",
"addressLine1": "",
"addressLine2": "",
"addressLine3": ""
}
],
"EFUserName": "05AAACD8069K1ZF",
"EFPassword": "abc123@@",
"CDKey": "1000687"
}
34 | P a g e
Response Information
Resource Description: string
Success =>
[
{
"ErrorMessage": "",
"GSTIN": "05AAACD8069K1ZF",
"DocNo": null,
"Date": "05/05/2018 11:59:00 AM",
"Old_EWayBill": 0,
"EWayBill": 311001027621,
"ValidUpTo": "07/05/2018 11:59:00 PM",
"IsSuccess": "true",
"ErrorCode": "",
"VehicleNo": null,
"SupplierState": null,
"EWBDetails": null
}
]
Validations:
1. The Validity of EWB can be extended only by the current transporter. If transporter is not
assigned, then the generator can update.
2. The validity of EWB can be extended between 8 hours before expiry time and 8 hours after
expiry time.
3. The reason code along with reason description for the extension has to be entered.
4. The present location of the consignment, at the time of requesting for the extension, has to be
entered and distance to travel from there to destination has to be entered.
5. If vehicle number is passed, the format of the vehicle number should be valid and as per the
format
6. In case of road as a transportation mode , the vehicle number should be passed and transport
document number is optional
7. In case of rail, air or ship as a transportation mode, the transport document number is must
8. Remaining distance should not be more than the actual distance mentioned during the
generation of E-way bill.
35 | P a g e
Regenerate Consolidated EWB API
URI : http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/ReGenConsolidatedEWB
Body Parameters:
RegenConsolidated
36 | P a g e
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
{
"Push_Data_List": [
{
"GSTIN": "05AAACD8069K1ZF",
"tripSheetNo": 3710006434,
"VehicleNumber": "DL06AX1365",
"SupPlace": "NEW DELHI",
"SupState": "05",
"TransDocNo": "444468",
"TransDocDate": "20180411",
"TransMode": "1",
"ReasonCode": "1",
"Remark": "Due to Flood",
"EWBUserName": "05AAACD8069K1ZF",
"EWBPassword": "abc123@@"
}
],
"Year": 2018,
"Month": 3,
"EFUserName": "05AAACD8069K1ZF",
"EFPassword": "abc123@@",
"CDKey": "1000687"
}
37 | P a g e
Response Information
Resource Description: string
Success =>
[
{
"ErrorMessage": "",
"GSTIN": "05AAACD8069K1ZF",
"DocNo": null,
"Date": "",
"Old_EWayBill": 3710006434,
"EWayBill": 3410006435,
"ValidUpTo": "",
"IsSuccess": "true",
"ErrorCode": "",
"VehicleNo": null,
"SupplierState": null,
"EWBDetails": "[{\"ewbNo\":\"361001030611\"},{\"ewbNo\":\"331001030612\"}]"
}
]
Validations:
1. CEWB can be re-generated by the generator of that CEWB or the current transporter.
2. Re-generate CEWB considers only the e-way bills which are active, that is, not cancelled
3. Re-generate CEWB considers only the e-way bills which are within the validity period, that is
validity is not expired.
4. If vehicle number is passed, the format of the vehicle number should be valid and as per the
format
5. In case of road as a transportation mode , the vehicle number should be passed and transport
document number is optional
6. In case of rail, air or ship as a transportation mode, the transport document number is must
38 | P a g e
Get E-WAY BILL for Transporter
URI : http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/GetEWBForTransporter
Body Parameters:
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
{
"GSTIN": "05AAACD5767E1ZT",
"Date": 20180619,
"EWBUserName": "05AAACD5767E1ZT",
"EWBPassword": "abc123@@",
"Year": 2018,
"Month": 6,
"EFUserName": "05AAACD5767E1ZT",
"EFPassword": "abc123@@",
"CDKey": "1000685"
}
39 | P a g e
Response Information
Resource Description: string
Success =>
[
{
"ErrorMessage": null,
"GSTIN": "05AAACD5767E1ZT",
"DocNo": null,
"Date": "20180619",
"Old_EWayBill": 0,
"EWayBill": 0,
"ValidUpTo": null,
"IsSuccess": "true",
"ErrorCode": null,
"VehicleNo": null,
"SupplierState": null,
"EWBDetails": "[{\"status\":\"ACT\",\"errorCodes\":null,\"errorDesc\":null,\"ewbNo\":3
21001361139,\"ewbDate\":\"19/06/2018 03:54:00 PM\",\"genGstin\":\"05AAACD8069K1ZF\",\"docNo\":
\"340156791\",\"docDate\":\"01/06/2018\",\"delPinCode\":201308.0,\"delStateCode\":5.0,\"delPla
ce\":\"Amritsar\",\"validUpto\":\"21/06/2018 11:59:00 PM\",\"extendedTimes\":0,\"rejectStatus\
":\"N\"},{\"status\":\"ACT\",\"errorCodes\":null,\"errorDesc\":null,\"ewbNo\":381001361140,\"e
wbDate\":\"19/06/2018 03:54:00 PM\",\"genGstin\":\"05AAACD8069K1ZF\",\"docNo\":\"340156793\",\
"docDate\":\"01/06/2018\",\"delPinCode\":201308.0,\"delStateCode\":5.0,\"delPlace\":\"Amritsar
\",\"validUpto\":\"21/06/2018 11:59:00 PM\",\"extendedTimes\":0,\"rejectStatus\":\"N\"},{\"sta
tus\":\"ACT\",\"errorCodes\":null,\"errorDesc\":null,\"ewbNo\":301001361146,\"ewbDate\":\"19/0
6/2018 03:56:00 PM\",\"genGstin\":\"05AAACD8069K1ZF\",\"docNo\":\"340156793\",\"docDate\":\"01
/06/2018\",\"delPinCode\":201308.0,\"delStateCode\":5.0,\"delPlace\":\"Amritsar\",\"validUpto\
":\"21/06/2018 11:59:00 PM\",\"extendedTimes\":0,\"rejectStatus\":\"N\"}]"
}
]
40 | P a g e
Get E-WAY BILL by GSTIN and DATE
URI : http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/GetEWBbyGSTINandDate
Body Parameters:
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
"GSTIN": "05AAACD5767E1ZT",
"gen_date": "20180619",
"Gen_GSTIN": "05AAACD8069K1ZF",
"Year": 2018,
"Month": 6,
"EFUserName": "05AAACD5767E1ZT",
"EFPassword": "abc123@@",
"CDKey": "1000685",
"EWBUserName": "05AAACD5767E1ZT",
"EWBPassword": "abc123@@"
}
41 | P a g e
Response Information
Success =>
[
{
"ErrorMessage": null,
"GSTIN": "05AAACD5767E1ZT",
"DocNo": null,
"Date": "20180717",
"Old_EWayBill": 0,
"EWayBill": 0,
"ValidUpTo": null,
"IsSuccess": "true",
"ErrorCode": null,
"VehicleNo": null,
"SupplierState": null,
"EWBDetails": "[{\"status\":\"ACT\",\"errorCodes\":null,\"errorDesc\":null,\"ewbNo\":3
21001361139,\"ewbDate\":\"19/06/2018 03:54:00 PM\",\"genGstin\":\"05AAACD8069K1ZF\",\"docNo\":
\"340156791\",\"docDate\":\"01/06/2018\",\"delPinCode\":201308.0,\"delStateCode\":5.0,\"delPla
ce\":\"Amritsar\",\"validUpto\":\"21/06/2018 11:59:00 PM\",\"extendedTimes\":0,\"rejectStatus\
":\"N\"},{\"status\":\"ACT\",\"errorCodes\":null,\"errorDesc\":null,\"ewbNo\":381001361140,\"e
wbDate\":\"19/06/2018 03:54:00 PM\",\"genGstin\":\"05AAACD8069K1ZF\",\"docNo\":\"340156793\",\
"docDate\":\"01/06/2018\",\"delPinCode\":201308.0,\"delStateCode\":5.0,\"delPlace\":\"Amritsar
\",\"validUpto\":\"21/06/2018 11:59:00 PM\",\"extendedTimes\":0,\"rejectStatus\":\"N\"},{\"sta
tus\":\"ACT\",\"errorCodes\":null,\"errorDesc\":null,\"ewbNo\":301001361146,\"ewbDate\":\"19/0
6/2018 03:56:00 PM\",\"genGstin\":\"05AAACD8069K1ZF\",\"docNo\":\"340156793\",\"docDate\":\"01
/06/2018\",\"delPinCode\":201308.0,\"delStateCode\":5.0,\"delPlace\":\"Amritsar\",\"validUpto\
":\"21/06/2018 11:59:00 PM\",\"extendedTimes\":0,\"rejectStatus\":\"N\"}]"
}
]
Validation:
42 | P a g e
Get E-WAY BILLS Generated by Other Party
URI : http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/GetEWBOtherParty
Body Parameters:
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
{
"GSTIN": "05AAACD8069K1ZF",
"Date": 20180315,
"EWBUserName": "05AAACD8069K1ZF",
"EWBPassword": "abc123@@",
"Year": 2018,
"Month": 3,
"EFUserName": "05AAACD8069K1ZF",
"EFPassword": "abc123@@",
"CDKey": "1000687"
}
43 | P a g e
Response Information
Resource Description: string
Success =>
[
{
"ErrorMessage": null,
"GSTIN": "05AAACD8069K1ZF",
"DocNo": null,
"Date": "20180315",
"Old_EWayBill": 0,
"EWayBill": 0,
"ValidUpTo": null,
"IsSuccess": "true",
"ErrorCode": null,
"VehicleNo": null,
"SupplierState": null,
"EWBDetails": "[{\"status\":\"ACT\",\"ewbNo\":341000799494,\"ewayBillDate\":\"15/03/20
18 04:34:00 PM\",\"genMode\":\"API\",\"genGstin\":\"05AAACD5767E1ZT\",\"docNo\":\"A00005\",\"d
ocDate\":\"3/7/2018 12:00:00 AM\",\"fromGstin\":\"05AAACD5767E1ZT\",\"fromTradeName\":\"Blue W
arehouse\",\"toGstin\":\"05AAACD8069K1ZF\",\"toTradeName\":\"NEW\",\"totInvValue\":0.0,\"hsnCo
de\":0,\"hsnDesc\":\"\",\"rejectStatus\":\"N\"},{\"status\":\"ACT\",\"ewbNo\":311000799297,\"e
wayBillDate\":\"15/03/2018 12:52:00 PM\",\"genMode\":\"API\",\"genGstin\":\"05AAACD5767E1ZT\",
\"docNo\":\"A00005\",\"docDate\":\"3/7/2018 12:00:00 AM\",\"fromGstin\":\"05AAACD5767E1ZT\",\"
fromTradeName\":\"Blue Warehouse\",\"toGstin\":\"05AAACD8069K1ZF\",\"toTradeName\":\"NEW\",\"t
otInvValue\":0.0,\"hsnCode\":0,\"hsnDesc\":\"\",\"rejectStatus\":\"N\"},{\"status\":\"ACT\",\"
ewbNo\":311000799495,\"ewayBillDate\":\"15/03/2018 04:37:00 PM\",\"genMode\":\"API\",\"genGsti
n\":\"05AAACD5767E1ZT\",\"docNo\":\"A00005\",\"docDate\":\"3/7/2018 12:00:00 AM\",\"fromGstin\
":\"05AAACD5767E1ZT\",\"fromTradeName\":\"Blue Warehouse\",\"toGstin\":\"05AAACD8069K1ZF\",\"t
oTradeName\":\"NEW\",\"totInvValue\":0.0,\"hsnCode\":0,\"hsnDesc\":\"\",\"rejectStatus\":\"N\"
}]"
}
]
Validation:
1. Passing date should be within last/latest 3 days , other than current date
2. Passing date cannot be current date
44 | P a g e
Get Distance
URI : http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/GetDistance
Body Parameters:
GetDistance
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
{
"Push_Data_List": [
{
"GSTIN": "27AAACW3775F1Z6",
"SourcePincode": "110059",
"DestinationPincode": "110008",
"EWBUserName": "rajeevkh",
"EWBPassword": "webtel1234"
},
45 | P a g e
{
"GSTIN": "27AAACW3775F1Z6",
"SourcePincode": "110059",
"DestinationPincode": "110010",
"EWBUserName": "rajeevkh",
"EWBPassword": "webtel1234"
}
],
"EFUserName": "suresh1",
"EFPassword": "1234567",
"CDKey": "1000684"
}
Response Information
Resource Description: string
Success =>
[
{
"ErrorMessage": "",
"GSTIN": "05AAACD8069K1ZF",
"IsSuccess": "true",
"ErrorCode": "",
"SourcePincode": "110059",
"DestinationPincode": "110008",
"Distance": 13
},
{
"ErrorMessage": "",
"GSTIN": "05AAACD8069K1ZF",
"IsSuccess": "true",
"ErrorCode": "",
"SourcePincode": "110059",
"DestinationPincode": "110010",
"Distance": 9
}
]
46 | P a g e
Initiate Multiple Vehicle Movement API
URI : http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/MultiVehInt
Body Parameters:
Multiple Vehicle
47 | P a g e
Validations
1. Eway bill should be active and valid.
2. Valid reasonCode, state code and unitCode to be sent.
3. totalQuantity should not be more than the quantity mentioned in eway bill for the first
initiation.
4. After one group movement of consignment in multiple vehicles is initiated, requests for next
group movement will consider the totalQuantity of previous group.
5. If same JSON is passed without any change, new group will not be created.
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
{
"Push_Data_List": [
{
"GSTIN": "05AAACD8069K1ZF",
"EWBNumber": 371001522054,
"ReasonCode": "1",
"ReasonRemark": "BreakDown",
"FromPlace": "delhi",
"FromState": "07",
"ToPlace": "Haridwar",
"ToState": "05",
"TransMode": "1",
"TotalQuantity": 120,
"UnitCode": "NOS",
"EWBUserName": "05AAACD8069K1ZF",
"EWBPassword": "abc123@@"
}
],
"EFUserName": "05AAACD8069K1ZF",
"EFPassword": "abc123@@",
"CDKey": "1000687"
}
48 | P a g e
Response Information
Resource Description: string
Success =>
[
{
"ErrorMessage": "",
"GSTIN": "05AAACD8069K1ZF",
"EWayBill": 371001522054,
"GroupNo": "1",
"Date": "21/09/2018 10:38:00 AM",
"IsSuccess": "true",
"ErrorCode": ""
}
]
49 | P a g e
Add Vehicle Detail In Multiple Vehicle Movement API
URI : http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/MultiVehAdd
Body Parameters:
Validations
50 | P a g e
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
{
"Push_Data_List": [
{
"GSTIN": "05AAACD8069K1ZF",
"EWBNumber": 371001522054,
"GroupNo": "1",
"VehicleNo": "DL02AX1366",
"TransDocNo": "12345",
"TransDocDate": "20180921",
"Quantity": 110,
"EWBUserName": "05AAACD8069K1ZF",
"EWBPassword": "abc123@@"
}
],
"EFUserName": "05AAACD8069K1ZF",
"EFPassword": "abc123@@",
"CDKey": "1000687"
}
Response Information
Resource Description: string
Success =>
[
{
"ErrorMessage": "",
"GSTIN": "05AAACD8069K1ZF",
"EWayBill": 371001522054,
"GroupNo": "1",
"Date": "21/09/2018 11:57:00 AM",
"IsSuccess": "true",
"ErrorCode": ""
}
]
51 | P a g e
Change Vehicle Detail In Multiple Vehicle Movement API
URI : http://ewaysandbox.webtel.in/Sandbox/EWayBill/v1.3/MultiVehUpd
Body Parameters:
Validations
52 | P a g e
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
{
"Push_Data_List": [
{
"GSTIN": "05AAACD8069K1ZF",
"EWBNumber": 371001522054,
"GroupNo": "1",
"OldVehicleNo": "DL02AX1366",
"NewVehicleNo": "DL02AX1367",
"OldTranNo": "12345",
"NewTranNo": "12346",
"FromPlace": "delhi",
"FromState": "07",
"ReasonCode": "1",
"ReasonRemark": "Break Down",
"EWBUserName": "05AAACD8069K1ZF",
"EWBPassword": "abc123@@"
}
],
"EFUserName": "05AAACD8069K1ZF",
"EFPassword": "abc123@@",
"CDKey": "1000687"
}
Response Information
Resource Description: string
Success =>
[
{
"ErrorMessage": "",
"GSTIN": "05AAACD8069K1ZF",
"EWayBill": 371001522054,
"GroupNo": "1",
"Date": "21/09/2018 12:37:00 PM",
"IsSuccess": "true",
"ErrorCode": ""
}
]
53 | P a g e
GET GSTN Status
Body Parameters:
Request Header:
Authorization: /IalkRmh3z4=:::ZH4TUvIeJ3A=
Content-Type: application/json or text/json
{
"GSTIN": "05AAACD8069K1ZF",
"SearchGSTIN": "06AAACS0628K1ZH",
"EFUserName": "05AAACD8069K1ZF",
"EFPassword": "abc123@@",
"CDKey": "1000687",
"EWBUserName": "05AAACD8069K1ZF",
"EWBPassword": "abc123@@"
}
54 | P a g e
Response Information
Resource Description: string
Success =>
[
{
\"ErrorMessage\":null,\"GSTIN\":\"05AAACD8069K1ZF\",\"DocNo\":null,\"Date\":\"13/12/20
19 05:19:51 PM\",\"Old_EWayBill\":0,\"EWayBill\":0,\"ValidUpTo\":\"\",\"IsSuccess\":\"true\",\
"ErrorCode\":null,\"VehicleNo\":null,\"SupplierState\":null,\"EWBDetails\":\"{\\\"gstin\\\":\\
\"06AAACS0628K1ZH\\\",\\\"tradeName\\\":\\\"SHANTI PETRO FOAMS P.LTD.\\\",\\\"legalName\\\":\\
\"SHANTI PETROFOAMS LIMITED\\\",\\\"address1\\\":\\\"T-
1/ASONIPAT\\\",\\\"address2\\\":\\\"131001INDL.AREA\\\",\\\"stateCode\\\":\\\"6\\\",\\\"pinCod
e\\\":\\\"131001\\\",\\\"txpType\\\":\\\"\\\",\\\"status\\\":\\\"ACT\\\",\\\"blkStatus\\\":\\\
"B\\\",\\\"resstatus\\\":\\\"1\\\",\\\"errorCodes\\\":null,\\\"errorDesc\\\":null}\"
}
]
55 | P a g e
GET E-Way Bill By Date
Body Parameters:
Request Header:
{
"GSTIN": "05AAACD8069K1ZF",
"Date": "01/01/2020",
"EFUserName": "05AAACD8069K1ZF",
"EFPassword": "abc123@@",
"CDKey": "1000687",
"EWBUserName": "05AAACD8069K1ZF",
"EWBPassword": "abc123@@"
}
56 | P a g e
Response Information
Resource Description: string
Success =>
[
{
"ErrorMessage": null,
"ErrorCode": null,
"IsSuccess": "true",
"GSTIN": "05AAACD8069K1ZF",
"Date": "01/01/2020 06:41:42 PM",
"EWBDetails": [
{
"ewbNo": 261160507895,
"ewbDate": "01/01/2020 03:57:00 PM",
"status": "ACT",
"genGstin": "05AAACD8069K1ZF",
"docNo": "6247308",
"docDate": "26/12/2019",
"delPinCode": 410501,
"delStateCode": 27,
"delPlace": "CHAKAN",
"validUpto": "03/01/2020 11:59:00 PM",
"extendedTimes": "0",
"rejectStatus": "N"
}
]
}
]
57 | P a g e
APPENDIX –1
(UQC FOR E-WAY BILL)
UQC Code
BAGS BAG
BALE BAL
BUNDLES BDL
BUCKLES BKL
BILLION OF UNITS BOU
BOX BOX
BOTTLES BTL
BUNCHES BUN
CANS CAN
CUBIC METERS CBM
CUBIC CENTIMETERS CCM
CENTI METERS CMS
CARTONS CTN
DOZENS DOZ
DRUMS DRM
GREAT GROSS GGK
GRAMMES GMS
GROSS GRS
GROSS YARDS GYD
KILO GRAMS KGS
KILOMETRE KME
KILOLITRE KLR
MILLI LITRE MLT
METRIC TON MTS
NUMBERS NOS
OTHERS OTH
PAIRS PRS
PACKS PAC
PIECES PCS
QUINTAL QTL
ROLLS ROL
SETS SET
58 | P a g e
SQUARE FEET SQF
SQUARE METERS SQM
SQUARE YARDS SQY
TABLETS TBS
TEN GROSS TGM
THOUSANDS THD
TONNES TON
US GALLONS UGS
UNITS UNT
YARDS YDS
TUBES TUB
APPENDIX –2
(SUB TYPE FOR E-WAY BILL)
Inward Supply 1
Import 2
For Own Use 5
Job work Returns 6
Sales Return 7
Others 8
SKD/CKD 9
Exhibition or Fairs 12
59 | P a g e
APPENDIX –3
(DOCUMENT TYPE FOR E-WAY BILL)
Description Code
Tax Invoice INV
Bill of Supply BIL
Bill of Entry BOE
Challan CHL
Credit Note CNT
Others OTH
APPENDIX –4
(TRANSPORT MODE TYPE FOR E-WAY BILL)
Description Code
Road 1
Rail 2
Air 3
Ship 4
In Transit 5
APPENDIX –5
(STATE CODE FOR E-WAY BILL)
State State Code
OTHER TERRITORY 97
OTHER COUNTRIES 99
JAMMU AND KASHMIR 1
HIMACHAL PRADESH 2
PUNJAB 3
CHANDIGARH 4
UTTARAKHAND 5
HARYANA 6
60 | P a g e
DELHI 7
RAJASTHAN 8
UTTAR PRADESH 9
BIHAR 10
SIKKIM 11
ARUNACHAL PRADESH 12
NAGALAND 13
MANIPUR 14
MIZORAM 15
TRIPURA 16
MEGHALAYA 17
ASSAM 18
WEST BENGAL 19
JHARKHAND 20
ORISSA 21
CHHATTISGARH 22
MADHYA PRADESH 23
GUJARAT 24
DAMAN AND DIU 25
DADAR AND NAGAR HAVELI 26
MAHARASTRA 27
ANDHRA PRADESH 37
KARNATAKA 29
GOA 30
LAKSHADWEEP 31
KERALA 32
TAMIL NADU 33
PONDICHERRY 34
ANDAMAN AND NICOBAR 35
TELENGANA 36
61 | P a g e
APPENDIX –6
APPENDIX –7
62 | P a g e
APPENDIX –8
(ERROR CODES)
Error
Codes Error Description
100 Invalid json
101 Invalid Username
102 Invalid Password
103 Invalid Client –Id
104 Invalid Client –Id
105 Invalid Token
106 Token Expired
107 Authentication failed. Pls. inform the helpdesk
108 Invalid login credentials.
109 Decryption of data failed
110 Invalid Client-ID/Client-Secret
111 GSTIN is not registerd to this GSP
112 IMEI does not belong to the user
201 Invalid Supply Type
202 Invalid Sub-supply Type
203 Sub-transaction type does not belongs to transaction type
204 Invalid Document type
205 Document type does not match with transaction & Sub trans type
206 Invaild Invoice Number
207 Invalid Invoice Date
208 Invalid Supplier GSTIN
209 Blank Supplier Address
210 Invalid or Blank Supplier PIN Code
211 Invalid or Blank Supplier state Code
212 Invalid Consignee GSTIN
213 Invalid Consignee Address
214 Invalid Consignee PIN Code
215 Invalid Consignee State Code
216 Invalid HSN Code
217 Invalid UQC Code
218 Invalid Tax Rate for Intra State Transaction
219 Invalid Tax Rate for Inter State Transaction
220 Invalid Trans mode
221 Invalid Approximate Distance
222 Invalid Transporter Id
63 | P a g e
223 Invalid Transaction Document Number
224 Invalid Transaction Date
225 Invalid Vehicle Number Format
226 Both Transaction and Vehicle Number Blank
227 User Gstin cannot be blank
228 User id cannot be blank
229 Supplier name is required
230 Supplier place is required
231 Consignee name is required
232 Consignee place is required
233 Eway bill does not contains any items
234 Total amount/Taxable amout is mandatory
235 Tax rates for Intra state transaction is blank
236 Tax rates for Inter state transaction is blank
237 Invalid client -Id/client-secret
238 Invalid auth token
239 Invalid action
240 Could not generate eway bill, pls contact helpdesk
242 Invalid or Blank Officer StateCode
243 Invalid or Blank IR Number
244 Invalid or Blank Actual Vehicle Number Format
245 Invalid Verification Date Format
246 Invalid Vehicle Release Date Format
247 Invalid Verification Time Format
248 Invalid Vehicle Release Date Format
249 Actual Value cannot be less than or equal to zero
250 Invalid Vehicle Release Date Format
251 CGST nad SGST TaxRate should be same
252 Invalid CGST Tax Rate
253 Invalid SGST Tax Rate
254 Invalid IGST Tax Rate
255 Invalid CESS Rate
256 Invalid Cess Non Advol value
278 User Gstin does not match with Transporter Id
280 Status is not ACTIVE
281 Eway Bill is already expired hence update transporter is not allowed.
301 Invalid eway bill number
302 Invalid transporter mode
303 Vehicle number is required
304 Invalid vehicle format
305 Place from is required
64 | P a g e
306 Invalid from state
307 Invalid reason
308 Invalid remarks
309 Could not update vehicle details, pl contact helpdesk
311 Validity period lapsed, you cannot update vehicle details
312 This eway bill is either not generated by you or cancelled
313 Error in validating ewaybill for vehicle updation
315 Validity period lapsed, you cannot cancel this eway bill
316 Eway bill is already verified, you cannot cancel it
317 Could not cancel eway bill, please contact helpdesk
320 Invalid state to
321 Invalid place to
322 Could not generate consolidated eway bill
325 Could not retrieve data
326 Could not retrieve GSTIN details for the given GSTIN number
327 Could not retrieve data from hsn
328 Could not retrieve transporter details from gstin
329 Could not retrieve States List
330 Could not retrieve UQC list
331 Could not retrieve Error code
334 Could not retrieve user details by userid
336 Could not retrieve transporter data by gstin
337 Could not retrieve HSN details for the given HSN number
You cannot update transporter details, as the current tranporter is already entered Part B
338 details of the eway bill
339 You are not assigned to update the tranporter details of this eway bill
341 This e-way bill is generated by you and hence you cannot reject it
342 You cannot reject this e-way bill as you are not the other party to do so
343 This e-way bill is cancelled
344 Invalid eway bill number
345 Validity period lapsed, you cannot reject the e-way bill
346 You can reject the e-way bill only within 72 hours from generated time
347 Validation of eway bill number failed, while rejecting ewaybill
348 Part-B is not generated for this e-way bill, hence rejection is not allowed.
350 Could not generate consolidated eway bill
351 Invalid state code
352 Invalid rfid date
353 Invalid location code
354 Invalid rfid number
355 Invalid Vehicle Number Format
356 Invalid wt on bridge
357 Could not retrieve eway bill details, pl. contact helpdesk
65 | P a g e
GSTIN passed in request header is not matching with the user gstin mentioned in payload
358 JSON
359 User GSTIN should match to GSTIN(from) for outward transactions
360 User GSTIN should match to GSTIN(to) for inward transactions
361 Invalid Vehicle Type
362 Transporter document date cannot be earlier than the invoice date
363 E-way bill is not enabled for intra state movement for you state
364 Error in verifying eway bill
365 Error in verifying consolidated eway bill
You will not get the ewaybills generated today, howerver you cann access the ewaybills of
366 yester days
367 Could not retrieve data for officer login
368 Could not update transporter
GSTIN/Transin passed in request header should match with the transported Id mentioned in
369 payload JSON
GSTIN/Transin passed in request header should not be the same as supplier(fromGSTIN) or
370 recepient(toGSTIN)
371 Invalid or Blank Supplier Ship-to State Code
372 Invalid or Blank Consignee Ship-to State Code
373 The Supplier ship-to state code should be Other Country for Sub Supply Type- Export
374 The Consignee pin code should be the pin of dispatching state for Sub Supply Type- Export
375 The Supplier ship-from state code should be Other Country for Sub Supply Type- Import
376 The Supplier pin code should be the pin of dispatching state for Sub Supply Type- Import
377 Sub Supply Type is mentioned as Others, the description for that is mandatory
378 The supplier or conginee belong to SEZ, Inter state tax rates are applicable here
379 Eway Bill can not be extended.. Already Cancelled
380 Eway Bill Can not be Extended. Not in Active State
381 There is No PART-B/Vehicle Entry.. So Please Update Vehicle Information..
You Cannot Extend as EWB can be Extended only 8 hour before or after w.r.t Validity of
382 EWB..!!
383 Error While Extending..Please Contact Helpdesk.
384 You are not current transporter or Generator of the ewayBill, with no transporter details.
385 For Rail/Ship/Air transDocNo and transDocDate is mandatory
386 Reason Code, Remarks is mandatory.
387 No Record Found for Entered consolidated eWay bill.
388 Exception in regenration of consolidated eWayBill!!Please Contact helpdesk
389 Remaining Distance Required
390 Remaining Distance Can not be greater than Actual Distance.
391 No eway bill of specified tripsheet, neither ACTIVE nor not Valid.
392 Tripsheet is already cancelled, Hence Regeration is not possible
393 Invalid GSTIN
394 For other than Road Transport, TransDoc number is required
66 | P a g e
395 Eway Bill Number should be numeric only
396 Either Eway Bill Number Or Consolidated Eway Bill Number is required for Verification
397 Error in Multi Vehicle Movement Initiation
398 Eway Bill Item List is Empty
399 Unit Code is not matching with any of the Unit Code from eway bill ItemList
400 total quantity is exceeding from multi vehicle movement initiation quantity
401 Error in inserting multi vehicle details
402 total quantity cannot be less than or equal to zero
403 Error in multi vehicle details
No record found for multi vehicle update with specified ewbNo groupNo and old
405 vehicleNo/transDocNo with status as ACT
406 Group number cannot be empty or zero
407 Invalid old vehicle number format
408 Invalid new vehicle number format
409 Invalid old transDoc number
410 Invalid new transDoc number
411 Multi Vehicle Initiation data is not there for specified ewayBill and group No
412 Multi Vehicle movement is already Initiated,hence PART B updation not allowed
413 Unit Code is not matching with unit code of first initiaton
415 Error in fetching in verification data for officer
416 Date range is exceeding allowed date range
417 No verification data found for officer
418 No record found
419 Error in fetching search result for taxpayer/transporter
420 Minimum six character required for Tradename/legalname search
421 Invalid pincode
422 Invalid mobile number
423 Error in fetching ewaybill list by vehicle number
424 Invalid PAN number
425 Error in fetching Part A data by IR Number
426 For Vehicle Released vehicle release date and time is mandatory
427 Error in saving Part-A verification Report
428 For Goods Detained,Vehicle Released feild is mandatory
429 Error in saving Part-B verification Report
430 Goods Detained Field required.
431 Part-A for this ewaybill is already generated by you.
432 invalid vehicle released value
433 invalid goods detained parameter value
434 invalid ewbNo Available parameter value
435 Part B is already updated, hence updation is not allowed
436 Invalid Consignee ship to State Code for the given pincode
437 Invalid Supplier ship from State Code for the given pincode
67 | P a g e
438 Invalid Latitude
439 Invalid Longitude
440 Error in inserting in verification data
441 Invalid verification type
442 Error in inserting verification details
443 invalid invoice available value
600 Invalid category
601 Invalid date format
602 Invalid File Number
603 For file details file number is required
E-way bill(s) are already generated for the same document number, you cannot generate
604 again on same document number
607 dispatch from gstin is mandatary
608 ship to from gstin is mandatary
609 invalid ship to from gstin
610 invalid dispatch from gstin
611 invalid document type for the given supply type
612 Invalid transaction type
613 Exception in getting Officer Role
614 Transaction type is mandatory
615 Dispatch From GSTIN cannot be sent as the transaction type selected is Regular
616 Ship to GSTIN cannot be sent as the transaction type selected is Regular
617 Bill-from and dispatch-from gstin should not be same for this transaction type
618 Bill-to and ship-to gstin should not be same for this transaction type
619 Transporter Id is mandatory for generation of Part A slip
620 Total invoice value cannot be less than the sum of total assessible value and tax values
621 Transport mode is mandatory since vehicle number is present
622 Transport mode is mandatory since transport document number is present
623 IGST value is not applicable for Intra State Transaction
624 CGST/SGST value is not applicable for Inter State Transaction
627 Total value should not be negative
628 Total invoice value should not be negative
629 IGST value should not be negative
630 CGST value should not be negative
631 SGST value should not be negative
632 Cess value should not be negative
633 Cess non advol should not be negative
634 Vehicle type should not be ODC when transmode is other than road
You cannot update part B, as the current tranporter is already entered Part B details of the
635 eway bill
636 You are not assigned to update part B
637 You cannot extend ewaybill, as the current tranporter is already entered Part B details of the
68 | P a g e
ewaybill
69 | P a g e
4023 The transport document date should be passed in case of transportation mode is other than
Road.
4024 Vehicle type should not be ODC when transmode is other than road
4025 Invalid User-Id
4026 Duplicate EwayBill for document numer - ({0})
4027 Transporter Id is mandatory for generation of Part A slip
4028 Transport mode is mandatory as Vehicle Number/Transport Document Number is given
4029 Valid distance to be sent in case of same pin codes, you cannot send 0 as distance in this
case.
4030 The distance between the pincodes {0} and {1} is not available in the system, you need to
pass the actual distance.
4031 Ship to details are mandatory for export transactions to generate e-Way Bill.
4032 Ship to state code cannot be other country code(96) for e-Way Bill generation
4033 Ship to PIN code cannot be 999999 for e-Way Bill generation
4034 Since the you passed Supplier/Recepient/Dispatch from/Ship to Pincode as 999999, distance
cannot be 0
4035 Dispatch state code cannot be other country code(96) for e-Way Bill generation
4036 Dispatch PIN code cannot be 999999 for e-Way Bill generation
4037 You are not authorised to get data
4038 The distance between the pincodes given is too high
70 | P a g e
APPENDIX –9
71 | P a g e
APPENDIX –10
APPENDIX –11
APPENDIX –12
(TAX RATES)
CGST SGST IGST CESS (Advol) CESS (Non-Advol)
0 0 0
0.05 0.05 0.1 0 or 1 or 3 or 5 or 11
0.125 0.125 0.25 or 12 or 12.5 or 15 or
1.5 1.5 3
17 or 20 or 21 or 22 or 0 or 400 or 2076 or
36 or 49 or 60 or 61 or 2747 or 3668 or
2.5 2.5 5 4006 or 4170
65 or 71 or 72 or 89 or
6 6 12 96 or 142 or 160 or
9 9 18 204 or 290
14 14 28
72 | P a g e
APPENDIX –13
(SUPPLY TYPE AND DOCUMENT TYPE VALIDATIONS)
Trans Transaction
action Type Sub-Type Document Type From GSTIN (Supplier) To GSTIN (Buyer)
Tax Invoice Self Other GSTIN /URP
Supply
Bill of Supply Self Other GSTIN /URP
Tax Invoice Self URP
Export
Bill of Supply Self URP
Job Work Delivery Challan Self Other GSTIN/URP
Tax Invoice Self Other GSTIN /URP
SKD/CKD Bill of Supply Self Other GSTIN /URP
73 | P a g e
(Dummy Credentials)
These are testing credentials which can be used for sandbox testing, we’ve created test credentials for
all the states.
74 | P a g e
New Update :
75 | P a g e