Get e-Invoice by IRN

Fetch the e-Invoice by passing the invoice registration number (IRN). 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/{irn}

Get E-Invoice by IRN

cURL

curl --request GET \
  --url https://api.sandbox.co.in/gst/compliance/e-invoice/tax-payer/invoice/{irn} \
  --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/{irn}"

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/{irn}', 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/{irn}",
  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/{irn}"

	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/{irn}")
  .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/{irn}")

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 (CRN)

{
  "code": 200,
  "data": {
    "Data": {
      "AckDt": "2024-02-21 20:56:00",
      "AckNo": 112410188572727,
      "EwbDt": null,
      "EwbNo": null,
      "EwbValidTill": null,
      "Irn": "4184721bc35a48cce034a9ded1443d862c48e3aae875f69090e348cc65f24fe5",
      "Remarks": null,
      "SignedInvoice": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE1MTNCODIxRUU0NkM3NDlBNjNCODZFMzE4QkY3MTEwOTkyODdEMUYiLCJ4NXQiOiJGUk80SWU1R3gwbW1PNGJqR0w5eEVKa29mUjgiLCJ0eXAiOiJKV1QifQ.eyJkYXRhIjoie1wiQWNrTm9cIjoxMTI0MTAxODg1NzI3MjcsXCJBY2tEdFwiOlwiMjAyNC0wMi0yMSAyMDo1NjowMFwiLFwiSXJuXCI6XCI0MTg0NzIxYmMzNWE0OGNjZTAzNGE5ZGVkMTQ0M2Q4NjJjNDhlM2FhZTg3NWY2OTA5MGUzNDhjYzY1ZjI0ZmU1XCIsXCJWZXJzaW9uXCI6XCIxLjFcIixcIlRyYW5EdGxzXCI6e1wiVGF4U2NoXCI6XCJHU1RcIixcIlN1cFR5cFwiOlwiQjJCXCIsXCJSZWdSZXZcIjpcIllcIixcIklnc3RPbkludHJhXCI6XCJOXCJ9LFwiRG9jRHRsc1wiOntcIlR5cFwiOlwiQ1JOXCIsXCJOb1wiOlwiRE9DLzEyNDNcIixcIkR0XCI6XCIwMS8wMS8yMDI0XCJ9LFwiU2VsbGVyRHRsc1wiOntcIkdzdGluXCI6XCIyOUFBQUNRMzc3MEUwMDBcIixcIkxnbE5tXCI6XCJRdWlja28gSW5mb3NvZnQgUHJpdmF0ZSBMaW1pdGVkXCIsXCJUcmRObVwiOlwiUXVpY2tvIEluZm9zb2Z0IFByaXZhdGUgTGltaXRlZFwiLFwiQWRkcjFcIjpcIjV0aCBibG9jaywga3V2ZW1wdSBsYXlvdXRcIixcIkFkZHIyXCI6XCJrdXZlbXB1IGxheW91dFwiLFwiTG9jXCI6XCJCQU5HQUxPUkVcIixcIlBpblwiOjU2MDA5MSxcIlN0Y2RcIjpcIjI5XCIsXCJQaFwiOlwiOTAwMDAwMDAwMFwiLFwiRW1cIjpcImFiY0BnbWFpbC5jb21cIn0sXCJCdXllckR0bHNcIjp7XCJHc3RpblwiOlwiMjlBV0dQVjcxMDdCMVoxXCIsXCJMZ2xObVwiOlwiWFlaIGNvbXBhbnkgcHZ0IGx0ZFwiLFwiVHJkTm1cIjpcIlhZWiBJbmR1c3RyaWVzXCIsXCJQb3NcIjpcIjEyXCIsXCJBZGRyMVwiOlwiN3RoIGJsb2NrLCBrdXZlbXB1IGxheW91dFwiLFwiQWRkcjJcIjpcImt1dmVtcHUgbGF5b3V0XCIsXCJMb2NcIjpcIkdBTkRISU5BR0FSXCIsXCJQaW5cIjo1NjIxNjAsXCJQaFwiOlwiOTExMTExMTExMTFcIixcIkVtXCI6XCJ4eXpAeWFob28uY29tXCIsXCJTdGNkXCI6XCIyOVwifSxcIkRpc3BEdGxzXCI6e1wiTm1cIjpcIkFCQyBjb21wYW55IHB2dCBsdGRcIixcIkFkZHIxXCI6XCI3dGggYmxvY2ssIGt1dmVtcHUgbGF5b3V0XCIsXCJBZGRyMlwiOlwia3V2ZW1wdSBsYXlvdXRcIixcIkxvY1wiOlwiQmFuYWdhbG9yZVwiLFwiUGluXCI6NTYyMTYwLFwiU3RjZFwiOlwiMjlcIn0sXCJTaGlwRHRsc1wiOntcIkdzdGluXCI6XCIyOUFXR1BWNzEwN0IxWjFcIixcIkxnbE5tXCI6XCJDQkUgY29tcGFueSBwdnQgbHRkXCIsXCJUcmRObVwiOlwia3V2ZW1wdSBsYXlvdXRcIixcIkFkZHIxXCI6XCI3dGggYmxvY2ssIGt1dmVtcHUgbGF5b3V0XCIsXCJBZGRyMlwiOlwia3V2ZW1wdSBsYXlvdXRcIixcIkxvY1wiOlwiQmFuYWdhbG9yZVwiLFwiUGluXCI6NTYyMTYwLFwiU3RjZFwiOlwiMjlcIn0sXCJJdGVtTGlzdFwiOlt7XCJJdGVtTm9cIjowLFwiU2xOb1wiOlwiMVwiLFwiSXNTZXJ2Y1wiOlwiTlwiLFwiUHJkRGVzY1wiOlwiUmljZVwiLFwiSHNuQ2RcIjpcIjEwMDFcIixcIkJhcmNkZVwiOlwiMTIzNDU2XCIsXCJRdHlcIjoxMDAuMzQ1LFwiRnJlZVF0eVwiOjEwLFwiVW5pdFwiOlwiQkFHXCIsXCJVbml0UHJpY2VcIjo5OS41NDUsXCJUb3RBbXRcIjo5OTg4Ljg0LFwiRGlzY291bnRcIjoxMCxcIlByZVRheFZhbFwiOjEsXCJBc3NBbXRcIjo5OTc4Ljg0LFwiR3N0UnRcIjoxMi4wLFwiSWdzdEFtdFwiOjExOTcuNDYsXCJDZ3N0QW10XCI6MCxcIlNnc3RBbXRcIjowLFwiQ2VzUnRcIjo1LFwiQ2VzQW10XCI6NDk4Ljk0LFwiQ2VzTm9uQWR2bEFtdFwiOjEwLFwiU3RhdGVDZXNSdFwiOjEyLFwiU3RhdGVDZXNBbXRcIjoxMTk3LjQ2LFwiU3RhdGVDZXNOb25BZHZsQW10XCI6NSxcIk90aENocmdcIjoxMCxcIlRvdEl0ZW1WYWxcIjoxMjg5Ny43LFwiT3JkTGluZVJlZlwiOlwiMzI1NlwiLFwiT3JnQ250cnlcIjpcIkFHXCIsXCJQcmRTbE5vXCI6XCIxMjM0NVwifV0sXCJWYWxEdGxzXCI6e1wiQXNzVmFsXCI6OTk3OC44NCxcIkNnc3RWYWxcIjowLFwiU2dzdFZhbFwiOjAsXCJJZ3N0VmFsXCI6MTE5Ny40NixcIkNlc1ZhbFwiOjUwOC45NCxcIlN0Q2VzVmFsXCI6MTIwMi40NixcIkRpc2NvdW50XCI6MTAsXCJPdGhDaHJnXCI6MjAsXCJSbmRPZmZBbXRcIjowLjMsXCJUb3RJbnZWYWxcIjoxMjkwOCxcIlRvdEludlZhbEZjXCI6MTI4OTcuN30sXCJFeHBEdGxzXCI6e1wiU2hpcEJOb1wiOlwiQS0yNDhcIixcIlNoaXBCRHRcIjpcIjAxLzA4LzIwMjBcIixcIlBvcnRcIjpcIklOQUJHMVwiLFwiUmVmQ2xtXCI6XCJOXCIsXCJGb3JDdXJcIjpcIkFFRFwiLFwiQ250Q29kZVwiOlwiQUVcIn0sXCJFd2JEdGxzXCI6e1wiVHJhbnNJZFwiOlwiMTJBV0dQVjcxMDdCMVoxXCIsXCJUcmFuc05hbWVcIjpcIlhZWiBFWFBPUlRTXCIsXCJUcmFuc01vZGVcIjpcIjFcIixcIkRpc3RhbmNlXCI6NSxcIlRyYW5zRG9jTm9cIjpcIkRPQzAxXCIsXCJUcmFuc0RvY0R0XCI6XCIwNS8wMS8yMDI0XCIsXCJWZWhOb1wiOlwia2ExMjM0NTZcIixcIlZlaFR5cGVcIjpcIlJcIn19IiwiaXNzIjoiTklDIFNhbmRib3gifQ.Ravl2Pqb0q52Vi5Cnv6UJDYfPXICDd66d5BtzPrh_Yx59jnYmtn_Ft0_5B9oC7TDrXzNoFcYbEZAhDPWAnyO6PVC-cTq9pSYbGbWK8PBltf330bKQ_CA0xB-9-VaQPFReHLn6hMO5t9dHFA4-g-sA4gIYl2zckpV7pMBSUDft4y6layU4-UwXrUsF2yfW8WzMc01453QfDYwo66HKLS8SdtmZNMuqsdBsi2CvwKHiaqZmQwq3x2wK84yaVQnQRA2VjYvXcNy4FsyKpEX2zce7yqtStSlzOurTrHPfCJbHLFVEADUTCq8ab6f5oW0TVVk2R5AyTFX3IbFqtYEpE9vqg",
      "SignedQRCode": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE1MTNCODIxRUU0NkM3NDlBNjNCODZFMzE4QkY3MTEwOTkyODdEMUYiLCJ4NXQiOiJGUk80SWU1R3gwbW1PNGJqR0w5eEVKa29mUjgiLCJ0eXAiOiJKV1QifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFBQ1EzNzcwRTAwMFwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBV0dQVjcxMDdCMVoxXCIsXCJEb2NOb1wiOlwiRE9DLzEyNDNcIixcIkRvY1R5cFwiOlwiQ1JOXCIsXCJEb2NEdFwiOlwiMDEvMDEvMjAyNFwiLFwiVG90SW52VmFsXCI6MTI5MDgsXCJJdGVtQ250XCI6MSxcIk1haW5Ic25Db2RlXCI6XCIxMDAxXCIsXCJJcm5cIjpcIjQxODQ3MjFiYzM1YTQ4Y2NlMDM0YTlkZWQxNDQzZDg2MmM0OGUzYWFlODc1ZjY5MDkwZTM0OGNjNjVmMjRmZTVcIixcIklybkR0XCI6XCIyMDI0LTAyLTIxIDIwOjU2OjAwXCJ9IiwiaXNzIjoiTklDIFNhbmRib3gifQ.T9u79gPmNuTkh0P2iyr5ig-aHFUHvIN7lU5k03iwDu6uBP47oS9DtCrpFcMP8kahFOy5nhylHGaVOXemmbNTx9IdRfE_IcoBwBXqjT72klD9yOrdb8TMzp_RW0uMUeWrrle7WDQKmyGxh0PskDlxNBZOKVZ7YcR6n-nWanDeT7ifDTTrMEQNPdUAlIrP9suKhTOhnMS8ByLkKHeCGt2mAmGJww4h0XIcSGBS2bqVHPtuhkk7GU3kYJmlaq4HDFGXF4u-pRp_ntmOmnnPZRGFDnaUNuIO1Acq3-D2jwgf1Du1E1n9INuNiUyS47U8Lh8Z74vRNyquygtaVhvyioB71A",
      "Status": "ACT"
    },
    "ErrorDetails": null,
    "InfoDtls": null,
    "Status": 1
  },
  "timestamp": 1763446641000,
  "transaction_id": "e59896a7-cbf0-4d27-aa0d-ab7af731e74c"
}

Only e-Invoices generated within the last 2 days can be fetched with this API.

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-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"

x-api-version · string · default: 1.0.0

API version

x-api-key · string · required

API key for identification

Path Parameters

irn · string · required

Response

200 - application/json

2148 IRN data not available / 2283 IRN generated more than 2 days ago / 200 Get cancelled IRN / 200 Get IRN (DBN) / 200 Get IRN (CRN) / 200 Get IRN (INV)

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:

"175fe134-c501-4ac0-8403-b52a4abccd0b"

data · object · required

Show child attributes