(Deprecated) Getting E-Waybill
This API is deprecated. Please use the E-Waybill APIs from the unified set available here.
The response objects here will be same as describer in generate E-Waybill
Get an E-Waybill
You can get an E-Waybill by submitting a GET request to the E-Waybill API with the following request headers.
URL query string:
Request Parameters:
Parameters | Parameter Type | Type | Description |
X-Cleartax-Auth-Token | Header | String | Mandatory. The auth token generated from ClearTax user id and password. |
taxable_entity_id | Path | String | Required. This is the unique ID associated with the GSTIN in your account. |
id | Path | String | Required. Unique Transaction ID. |
source | Query | ENUM | Optional. Possible values: USER, GOVERNMENT. Default: USER. |
Sample Request:
Sample Response:
Get many E-Waybills
You can get many E-Waybills by submitting a GET request to the E-Waybill API with the following request headers.
URL query string:
Request Parameters:
Parameter | Parameter Type | Type | Description |
X-Cleartax-Auth-Token | Header | String | Mandatory. The auth token generated from ClearTax user id and password. |
taxable_entity_id | Path | String | Required. This is the unique ID associated with the GSTIN in your account. |
source | Query | String | USER, GOVERNMENT |
return_period | Query | String | Return period in the format MMYYYY |
start_date | Query | String | Start date by which you need to filter |
end_date | Query | String | End date by which you need to filter |
seller_gstin | Query | Array | Seller GSTIN number |
buyer_gstin | Query | Array | Buyer GSTIN number |
invoice_direction | Query | ENUM | SALE, PURCHASE |
id | Query | Array | Unique Transaction ID |
is_ammended | Query | Boolean | TRUE, FALSE |
invoice_type | Query | Array | B2B , B2BUR , B2BA , B2CL , B2CS , EXPORT , IMPORT , ISD , COMPOSITE , B2B_EXPORT |
start | Query | String | Default: 0 /used for pagination |
limit | Query | String | Default: 20 / number of invoices to limit in the response |
ewb_numbers | Query | String | Eway Bill number |
ewb_status | Query | Array | PENDING, PART_A, GENERATED, CANCELLED |
min_distance | Query | String | Minimum distance |
max_distance | Query | String | Maximum distance |
transporter_gstins | Query | String | Transporter GSTIN |
vehicleNumbers | Query | String | Vehicle number |
sub_supply_type | Query | Array | SUPPLY, EXPORT, JOB_WORK, OWN_USE, SKD_CKD, LINE_SALES, RECIPIENT_UNKNOWN, EXHIBITION, FAIRS, SALES_RETURN, JOB_WORK_RETURNS, IMPORT, OTHERS |
Sample Request:
Sample Response:
Last updated