Get Consolidated EWB PDF

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

Request Method

GET

Request URL

{{HOST}}/einv/v1/consolidate-ewaybill/print?ewb_number={{ewb_number}}

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 = EXTEND_VALIDITY

Request Body

There is no request body for this API.

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
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

NA

Response - Success:

HTTP Status Code - 200 OK

73KB

Consolidated EWB.pdf

pdf

Consolidated EWB

Response - Failure:

HTTP Status Code 200 OK

{
    "error_code": "102",
    "error_message": "No documents with the selected Input are present in the Database;",
    "error_source": "CLEARTAX"
}

API Validations

Currently there are no known validations for this API.

API Constraints

EWB should be present in the ClearTax database.