Get E-Way Bill Details
API takes in the GSTIN of the Requester(Taxpayer or Transporter) and E-Way bill number to give the details of the E-Way bill.
Overview
This API takes in the gstin of the Requester(Taxpayer or Transporter) and E-Way bill number to give the details of the E-Way bill.
Endpoint
HTTP Method | Resource |
---|---|
Get | /ewb/tax-payer/seller/bills/{ewb_no} |
Request
Follow the below guidelines to pass the below parameters to call the API.
Headers
Param | Type | Description | Example |
---|---|---|---|
x-api-key | string | An API key is a public key to identify users when calling any Sandbox API. | key_live_ZUQT5UEf4...... |
Authorization | string | JWT Authorization token which is generated using E-Way Bill Authentication API. | eyJhsebihGyUf...... |
Path Parameters
Param | Type | Description | Example |
---|---|---|---|
ewb_no | string | E-way bill number | 131001298692 |
Once the values are added, Your curl will look something like this
curl --request GET \
--url https://api.sandbox.co.in/ewb/tax-payer/seller/bills/131001298692 \
--header 'Authorization: xxxxxxxxxx' \
--header 'accept: application/json' \
--header 'x-api-key: xxxxxxxxxx' \
--header 'x-api-version: 1.0'
Response
Param | Type | Description | Examples |
---|---|---|---|
ewbNo | num | E-way bill Generated | 131000026768 |
ewayBillDate | string | E-Way bill date | 26/09/2018 02:40:00 PM |
genMode | string | Mode of generation of E-Way Bill Possible Value - API : Application Programming InterfaceExc : Bulk UploadSMS : SMS FacilityAPP : Mobile APPWEB : Web-based system | API |
userGstin | string | GSTIN of the user | |
supplyType | string | Supply whether it is outward/inward. Possible value - I : InwardO : Outward | O |
subSupplyType | string | Sub types of Supply Possible value - 1 : Supply2 : Import3 : Export4 : Job Work5 : For own use6 : Job Work Returns7 : Sales Return8 : Others9 : SKD/CKD/Lots10 : Line Sales11 : Recipient not known12 : Exhibition or Fairs | Import |
docType | string | Document Type Possible value - INV : Tax InvoiceBIL : Bill of SupplyBOE : Bill of EntryCHL : Delivery ChallanOTH : Others | Delivery Challan |
docNo | string | Document No | 12 |
docDate | string | Document Date | 12/09/2017 |
fromGstin | string | GSTIN of the Consignor | 29AAAAA0300L1Z8 |
fromTrdName | string | LegalName of consignor | ABHYUDHYA CO OP BANK |
fromAddr1 | string | Address of consignor - Line 1 | Shambhai Fortune |
fromAddr2 | string | Address of consignor - Line 2 | Behind KSRTC Bus Stop |
fromPlace | string | Place of consignor | Bengaluru |
fromPincode | num | Pin code of consignor | 576101 |
fromStateCode | num | State of consignor Possible value - 1 : JAMMU AND KASHMIR2 : HIMACHAL PRADESH3 : PUNJAB4 : CHANDIGARH5 : UTTARAKHAND6 : HARYANA7 : DELHI8 : RAJASTHAN9 : UTTAR PRADESH10 : BIHAR11 : SIKKIM12 : ARUNACHAL PRADESH13 : NAGALAND14 : MANIPUR15 : MIZORAM16 : TRIPURA17 : MEGHALAYA18 : ASSAM19 : WEST BENGAL20 : JHARKHAND21 : ORRISA22 : CHATTISGARH23 : MADHYA PRADESH24 : GUJARAT26 : DADAR AND NAGAR HAVELI & DAMAN AND DIU27 : MAHARASHTRA29 : KARNATAKA30 : GOA31 : LAKSHADWEEP32 : KERELA33 : TAMIL NADU34 : PUDUCHERRY35 : ANDAMAN AND NICOBAR36 : TELENGANA37 : ANDHRA PRADESH38 : LADAKH97 : OTHER TERRITORY99 : OTHER COUNTRY | KARNATAKA |
actFromStateCode | num | State of Supply Possible value - 1 : JAMMU AND KASHMIR2 : HIMACHAL PRADESH3 : PUNJAB4 : CHANDIGARH5 : UTTARAKHAND6 : HARYANA7 : DELHI8 : RAJASTHAN9 : UTTAR PRADESH10 : BIHAR11 : SIKKIM12 : ARUNACHAL PRADESH13 : NAGALAND14 : MANIPUR15 : MIZORAM16 : TRIPURA17 : MEGHALAYA18 : ASSAM19 : WEST BENGAL20 : JHARKHAND21 : ORRISA22 : CHATTISGARH23 : MADHYA PRADESH24 : GUJARAT26 : DADAR AND NAGAR HAVELI & DAMAN AND DIU27 : MAHARASHTRA29 : KARNATAKA30 : GOA31 : LAKSHADWEEP32 : KERELA33 : TAMIL NADU34 : PUDUCHERRY35 : ANDAMAN AND NICOBAR36 : TELENGANA37 : ANDHRA PRADESH38 : LADAKH97 : OTHER TERRITORY99 : OTHER COUNTRY | CHANDIGARH |
toGstin | string | GSTIN of consignee | 29ACGPI2251K1ZJ |
toTrdname | string | Legal name of consignee | INDER CHHAJER |
toAddr1 | string | Address of consignee - Line 1 | PRIYADARSHANI LAYOUT |
toAddr2 | string | Address of consignee- Line 2 | MUDALAYAPALYA |
toPlace | string | Place of consignee | Bengaluru |
toPincode | num | Pincode of the consignee | 560072 |
toStateCode | num | State of Supply Possible value - 1 : JAMMU AND KASHMIR2 : HIMACHAL PRADESH3 : PUNJAB4 : CHANDIGARH5 : UTTARAKHAND6 : HARYANA7 : DELHI8 : RAJASTHAN9 : UTTAR PRADESH10 : BIHAR11 : SIKKIM12 : ARUNACHAL PRADESH13 : NAGALAND14 : MANIPUR15 : MIZORAM16 : TRIPURA17 : MEGHALAYA18 : ASSAM19 : WEST BENGAL20 : JHARKHAND21 : ORRISA22 : CHATTISGARH23 : MADHYA PRADESH24 : GUJARAT26 : DADAR AND NAGAR HAVELI & DAMAN AND DIU27 : MAHARASHTRA29 : KARNATAKA30 : GOA31 : LAKSHADWEEP32 : KERELA33 : TAMIL NADU34 : PUDUCHERRY35 : ANDAMAN AND NICOBAR36 : TELENGANA37 : ANDHRA PRADESH38 : LADAKH97 : OTHER TERRITORY99 : OTHER COUNTRY | |
totalValue | num | Sum of Taxable value | 2000 |
totInvValue | num | Total Invoice Value | |
cgstValue | num | CGST Amount | 0 |
sgstValue | num | SGST Amount | 0 |
igstValue | num | IGST Amount | 240 |
cessValue | num | CESS Amount | 20 |
cessNonAdvolValue | num | CESS Non Advol Amount | 20 |
otherValue | num | Other Charges if any | 0.01 |
actToStateCode | num | State of Supply Possible value - 1 : JAMMU AND KASHMIR2 : HIMACHAL PRADESH3 : PUNJAB4 : CHANDIGARH5 : UTTARAKHAND6 : HARYANA7 : DELHI8 : RAJASTHAN9 : UTTAR PRADESH10 : BIHAR11 : SIKKIM12 : ARUNACHAL PRADESH13 : NAGALAND14 : MANIPUR15 : MIZORAM16 : TRIPURA17 : MEGHALAYA18 : ASSAM19 : WEST BENGAL20 : JHARKHAND21 : ORRISA22 : CHATTISGARH23 : MADHYA PRADESH24 : GUJARAT26 : DADAR AND NAGAR HAVELI & DAMAN AND DIU27 : MAHARASHTRA29 : KARNATAKA30 : GOA31 : LAKSHADWEEP32 : KERELA33 : TAMIL NADU34 : PUDUCHERRY35 : ANDAMAN AND NICOBAR36 : TELENGANA37 : ANDHRA PRADESH38 : LADAKH97 : OTHER TERRITORY99 : OTHER COUNTRY | |
fromPlace | string | Place of consignor | BANGLORE SOUTH |
fromState | num | State of Consignor Possible value - 1 : JAMMU AND KASHMIR2 : HIMACHAL PRADESH3 : PUNJAB4 : CHANDIGARH5 : UTTARAKHAND6 : HARYANA7 : DELHI8 : RAJASTHAN9 : UTTAR PRADESH10 : BIHAR11 : SIKKIM12 : ARUNACHAL PRADESH13 : NAGALAND14 : MANIPUR15 : MIZORAM16 : TRIPURA17 : MEGHALAYA18 : ASSAM19 : WEST BENGAL20 : JHARKHAND21 : ORRISA22 : CHATTISGARH23 : MADHYA PRADESH24 : GUJARAT26 : DADAR AND NAGAR HAVELI & DAMAN AND DIU27 : MAHARASHTRA29 : KARNATAKA30 : GOA31 : LAKSHADWEEP32 : KERELA33 : TAMIL NADU34 : PUDUCHERRY35 : ANDAMAN AND NICOBAR36 : TELENGANA37 : ANDHRA PRADESH38 : LADAKH97 : OTHER TERRITORY99 : OTHER COUNTRY | 29 |
remainingDistance | num | remainingDistance | 50 |
transDocNo | string | transDocNo | TrnDoc123 |
transDocDate | string | Transporter Document Date | 12/09/2017 |
extnRemarks | num | extnRemarks Possible value - 1 : Natural Calamity2 : Law and Order Situation4 : Transshipment5 : Accident99 : Others | 1 |
transMode | num | Mode of Transport Possible value - 1 : Road2 : Rail3 : Air4 : Ship5 : inTransit | 1 |
extnRsnCode | num | extnRsnCode | 1 |
fromPincode | num | fromPincode | 560090 |
consignmentStatus | string | consignmentStatus Possible value - M : inMovementT : inTransit | T |
transitType | string | transitType | R |
addressLine1 | string | addressLine1 | Bengaluru |
addressLine2 | string | addressLine2 | Bengaluru |
addressLine3 | string | addressLine3 | Bengaluru |
transporterName | string | Name of the Transporter | - |
vehicleType | char | Type of Vehicle Possible value - R : RegularO : ODC(Over Dimensional Cargo) | R |
validUpto | string | Refers to valid date of E-way Bill | 26/09/2018 12.00:00 PM |
noValidDays | num | Number of Valid Days | 1 |
rejectStatus | char | Status of Rejection of E-Way Bill | N |
actualDist | num | Total distance between two transportation points | 100 |
transactionType | num | Type of transaction Possible value - 1 : Regular2 : Bill To - Ship To3 : Bill From - Dispatch From4 : Combination of 2 and 3 | 1 |
transporterId | string | Transporter Id | 29BQSPA3829E1Z0 |
extendedTimes | num | Number of Times extended | 0 |
status | string | E-Way Bill Status Possbile Values - ACT : ActiveCNL : CancelledDIS : Discarded | Active |
itemList | array | Array of Objects containing Product Details | Look below |
vehicleListDetails | array | Array of Objects containing Vehicle Details | Look below |
itemList
Param | Type | Description | Example |
---|---|---|---|
itemNo | num | Index number of the item | 1 |
productName | string | Name of the Product | Steel |
productId | num | Id of the Product | 0 |
productDesc | string | Description of the Product | 5 mm Rod |
hsnCode | num | HSN Code of the Product | 10101 |
quantity | num | Quantity of Product in Numbers | 200 |
qtyUnit | string | Unit of the Product, like Liter,Kg etc Possible value - BAG : BAGSBAL : BALEBDL : BUNDLESBKL : BUCKLESBOU : BILLION OF UNITSBOX : BOXBTL : BOTTLESBUN : BUNCHESCAN : CANSCBM : CUBIC METERSCCM : CUBIC CENTIMETERSCMS : CENTI METERSCTN : CARTONSDOZ : DOZENSDRM : DRUMSGGK : GREAT GROSSGMS : GRAMMESGRS : GROSSGYD : GROSS YARDSKGS : KILOGRAMSKLR : KILOLITREKME : KILOMETRELTR : LITRESMTR : METERSMLT : MILILITREMTS : METRIC TONNOS : NUMBERSOTH : OTHERSPAC : PACKSPCS : PIECESPRS : PAIRSQTL : QUINTALROL : ROLLSSET : SETS SQF : SQUARE FEETSQM : SQUARE METERSSQY : SQUARE YARDSTBS : TABLETSTGM : TEN GROSSTHD : THOUSANDSTON : TONNESTUB : TUBESUGS : US GALLONSUNT : UNITSYDS : YARDS | QTS |
taxableAmount | num | Taxable Amount | 100000 |
cgstRate | num | CGST Rate | 9 |
sgstRate | num | SGST Rate | 9 |
igstRate | num | IGST Rate | 18 |
cessRate | num | CESS Rate | 0 |
cessNonadvol | num | Cess Non-Advolerum | 0 |
vehicleListDetails
Param | Type | Description | Example |
---|---|---|---|
updMode | num | Mode of updation of E-Way Bill Possible Value - API : Application Programming InterfaceExc : Bulk UploadSMS : SMS FacilityAPP : Mobile APPWEB : Web-based system | API |
vehicleNo | string | Number of the Vehicle | PQR1234 |
fromPlace | string | Place of Consignor | Bengaluru |
fromState | string | State of Consignor Possible value - 1 : JAMMU AND KASHMIR2 : HIMACHAL PRADESH3 : PUNJAB4 : CHANDIGARH5 : UTTARAKHAND6 : HARYANA7 : DELHI8 : RAJASTHAN9 : UTTAR PRADESH10 : BIHAR11 : SIKKIM12 : ARUNACHAL PRADESH13 : NAGALAND14 : MANIPUR15 : MIZORAM16 : TRIPURA17 : MEGHALAYA18 : ASSAM19 : WEST BENGAL20 : JHARKHAND21 : ORRISA22 : CHATTISGARH23 : MADHYA PRADESH24 : GUJARAT26 : DADAR AND NAGAR HAVELI & DAMAN AND DIU27 : MAHARASHTRA29 : KARNATAKA30 : GOA31 : LAKSHADWEEP32 : KERELA33 : TAMIL NADU34 : PUDUCHERRY35 : ANDAMAN AND NICOBAR36 : TELENGANA37 : ANDHRA PRADESH38 : LADAKH97 : OTHER TERRITORY99 : OTHER COUNTRY | 29 |
tripshtNo | num | HSN Code of the Product | 10101 |
userGSTINTransin | string | User GSTIN | 29AAAAA0300L1Z8 |
enteredDate | string | Entered Date of the Transporter | 26/09/2018 02:40:00 PM |
transMode | num | Mode of Transport Possible value - 1 : Road2 : Rail3 : Air4 : Ship5 : inTransit | 1 |
transDocNo | string | Transporter Document number | 12-86/3 |
transDocDate | string | Transporter Document Date | 12/09/2017 |
groupNo | num | Group Number | 1 |
Response Caching
Response caching is not available for this API. Learn more about our response caching mechanism here
Wallet Charges
Since Generate E-Way Bill is a Paid API, a wallet charge of INR 0.25 + GST will take place.
Versioning
This API is currently in major version 1.0. Refer to our versioning policies here
Updated about 1 month ago