Get E-Way Bills by date

Get E-Way Bills By Date

curl --request GET \
  --url https://api.sandbox.co.in/gst/compliance/e-way-bill/consignor/bills \
  --header 'authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.sandbox.co.in/gst/compliance/e-way-bill/consignor/bills"

headers = {
    "authorization": "<api-key>",
    "x-api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {authorization: '<api-key>', 'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.co.in/gst/compliance/e-way-bill/consignor/bills', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.co.in/gst/compliance/e-way-bill/consignor/bills",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "authorization: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.co.in/gst/compliance/e-way-bill/consignor/bills"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "<api-key>")
	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.co.in/gst/compliance/e-way-bill/consignor/bills")
  .header("authorization", "<api-key>")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.co.in/gst/compliance/e-way-bill/consignor/bills")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = '<api-key>'
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "data": {
    "data": [
      {
        "docDate": "15/12/2017",
        "docNo": "7001-8",
        "ewbDate": "02/05/2024 07:00:00 PM",
        "ewbNo": 291010077010,
        "genGstin": "29AAACQ3770E000",
        "rejectStatus": "Y",
        "rejectedDate": "02/05/2024 07:43:00 PM",
        "status": "CNL",
        "validUpto": "06/05/2024 11:59:00 PM"
      }
    ],
    "status": "1"
  },
  "timestamp": 1763446641000,
  "transaction_id": "6a0c19c2-ae4d-4f70-9c48-50770fb74dfd"
}

GET

gst

compliance

e-way-bill

consignor

bills

Get E-Way Bills By Date

curl --request GET \
  --url https://api.sandbox.co.in/gst/compliance/e-way-bill/consignor/bills \
  --header 'authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.sandbox.co.in/gst/compliance/e-way-bill/consignor/bills"

headers = {
    "authorization": "<api-key>",
    "x-api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {authorization: '<api-key>', 'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.co.in/gst/compliance/e-way-bill/consignor/bills', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.co.in/gst/compliance/e-way-bill/consignor/bills",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "authorization: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.co.in/gst/compliance/e-way-bill/consignor/bills"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "<api-key>")
	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.co.in/gst/compliance/e-way-bill/consignor/bills")
  .header("authorization", "<api-key>")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.co.in/gst/compliance/e-way-bill/consignor/bills")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = '<api-key>'
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "data": {
    "data": [
      {
        "docDate": "15/12/2017",
        "docNo": "7001-8",
        "ewbDate": "02/05/2024 07:00:00 PM",
        "ewbNo": 291010077010,
        "genGstin": "29AAACQ3770E000",
        "rejectStatus": "Y",
        "rejectedDate": "02/05/2024 07:43:00 PM",
        "status": "CNL",
        "validUpto": "06/05/2024 11:59:00 PM"
      }
    ],
    "status": "1"
  },
  "timestamp": 1763446641000,
  "transaction_id": "6a0c19c2-ae4d-4f70-9c48-50770fb74dfd"
}

NIC validations

The rejected query parameter selects the NIC API that Sandbox calls. Each NIC API applies its own validations.

View NIC validations

When `rejected` is `false`

Only E-way bill generator can access this API.
Only active E-way bills will be considered in this API.

When `rejected` is `true`

Only E-way bill generator can access this API.

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

required

E-Way bill generated date

Example:

"21/02/2025"

rejected

string

Pass true to get rejected E-Way Bills

Example:

"true"

Response

200 - application/json

200 EWBs fetched / 418 No data found / 200 Rejected EWBs fetched / 200 Cancelled and rejected EWBs fetched / Option not enabled in EWB 2

Option 1
Option 2

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

Show child attributes

Analytics

Compliance

Annexures

Get E-Way Bills by date

NIC validations

When `rejected` is `false`

When `rejected` is `true`

Response schema

View JSON schema

Authorizations

Headers

Query Parameters

Response

​NIC validations

​When rejected is false

​When rejected is true

​Response schema

View JSON schema

Authorizations

Headers

Query Parameters

Response

NIC validations

When `rejected` is `false`

When `rejected` is `true`

Response schema