IRN List API

This API is to get list of IRNs

IRN List API is an application programming interface that allows users to get the list of (IRNs) for a given return period, supply type, and supplier or recipient GSTIN. The IRN List API can be used to retrieve the IRNs for a specific month or quarter, for inward or outward supplies, and for a specific seller or buyer.

To use the IRN List API, the user needs to send an HTTP GET request to the URL of the API, along with the return period as the parameter. The user also needs to provide the authentication details such as the auth token, and the GSTIN in the request header.

The API will return a JSON response that contains the status of the request, the data, the error details, and the info details. The data is a JSON array that contains the IRNs and their details, such as the IRN, the invoice number, the invoice date, the invoice value, the status, the e-Way Bill number, and the e-Way Bill date.

tails, and the info details. The data is a JSON array that contains the IRNs and their details, such as the IRN, the invoice number, the invoice date, the invoice value, the status, the e-Way Bill number, and the e-Way Bill date.

Data from the government is available in T+2 days

Name
Description

Method Type

GET

Headers

Key
Value
description

Gstin

33AADCT1398N1ZX

Mandatory. Buyer Business GSTIN

Authorization

JWT paste token value

Params

Pass the Duration like year & month in the Params

Key
Value
Mandatory

year

2023

Yes

month

8

Yes

irn_type

purchase

Yes

ack_date_from

01/05/2024

No

ack_date_to

01/05/2024

No

page

1

No

Action

Hit Send Button

Success Response

{
  "message": "Data Found",
  "count": 2400,
  "total_page": 2,
  "page_size": 2000,
  "page": 2,
  "current_count": 400,
  "data": [
    {
      "_id": "654dc1421794b0c071a6447c",
      "docNum": "2023241308",
      "docDt": "01/11/2023",
      "docType": "INV",
      "supplyType": "B2B",
      "totInvAmt": 46618.72,
      "irn": "5ca9fe3a867878f811feb99fd43a754b2164ac9b6e3c51305d968c45703e12o1",
      "irnStatus": "ACT",
      "ackNo": "152316134408458",
      "ackDt": "2023-11-01 17:14:00",
      "ewbNo": "",
      "ewbDt": "",
      "cnldt": "",
      "buyer_gstin": "33AADCT1398N1ZI",
      "supplier_gstin": "33ABSPV6417F1KA",
      "pdf_url": ""
    }
  ],
  "success": true
}

Data from the government is available in T+1 day

Response

Key
Value
Description

count

2950

Total number of einvoices or records available in list API

Last updated