# Generate E-Waybill for Non-IRN documents You can generate an EWB for the document types that are not eligible for IRN by sending a **`PUT`** request to E-Invoicing API with the following request headers. ### Request Method PUT ### Request URL ``` {{HOST}}/einv/v3/ewaybill/generate ``` ### Request Headers
PARAMETERTYPEDESCRIPTION
X-Cleartax-Auth-TokenStringMandatory. The auth token generated from ClearTax user id and password.
gstinStringMandatory. GSTIN number for the user
### Request Path Params There are no path parameters for this API. ### Request Query Params There are no query parameters for this API. ### Request Body
PARAMETERTYPEVALIDATIONSDESCRIPTION
DocumentNumberStringMax Length 16Mandatory. Document number
DocumentTypeString

INV = Tax Invoice

BOS = Bill of supply

BOE = Bill of entry

CHL = Delivery challan

OTH = Other

Mandatory Document type
DocumentDateStringShould in format dd/mm/yyyyyMandatory. Document date
SupplyTypeString

Inward

Outward

Mandatory. Supply Type
SubSupplyTypString

1 or Supply

2 or Import

3 or Export

4 or JOB_WORK

5 or OWN_USE

6 or JOB_WORK_RETURNS

7 or SALES_RETURN

8 or OTH

9 or SKD_CKD

10 or LINES_SALES

11 or RECIPIENT_NOT_KNOWN

12 or EXHIBITION_OR_FAIRS

Mandatory. Sub Supply Type

SubSupplyTypeDescStringNAOther Sub Supply Description
TransactionTypeString

1 or Regular

2 or Bill to-ship to

3 or Bill from-dispatch from

4 or Combination

Mandatory. Transaction type\
TotalInvoiceAmountString

Total Invoice value = Taxable amount of the items +

TotalCgstValue + TotalSgstValue + TotalIgstValue

TotalCessAmount + TotalCessNonAdvolAMount +

Other charges at Doc level

(with a grace range of +/- 2)

Mandatory. Total invoice value
TotalCgstAmountDecimal (18,2)NAConditional. Total CGST value
TotalSgstAmounDecimal (18,2)NAConditional. Total SGST value
TotalIgstAmountDecimal (18,2)NAConditional. Total IGST value
TotalCessAmountDecimal (18,2)NAOptional. Total cess value
TotalCessNonAdvolAmountDecimal (18,2)NAOptional. Cess non Advol value
TotalAssessableAmountDecimal (18,2)NAOptional. Total assessable value
OtherAmountDecimal (18,2)NAOptional. Other values
OtherTcsAmountDecimal (18,2)NAOptional. TCS values
TransIdStringValid GSTIN

Mandatory for PART-A

Transporter GSTIN or CEN (Common Enrollment Number)

TransNameStringMax Length 100Mandatory. Transporter name
TransModeString

Road-1

Rail-2

Air-3

Ship-4

Optional for PART-A otherwise Mandatory
DistanceNumber

minimum: 0

maximum: 4000

Mandatory.

Distance between source and destination PIN codes.

If the value is "0" then the distance will be auto-computed by NIC based on the availability of pin-codes in NIC database.

TransDocNoStringMax Length: 15Optional when transport mode is ROAD. Transporter document number
TransDocDtStringShould in format dd/mm/yyyyyOptional when transport mode is ROAD. Transporter document date
VehNoStringValid vehicle numberMandatory for transport mode ROAD.
VehTypeString

REGULAR

ODC

