Generate E-Way Bill

Headers

authorization

string

required

E-Way Bill access token. For token-generation steps, refer to the Generate E-Way Bill Session recipe, then pass the token in the authorization header.

x-api-version

string

default:1.0.0

API version

x-api-key

string

required

API key for identification

Body

application/json

E-Way Bill schema.

supplyType

enum<string>

required

Supply Type

Available options:

O,

I

Required string length: 1

subSupplyType

string

required

Sub Supply Type

docType

enum<string>

required

Document Type

Available options:

INV,

CHL,

BIL,

BOE,

OTH

docNo

string

required

Document Number (Alphanumeric with / and - are allowed)

Maximum string length: 16

docDate

string

required

Document Date

Pattern: [0-3][0-9]/[0-1][0-9]/[2][0][1-2][0-9]

fromGstin

string

required

From GSTIN (Supplier or Consignor)

Maximum string length: 15

Pattern: ^[0-9]{2}[0-9A-Z]{13}$|^URP$|^urp$

actFromStateCode

integer

required

Actual From State Code

Required range: x <= 99

fromPincode

integer

required

From Pincode

Required range: 100000 <= x <= 999999

fromStateCode

integer

required

From State Code

Required range: x <= 99

toGstin

string

required

To GSTIN (Consignee or Recipient)

Maximum string length: 15

Pattern: ^[0-9]{2}[0-9A-Z]{13}$|^URP$|^urp$

toPincode

integer

required

To Pincode

actToStateCode

integer

required

Actual To State Code

Required range: x <= 99

toStateCode

integer

required

To State Code

Required range: x <= 99

transactionType

integer

required

Transaction type

Required range: x <= 4

totInvValue

number

required

Total Invoice Value (Including taxable value, tax value,and other charges if any)

Must be a multiple of 0.01

transDistance

string

required

Distance (<4000 km)

itemList

object[]

required

The itemList value.

Show child attributes

subSupplyDesc

string

Other Sub Supply Description

Maximum string length: 20

fromTrdName

string

From Trade Name (Consignor Trade name)

Maximum string length: 100

fromAddr1

string

From Address Line 1 (Valid Special Chars #,-,/)

Maximum string length: 120

fromAddr2

string

From Address Line 2(Valid Special Chars # , - ,/)

Maximum string length: 120

fromPlace

string

From Place

Maximum string length: 50

toTrdName

string

To Trade Name (Consignee Trade name or Recipient Trade name)

Maximum string length: 100

toAddr1

string

To Address Line 1 (Valid Special Chars #,-,/)

Maximum string length: 120

toAddr2

string

To Address Line 2 (Valid Special Chars #,-,/)

Maximum string length: 120

toPlace

string

To Place

Maximum string length: 50

totalValue

number

Sum of Taxable value

Must be a multiple of 0.01

cgstValue

number

CGST value

Must be a multiple of 0.01

sgstValue

number

SGST value

Must be a multiple of 0.01

igstValue

number

IGST value

Must be a multiple of 0.01

cessValue

number

Cess value

Must be a multiple of 0.01

cessNonAdvolValue

number

Cess Non Advol value

Must be a multiple of 0.01

otherValue

number

Other charges, if any

Must be a multiple of 0.01

transMode

enum<string>

Mode of transport (Road-1, Rail-2, Air-3, Ship-4)

Available options:

1,

2,

3,

4

transporterName

string

Name of the transporter

Maximum string length: 100

transporterId

string

15 Digit Transporter GSTIN/TRANSIN

Pattern: [0-9]{2}[0-9|A-Z]{13}

transDocNo

string

Transport Document Number (Alphanumeric with / and â€“ are allowed)

Maximum string length: 15

transDocDate

string

Transport Document Date

vehicleNo

string

Vehicle Number

Required string length: 7 - 15

vehicleType

string

Vehicle Type

Response

200 - application/json

212 Invalid Consignee GSTIN / 702 Distance between pincodes is too high or low / 200 EWB generated with alert / 604 Duplicate EWB / 620 Invoice value cannot be less than sum of items / 200 EWB generated / 359 User GSTIN should match from GSTIN / 619 Transporter Id is mandatory for Part A

Option 1
Option 2

An E-Way Bill success or NIC business-failure response. Both variants use HTTP 200.

code

enum<integer>

required

NIC response code.

Available options:

200

timestamp

integer<int64>

required

Unix timestamp.

transaction_id

string

required

Request transaction identifier.

data

object

required

Show child attributes

Analytics

Compliance

Annexures

Generate E-Way Bill

Request body schema

View request body schema

Headers

Body

Response

​Request body schema

View request body schema

Headers

Body

Response

Request body schema