Download E-waybills by Others

This API can be used to pull the details of the E-way bills generated by 3rd party against your GSTIN.

Request Method

POST

Request URL

{{HOST}}/einv/other_party_ewb/download

Request Headers

Parameter	Data Type	Field Validations	Description
X-Cleartax-Auth-Token	String	NA	Mandatory. The auth token generated from ClearTax user id and password. Know how.
gstin	String	NA	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	Data Type	Field Validations	Description
from_date	String	The minimum date can be up to three days before the current date (excluded).	Mandatory. The start date for the documents to be downloaded.
till_date	String	The maximum date can be the current date minus one.	Mandatory. The end date for the documents to be downloaded.

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.

Sample Request and Response

Request

{
    "from_date":"02/02/2022",
    "till_date":"02/02/2022"
}

Response - Success:

HTTP Status Code 200 OK

{
   "workflow_id": "61fcc328ef10ce2f6ef58e7b",
   "status": "INIT",
   "error_message": null,
   "message": null,
   "total": 0,
   "failed": 0,
   "success": 0
}

Response - Failure:

HTTP Status Code 200 OK

{
   "message": "Passing date should be within last/latest 3 days, other than current date.",
   "error_group_code": 0,
   "error_id": 0
}

API Validations

Currently there are no known validations for this API.

API Constraints

The API can pull data up to the current date minus one. The API is restricted by the government to pull just three days of data excluding the current date.

This API triggers download activity asynchronously. Make a note of the workflow_id to track the status of the downloaded E-Waybills later by calling the Get E-Waybill Download Status API.