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.

API Pricing Documentation

Overview

This API takes in E-Way details and generates E-Way Bill.

Endpoint

HTTP MethodResource
Post/ewb/tax-payer/seller/bills

API Endpoint Contact Us  Free Trial

Request

Follow the below guidelines to pass the below parameters to call the API.

Headers

ParamTypeDescriptionExample
x-api-keystringAn API key is a public key to identify users when calling any Sandbox API.key_live_ZUQT5UEf4......
AuthorizationstringJWT Authorization token which is generated using E-Way Bill Authentication API.eyJhsebihGyUf......

Body Parameters

ParamTypeDescriptionExamples
supplyTypestringSupply whether it is outward/inward.
Possible value -
I : Inward
O : Outward
Outward
subSupplyTypestringSub types of Supply
Possible value -
1 : Supply
2 : Import
3 : Export
4 : Job Work
5 : For own use
6 : Job Work Returns
7 : Sales Return
8 : Others
9 : SKD/CKD/Lots
10 : Line Sales
11 : Recipient not known
12 : Exhibition or Fairs
Import
subSypplyDescstringSub Supply Description if selected “Others” in subSupplyType
docTypestringDocument Type
Possible value -
INV : Tax Invoice
BIL : Bill of Supply
BOE : Bill of Entry
CHL : Delivery Challan
OTH : Others
Delivery Challan
docNostringDocument No12
docDatestringDocument Date12/09/2017
fromGstinstringGSTIN of the Consignor29AAAAA0300L1Z8
fromTrdNamestringLegalName of consignorABHYUDHYA CO OP BANK
fromAddr1stringAddress of consignor - Line 1Shambhai Fortune
fromAddr2stringAddress of consignor - Line 2Behind KSRTC Bus Stop
fromPlacestringPlace of consignorBengaluru
fromPincodenumPin code of consignor576101
fromStateCodenumState of consignor
Possible value -
1 : JAMMU AND KASHMIR
2 : HIMACHAL PRADESH
3 : PUNJAB
4 : CHANDIGARH
5 : UTTARAKHAND
6 : HARYANA
7 : DELHI
8 : RAJASTHAN
9 : UTTAR PRADESH
10 : BIHAR
11 : SIKKIM
12 : ARUNACHAL PRADESH
13 : NAGALAND
14 : MANIPUR
15 : MIZORAM
16 : TRIPURA
17 : MEGHALAYA
18 : ASSAM
19 : WEST BENGAL
20 : JHARKHAND
21 : ORRISA
22 : CHATTISGARH
23 : MADHYA PRADESH
24 : GUJARAT
26 : DADAR AND NAGAR HAVELI & DAMAN AND DIU
27 : MAHARASHTRA
29 : KARNATAKA
30 : GOA
31 : LAKSHADWEEP
32 : KERELA
33 : TAMIL NADU
34 : PUDUCHERRY
35 : ANDAMAN AND NICOBAR
36 : TELENGANA
37 : ANDHRA PRADESH
38 : LADAKH
97 : OTHER TERRITORY
99 : OTHER COUNTRY
KARNATAKA
actFromStateCodenumState of Supply
Possible value -
1 : JAMMU AND KASHMIR
2 : HIMACHAL PRADESH
3 : PUNJAB
4 : CHANDIGARH
5 : UTTARAKHAND
6 : HARYANA
7 : DELHI
8 : RAJASTHAN
9 : UTTAR PRADESH
10 : BIHAR
11 : SIKKIM
12 : ARUNACHAL PRADESH
13 : NAGALAND
14 : MANIPUR
15 : MIZORAM
16 : TRIPURA
17 : MEGHALAYA
18 : ASSAM
19 : WEST BENGAL
20 : JHARKHAND
21 : ORRISA
22 : CHATTISGARH
23 : MADHYA PRADESH
24 : GUJARAT
26 : DADAR AND NAGAR HAVELI & DAMAN AND DIU
27 : MAHARASHTRA
29 : KARNATAKA
30 : GOA
31 : LAKSHADWEEP
32 : KERELA
33 : TAMIL NADU
34 : PUDUCHERRY
35 : ANDAMAN AND NICOBAR
36 : TELENGANA
37 : ANDHRA PRADESH
38 : LADAKH
97 : OTHER TERRITORY
99 : OTHER COUNTRY
CHANDIGARH
toGstinstringGSTIN of consignee29ACGPI2251K1ZJ
toTrdnamestringLegal name of consigneeINDER CHHAJER
toAddr1stringAddress of consignee - Line 1PRIYADARSHANI LAYOUT
toAddr2stringAddress of consignee- Line 2MUDALAYAPALYA
toPlacestringPlace of consigneeBengaluru
toPincodenumPincode of the consignee560072
toStateCodenumState of Supply
Possible value -
1 : JAMMU AND KASHMIR
2 : HIMACHAL PRADESH
3 : PUNJAB
4 : CHANDIGARH
5 : UTTARAKHAND
6 : HARYANA
7 : DELHI
8 : RAJASTHAN
9 : UTTAR PRADESH
10 : BIHAR
11 : SIKKIM
12 : ARUNACHAL PRADESH
13 : NAGALAND
14 : MANIPUR
15 : MIZORAM
16 : TRIPURA
17 : MEGHALAYA
18 : ASSAM
19 : WEST BENGAL
20 : JHARKHAND
21 : ORRISA
22 : CHATTISGARH
23 : MADHYA PRADESH
24 : GUJARAT
26 : DADAR AND NAGAR HAVELI & DAMAN AND DIU
27 : MAHARASHTRA
29 : KARNATAKA
30 : GOA
31 : LAKSHADWEEP
32 : KERELA
33 : TAMIL NADU
34 : PUDUCHERRY
35 : ANDAMAN AND NICOBAR
36 : TELENGANA
37 : ANDHRA PRADESH
38 : LADAKH
97 : OTHER TERRITORY
99 : OTHER COUNTRY
actToStateCodenumState of Supply
Possible value -
1 : JAMMU AND KASHMIR
2 : HIMACHAL PRADESH
3 : PUNJAB
4 : CHANDIGARH
5 : UTTARAKHAND
6 : HARYANA
7 : DELHI
8 : RAJASTHAN
9 : UTTAR PRADESH
10 : BIHAR
11 : SIKKIM
12 : ARUNACHAL PRADESH
13 : NAGALAND
14 : MANIPUR
15 : MIZORAM
16 : TRIPURA
17 : MEGHALAYA
18 : ASSAM
19 : WEST BENGAL
20 : JHARKHAND
21 : ORRISA
22 : CHATTISGARH
23 : MADHYA PRADESH
24 : GUJARAT
26 : DADAR AND NAGAR HAVELI & DAMAN AND DIU
27 : MAHARASHTRA
29 : KARNATAKA
30 : GOA
31 : LAKSHADWEEP
32 : KERELA
33 : TAMIL NADU
34 : PUDUCHERRY
35 : ANDAMAN AND NICOBAR
36 : TELENGANA
37 : ANDHRA PRADESH
38 : LADAKH
97 : OTHER TERRITORY
99 : OTHER COUNTRY
transactionTypenumType of transaction
Possible value -
1 : Regular
2 : Bill To - Ship To
3 : Bill From - Dispatch From
4 : Combination of 2 and 3
1
otherValuenumOther Charges if any2000
totalValuenumSum of Taxable value2000
totInvValuenumTotal Invoice Value
cgstValuenumCGST Amount0
sgstValuenumSGST Amount0
igstValuenumIGST Amount240
cessValuenumCESS Amount20
cessNonAdvolValuenumCESS Non Advol Amount20
transModenumMode of transportation
Possible value -
1 : Road
2 : Rail
3 : Air
4 : Ship
5 : inTransit
1
VehicleTypecharType of Vehicle
Possible value -
R : Regular
O : ODC(Over Dimensional Cargo)
R
transDistancenumDistance of transportation10
transporterIdstringTransporter Id29BQSPA3829E1Z0
transporterNamestringTransporter NameTAPURI
transDocNostringTransporter Doc No11
transDocDatestringTransporter Doc Date13/09/2017
vehicleNostringVehicle 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
itemListarrayArray of Objects containing Product Details Look below

