> ## Documentation Index
> Fetch the complete documentation index at: https://developer.sandbox.co.in/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Filing Preference
> Get filing preference for a return period for authenticated taxpayer
#### Response schema
For successful responses, these resources describe the GSTN payload at `data.data`.
## OpenAPI
````yaml api-reference/gst/compliance/openapi.json GET /gst/compliance/tax-payer/gstrs/preference
openapi: 3.0.1
info:
title: compliance
description: >-
**GST Compliance API** enables businesses to automate compliance
requirements like [Taxpayer
verification](https://developer.sandbox.co.in/reference/search-gstin-api),
[GSTR
Filing](https://developer.sandbox.co.in/reference/gst-taxpayer-authentication),
[Generating
E-Invoices](https://developer.sandbox.co.in/reference/e-invoice-authentication-api),
and [E-Way
Bills](https://developer.sandbox.co.in/reference/e-way-bill-authentication-api).We
provide these APIs from GSTN-authorised GST Suvidha Providers, handling the
encryption-decryption and signing so you don't have to handle the
complexities.
version: 1.0.0
servers:
- url: https://api.sandbox.co.in
- url: https://test-api.sandbox.co.in
security: []
tags:
- name: Public
- name: Taxpayer
- name: Taxpayer Auth
- name: Returns
- name: GSTR-1 Documents
- name: File GSTR-1
- name: GSTR-2A Documents
- name: GSTR-2B Document
- name: File GSTR-3B
- name: GSTR-4
- name: File GSTR-9
- name: Invoice Management System
- name: GSTR-1A Documents
- name: File GSTR-1A
- name: Ledgers
- name: e-Invoice
- name: Sales e-Invoices for return period
- name: Purchase e-Invoices for return period
- name: Front Office Notices
- name: Front Office
- name: AATO
- name: e-Invoice1
- name: Authentication
- name: e-Invoice12
- name: E-Way Bill
- name: E-Way Bill1
- name: Authentication1
- name: Consignor
- name: Consolidated E-Way Bill
- name: Multi-Vehicle Movement
- name: Consignee
- name: Transporter
- name: Consolidated E-Way Bill1
- name: Multi-vehicle Movement
- name: Common
paths:
/gst/compliance/tax-payer/gstrs/preference:
get:
tags:
- Taxpayer
- Returns
summary: Get Preference
description: Get Preference
operationId: getPreference
parameters:
- name: financial_year
in: query
description: ''
required: false
schema:
type: string
example: FY 2024-25
- name: authorization
in: header
description: >-
GST taxpayer access token. For token-generation steps, refer to the
[Generate Taxpayer
Session](/recipes/gst/authentication/generate_tax_payer_session)
recipe, then pass the token in the authorization header.
required: true
example: ''
schema:
type: string
- name: x-api-key
in: header
description: API key for identification
required: true
example: ''
schema:
type: string
- name: x-api-version
in: header
description: API version
required: false
example: ''
schema:
type: string
default: 1.0.0
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetPreferenceResponse'
examples:
Success:
summary: Success
value:
code: 200
data:
status_cd: '1'
data:
response:
- preference: M
quarter: Q1
- preference: M
quarter: Q2
- preference: M
quarter: Q3
- preference: M
quarter: Q4
timestamp: 1685540172000
transaction_id: 3733caed-31b1-45db-8cfa-0144afd983eb
headers: {}
deprecated: false
security: []
components:
schemas:
GetPreferenceResponse:
oneOf:
- $ref: '#/components/schemas/GetPreferenceSuccessResponse'
- $ref: '#/components/schemas/GstnBusinessErrorResponse'
description: >-
A GSTN success or GSTN business-failure response. Both variants use HTTP
200.
GetPreferenceSuccessResponse:
allOf:
- $ref: '#/components/schemas/TaxpayerResponseMetadata'
- type: object
required:
- data
properties:
data:
type: object
description: The GSTN success wrapper.
required:
- status_cd
- data
properties:
status_cd:
type: string
enum:
- '1'
description: GSTN success status.
example: '1'
data:
$ref: '#/components/schemas/GetPreferenceSuccessPayload'
GstnBusinessErrorResponse:
type: object
description: HTTP 200 response containing a GSTN business failure.
required:
- code
- timestamp
- transaction_id
- data
properties:
code:
type: integer
description: The HTTP status code reported in the response body.
enum:
- 200
example: 200
timestamp:
type: integer
format: int64
description: The response timestamp in Unix epoch milliseconds.
example: 1763446641000
transaction_id:
type: string
description: The transaction identifier used to trace the request.
example: 41bb8041-fb83-4654-8d75-85a19f329158
data:
type: object
description: The GSTN business-failure wrapper.
required:
- status_cd
- error
properties:
status_cd:
type: string
enum:
- '0'
description: GSTN business-failure status.
example: '0'
error:
$ref: '#/components/schemas/GstnBusinessError'
TaxpayerResponseMetadata:
type: object
description: Fields included in every taxpayer endpoint response.
required:
- code
- timestamp
- transaction_id
properties:
code:
type: integer
description: The HTTP status code reported in the response body.
enum:
- 200
example: 200
timestamp:
type: integer
format: int64
description: The response timestamp in Unix epoch milliseconds.
example: 1763446641000
transaction_id:
type: string
description: The transaction identifier used to trace the request.
example: 41bb8041-fb83-4654-8d75-85a19f329158
GetPreferenceSuccessPayload:
type: object
description: Successful GSTN payload for Get Preference.
properties:
response:
type: array
description: The response value returned by GSTN.
minItems: 0
maxItems: 4
items:
type: object
properties:
quarter:
type: string
description: Quarter value
enum:
- Q1
- Q2
- Q3
- Q4
preference:
type: string
description: Preference for the quarter
enum:
- M
- Q
- 'N'
GstnBusinessError:
type: object
description: A business error returned by GSTN.
required:
- error_cd
- message
properties:
error_cd:
type: string
description: The GSTN business error code.
example: RET11416
message:
type: string
description: A human-readable description of the GSTN business error.
example: No records found.
````