Optional. Vehicle type
#### Seller, Buyer, Shipping and Dispatch Objects **Use the below keys in the above four objects:** | Parameter | Data Type | Field Validations | Description | | --------- | --------- | ------------------------------------ | --------------------------------------------------------------------- | | Gstin | String | Valid gstin Value/URP | Mandatory. GSTIN number | | LglNm | String | Max length of 100 | Mandatory. Legal name | | TrdNm | String | Max length of 100 | Optional. Trade Name | | Addr1 | String | Max Length 120 | Mandatory. Address one | | Addr2 | String | Max Length 120 | Optional. Address two | | Loc | String | Max length 50 | Mandatory. location | | Pin | Integer | valid Pincode | Optional if dispatch details are present otherwise mandatory. Pincode | | Stcd | String | valid State code with max value of 2 | Mandatory. State code. | #### Line Item Objects | Parameter | Data Type | Field Validations | Description | | ------------ | -------------- | ----------------- | ------------------------------- | | ProdName | string | NA | Optional. Product Name | | ProdDesc | string | NA | Optional. Product description | | HsnCd | Number | NA | Mandatory. Hsn code | | Qty | Decimal (8,2) | NA | Mandatory. Quantity | | Unit | Text (3) | NA | Mandatory. Unit of measurement | | AssAmt | Decimal (18,2) | NA | Mandatory. Assessable amount | | CgstRt | Decimal (6,3) | NA | Conditional. CGST rate | | CgstAmt | Decimal (18,2) | NA | Optional. CGST Amount | | SgstRt | Decimal (6,3) | NA | Conditional. SGST Rate | | SgstAmt | Decimal (18,2) | NA | Optional. SGST Amount | | IgstRt | Decimal (6,3) | NA | Conditional. IGST Rate | | IgstAmt | Decimal (18,2) | NA | Optional. Igst Amount | | CesRt | Decimal (6,3) | NA | Optional. Cess Rate | | CesAmt | Decimal (18,2) | NA | Optional. Cess amount | | OthChrg | Decimal (18,2) | NA | Optional. Other charges | | CesNonAdvAmt | Decimal (18,2) | NA | Optional. cess non advol amount | **Refer to the below link for Supply Type - Document Type mapping:** {% content-ref url="../../../learn-e-waybill-api-basics" %} [learn-e-waybill-api-basics](https://docs.cleartax.in/cleartax-docs/e-invoicing-api/learn-e-waybill-api-basics) {% endcontent-ref %} ### Response Status Codes | HTTP Status Code | Description | | ---------------- | ---------------------------------------------------------------------------- | | 200 | For a successfully processed request (may be a success or validation error). | | 400 | Bad Request. Invalid JSON Payload | | 401 | If the user is not authenticated for the operation. | | 403 | If the user is not authorized for the operation. | | 500 | If there are any unhandled exceptions on the Clear side. | ### Response Schema | Parameter | Data Type | Field Validations | Description | | --------------- | --------- | --------------------- | ----------------------------------------------------------- | | owner\_id | String | NA | Its value will be null. | | ewb\_status | String | Enum: GENERATED, null | Status of generation of EWB | | ewb\_request | Object | NA | EWB requests details provided in input. | | govt\_response | Object | NA | Govt response containing EWB generation details. | | transaction\_id | String | NA | Unique ID created by ClearTax for troubleshooting purposes. | #### Govt response object | Parameter | Data Type | Field Validations | Description | | ------------ | --------- | ----------------- | ------------------------------------ | | Success | Boolean | ‘Y’, ‘N’ | If Success or Failure. | | Status | String | Enum: Generated | Generation Status of EWB | | EwbNo | Number | NA | E-Way bill Number. | | EwbDt | String | NA | E-Way bill generation date and time. | | EwbValidTill | String | NA | E-Way bill expiry date and time. | ### Sample Request & Response #### Request {% tabs %} {% tab title="PART A & B" %} ```json { "DocumentNumber": "STEST0004", "DocumentType": "INV", "DocumentDate": "12/10/2023", "SupplyType": "OUTWARD", "SubSupplyType": "SUPPLY", "SubSupplyTypeDesc": "TEST", "TransactionType": "Combination", "BuyerDtls": { "Gstin": "29AWGPV7107B1Z1", "LglNm": "XYZ company pvt ltd", "TrdNm": "XYZ Industries", "Addr1": "7th block, kuvempu layout", "Addr2": "kuvempu layout", "Loc": "GANDHINAGAR", "Pin": 562160, "Stcd": "29" }, "SellerDtls": { "Gstin": "29AAFCD5862R000", "LglNm": "NIC company pvt ltd", "TrdNm": "NIC Industries", "Addr1": "5th block, kuvempu layout", "Addr2": "kuvempu layout", "Loc": "GANDHINAGAR", "Pin": 560027, "Stcd": "29" }, "ExpShipDtls": { "LglNm": "ABCD", "Addr1": "322 & 323 THIRUVALLUVAR NAGAR NEELI", "Addr2": null, "Loc": "COIMBATORE", "Pin": 641033, "Stcd": "33" }, "DispDtls": { "Nm": "XYZ", "Addr1": "322 & 323 THIRUVALLUVAR NAGAR", "Addr2": "2nd cross, apavu nagar", "Loc": "Hosur", "Pin": 635109, "Stcd": "33" }, "ItemList": [ { "ProdName": "Rice", "ProdDesc": "test", "HsnCd": "1001", "Qty": 1, "Unit": "BAG", "AssAmt": 100, "CgstRt": 9, "CgstAmt": 9, "SgstRt": 9, "SgstAmt": 9, "IgstRt": 0, "IgstAmt": 0, "CesRt": 0, "CesAmt": 0, "OthChrg": 0, "CesNonAdvAmt": 0, "LineItemCustomFields": { "test": "0100" } } ], "TotalInvoiceAmount": 118, "TotalCgstAmount": 9, "TotalSgstAmount": 9, "TotalIgstAmount": 0, "TotalCessAmount": 0, "TotalCessNonAdvolAmount": 0, "TotalAssessableAmount": 100, "OtherAmount": 0, "OtherTcsAmount": 0, "TransId": "29AAACW6288M1ZH", "TransName": "TRANSPORT", "TransMode": "ROAD", "Distance": 0, "TransDocNo": "TEST-123", "TransDocDt": "12/10/2023", "VehNo": "KA123456", "VehType": "REGULAR", "CustomFields": { "company number": "104" } } ``` {% endtab %} {% tab title="PART A" %} ```json { "DocumentNumber": "STEST0004", "DocumentType": "INV", "DocumentDate": "12/10/2023", "SupplyType": "OUTWARD", "SubSupplyType": "SUPPLY", "SubSupplyTypeDesc": "TEST", "TransactionType": "Combination", "BuyerDtls": { "Gstin": "29AWGPV7107B1Z1", "LglNm": "XYZ company pvt ltd", "TrdNm": "XYZ Industries", "Addr1": "7th block, kuvempu layout", "Addr2": "kuvempu layout", "Loc": "GANDHINAGAR", "Pin": 562160, "Stcd": "29" }, "SellerDtls": { "Gstin": "29AAFCD5862R000", "LglNm": "NIC company pvt ltd", "TrdNm": "NIC Industries", "Addr1": "5th block, kuvempu layout", "Addr2": "kuvempu layout", "Loc": "GANDHINAGAR", "Pin": 560027, "Stcd": "29" }, "ExpShipDtls": { "LglNm": "ABCD", "Addr1": "322 & 323 THIRUVALLUVAR NAGAR NEELI", "Addr2": null, "Loc": "COIMBATORE", "Pin": 641033, "Stcd": "33" }, "DispDtls": { "Nm": "XYZ", "Addr1": "322 & 323 THIRUVALLUVAR NAGAR", "Addr2": "2nd cross, apavu nagar", "Loc": "Hosur", "Pin": 635109, "Stcd": "33" }, "ItemList": [ { "ProdName": "Rice", "ProdDesc": "test", "HsnCd": "1001", "Qty": 1, "Unit": "BAG", "AssAmt": 100, "CgstRt": 9, "CgstAmt": 9, "SgstRt": 9, "SgstAmt": 9, "IgstRt": 0, "IgstAmt": 0, "CesRt": 0, "CesAmt": 0, "OthChrg": 0, "CesNonAdvAmt": 0, "LineItemCustomFields": { "test": "0100" } } ], "TotalInvoiceAmount": 118, "TotalCgstAmount": 9, "TotalSgstAmount": 9, "TotalIgstAmount": 0, "TotalCessAmount": 0, "TotalCessNonAdvolAmount": 0, "TotalAssessableAmount": 100, "OtherAmount": 0, "OtherTcsAmount": 0, "TransId": "29AAACW6288M1ZH", "TransName": "TRANSPORT", "TransMode": null, "Distance": 0, "TransDocNo": "TEST-123", "TransDocDt": "12/10/2023", "VehNo": null, "VehType": null, "CustomFields": { "company number": "104" } } ``` {% endtab %} {% endtabs %} #### Response - **Success:** **HTTP Status Code: 200 OK** ```json { "owner_id": null, "ewb_status": "GENERATED", "ewb_request": { "TransId": "29AAACW6288M1ZH", "TransName": "ABC", "TransMode": "ROAD", "Distance": 0, "TransDocNo": "TEST-123", "TransDocDt": "12/10/2023", "VehNo": "KA123456", "VehType": "REGULAR", "DispDtls": { "Addr1": "322 & 323 THIRUVALLUVAR NAGAR", "Addr2": "2nd cross, apavu nagar", "Loc": "Hosur", "Pin": 635109, "Stcd": "33" }, "ExpShipDtls": { "CustomerName": "ABC", "Addr1": "322 & 323 THIRUVALLUVAR NAGAR NEELI", "Addr2": "Test2", "Loc": "COIMBATORE", "Pin": 641033, "Stcd": "33" }, "BuyerDtls": { "Gstin": "29AAFCD5862R1ZR", "TrdNm": "XYZ Industries", "Addr1": "7th block, kuvempu layout", "Addr2": "kuvempu layout", "Loc": "GANDHINAGAR", "Pin": 562160, "Stcd": "29" }, "SellerDtls": { "Gstin": "07AAFCD5862R007", "TrdNm": "NIC Industries", "Addr1": "5th block, kuvempu layout", "Addr2": "kuvempu layout", "Loc": "GANDHINAGAR", "Pin": 110001, "Stcd": "07" }, "DocumentNumber": "STEST0002", "DocumentType": "CHL", "DocumentDate": "12/10/2023", "SupplyType": "OUTWARD", "SubSupplyType": "Job Work", "SubSupplyTypeDesc": "TEST", "TransactionType": "Combination", "ItemList": [ { "ProdName": "Rice", "ProdDesc": "test", "HsnCd": "1001", "Qty": 1.000, "Unit": "BAG", "AssAmt": 100.00, "CgstRt": 0.00, "CgstAmt": 0.00, "SgstRt": 0.00, "SgstAmt": 0.00, "IgstRt": 0.00, "IgstAmt": 0.00, "CesRt": 0.00, "CesAmt": 0.00, "CesNonAdvAmt": 0.00, "OthChrg": 0.00, "OthChrgTcs": null, "LineItemCustomFields": null } ], "TotalInvoiceAmount": 100.00, "IsSupplyToOrSezUnit": null, "TotalCgstAmount": 0.00, "TotalSgstAmount": 0.00, "TotalIgstAmount": 0.00, "TotalCessAmount": 0.00, "TotalCessNonAdvolAmount": 0.00, "TotalAssessableAmount": 100.00, "OtherAmount": 0.00, "OtherTcsAmount": 0.00, "CustomFields": null }, "govt_response": { "Success": "Y", "Status": "GENERATED", "EwbNo": 741008837974, "EwbDt": "2023-11-03 12:37:00", "EwbValidTill": "2023-11-05 23:59:00", "Alert": ", Distance between these two pincodes is 315, " }, "transaction_id": "07AAFCD5862R007_WAREWB67_CHL_2023" } ``` #### Response - **Failure:** **HTTP Status Code: 200 OK** ```json { "owner_id": null, "ewb_status": null, "ewb_request": { "TransId": "29AAACW6288M1ZH", "TransName": "ABC", "TransMode": "ROAD", "Distance": 0, "TransDocNo": null, "TransDocDt": null, "VehNo": "KA123456", "VehType": "REGULAR", "DispDtls": { "Addr1": "322 & 323 THIRUVALLUVAR NAGAR", "Addr2": "2nd cross, apavu nagar", "Loc": "Hosur", "Pin": 635109, "Stcd": "33" }, "ExpShipDtls": { "CustomerName": "ABC", "Addr1": "322 & 323 THIRUVALLUVAR NAGAR NEELI", "Addr2": "Test2", "Loc": "COIMBATORE", "Pin": 641033, "Stcd": "33" }, "BuyerDtls": { "Gstin": "29AAFCD5862R1ZR", "TrdNm": "XYZ Industries", "Addr1": "7th block, kuvempu layout", "Addr2": "kuvempu layout", "Loc": "GANDHINAGAR", "Pin": 562160, "Stcd": "29" }, "SellerDtls": { "Gstin": "07AAFCD5862R007", "TrdNm": "NIC Industries", "Addr1": "5th block, kuvempu layout", "Addr2": "kuvempu layout", "Loc": "GANDHINAGAR", "Pin": 110001, "Stcd": "07" }, "DocumentNumber": "WAREWB68", "DocumentType": "CHL", "DocumentDate": "12/10/2023", "SupplyType": "OUTWARD", "SubSupplyType": "Job Work", "SubSupplyTypeDesc": "TEST", "TransactionType": "Regular", "ItemList": [ { "ProdName": "Rice", "ProdDesc": "test", "HsnCd": "1001", "Qty": 1.000, "Unit": "BAG", "AssAmt": 100.00, "CgstRt": 0.00, "CgstAmt": 0.00, "SgstRt": 0.00, "SgstAmt": 0.00, "IgstRt": 0.00, "IgstAmt": 0.00, "CesRt": 0.00, "CesAmt": 0.00, "CesNonAdvAmt": 0.00, "OthChrg": 0.00, "OthChrgTcs": null, "LineItemCustomFields": null } ], "TotalInvoiceAmount": 100.00, "IsSupplyToOrSezUnit": null, "TotalCgstAmount": 0.00, "TotalSgstAmount": 0.00, "TotalIgstAmount": 0.00, "TotalCessAmount": 0.00, "TotalCessNonAdvolAmount": 0.00, "TotalAssessableAmount": 100.00, "OtherAmount": 0.00, "OtherTcsAmount": 0.00, "CustomFields": null }, "govt_response": { "Success": "N", "ErrorDetails": [ { "error_code": "107", "error_message": "transactionType : Invalid Transaction Type. Transaction Type should be a Combination of 2 & 3 when Buyer, seller, shipping and dispatch State Codes or Pin codes are not equal. Please correct the Transaction Type value and try again", "error_source": "CLEARTAX" } ] }, "transaction_id": null } ``` ### API Validations Currently there are no known validations for this API. ### API Constraints Currently there are no known constraints for this API.