Skip to main content
GET
GSTR-1 CDNR

Response schema

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

View JSON schema

View Excel field reference

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-key
string
required

API key for identification

x-api-version
string
default:1.0.0

API version

Path Parameters

year
string
required
month
string
required

Query Parameters

action_required
string

optional Status filter for filtering the invoices. Possible values: Y or N. Status filter for filtering the invoices. Use filter value Y to fetches the invoices where tax payer need to take action. Already accepted or uploaded invoices can be fetched by using filter value N.

Example:

"{{action_required}}"

from
string

From Date (DD/MM/YYYY)

Example:

"{{from}}"

Response

200 - application/json

RET11416 No data found / 200 Success

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.