Generate e-Way Bill by IRN
e-Invoice system allows the generation of e-Way Bills if an e-Invoice exists for that transaction
Overview
API to generate e-Way Bill by passing irn and other required details in the request body.
Endpoint
| HTTP Method | Resource |
|---|---|
POST | /irp/tax-payer/e-invoice/:irn/e-way-bill |
Request
Follow the below guidelines to pass IRN and transport details to generate e-Way Bill.
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-Invoice Authentication API. | eyJhsebihGyUf...... |
Query Parameter
| Param | Type | Description | Example |
|---|---|---|---|
| supplier-gstin | string | 15-character alphanumeric unique identifier assigned to business entities registering under the GST regime | 24AAACJ3770E2ZV |
Path Parameter
| Param | Type | Description | Example |
|---|---|---|---|
| Irn | string | Irn Number | d056a57cc7cfcc6c9230aa0014 |
Body Parameters
| Param | Type | Description | Example |
|---|---|---|---|
| Irn | string | Irn Number | d056a57cc7cfcc6c9230aa0014e439259d0dc57cfa4eea2326253011fd53ea7e |
| TransId | string | Transin/GSTIN | 12AWGPV7107B1Z1 |
| TransName | string | Name of the transporter | trans name |
| TransMode | string | Mode of transport (Road-1, Rail-2, Air-3, Ship-4) | 1 |
| Distance | num | Distance between source and destination PIN codes | 100 |
| TransDocNo | string | Transport Document Number | TRAN/DOC/11 |
| TransDocDt | string | Transport Document Date | 01/08/2020 |
| VehNo | string | Vehicle Number | KA12ER1234 |
| VehType | string | Whether O-ODC or R-Regular | R |
| ExpShipDtls | json object | Export/Shipping Details | |
| DispDtls | json object | Dispatch Details |
Export/Shipping Details
| Param | Type | Description | Example |
|---|---|---|---|
| Addr1 | string | Address1 of the entity to whom the supplies are shipped to. (Building/Flat no.,Road/Street etc.) | 7th block, kuvempu layout |
| Addr2 | string | Address 2 of the entity to whom the supplies are shipped to. (Floor no., Name of the premises/building). | kuvempu layout |
| Loc | string | Place (City,Town,Village) entity to whom the supplies are shipped to. | Banagalore |
| Pin | num | Pincode | 562160 |
| Stcd | string | State Code to which supplies are shipped to. Refer the master | 29 |
Dispatch Details
| Param | Type | Description | Example |
|---|---|---|---|
| Nm | string | Name of the company from which the goods are dispatched | ABC company pvt ltd |
| Addr1 | string | Address 1 of the entity from which goods are dispatched. (Building/Flat no.,Road/Street etc.) | 7th block, kuvempu layout |
| Addr2 | string | Address 2 of the entity from which goods are dispatched.(Floor no., Name of the premises/building). | kuvempu layout |
| Loc | string | Place (City,Town,Village) entity to whom the supplies are shipped to. | Banagalore |
| Pin | num | Pincode | 562160 |
| Stcd | string | State Code to which supplies are shipped to. Refer the master | 29 |
Sample CURL Request
curl --request POST \
--url https://api.sandbox.co.in/irp/tax-payer/e-invoice/d056a57cc7cfcc6c9230aa0014/e-way-bill \
--header 'Authorization: xxxxxxxxxx' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-api-key: xxxxxxxxxx' \
--header 'x-api-version: 1.0' \
--data '
{
"Irn": "86cb880253c20a314fcddeb966870db8f272472172faf59c745338014c8767b5",
"Distance": 100,
"TransMode": "2",
"TransId": "12AWGPV7107B1Z1",
"TransName": "trans name",
"TransDocDt": "18/08/2022",
"TransDocNo": "TRAN/DOC/11",
"VehNo": "KA12ER1234",
"VehType": "R",
"ExpShipDtls": {
"Addr1": "7th block, kuvempu layout",
"Addr2": "kuvempu layout",
"Loc": "Banagalore",
"Pin": 562160,
"Stcd": "29"
},
"DispDtls": {
"Nm": "ABC company pvt ltd",
"Addr1": "7th block, kuvempu layout",
"Addr2": "kuvempu layout",
"Loc": "Banagalore",
"Pin": 562160,
"Stcd": "29"
}
}
'
Test Environment Not Available
Response
| Param | Type | Description | Example |
|---|---|---|---|
| EwbNo | num | e-Way Bill Number | 111008683051 |
| EwbDt | string | e-Way Bill date | 2020-04-24 11:28:00 |
| EwbValidTill | string | e-Way Bill validity | 2020-04-26 23:59:00 |
| Remarks | string | Additional information such as, If distance is passed is 0, shows actual distance calculated for the pair of PIN codes | Pin-Pin calc distance: 997KM |
Response Caching
Response caching is not available for this API. Learn more about our response caching mechanism here
Wallet Charges
Since Get GSTIN Details API 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 2 months ago