> ## 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 AATO Values
> Get annual aggregate turnover (AATO) values for a taxpayer for a financial year.
#### Response body schema
#### Response schema
For successful responses, this reference describes the GSTN payload at `data.data`.
## OpenAPI
````yaml api-reference/gst/compliance/openapi.json GET /gst/compliance/tax-payer/aato
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/aato:
get:
tags:
- Taxpayer
- Front Office
- AATO
summary: Get AATO Values
description: >-
Get annual aggregate turnover (AATO) values for a taxpayer for a
financial year.
operationId: getAatoValues
parameters:
- name: financial_year
in: query
description: >-
Financial year on the compliance surface. Example: `FY 2025-26`. The
manager should normalize this to the GST FO request year such as
`2025-26` before calling the lower client.
required: true
example: FY 2025-26
schema:
type: string
- name: authorization
in: header
description: >-
GST taxpayer access token. For token-generation steps, refer to the
Generate Taxpayer Session flow and pass the token in the
authorization header.
required: true
example: '{{gsp_access_token}}'
schema:
type: string
- name: x-api-version
in: header
description: Compliance API version.
required: false
example: 1.0.0
schema:
type: string
default: 1.0.0
- name: x-api-key
in: header
description: API key for identification.
required: true
example: '{{api_key}}'
schema:
type: string
responses:
'200':
description: 200 Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetAatoValuesResponse'
examples:
success:
summary: Success
value:
code: 200
timestamp: 1763446641000
transaction_id: 41bb8041-fb83-4654-8d75-85a19f329158
data:
status_cd: '1'
data:
gstin: 33GSPTN0062G1ZH
fy: 2020-21
pan: AAGFT0853L
gsttofil: 1100
pantofil: 5000
estgstto: 1234
estpanto: 5678
finalgstto: 1234
finalpanto: 5678
tpdecto:
- estgstto: 1234
gsttobytp: 1334
docId:
id: '20210407311'
remarks: GSP 1st submission
filingDate: 01/07/2021 15:31:13
- estgstto: 1234
gsttobytp: 1334
docId:
id: '20210407311'
remarks: GSP 2nd submission
filingDate: 01/07/2021 15:31:13
headers: {}
deprecated: false
security: []
components:
schemas:
GetAatoValuesResponse:
oneOf:
- $ref: '#/components/schemas/GetAatoValuesSuccessResponse'
- $ref: '#/components/schemas/GstnBusinessErrorResponse'
description: >-
A GSTN success or GSTN business-failure response. Both variants use HTTP
200.
GetAatoValuesSuccessResponse:
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/GetAatoValuesSuccessPayload'
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
GetAatoValuesSuccessPayload:
type: object
description: Successful GSTN payload for Get Aato Values.
properties:
gstin:
type: string
description: GSTIN of the taxpayer.
minLength: 15
maxLength: 15
fy:
type: string
description: Previous financial year.
pan:
type: string
description: PAN of the taxpayer.
minLength: 10
maxLength: 10
gsttofil:
type: number
description: GSTIN turnover based on return filing.
pantofil:
type: number
description: PAN turnover based on return filing.
estgstto:
type: number
description: Estimated GSTIN turnover.
estpanto:
type: number
description: Estimated PAN turnover.
finalgstto:
type: number
description: Final GSTIN turnover after officer action.
finalpanto:
type: number
description: Final PAN turnover after officer action.
tpdecto:
type: array
description: Turnover declarations submitted by the taxpayer.
items:
type: object
properties:
estgstto:
type: number
description: Estimated GSTIN turnover provided by GSTN.
gsttobytp:
type: number
description: GSTIN turnover declared by the taxpayer.
docId:
type: object
description: Declaration document identifier.
properties:
id:
type: string
description: Declaration document identifier.
remarks:
type: string
description: Remarks submitted with the declaration.
filingDate:
type: string
description: Date and time when the declaration was filed.
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.
````