Skip to main content
GET
Get GSTR-2A B2B invoices

Response schema

For successful responses, these resources describe the GSTN payload at data.data.

View JSON schema

View Excel field reference

Authorizations

authorization
string
header
required

GST taxpayer access token returned by Verify OTP.

x-api-key
string
header
required

Sandbox API key from your Sandbox account.

Headers

x-api-version
string
default:1.0.0

API version

Authorization
string
x-api-key
string

Path Parameters

year
integer<int32>
required

Calendar year of the return period.

Example:

2024

month
integer<int32>
required

Month of the return period.

Example:

4

Query Parameters

from
string

Date from which to fetch records, in DD/MM/YYYY format.

Example:

"29/01/2025"

counterparty_gstin
string

GSTIN of the supplier or counterparty used to filter the response.

Example:

"{{gstin}}"

Response

200 - application/json

GSTN success or business-error response. GSTN returns both variants with HTTP 200.

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.