Skip to main content
GET
GSTR-2B Document

Response body schema

View response body schema

Headers

authorization
string
required

GST taxpayer access token. For token-generation steps, refer to the Generate Taxpayer Session recipe, then pass the token in the authorization header.

x-api-version
string
default:1.0.0

API version

x-api-key
string
required

API key for identification

Path Parameters

year
string
required
month
string
required

Query Parameters

file_number
integer<int32>

Specify file_number incrementally (from 1 to fc) in additional requests to retrieve all invoice data. Only applicable if status_cd = 3.

Example:

"{{file_number}}"

Response

200 - application/json

200 Success / 200 Success page number 1 / 200 Success (before Oct 2024) / 200 Success with file count pagination / 200 Success page number 1 (before Oct 2024) / RET2B1023 GSTR-2B not available / RET2B1016 No details available to view

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.