Skip to main content
GET
Get E-Way Bills by date and state

Choose a lookup

Use one of these query parameter combinations: Dates use DD/MM/YYYY. Do not pass both date parameters in the same request. generator_state_code is required for assignment-date lookups and optional for generation-date lookups.

NIC validations

The query parameters you pass select the NIC API that Sandbox calls. Each NIC API applies its own validations.

With generated_date only

NIC has not published validations for this request.

With generated_date and generator_state_code

  1. Valid EWB generated date has to be passed.
  2. Only active E-waybill will be considered in this API.
  3. Valid state code of the EWB generator has to be passed.
  4. Rate control limit has been set for accessing this API. This API can be accessed 50 times with in a span of 15 min. This 15 min window starts from the time of first access of this API, if API is accessed 50 times within this period, API will be blocked for the remaining duration of time period. For example: If you have accessed this API at 2:00 PM and tried 50 access till 2:05 PM then, you will be blocked till 2:15 PM for accessing this API as the allowed number of requests has been exceeded, you will get an error code 658. Again you are allowed to access this API only after 2.15 PM and the same above process will continue there after.

With assigned_date and generator_state_code

  1. Valid EWB generated date has to be passed.
  2. Only active E-waybill will be considered in this API.
  3. Valid state code of the EWB generator has to be passed.
  4. Rate control limit has been set for accessing this API. This API can be accessed 50 times with in a span of 15 min. This 15 min window starts from the time of first access of this API, if API is accessed 50 times within this period, API will be blocked for the remaining duration of time period. For example: If you have accessed this API at 2:00 PM and tried 50 access till 2:05 PM then, you will be blocked till 2:15 PM for accessing this API as the allowed number of requests has been exceeded, you will get an error code 658. Again you are allowed to access this API only after 2.15 PM and the same above process will continue there after.
NIC rate limitApplies when you pass generator_state_code with either generated_date or assigned_date.“This API can be accessed 50 times with in a span of 15 min.”Read the NIC validations section for the window, blocking behaviour and error 658. Sandbox rate limits apply separately.
For the assigned_date lookup, NIC’s first validation refers to the generated date. Pass the assignment date in assigned_date.
NIC’s rate control for the two state-code lookups is separate from Sandbox rate limits.

Response schema

For successful responses, this reference describes the NIC E-Way Bill payload at data.data.

View JSON schema

Authorizations

authorization
string
header
required

E-Way Bill taxpayer access token returned by Authenticate.

x-api-key
string
header
required

Sandbox API key from your Sandbox account.

Headers

x-api-version
string
default:1.0.0

API version

x-source
enum<string>
default:primary

NIC server for the session used by this request. primary selects NIC1. secondary selects NIC2. Defaults to primary. See NIC1 and NIC2 routing.

Available options:
primary,
secondary
x-proxy
enum<string>

NIC server that receives the request. If omitted, the request goes to the server selected by x-source. When specified, selects the other server. See NIC1 and NIC2 routing.

Available options:
primary,
secondary

Query Parameters

generated_date
string

E-Way Bill generated date

Example:

"19/09/2024"

generator_state_code
string

Generator state code. Use it with generated_date or with assigned_date. You can also use generated_date without this parameter.

Example:

"29"

assigned_date
string

E-Way Bill assigned date

Example:

"19/09/2024"

Response

200 - application/json

200 EWBs fetched / 336 Could not retrieve data

An E-Way Bill success or NIC business-failure response. Both variants use HTTP 200.

code
enum<integer>
required

NIC response code.

Available options:
200
timestamp
integer<int64>
required

Unix timestamp.

transaction_id
string
required

Request transaction identifier.

data
object
required