Initiate Multi-Vehicle E-Waybills

You can update Multi-Vehicle E-Waybills by sending a PUT request to E-Invoicing API with the following request headers.

Request Method

PUT

Request URL

{{HOST}}/einv/v1/ewaybill/multi-vehicle

Request Headers

Parameter	Field Validations	Data Type	Description
X-Cleartax-Auth-Token	Header	String	Mandatory. The auth token generated from ClearTax user id and password. Know how.
gstin	Header	String	Mandatory. 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

Parameter	Field Validations	Data Type	Description
EwbNumber	12 Characters	String	Conditional. E-Way bill number.
FromPlace	Max = 50 Characters	String	Mandatory. From place.
FromState	Max = 2 Characters	Number	Mandatory. From state code.
ToPlace	Max = 50 Characters	String	Mandatory. To place.
ToState	Max = 2 Characters	Number	Mandatory. To state code.
TransMode	Enum: ROAD RAIL AIR SHIP	String	Mandatory. Mode of transport.
TotalQuantity	NA	Number	Mandatory. Total quantity of the goods.
UnitOfMeasurement	Refer to masters.	String	Mandatory. Unit of Measurement.
GroupNumber	NA	Number	Mandatory. Group number should always be 0 to initiate multivehicle EWB.
VehicleListDetails	NA	List	Details of Vehicle

Vehicle List Details Object

Parameter	Data Type	Field Validations	Description
VehicleNo	String	NA	Mandatory. Vehicle Number.
DocumentNumber	String	NA	Optional. Document Number.
DocumentDate	String	NA	Optional. Document date.
Quantity	Number	NA	Mandatory. Quantity in each vehicle.

Response Status Codes

HTTP Status Code	Description
200	For a successfully processed request (may be a success or validation error).
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
EwbNumber	Number	12 Characters	E-Way bill number.
GroupNumber	Number	NA	Group Number
UpdatedDate	String	NA	Date and time of update.
errors	List	NA	Array of objects containing error details.

Errors object details

Parameter	Data Type	Field Validations	Description
error_code	Number	NA	Error Code. If there is no error, then this field will not be present.
error_message	String	NA	Error message. If there is no error, then this field will not be present.
error_source	String	Enum: CLEARTAX, GOVT.	Error Source. If there is no error, then this field will not be present.

Sample Request and Response

Request

{
    "EwbNumber": 171009166265,
    "FromPlace": "Bangalore",
    "FromState": 29,
    "ToPlace": "Mumbai",
    "ToState": 33,
    "TransMode": "ROAD",
    "TotalQuantity": 100.345,
    "UnitOfMeasurement": "BAG",
    "GroupNumber": 0,
    "VehicleListDetails": [
      {
        "VehicleNo": "KA12AS1234",
        "DocumentNumber": "23DF34FG45",
        "DocumentDate": "12/12/2020",
        "Quantity": 100.345
      }
    ]
}

Response - Success:

HTTP Status Code - 200 OK

{
    "EwbNumber": 171009166265,
    "GroupNumber": 1,
    "UpdatedDate": "08/02/2021 12:03:00 PM",
    "errors": null
}

Response - Failure:

HTTP Status Code - 200 OK

{
    "EwbNumber": null,
    "GroupNumber": 0,
    "UpdatedDate": null,
    "errors": [
        {
            "error_code": "2000",
            "error_message": "Quantity in Group cannot exceed total quantity in E-Way Bill.",
            "error_source": "CLEARTAX"
        }
    ]
}

API Validations

The total quantity should be greater than the sum of all the group quantities.

API Constraints

EWB should be present in the ClearTax database.