Table of Contents 1. 2. Overview . 3. Process Flow 4. List of API 10 5. API 1 6. Generation API 4 7. Number Updation - API 8. E-waybill Generation- API 9. of E- waybill - API 10. E-waybill - API Methods- API codes in C#.Net with explanation Annexure – A: API Data Structure Specification 43 Annexure – B: E-way Bill Master Code List 47 Annexure – C: API Error Codes List 50 Annexure – D: JSON SCHEMA 50 List of Abbreviations Abbreviation Full Form API Application Program Interface CGST Central Goods and Service Tax CKD Completely Knocked Down EBN e-way bill Number EWB e-way bill GSP Goods and Services Tax Suvidha Provider GST Goods and Services Tax GSTIN Goods and Services Tax Identification No GSTN Goods and Services Tax Network
Parameter Name Type Description Values Sample Data Allowed character supplyType Text(1) Supply whether it is outward/inward. Refer Code List O Number(2) Sub types of Supply Refer Code List 2 Text(20) Su Supply Description if selected “Others” in subSupplyType docType Text(3) Document Type Refer Code List CHL docNo Text(50) Document No 12 Alphanum, / docDate Text Document Date format 12/09/2017 fromGstin Text(15) GSTIN of the Consignor Alphanum fromTrdName Text(100) LegalName of consignor CO OP BANK fromAddr1 Text(120) Address of consignor - Line 1 Shambhai Fortune fromAddr2 Text(120) Address of consignor - Line 2 Behind KSRTC Bus Stop fromPlace Text(50) Place of consignor Bengaluru Alphabetic fromPincode Number(6) Pincode of consignor 576101 Number Number(2) State of consignor Refer Code List 29 Number(2) State of Supply Refer Code List 4 toGstin Text(15) GSTIN of consignee toTrdname Text(100) Legalname of consignee INDER CHHAJER toAddr1 Text(120) Address of consignee - Line 1 LAYOUT toAddr2 Text(120) Address of consignee- Line 2 toPlace Text(50) Place of consignee Bengaluru Alphabetic toPincode Number(6) Pincode of the consignee 560072 Number toStateCode Number(2) State of Supply Refer Code List 4
Number(2) State of Supply Refer Code List 4 totalValue Total Amount/ Taxable Amount 2000 totInvValue Total Invoice Value cgstValue CGST Amount 0 sgstValue SGST Amount 0 igstValue IGST Amount 240 cessValue CESS Amount 20 transMode Number(1) Mode of transportation Refer Code List 1 VehicleType Char(1) Type of Vehcile R or O R transDistance Number(5) Distance of transportation 10 Max Value = 4000 transporterId Text(15) Transporter Id Text(100) Transporter Name TAPURI transDocNo Text(15) Transporter Doc No 11 transDocDate Text Transporter Doc Date format 13/09/2017 vehicleNo Text(10) Vehicle No. Pl refer Code List KA12BL4567 Vehicle No. to begin with state code as given in the Code list productName Text(100) Name of the Product Steel productDesc Description of the Product 5mm Rod hsnCode Number(8) HSN Code of the Product 10101 quantity Decimal(8,2) Quantity of Product in Numbers QTS qtyUnit Text(3) Unit of the Product, like Liter,Kg etc Refer Code List 200 Total Amount/ Taxable Amount 100000
Annexure -A3: Update Vehicle number Parameter Name Type Description Values Sample Data Allowed character ewbNo E-way bill Generated Numbers vehicleNo Text(20) Vehicle number KA12TR1234 Alpha-numeric fromPlace Text(50) Place of Consignor BANGALORE SOUTH Alpha-numeric fromState State of Consignor Refer Code list 29 Numbers reasonCode Reason code for vehicle updation Refer Code list 2 Numbers reasonRem Text(50) Reason for Vehicle Updation Vehicle details updated Alpha-numeric transDocNo Text(50) Transporter Document number 12-86/3 Alphanumeric, -, / Text Transporter Document Date format 12/09/2017 transMode Mode of Transport Refer Code list 1 Numbers Annexure -A4: Cancel E-way bill Parameter Name Type Description Values Sample Data Allowed character ewbNo E-way bill Generated 131000026768 Numbers Number(1) Reason code for cancelling eway bill Refer Code list 2 Numbers cancelRmrk Text(50) Reason for - cancelling eway bill Vehicle details not updated Alpha-numeric Annexure A5- Reject e-way bill Parameter Name Type Description Values Sample Data Allowed character ewbNo E-way bill Generated 131000026768 Numbers Annexure A6- Update Transporter Parameter Name Type Description Values Sample Data Allowed character ewbNo E-way bill Generated 131000026768 Numbers transporterId Text(15) Transporter Id
Annexure A7- Extend Validity Parameter Name Type Description Values Sample Data Allowed character ewbNo E-way billnumber 131000026768 Numbers vehicleNo Text(20) Vehicle number KA12TR1234 Alpha-numeric fromPlace Text(50) Current place BANGALORE SOUTH Alpha-numeric Number(2) Current State Refer Code list 29 Numbers Number(5) Distance remaining to reach destination 10 Max Value = 4000 transDocNo Text(50) Transporter Document number 12-86/3 Alphanumeric, -, / transDocDate Text Transporter Document Date format 12/09/2017 transMode Number(1) Mode of Transport Refer Code list 1 Numbers extnRsnCode Number(1) Reason code for extension of eway bill Refer Code list 2 Numbers extnRemarks Text(50) Reason for – Extension of eway bill Vehicle details not updated Alpha-numeric Annexure A8- Regeneration of Consolidated e-way bill Parameter Name Type Description Values Sample Data Allowed character tripSheetNo Consolidated Bill No (TripSheet No) 1310006768 Numbers vehicleNo Text(20) Vehicle number KA12TR1234 Alpha-numeric fromPlace Text(50) Current place BANGALORE SOUTH Alpha-numeric Number(2) Current State Refer Code list 29 Numbers rsnCode Number(2) Reason code for Regeneration of Consolidated Bill Refer Code list 2 Numbers
379 Eway Bill cannot be extended.. Already Cancelled 380 Eway Bill Cannot be Extended. Not in Active State 381 There is No PART-B/Vehicle Entry.. So Please Update Vehicle Information.. 382 You Cannot Extend as EWB can be Extended only 8 hour before or after w.r.t Validity of 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 regeneration of consolidated eWayBill!!Please Contact helpdesk 389 Remaining Distance Required 390 Remaining Distance cannot be greater than Actual Distance.