Skip to main content
POST
Get Return Preference

Response schema

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

View response JSON schema

View Excel field reference

Headers

authorization
string
required

JWT authorization token

x-accept-cache
boolean

Pass true to get cached response.

x-api-key
string
required

Public key required to authorize API access.

x-api-version
string
default:1.0.0

API version

Query Parameters

financial_year
string
required

Financial year for which the return preference is requested

Example:

"FY 2025-26"

Body

application/json
gstin
string
required

GSTIN for which the return preference is requested

Response

200 - application/json

200 Monthly preference

code
number
required
Example:

200

data
object
required
timestamp
number
required
Example:

1775825033134

transaction_id
string
required
Example:

"903962ca-bc29-45c5-b879-3e51c7f9887d"