Get e-Invoice by document data

Fetch the e-Invoice by passing the document type, document number & document date. To fetch an e-Invoice, the authenticated taxpayer has to be a party in the transaction, either the seller or the buyer.

GET /gst/compliance/e-invoice/tax-payer/invoice

Get E-Invoice by document data

cURL

curl --request GET \
  --url https://api.sandbox.co.in/gst/compliance/e-invoice/tax-payer/invoice \
  --header 'authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>'

import requests

url = "https://api.sandbox.co.in/gst/compliance/e-invoice/tax-payer/invoice"

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

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

print(response.text)

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

fetch('https://api.sandbox.co.in/gst/compliance/e-invoice/tax-payer/invoice', 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-invoice/tax-payer/invoice",
  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: <authorization>",
    "x-api-key: <x-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-invoice/tax-payer/invoice"

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

	req.Header.Add("authorization", "<authorization>")
	req.Header.Add("x-api-key", "<x-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-invoice/tax-payer/invoice")
  .header("authorization", "<authorization>")
  .header("x-api-key", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.co.in/gst/compliance/e-invoice/tax-payer/invoice")

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

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

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

200

200 Get IRN

{
  "code": 200,
  "data": {
    "Data": {
      "AckDt": "2023-03-30 17:08:00",
      "AckNo": 162310037589380,
      "EwbDt": null,
      "EwbNo": null,
      "EwbValidTill": null,
      "Irn": "49a7c675b25f730d2353622e4767df203fed2495411953e0351737d47308d868",
      "Remarks": null,
      "SignedInvoice": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE1MTNCODIxRUU0NkM3NDlBNjNCODZFMzE4QkY3MTEwOTkyODdEMUYiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJGUk80SWU1R3gwbW1PNGJqR0w5eEVKa29mUjgifQ.eyJkYXRhIjoie1wiQWNrTm9cIjoxNjIzMTAwMzc1ODkzODAsXCJBY2tEdFwiOlwiMjAyMy0wMy0zMCAxNzowNzo0NlwiLFwiSXJuXCI6XCI0OWE3YzY3NWIyNWY3MzBkMjM1MzYyMmU0NzY3ZGYyMDNmZWQyNDk1NDExOTUzZTAzNTE3MzdkNDczMDhkODY4XCIsXCJWZXJzaW9uXCI6XCIxLjFcIixcIlRyYW5EdGxzXCI6e1wiVGF4U2NoXCI6XCJHU1RcIixcIlN1cFR5cFwiOlwiQjJCXCIsXCJSZWdSZXZcIjpcIllcIixcIklnc3RPbkludHJhXCI6XCJOXCJ9LFwiRG9jRHRsc1wiOntcIlR5cFwiOlwiSU5WXCIsXCJOb1wiOlwiRE9DLzEyMTAxXCIsXCJEdFwiOlwiMTgvMDgvMjAyMlwifSxcIlNlbGxlckR0bHNcIjp7XCJHc3RpblwiOlwiMjRBQUFQSTMxODJNMDAyXCIsXCJMZ2xObVwiOlwiTklDIGNvbXBhbnkgcHZ0IGx0ZFwiLFwiVHJkTm1cIjpcIk5JQyBJbmR1c3RyaWVzXCIsXCJBZGRyMVwiOlwiNXRoIGJsb2NrLCBrdXZlbXB1IGxheW91dFwiLFwiQWRkcjJcIjpcImt1dmVtcHUgbGF5b3V0XCIsXCJMb2NcIjpcIkdBTkRISU5BR0FSXCIsXCJQaW5cIjozODAwMjYsXCJTdGNkXCI6XCIyNFwiLFwiUGhcIjpcIjkwMDAwMDAwMDBcIixcIkVtXCI6XCJhYmNAZ21haWwuY29tXCJ9LFwiQnV5ZXJEdGxzXCI6e1wiR3N0aW5cIjpcIjI5QVdHUFY3MTA3QjFaMVwiLFwiTGdsTm1cIjpcIlhZWiBjb21wYW55IHB2dCBsdGRcIixcIlRyZE5tXCI6XCJYWVogSW5kdXN0cmllc1wiLFwiUG9zXCI6XCIxMlwiLFwiQWRkcjFcIjpcIjd0aCBibG9jaywga3V2ZW1wdSBsYXlvdXRcIixcIkFkZHIyXCI6XCJrdXZlbXB1IGxheW91dFwiLFwiTG9jXCI6XCJHQU5ESElOQUdBUlwiLFwiUGluXCI6NTYyMTYwLFwiUGhcIjpcIjkxMTExMTExMTExXCIsXCJFbVwiOlwieHl6QHlhaG9vLmNvbVwiLFwiU3RjZFwiOlwiMjlcIn0sXCJEaXNwRHRsc1wiOntcIk5tXCI6XCJBQkMgY29tcGFueSBwdnQgbHRkXCIsXCJBZGRyMVwiOlwiN3RoIGJsb2NrLCBrdXZlbXB1IGxheW91dFwiLFwiQWRkcjJcIjpcImt1dmVtcHUgbGF5b3V0XCIsXCJMb2NcIjpcIkJhbmFnYWxvcmVcIixcIlBpblwiOjU2MjE2MCxcIlN0Y2RcIjpcIjI5XCJ9LFwiU2hpcER0bHNcIjp7XCJHc3RpblwiOlwiMjlBV0dQVjcxMDdCMVoxXCIsXCJMZ2xObVwiOlwiQ0JFIGNvbXBhbnkgcHZ0IGx0ZFwiLFwiVHJkTm1cIjpcImt1dmVtcHUgbGF5b3V0XCIsXCJBZGRyMVwiOlwiN3RoIGJsb2NrLCBrdXZlbXB1IGxheW91dFwiLFwiQWRkcjJcIjpcImt1dmVtcHUgbGF5b3V0XCIsXCJMb2NcIjpcIkJhbmFnYWxvcmVcIixcIlBpblwiOjU2MjE2MCxcIlN0Y2RcIjpcIjI5XCJ9LFwiSXRlbUxpc3RcIjpbe1wiSXRlbU5vXCI6MCxcIlNsTm9cIjpcIjFcIixcIklzU2VydmNcIjpcIk5cIixcIlByZERlc2NcIjpcIlJpY2VcIixcIkhzbkNkXCI6XCIxMDAxXCIsXCJCYXJjZGVcIjpcIjEyMzQ1NlwiLFwiUXR5XCI6MTAwLjM0NSxcIkZyZWVRdHlcIjoxMCxcIlVuaXRcIjpcIkJBR1wiLFwiVW5pdFByaWNlXCI6OTkuNTQ1LFwiVG90QW10XCI6OTk4OC44NCxcIkRpc2NvdW50XCI6MTAsXCJQcmVUYXhWYWxcIjoxLFwiQXNzQW10XCI6OTk3OC44NCxcIkdzdFJ0XCI6MTIsXCJJZ3N0QW10XCI6MTE5Ny40NixcIkNnc3RBbXRcIjowLFwiU2dzdEFtdFwiOjAsXCJDZXNSdFwiOjUsXCJDZXNBbXRcIjo0OTguOTQsXCJDZXNOb25BZHZsQW10XCI6MTAsXCJTdGF0ZUNlc1J0XCI6MTIsXCJTdGF0ZUNlc0FtdFwiOjExOTcuNDYsXCJTdGF0ZUNlc05vbkFkdmxBbXRcIjo1LFwiT3RoQ2hyZ1wiOjEwLFwiVG90SXRlbVZhbFwiOjEyODk3LjcsXCJPcmRMaW5lUmVmXCI6XCIzMjU2XCIsXCJPcmdDbnRyeVwiOlwiQUdcIixcIlByZFNsTm9cIjpcIjEyMzQ1XCIsXCJCY2hEdGxzXCI6e1wiTm1cIjpcIjEyMzQ1NlwiLFwiRXhwRHRcIjpcIjAxLzA4LzIwMjBcIixcIldyRHRcIjpcIjAxLzA5LzIwMjBcIn0sXCJBdHRyaWJEdGxzXCI6W3tcIk5tXCI6XCJSaWNlXCIsXCJWYWxcIjpcIjEwMDAwXCJ9XX1dLFwiVmFsRHRsc1wiOntcIkFzc1ZhbFwiOjk5NzguODQsXCJDZ3N0VmFsXCI6MCxcIlNnc3RWYWxcIjowLFwiSWdzdFZhbFwiOjExOTcuNDYsXCJDZXNWYWxcIjo1MDguOTQsXCJTdENlc1ZhbFwiOjEyMDIuNDYsXCJEaXNjb3VudFwiOjEwLFwiT3RoQ2hyZ1wiOjIwLFwiUm5kT2ZmQW10XCI6MC4zLFwiVG90SW52VmFsXCI6MTI5MDgsXCJUb3RJbnZWYWxGY1wiOjEyODk3Ljd9LFwiUGF5RHRsc1wiOntcIk5tXCI6XCJBQkNERVwiLFwiQWNjRGV0XCI6XCI1Njk3Mzg5NzEzMjEwXCIsXCJNb2RlXCI6XCJDYXNoXCIsXCJGaW5JbnNCclwiOlwiU0JJTjExMDAwXCIsXCJQYXlUZXJtXCI6XCIxMDBcIixcIlBheUluc3RyXCI6XCJHaWZ0XCIsXCJDclRyblwiOlwidGVzdFwiLFwiRGlyRHJcIjpcInRlc3RcIixcIkNyRGF5XCI6MTAwLFwiUGFpZEFtdFwiOjEwMDAwLFwiUGF5bXREdWVcIjo1MDAwfSxcIlJlZkR0bHNcIjp7XCJJbnZSbVwiOlwiVEVTVFwiLFwiRG9jUGVyZER0bHNcIjp7XCJJbnZTdER0XCI6XCIwMS8wOC8yMDIwXCIsXCJJbnZFbmREdFwiOlwiMDEvMDkvMjAyMFwifSxcIlByZWNEb2NEdGxzXCI6W3tcIkludk5vXCI6XCJET0MvMDAyXCIsXCJJbnZEdFwiOlwiMDEvMDgvMjAyMFwiLFwiT3RoUmVmTm9cIjpcIjEyMzQ1NlwifV0sXCJDb250ckR0bHNcIjpbe1wiUmVjQWR2UmVmclwiOlwiRG9jLzAwM1wiLFwiUmVjQWR2RHRcIjpcIjAxLzA4LzIwMjBcIixcIlRlbmRSZWZyXCI6XCJBYmMwMDFcIixcIkNvbnRyUmVmclwiOlwiQ28xMjNcIixcIkV4dFJlZnJcIjpcIllvNDU2XCIsXCJQcm9qUmVmclwiOlwiRG9jLTQ1NlwiLFwiUE9SZWZyXCI6XCJEb2MtNzg5XCIsXCJQT1JlZkR0XCI6XCIwMS8wOC8yMDIwXCJ9XX0sXCJBZGRsRG9jRHRsc1wiOlt7XCJVcmxcIjpcImh0dHBzOi8vZWludi1hcGlzYW5kYm94Lm5pYy5pblwiLFwiRG9jc1wiOlwiVGVzdCBEb2NcIixcIkluZm9cIjpcIkRvY3VtZW50IFRlc3RcIn1dLFwiRXhwRHRsc1wiOntcIlNoaXBCTm9cIjpcIkEtMjQ4XCIsXCJTaGlwQkR0XCI6XCIwMS8wOC8yMDIwXCIsXCJQb3J0XCI6XCJJTkFCRzFcIixcIlJlZkNsbVwiOlwiTlwiLFwiRm9yQ3VyXCI6XCJBRURcIixcIkNudENvZGVcIjpcIkFFXCJ9LFwiRXdiRHRsc1wiOntcIlRyYW5zSWRcIjpcIjEyQVdHUFY3MTA3QjFaMVwiLFwiVHJhbnNOYW1lXCI6XCJYWVogRVhQT1JUU1wiLFwiVHJhbnNNb2RlXCI6XCIxXCIsXCJEaXN0YW5jZVwiOjEwMCxcIlRyYW5zRG9jTm9cIjpcIkRPQzAxXCIsXCJUcmFuc0RvY0R0XCI6XCIxOC8wOC8yMDIwXCIsXCJWZWhOb1wiOlwia2ExMjM0NTZcIixcIlZlaFR5cGVcIjpcIlJcIn19IiwiaXNzIjoiTklDIFNhbmRib3gifQ.AmIULcritlmFFfXLSh-efRGfpmyOLgePydu_dwmDIxbmZbQJP_qgqpLKFwL8q3qSEFVyIntjkj2LBBws2WmEWGFcqTETIbniKRDdTBHGqy7aV-r05RhQs34DCkUJs56lqeRVBKe42xMuc_y1dZNHqMOpKv8FnhB6u9UDm-BCe7yIK3evUij3okrPvuXOVR48HCMjNnu25yhCdW_pAKtPUkWRxIZaW2eCOBnJs2v0lBC_lSDLdTklJBEk1cDs2dvOyVyd-IgZCBJOK2Ebsj9LdopC07NqDXKS0f7spJU8nXVXkkxqcmzgCHFXH7KztlxljYipkBTquFREcoGsw8ZLgQ",
      "SignedQRCode": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE1MTNCODIxRUU0NkM3NDlBNjNCODZFMzE4QkY3MTEwOTkyODdEMUYiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJGUk80SWU1R3gwbW1PNGJqR0w5eEVKa29mUjgifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI0QUFBUEkzMTgyTTAwMlwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBV0dQVjcxMDdCMVoxXCIsXCJEb2NOb1wiOlwiRE9DLzEyMTAxXCIsXCJEb2NUeXBcIjpcIklOVlwiLFwiRG9jRHRcIjpcIjE4LzA4LzIwMjJcIixcIlRvdEludlZhbFwiOjEyOTA4LFwiSXRlbUNudFwiOjEsXCJNYWluSHNuQ29kZVwiOlwiMTAwMVwiLFwiSXJuXCI6XCI0OWE3YzY3NWIyNWY3MzBkMjM1MzYyMmU0NzY3ZGYyMDNmZWQyNDk1NDExOTUzZTAzNTE3MzdkNDczMDhkODY4XCIsXCJJcm5EdFwiOlwiMjAyMy0wMy0zMCAxNzowNzo0NlwifSIsImlzcyI6Ik5JQyBTYW5kYm94In0.EwKrLMKD3NLqa2oUNfuok0asxNqhhNGppaXBF4isim8L2Q2rC7Xj8biJN4z2vee0M1aOPwIiBS9tQqmrUOuN1sbnnjYu_WbesoVsUWDrBgGlSYjo1AQiPO_41lo1tpuCxvIJjveq25PchVr2-_7BkS5tHGTITK1lrK-rqfMuhn8EWvg9ACWMka0xx86HV2BEHHb6XFJVHocMKnvIulb1wv5U6o1yFmy3rOZOMqFzffBFjlvFvcuntWAmJos1jTl3y0X1EJ7YGAR3EOb8A4nI7JaJb9v8GEZY9ECyRyR7pXVXxZbHI2A9gxGTIGobKxPAlbk59mPkwjWkZhiB3iWtEw",
      "Status": "ACT"
    },
    "ErrorDetails": null,
    "InfoDtls": null,
    "Status": 1
  },
  "timestamp": 1763446641000,
  "transaction_id": "53e1bc69-275a-4504-b5c3-03457c7d09a9"
}

Response schema

For successful responses, this resource describes the NIC payload at data.Data.

View JSON schema

Headers

authorization · string · required

E-Invoice access token. For token-generation steps, refer to the Generate E-Invoice Session recipe, then pass the token in the authorization header.

x-source · enum<string> · default: primary

Specifies the source to access, either primary (NIC 1) or secondary (NIC 2)

Available options: primary, secondary

Example:

"primary"

x-api-key · string · required

API key for identification

x-api-version · string · default: 1.0.0

API version

x-proxy · enum<string>

Enables criss-cross operations by routing requests through the specified source (e.g., access primary via secondary if primary is unavailable)

Available options: primary, secondary

Example:

"secondary"

Query Parameters

document_type · string · required

Document Type

Example:

"INV"

document_number · string · required

Document Number

Example:

"DOC/999"

document_date · string · required

Document Date

Example:

"01/01/2024"

Response

200 - application/json

200 Get IRN / 200 Get cancelled IRN / 2154 IRN not found

Option 1

Option 2

A successful NIC response or a NIC business-error response. Both variants use HTTP 200.

code · enum<integer> · required

HTTP-compatible Sandbox response code.

Available options: 200

Example:

200

timestamp · integer<int64> · required

Unix timestamp in milliseconds.

Example:

1763446641000

transaction_id · string · required

Request transaction identifier.

Example:

"53e1bc69-275a-4504-b5c3-03457c7d09a9"

data · object · required

Show child attributes