(Deprecated) Generating E-Waybill
Last updated
Was this helpful?
Last updated
Was this helpful?
This API is deprecated. Please use the .
Update: Generate E-Waybill with IRN
Now you can generate E-Waybill with IRN from IRP using the same endpoint earlier used to generate E-Waybill from NIC.
In case you have already generated IRN for a document and you want to generate E-Waybill using the IRN, then you can provide the IRN in the below API Request Body. Wherever IRN is specified, ClearTax will internally route this request to the IRN Portal to generate E-Waybill with IRN.
If IRN is not provided, the request will be routed to NIC to generate E-Waybill as usual.
E-Waybill is generated by submitting a single or an array of E-Waybill JSON object(s) in the request body.
Only for recording the details about supply such as :
GSTIN of the supplier, Place of dispatch, GSTIN of recipient, Place of delivery, Document number, Document Date, Value of goods, HSN Code and Reason for Transportation (Outward supply, Job work, Inward supply, sales return, Export, import, exhibition, for own use etc.)
For giving the goods the title for lawful movement of goods in GST by filling up the following information :
Mode of Transport (Road, Rail, Air, Ship), Vehicle Type (Regular or Over dimensional Cargo), Vehicle Number in case of Road Transportation, Transport Document Number and date,
Who is Required to Fill Part-B of E-Way Bill?
Part B can be update by supplier when he is transporting goods on either in his own or hired a conveyance.
By Transporter and only transporter in all cases Where the supplier has availed the service of Transporter and that the supplier has not prepared Part-A of E-way bill and he has authenticated such transporter to prepare the E-Way bill with such details forwarded by him to the transporter.
Key
Type
Validations
Description
id
String
Mandatory. Unique Transaction ID
irn
String
minLength: 64 maxLength: 64
Optional. In case you have already generated IRN and you want to generate E-Waybill with IRN, then provide the IRN here. ClearTax will internally route this request to the IRN Portal to generate E-Waybill with IRN.
transaction_date
String
Mandatory. Date of transaction
source
ENUM
Possible values: USER, GOVERNMENT
Mandatory. Source of the document.
document_number
String
maxLength: 16
Mandatory. Document number
type
ENUM
Possible values: SALE OR PURCHASE
Mandatory.
transport_mode
ENUM
Possible Values: ROAD, RAIL, AIR, SHIP
Mandatory for part B . Leave this field blank for part A generation. Mode of Transport.
transporter_gstin
String
pattern: "[0-9]{2}[0-9|A-Z]{13}"
Mandatory for part A. 15 Digit Transporter GSTIN/TRANSPORTER ID.
transporter_name
String
maxLength: 100
Name of Transporter.
transporter_from_place
String
maxLength: 50
Transporter City.
transporter_from_state
String
maximum: 99
Transporter State.
transport_doc_number
String
maxLength: 15
Transport document number. Mandatory if transportation mode is rail, air or ship. Leave this field blank for part A generation.
transport_date
String
Should be greater than equal to document date
Date of transport.
dispatch_from_state
ENUM
maximum: 99
Indian state
sub_supply
ENUM
Possible values: SUPPLY
EXPORT
JOB_WORK
OWN_USE
SKD_CKD
LINE_SALES
RECIPIENT_UNKNOWN
EXHIBITION
FAIRS
SALES_RETURN
JOB_WORK_RETURNS
IMPORT
OTHERS
Sub Supply Type
export_type
String
DEEMED
SEZ_WITHOUT_IGST
SEZ_WITH_IGST
EXPORT_WITH_IGST
EXPORT_UNDER_BOND
SALE_FROM_BONDED_WH
REGULAR
Export type
sub_supply_desc
String
maxLength: 20
Sub Supply Description (Mandatory if your sub_supply is OTHERS)
distance
Number
<4000 km
Do not send this field if you want to auto calculate distance based on from and to pin-code.
vehicle_number
String
minLength: 7
maxLength: 15
Vehicle number. Mandatory for road and transport_doc_number is optional. Leave this field blank for part A generation.
vehicle_type
String
NA
Vehicle type.[R - Regular, O - over-dimensional (cargo)]
document_type
String
INV - Tax Invoice
BIL - Bill of Supply
BOE- Bill of Entry
CHL- Delivery Challan
OTH- Others
seller
Object
Mandatory. Person object of the seller
receiver
Object
Mandatory. Person object of the receiver
consignee
Object
Person object of the consignee
transaction_type
ENUM
REGULAR, BILLTO, SHIPTO, Bill From - Dispatch From ,
COMBINATION
line_items
Array
Array of Line Item objects
other_val
String
Other charges in the invoice Eg: TCS value
Key
Type
Description
item_code
String
Client Item/SKU code
gst_code
String
HSN code of the Product
gst_type
ENUM
GOODS or SERVICES
description
String
Product name (not printed)
notes
String
Item description
unit_price
Number
Item unit price in rupees
unit_price_including_tax
Number
Item unit price including tax in rupees
unit_of_measurement
String
Item unit of measurement
item_id
String
Optional: Item ID in ClearTax
Default: null
serial_number
Number
Line item serial number, starting from 1
quantity
Number
Line item quantity
discount_rate
Number
Line item discount rate
discount
Number
Line item discount value
taxable_val
Number
Line item taxable value
cgst_rate
Number
Line item CGST rate. Should be equal to SGST
cgst_val
Number
Line item CGST value
sgst_rate
Number
Line item SGST rate. Should be equal to CGST
sgst_val
Number
Line item SGST value
igst_rate
Number
Line item IGST rate
igst_val
Number
Line item IGST value
cess_rate
Number
Line item cess rate
cess_val
Number
Line item cess value
total_val
Number
Line item total value
Key
Type
Description
name
String
Name of person
gstin
String
GSTIN of person
address1
String
Address Line 1 of person
address2
String
Address Line 2 of person
city
String
City of person
state
String
zip_code
Integer
Zip code of person
country
String
Country of person
phone_number
String
Phone number of person
Key
Type
Description
errorMessage
String
Error message description
errorCode
String
Error code.
E-Waybill can be generated by submitting a PUT request to the E-Waybill API with the following request headers.
URL query string:
Request Parameters:
Parameters
Parameter Type
Type
Description
X-Cleartax-Auth-Token
Header
String
Mandatory. The auth token generated from ClearTax user id and password.
taxable_entity_id
Path
String
Required. This is the unique ID associated with the GSTIN in your account.
id
Path
String
Required. Unique Transaction ID.
activity_type
Query
ENUM
[GENERATE_EWB]
E-Waybill can be generated by submitting a PUT request to the E-Waybill API with the following request headers.
Parameters
Parameter Type
Type
Description
X-Cleartax-Auth-Token
Header
String
Mandatory. The auth token generated from ClearTax user id and password.
taxable_entity_id
Path
String
Required. This is the unique ID associated with the GSTIN in your account.
-
Body
Array
Required. Array of E-Waybill Objects
State of person Refer