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.

Date Range Limitations

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.

Request URL

POST: {{HOST}}/einv/other_party_ewb/download

Request Headers

x-cleartax-auth-token: {{USER_AUTH_TOKEN}}
gstin:{{gstin_number}}
PARAMETER
TYPE
DESCRIPTION

X-Cleartax-Auth-Token

String

Mandatory. The auth token generated from ClearTax user id and password. Know how.

gstin

String

Mandatory. GSTIN number for the user

Request Body

PARAMETER
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 current date minus one.

Mandatory. The end date for the documents to be downloaded.

Sample Request

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

Sample Response

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

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.

Last updated