Get E-Waybill Download Status

This API can be used to pull the status of the E-way bills generated by 3rd party against your GSTIN. The API can pull data from the workflow ID provided.

Request Method

GET

Request URL

{{HOST}}/einv/async_action/{{workflow_id}}/otherparty_ewb_download_status

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

Parameter	Data Type	Field Validations	Description
workflow_id	String	24 Characters	Mandatory. The workflow ID which is captured from EWB by others' responses.

Request Query Params

There are no query parameters for this API.

Request Body

NA

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
workflow_id	String	24 Characters	Mandatory. The workflow ID which is captured from EWB by others' responses.
status	String	Enum: PROCESSED	Status of the activity.
message	String	NA	Activity Message
error_message	String	NA	Error message
total	Number	NA	Total E-Way bills found.
failed	Number	NA	Number of E-way bills could not be downloaded.
success	Number	NA	Number of E-Way bills downloaded.

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

Sample Request and Response

Request

There will be no request body.

Response - Success:

HTTP Status Code - 200 OK

{
    "workflow_id": "61fb6de92b86d943ddf7c25c",
    "status": "PROCESSED",
    "message": "Your E-way bill data was successfully downloaded. Total E-way bills downloaded: 4.",
    "error_message": null,
    "total": 4,
    "failed": 0,
    "success": 4
}

Response - Failure:

HTTP Status Code - 200 OK

{
    "error_code": "500",
    "error_message": "Something went wrong. Please retry after some time. Contact cleartax support ([email protected]) if issue persists.",
    "error_source": "CLEARTAX"
}

API Validations

Currently there are no known validations for this API.

API Constraints

Currently there are no known constraints for this API.