Skip to main content
POST
/
gst
/
compliance
/
tax-payer
/
gstrs
/
{gstr}
/
{year}
/
{month}
/
proceed
curl --request POST \
  --url https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{gstr}/{year}/{month}/proceed \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "gstin": "24AAACQ3770E1ZP",
  "ret_period": "012023"
}
'
{
  "code": 200,
  "data": {
    "data": {
      "reference_id": "897c98eb-7877-4252-934d-46cb3a86c51a"
    },
    "status_cd": "1"
  },
  "timestamp": "1685540073000",
  "transaction_id": "cceee039-ceea-4db2-94c8-057b78180163"
}

ā€‹
Request body schema

View request 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

ā€‹
gstr
string
required
Example:

"{{gst_return}}"

ā€‹
year
string
required

Year e.g. 2020

Example:

"2024"

ā€‹
month
string
required

Month e.g. 01

Example:

"03"

Body

application/json

Proceed to file GST Return

Response

200 - application/json

200 Success / AUTH154 Invalid return type / RET00003 Return already ready to be filed

ā€‹
code
number
Example:

200

ā€‹
data
object
ā€‹
timestamp
Example:

"1685540073000"

ā€‹
transaction_id
string
Example:

"cceee039-ceea-4db2-94c8-057b78180163"