Get E-Invoice HSN Summary

Get E-Invoice HSN summary for a return period for an authenticated taxpayer.

GET /gst/compliance/tax-payer/e-invoices/hsn/{year}/{month}

Get E-Invoice HSN Summary

cURL

curl --request GET \
  --url https://api.sandbox.co.in/gst/compliance/tax-payer/e-invoices/hsn/{year}/{month} \
  --header 'authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>'

200

success

{
  "code": 200,
  "data": {
    "status_cd": "1",
    "data": {
      "gstin": "01AABCE2207R1Z5",
      "fp": "052020",
      "hsn": {
        "hsn_b2b": [
          {
            "num": 1,
            "hsn_sc": "2101",
            "desc": "MISCELLANEOUS EDIBLE PREPARATIONS~Extracts, essences and concentrates, of coffee, tea or mate and preparations with a basis of these products or with a basis of coffee, tea or mate; roasted chicory and other roasted coffee substitutes, and extracts, essences and concentrates thereof",
            "user_desc": "Taxpayer Description",
            "uqc": "BDL",
            "qty": 12,
            "rt": 0.1,
            "txval": 1212,
            "iamt": 3342,
            "camt": 343,
            "samt": 24,
            "csamt": 423,
            "chksum": "fasdflkjwhrkfjshdfua"
          }
        ],
        "hsn_b2c": [
          {
            "num": 1,
            "hsn_sc": "1102",
            "desc": "CEREAL FLOURS OTHER THAN THAT OF WHEAT OR MESLIN",
            "user_desc": "Taxpayer Description",
            "uqc": "BDL",
            "qty": 10,
            "rt": 0.1,
            "txval": 4312,
            "iamt": 242,
            "camt": 643,
            "samt": 24,
            "csamt": 423,
            "chksum": "bnsfsfskfsifi"
          }
        ]
      }
    }
  },
  "timestamp": 1763446641000,
  "transaction_id": "5fc1acb2-1fd0-49e8-b6f3-19b60e67009d"
}

Response body schema

View response body schema

Response schema

For successful responses, this reference describes the GSTN payload at data.data.

View Excel field reference

Headers

authorization · string · required

GST taxpayer access token.

x-api-version · string · default: 1.0.0

API version.

x-api-key · string · required

API key for identification.

Path Parameters

year · string · required

Return period year.

Example:

"2024"

month · string · required

Return period month.

Example:

"05"

Response

200 - application/json

200 Success. The GST portal marks this source API as unencrypted, but the sandbox response is still wrapped in the standard code/data/timestamp/transaction_id envelope.

Option 1

Option 2

A GSTN success or GSTN business-failure response. Both variants use HTTP 200.

code · enum<integer> · required

The HTTP status code reported in the response body.

Available options: 200

Example:

200

timestamp · integer<int64> · required

The response timestamp in Unix epoch milliseconds.

Example:

1763446641000

transaction_id · string · required

The transaction identifier used to trace the request.

Example:

"41bb8041-fb83-4654-8d75-85a19f329158"

data · object · required

The GSTN success wrapper.

Show child attributes