Get Return Preference

API to get Return preference for taxpayers

POST /gst/compliance/public/gstrs/preference

cURL

Monthly preference

curl --request POST \
  --url https://api.sandbox.co.in/gst/compliance/public/gstrs/preference \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "gstin": "27ABCDE1234F1Z5"
}
'

200

{
  "code": 200,
  "timestamp": 1775825033134,
  "data": {
    "data": {
      "response": [
        {
          "preference": "M",
          "quarter": "Q1"
        },
        {
          "preference": "M",
          "quarter": "Q2"
        },
        {
          "preference": "M",
          "quarter": "Q3"
        },
        {
          "preference": "M",
          "quarter": "Q4"
        }
      ]
    },
    "status_cd": "1"
  },
  "transaction_id": "903962ca-bc29-45c5-b879-3e51c7f9887d"
}

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

Show child attributes

timestamp · number · required

Example:

1775825033134

transaction_id · string · required

Example:

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