Generate/Regenerate Consolidated EWB

You can generate a consolidated EWB by sending a POST request to E-Invoicing API with the following request headers.

Request Method

POST

Request URL

{{HOST}}/einv/v1/consolidate-ewaybill/generate?action={{action}}

Request Headers

Parameter	Data Type	Field Validations	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

Parameter	Data Type	Field Validations	Description
action	String	NA	Mandatory = GENERATE_CONSOLIDATED_EWB/REGENERATE_CONSOLIDATED_EWB

Request Body

Parameter	Data Type	Field Validations	Description
VehNo	Number	15 Digits	Conditional. Vehicle Number
FromPlace	String	12 Characters	Mandatory. From Place
FromState	Number	2 Digits	Mandatory. From State Code
TransDocNo	String	15 Characters	Conditional. Transport Document Number
TransDocDt	String	dd/mm/yyyy	Optional. Transport Document Date
TransMode	Enum	[ROAD RAIL AIR SHIP IN_TRANSIT]	Mandatory. Transport Mode
EwbNumbers	List	NA	Mandatory,Consolidate E-Way Bills

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 authorised for the operation.
500	If there are any unhandled exceptions on the Clear side.

Response Schema

Parameter	Data Type	Field Validations	Description
ConsolidatedEwbNumber	Number	12 Digits	Consolidated E-Way Bill number
EwbNumbers	List	NA	List of EWB which has been consolidated
ConsolidateEwbDate	String	NA	Date and time at which the EWB was consolidated.

Errors Object

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	NA	Error Source. If there is no error, then this field will not be present.

Sample Request and Response

Request

{
    "VehNo": "KA12AB123",
    "FromPlace": "BANGALORE SOUTH",
    "FromState": 29,
    "TransDocNo": "1234",
    "TransDocDt": "12/10/2017",
    "TransMode": "AIR",
    "EwbNumbers": [
        181009088610,
        171009088617
    ]
}

Response - Success:

HTTP Status Code - 200

{
    "ConsolidatedEwbNumber": "1810000387",
    "EwbNumbers": [
        "111000609282",
        "181000609270"
    ],
    "ConsolidateEwbDate": "15/12/2017 10:27:00 AM"
}

Response - Failure:

HTTP Status Code - 200

{
    "errors": {
        "error_code": "7001",
        "error_message": "Invalid Vehicle Number, Vehicle number length should be between 7 and 15 ",
        "error_source": "CLEARTAX"
    }
}

API Validations

Currently there are no known validations for this API.

API Constraints

1. EWB can be added to the CEWB if the generator of CEWB is a generator or the assigned transporter of the e-way bill.

2. EWB can be added to the CEWB only if the e-way bill is active and within the validity, that is, EWB is not cancelled or not expired.