Skip to main content
POST

Response schema

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

View response JSON schema

View Excel field reference

Authorizations

authorization
string
header
required

Sandbox access token returned by /authenticate.

x-api-key
string
header
required

Sandbox API key from your Sandbox account.

Headers

x-accept-cache
boolean

Pass true to accept the cached response. If the header is not passed, or if false is sent as the value, the request will hit the origin.

x-api-version
string
default:1.0.0

API version

Query Parameters

gstr
string

Optional GST Return type to be passed as filter. E.g. gstr-1

Example:

"{{gstr}}"

financial_year
string
required

Financial Year of GST Returns e.g. FY 2021-22

Example:

"{{financial_year}}"

Body

application/json
gstin
string
required

GSTIN of the Taxpayer

Response

200 Filed returns / RTN_22 Select Valid FY / RET13510 No Record Found

code
integer
required
Example:

200

data
object
required
timestamp
integer<int64>
required
Example:

1763446641000

transaction_id
string
required
Example:

"7495493a-b127-4eca-a304-a550fbc98447"