Save Filing Preference

Save filing preference for a return period for authenticated taxpayer

POST /gst/compliance/tax-payer/gstrs/preference

Save Preference

cURL

curl --request POST \
  --url https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/preference \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "fy": "2020-21",
  "preference": "M",
  "quarter": "Q2",
  "gstin": "27COWPR1617C2ZN"
}
'

import requests

url = "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/preference"

payload = {
    "fy": "2020-21",
    "preference": "M",
    "quarter": "Q2",
    "gstin": "27COWPR1617C2ZN"
}
headers = {
    "authorization": "<authorization>",
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    authorization: '<authorization>',
    'x-api-key': '<x-api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({fy: '2020-21', preference: 'M', quarter: 'Q2', gstin: '27COWPR1617C2ZN'})
};

fetch('https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/preference', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/preference",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fy' => '2020-21',
    'preference' => 'M',
    'quarter' => 'Q2',
    'gstin' => '27COWPR1617C2ZN'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "authorization: <authorization>",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/preference"

	payload := strings.NewReader("{\n  \"fy\": \"2020-21\",\n  \"preference\": \"M\",\n  \"quarter\": \"Q2\",\n  \"gstin\": \"27COWPR1617C2ZN\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("authorization", "<authorization>")
	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/preference")
  .header("authorization", "<authorization>")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fy\": \"2020-21\",\n  \"preference\": \"M\",\n  \"quarter\": \"Q2\",\n  \"gstin\": \"27COWPR1617C2ZN\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/preference")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = '<authorization>'
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fy\": \"2020-21\",\n  \"preference\": \"M\",\n  \"quarter\": \"Q2\",\n  \"gstin\": \"27COWPR1617C2ZN\"\n}"

response = http.request(request)
puts response.read_body

200

Success

{
  "code": 200,
  "data": {
    "status_cd": "0",
    "error": {
      "error_cd": "GSTN-EXEC2003",
      "message": "Something seems to have gone wrong while processing your request. Please try again. If error persists quote error number GSTN-EXEC2003 when you contact customer care for quick resolution "
    }
  },
  "timestamp": 1655494089128,
  "transaction_id": "189071f9-671d-4f1d-a89e-55c19bec7002"
}

Request body schema

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

API key for identification

x-api-version · string · default: 1.0.0

API version

Body

application/json

Public request body for Save Preference.

gstin · string · required

GSTIN for which the filing preference is saved.

Required string length: 15

Example:

"27COWPR1617C2ZN"

fy · string · required

The fy value provided in the request.

Example:

"2020-21"

preference · enum<string> · required

The preference value provided in the request.

Available options: Q, M

Example:

"M"

quarter · enum<string> · required

The quarter value provided in the request.

Available options: Q1, Q2, Q3, Q4

Example:

"Q2"

Response

200 - application/json

Success

Option 1

Option 2

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.

Show child attributes