Generate E-Way Bill
E-way bill is required to ensure that goods being transported comply with the GST. Sandbox API to Generate E-Way Bill.
Overview
This API takes in E-Way details and generates E-Way Bill.
Endpoint
HTTP Method | Resource |
---|---|
Post | /ewb/tax-payer/seller/bills |
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...... |
Body Parameters
Param | Type | Description | Examples |
---|---|---|---|
supplyType | string | Supply whether it is outward/inward. Possible value - I : InwardO : Outward | Outward |
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 |
subSypplyDesc | string | Sub Supply Description if selected “Others” in subSupplyType | |
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 | |
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 | |
transactionType | num | Type of transaction Possible value - 1 : Regular2 : Bill To - Ship To3 : Bill From - Dispatch From4 : Combination of 2 and 3 | 1 |
otherValue | num | Other Charges if any | 2000 |
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 |
transMode | num | Mode of transportation Possible value - 1 : Road2 : Rail3 : Air4 : Ship5 : inTransit | 1 |
VehicleType | char | Type of Vehicle Possible value - R : RegularO : ODC(Over Dimensional Cargo) | R |
transDistance | num | Distance of transportation | 10 |
transporterId | string | Transporter Id | 29BQSPA3829E1Z0 |
transporterName | string | Transporter Name | TAPURI |
transDocNo | string | Transporter Doc No | 11 |
transDocDate | string | Transporter Doc Date | 13/09/2017 |
vehicleNo | string | Vehicle No. Possible value - 1. AB121234 (First 2 char are State Code) 2. AB12A1234 (First 2 char are State Code) 3. AB12AB1234 (First 2 char are State Code) 4. ABC1234 5. AB123A1234 (First 2 char are State Code) 6. AB12ABC1234 (First 2 char are State Code) 7. DFXXXXXX (Defence Vehicle) 8. TMXXXXXXXXXXXXX (Temp RC) At least 7 characters 9. BPXXXXXXXXXXXXX (Bhutan Vehicle) At least 7 characters 10. NPXXXXXXXXXXXXX (Nepal Vehicle) At least 7 characters | KA12BL4567 |
itemList | array | Array of Objects containing Product Details | Look below |
itemList
Param | Type | Description | Example |
---|---|---|---|
productName | string | Name of the Product | Steel |
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 |
Once the values are added, Your curl will look something like this
curl --request POST \
--url https://api.sandbox.co.in/ewb/tax-payer/seller/bills \
--header 'Authorization: xxxxxxxxxx' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-api-key: xxxxxxxxxx' \
--header 'x-api-version: 1.0' \
--data '
{
"Raw Body": {
"supplyType": "O",
"subSupplyType": "1",
"subSupplyDesc": "",
"docType": "INV",
"docNo": "7001-8",
"docDate": "15/12/2017",
"fromGstin": "29AKLPM8755F1Z2",
"fromTrdName": "welton",
"fromAddr1": "2ND CROSS NO 59 19 A",
"fromAddr2": "GROUND FLOOR OSBORNE ROAD",
"fromPlace": "FRAZER TOWN",
"fromPincode": 560090,
"actFromStateCode": 29,
"fromStateCode": 29,
"toGstin": "02EHFPS5910D2Z0",
"toTrdName": "sthuthya",
"toAddr1": "Shree Nilaya",
"toAddr2": "Dasarahosahalli",
"toPlace": "Beml Nagar",
"toPincode": 560090,
"actToStateCode": 29,
"toStateCode": 27,
"transactionType": 4,
"otherValue": "-100",
"totalValue": 56099,
"cgstValue": 0,
"sgstValue": 0,
"igstValue": 300.67,
"cessValue": 400.56,
"cessNonAdvolValue": 400,
"totInvValue": 68358,
"transporterId": "",
"transporterName": "",
"transDocNo": "",
"transMode": "1",
"transDistance": "100",
"transDocDate": "",
"vehicleNo": "PVC1234",
"vehicleType": "R",
"itemList": [
{
"productName": "Wheat",
"productDesc": "Wheat",
"hsnCode": 1001,
"quantity": 4,
"qtyUnit": "BOX",
"cgstRate": 0,
"sgstRate": 0,
"igstRate": 3,
"cessRate": 3,
"cessNonadvol": 0,
"taxableAmount": 5609889
}
]
}
}
'
Response
Param | Type | Description | Example |
---|---|---|---|
ewaybillno | string | Refers to E-way bill number | 123456789012 |
ewayBillDate | num | Refers to date when E-way bill is generated | 25/09/2018 10:30:00 AM |
validUpto | num | Refers to valid date of E-way Bill | 26/09/2018 12.00:00 PM |
alert | string | Refers to any kind of alert | Total invoice value is more than the sum of total assessible value and tax values |
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