itemList

ParamTypeDescriptionExample
productNamestringName of the ProductSteel
productDescstringDescription of the Product5 mm Rod
hsnCodenumHSN Code of the Product10101
quantitynumQuantity of Product in Numbers200
qtyUnitstringUnit of the Product, like Liter,Kg etc
Possible value -
BAG : BAGS
BAL : BALE
BDL : BUNDLES
BKL : BUCKLES
BOU : BILLION OF UNITS
BOX : BOX
BTL : BOTTLES
BUN : BUNCHES
CAN : CANS
CBM : CUBIC METERS
CCM : CUBIC CENTIMETERS
CMS : CENTI METERS
CTN : CARTONS
DOZ : DOZENS
DRM : DRUMS
GGK : GREAT GROSS
GMS : GRAMMES
GRS : GROSS
GYD : GROSS YARDS
KGS : KILOGRAMS
KLR : KILOLITRE
KME : KILOMETRE
LTR : LITRES
MTR : METERS
MLT : MILILITRE
MTS : METRIC TON
NOS : NUMBERS
OTH : OTHERS
PAC : PACKS
PCS : PIECES
PRS : PAIRS
QTL : QUINTAL
ROL : ROLLS
SET : SETS
SQF : SQUARE FEET
SQM : SQUARE METERS
SQY : SQUARE YARDS
TBS : TABLETS
TGM : TEN GROSS
THD : THOUSANDS
TON : TONNES
TUB : TUBES
UGS : US GALLONS
UNT : UNITS
YDS : YARDS
QTS
taxableAmountnumTaxable Amount100000
cgstRatenumCGST Rate9
sgstRatenumSGST Rate9
igstRatenumIGST Rate18
cessRatenumCESS Rate0
cessNonadvolnumCess Non-Advolerum0

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

ParamTypeDescriptionExample
ewaybillnostringRefers to E-way bill number123456789012
ewayBillDatenumRefers to date when E-way bill is generated25/09/2018 10:30:00 AM
validUptonumRefers to valid date of E-way Bill26/09/2018 12.00:00 PM
alertstringRefers to any kind of alertTotal 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