> ## 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.
# GST Return status
> Get GST Return status after saving return. Returns any errors and info in the return saved.
#### 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/{year}/{month}/status
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/{year}/{month}/status:
get:
tags:
- Taxpayer
- Returns
summary: GST Return status
description: Get advance tax details for a return period for authenticated taxpayer
operationId: getGstReturnStatus
parameters:
- name: year
in: path
description: ''
required: true
example: ''
schema:
type: string
- name: month
in: path
description: ''
required: true
example: ''
schema:
type: string
- name: reference_id
in: query
description: '`required` Reference ID'
required: true
schema:
type: string
example: '{{reference_id}}'
- 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-version
in: header
description: API version
required: false
example: ''
schema:
type: string
default: 1.0.0
- name: x-api-key
in: header
description: API key for identification
required: true
example: ''
schema:
type: string
responses:
'200':
description: >-
200 GSTR-1 save processed / 200 GSTR-1 save processed with error /
200 GSTR-1 reset processed / 200 GSTR-3B save processed / 200 GSTR-9
save processed / 200 GSTR-9 save processed with error / RET191350
HSN code is not valid as per AATO / RET191353 The UQC entered is not
valid / RET191355 The Quantity entered is not valid / RET191175
Enter GST rate as per the rate list / RET191106 Error in JSON
structure / RET191251 RESET is under process / 200 Reset Request
Received
content:
application/json:
schema:
$ref: '#/components/schemas/GetGstReturnStatusResponse'
examples:
200 GSTR-1 reset processed:
summary: 200 GSTR-1 reset processed
value:
code: 200
data:
status_cd: '1'
data:
action: RESET
form_typ: R1
status_cd: P
timestamp: 1763446641000
transaction_id: c34bd5f1-d986-46fd-be85-457587ffda0e
200 GSTR-1 save processed:
summary: 200 GSTR-1 save processed
value:
code: 200
data:
status_cd: '1'
data:
action: SAVE
form_typ: R1
status_cd: P
timestamp: 1763446641000
transaction_id: dc8e3fd8-6e7e-49aa-9c79-16b473f05e34
200 GSTR-1 save processed with error:
summary: 200 GSTR-1 save processed with error
value:
code: 200
data:
status_cd: '1'
data:
action: SAVE
error_report:
at:
- error_cd: RET191114
error_msg: Invalid POS
itms:
- ad_amt: 100
csamt: 500
iamt: 9400
rt: 5
pos: '05'
sply_ty: INTER
b2b:
- ctin: 05CGDPP1321G1ZV
error_cd: RET191114
error_msg: >-
Date is Invalid. Date of invoice cannot exceed
the current tax period and be older than 18
months or older than registration date.
inv:
- etin: 01AABCE5507R1Z4
idt: 24-11-2016
inum: S008400
inv_typ: R
itms:
- itm_det:
csamt: 500
iamt: 833.33
rt: 5
txval: 10000
num: 1
pos: '06'
rchrg: 'N'
val: 729248.16
b2cl:
- error_cd: RET191114
error_msg: >-
Date is Invalid. Date of invoice cannot exceed
the current tax period and be older than 18
months or older than registration date.
inv:
- etin: 27AHQPA8875L1ZU
idt: 10-01-2016
inum: '92661'
itms:
- itm_det:
csamt: 500
iamt: 833.33
rt: 5
txval: 10000
num: 1
val: 784586.33
pos: '05'
b2cs:
- csamt: 10
error_cd: RET191114
error_msg: >-
Date is Invalid. Date of invoice cannot exceed
the current tax period and be older than 18
months or older than registration date.
etin: 20ABCDE7588L1ZJ
iamt: 10
pos: '05'
rt: 5
sply_ty: INTER
txval: 110
typ: E
cdnr:
- ctin: 01AAAAP1208Q1ZS
error_cd: RET191115
error_msg: >-
Date is Invalid. Date of note cannot exceed the
current tax period .
nt:
- idt: 23-09-2016
inum: '915914'
itms:
- itm_det:
csamt: 789.52
iamt: 845.22
rt: 10
txval: 5225.28
num: 1
nt_dt: 23-09-2016
nt_num: '533515'
ntty: C
p_gst: 'N'
rsn: Post Sale Discount
val: 123123
cdnur:
- error_cd: RET191115
error_msg: >-
Date is Invalid. Date of note cannot exceed the
current tax period .
idt: 23-09-2016
inum: '915914'
itms:
- itm_det:
csamt: 789.52
iamt: 845.22
rt: 10
txval: 5225.28
num: 1
nt_dt: 23-09-2016
nt_num: '533515'
ntty: C
p_gst: 'N'
rsn: Post Sale Discount
typ: B2CL
val: 64646
doc_issue:
doc_det:
- doc_num: 1
docs:
- cancel: 3
from: '20'
net_issue: 17
num: 1
to: '29'
totnum: 20
error_cd: ERRORCODE
error_msg: ERRORMESSAGE
exp:
- error_cd: RET191114
error_msg: >-
Date is Invalid. Date of invoice cannot exceed
the current tax period and be older than 18
months or older than registration date.
exp_typ: WPAY
inv:
- idt: 12-02-2016
inum: '81542'
itms:
- iamt: 833.33
rt: 5
txval: 10000
sbdt: 04-10-2016
sbnum: 7896542
sbpcode: ASB991
val: 995048.36
hsn:
data:
- csamt: 500
desc: Goods Description
hsn_sc: '1009'
iamt: 14.52
num: 1
qty: 2.05
txval: 10.23
uqc: kg
val: 995048.36
error_cd: RET191114
error_msg: >-
Date is Invalid. Date of invoice cannot exceed the
current tax period and be older than 18 months or
older than registration date.
nil:
error_cd: RET191114
error_msg: >-
Date is Invalid. Date of invoice cannot exceed the
current tax period and be older than 18 months or
older than registration date.
inv:
- expt_amt: 123.45
ngsup_amt: 1258.5
nil_amt: 1470.85
sply_ty: INTRB2B
- expt_amt: 123.45
ngsup_amt: 1258.5
nil_amt: 1470.85
sply_ty: INTRB2C
txpd:
- error_cd: RET191114
error_msg: Invalid POS
itms:
- ad_amt: 100
csamt: 500
iamt: 9400
rt: 5
pos: '05'
sply_ty: INTER
form_typ: R1
status_cd: PE
timestamp: 1763446641000
transaction_id: 77dbb7b7-f586-4883-94cd-1de088a7f660
200 GSTR-3B save processed:
summary: 200 GSTR-3B save processed
value:
code: 200
data:
status_cd: '1'
data:
action: SAVE
form_typ: R3B
status_cd: P
timestamp: 1763446641000
transaction_id: 127f9782-c3db-4b6d-be73-753dbcfe9c84
200 GSTR-9 save processed:
summary: 200 GSTR-9 save processed
value:
code: 200
data:
status_cd: '1'
data:
action: SAVE
form_typ: R9
status_cd: P
timestamp: 1763446641000
transaction_id: f7cea944-c467-425f-abaa-97ea142fa0b2
200 GSTR-9 save processed with error:
summary: 200 GSTR-9 save processed with error
value:
code: 200
data:
status_cd: '1'
data:
action: SAVE
error_report:
table17:
items:
- camt: 48287.66
csamt: 0
error_cd: RET91708
error_msg: >-
The reported tax amount differs with the
computed value by more than Rs. 10/-. Please
report the correct tax amount within the
acceptable range to proceed with the record
hsn_sc: '997331'
iamt: 0
isconcesstional: 'N'
rt: 18
samt: 48287.66
txval: 536762
- camt: 207620.5
csamt: 0
error_cd: RET91708
error_msg: >-
The reported tax amount differs with the
computed value by more than Rs. 10/-. Please
report the correct tax amount within the
acceptable range to proceed with the record
hsn_sc: '998232'
iamt: 5676040.91
isconcesstional: 'N'
rt: 18
samt: 207620.5
txval: 33840209.41
form_typ: R9
status_cd: PE
timestamp: 1763446641000
transaction_id: e6cc99e6-e5d2-4b7b-853c-7c647c0222df
200 Reset Request Received:
summary: 200 Reset Request Received
value:
code: 200
data:
status_cd: '1'
data:
action: RESET
form_typ: R1
status_cd: REC
timestamp: 1739192256000
transaction_id: bdb2cf8c-3c83-43ab-b3c4-68f726603b7e
RET191106 Error in JSON structure:
summary: RET191106 Error in JSON structure
value:
code: 200
data:
status_cd: '1'
data:
action: SAVE
error_report:
error_cd: RET191106
error_msg: Error in Json structure validation.
form_typ: R1
status_cd: ER
timestamp: 1739183552000
transaction_id: 43bf3220-b11f-4380-854b-91030fe8be53
RET191175 Enter GST rate as per the rate list:
summary: RET191175 Enter GST rate as per the rate list
value:
code: 200
data:
status_cd: '1'
data:
action: SAVE
error_report:
b2b:
- ctin: 23ACYFS6212N1ZH
error_cd: RET191175
error_msg: Do enter the correct rate as per the rate list.
inv:
- idt: 29-01-2025
inum: INV12345
inv_typ: R
isEdit: false
itms:
- itm_det:
iamt: 18
rt: 0.18
txval: 100
num: 1
pos: '23'
rchrg: 'N'
val: 118
form_typ: R1
status_cd: PE
timestamp: 1738757834000
transaction_id: 4fa30636-9f23-4dd5-893c-fbfb236a6848
RET191251 RESET is under process:
summary: RET191251 RESET is under process
value:
code: 200
data:
status_cd: '1'
data:
action: SAVE
error_report:
error_cd: RET191251
error_msg: RESET is under process. Please try again later
form_typ: R1
status_cd: ER
timestamp: 1739183803000
transaction_id: 6e736307-a6f1-45f4-9353-e6d25a17f9d9
RET191350 HSN code is not valid as per AATO:
summary: RET191350 HSN code is not valid as per AATO
value:
code: 200
data:
status_cd: '1'
data:
action: SAVE
error_report:
hsn:
- chksum: >-
df61c0865eb0d71db87b3660f876cd25211d39aa245fa51b1cf105188a20da1d
data:
- camt: 0
csamt: 0
desc: Fees
hsn_sc: '9983'
iamt: 0.36
num: 1
qty: 0
rt: 18
samt: 0
txval: 2
uqc: NA
error_cd: RET191350
error_msg: >-
Length of entered HSN code is not valid as per
AATO
form_typ: R1
status_cd: PE
timestamp: 1763446641000
transaction_id: 187c5dde-76cd-4ebf-9414-77fe66a47cf7
RET191353 The UQC entered is not valid:
summary: RET191353 The UQC entered is not valid
value:
code: 200
data:
status_cd: '1'
data:
action: SAVE
error_report:
hsn:
- chksum: >-
1a0926afb7f7392e4bb5484a453030a1f4b6098240aa4f55fc27369140ecbe0c
data:
- camt: 0
csamt: 0
desc: Fees
hsn_sc: '998399'
iamt: 0.36
num: 1
qty: 0
rt: 18
samt: 0
txval: 2
uqc: PCS
error_cd: RET191353
error_msg: The UQC entered is not valid
form_typ: R1
status_cd: PE
timestamp: 1738754890000
transaction_id: b725c670-72ca-4a69-a92b-3389d5285a36
RET191355 The Quantity entered is not valid:
summary: RET191355 The Quantity entered is not valid
value:
code: 200
data:
status_cd: '1'
data:
action: SAVE
error_report:
hsn:
- chksum: >-
945a8ab479b44ba81eb7972ab01c4da58ab82063ec537233c4b7267d57211ea3
data:
- camt: 0
csamt: 0
desc: Fees
hsn_sc: '998399'
iamt: 0.36
num: 1
qty: 1
rt: 18
samt: 0
txval: 2
uqc: NA
error_cd: RET191355
error_msg: The Quantity entered is not valid.
form_typ: R1
status_cd: PE
timestamp: 1738755264000
transaction_id: e4f97a39-5860-418c-b041-4900e5d14f4c
headers: {}
deprecated: false
security: []
components:
schemas:
GetGstReturnStatusResponse:
oneOf:
- $ref: '#/components/schemas/GetGstReturnStatusSuccessResponse'
- $ref: '#/components/schemas/GstnBusinessErrorResponse'
description: >-
A GSTN success or GSTN business-failure response. Both variants use HTTP
200.
GetGstReturnStatusSuccessResponse:
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/GetGstReturnStatusSuccessPayload'
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
GetGstReturnStatusSuccessPayload:
type: object
description: Successful GSTN payload for Get Gst Return Status.
properties:
error_report:
type: object
description: The error report value returned by GSTN.
properties:
at:
type: array
description: The at value returned by GSTN.
items:
type: object
properties:
error_cd:
type: string
description: The error cd value returned by GSTN.
error_msg:
type: string
description: The error msg value returned by GSTN.
itms:
type: array
description: The itms value returned by GSTN.
items:
type: object
properties:
ad_amt:
type: number
description: The ad amt value returned by GSTN.
csamt:
type: number
description: The csamt value returned by GSTN.
iamt:
type: number
description: The iamt value returned by GSTN.
rt:
type: number
description: The rt value returned by GSTN.
pos:
type: string
description: The pos value returned by GSTN.
sply_ty:
type: string
description: The sply ty value returned by GSTN.
b2b:
type: array
description: The b2b value returned by GSTN.
items:
type: object
properties:
ctin:
type: string
description: The ctin value returned by GSTN.
error_cd:
type: string
description: The error cd value returned by GSTN.
error_msg:
type: string
description: The error msg value returned by GSTN.
inv:
type: array
description: The inv value returned by GSTN.
items:
type: object
properties:
etin:
type: string
description: The etin value returned by GSTN.
idt:
type: string
description: The idt value returned by GSTN.
inum:
type: string
description: The inum value returned by GSTN.
inv_typ:
type: string
description: The inv typ value returned by GSTN.
itms:
type: array
description: The itms value returned by GSTN.
items:
type: object
properties:
itm_det:
type: object
description: The itm det value returned by GSTN.
properties:
csamt:
type: number
description: The csamt value returned by GSTN.
iamt:
type: number
description: The iamt value returned by GSTN.
rt:
type: number
description: The rt value returned by GSTN.
txval:
type: number
description: The txval value returned by GSTN.
num:
type: number
description: The num value returned by GSTN.
pos:
type: string
description: The pos value returned by GSTN.
rchrg:
type: string
description: The rchrg value returned by GSTN.
val:
type: number
description: The val value returned by GSTN.
isEdit:
type: boolean
description: The is Edit value returned by GSTN.
b2cl:
type: array
description: The b2cl value returned by GSTN.
items:
type: object
properties:
error_cd:
type: string
description: The error cd value returned by GSTN.
error_msg:
type: string
description: The error msg value returned by GSTN.
inv:
type: array
description: The inv value returned by GSTN.
items:
type: object
properties:
etin:
type: string
description: The etin value returned by GSTN.
idt:
type: string
description: The idt value returned by GSTN.
inum:
type: string
description: The inum value returned by GSTN.
itms:
type: array
description: The itms value returned by GSTN.
items:
type: object
properties:
itm_det:
type: object
description: The itm det value returned by GSTN.
properties:
csamt:
type: number
description: The csamt value returned by GSTN.
iamt:
type: number
description: The iamt value returned by GSTN.
rt:
type: number
description: The rt value returned by GSTN.
txval:
type: number
description: The txval value returned by GSTN.
num:
type: number
description: The num value returned by GSTN.
val:
type: number
description: The val value returned by GSTN.
pos:
type: string
description: The pos value returned by GSTN.
b2cs:
type: array
description: The b2cs value returned by GSTN.
items:
type: object
properties:
csamt:
type: number
description: The csamt value returned by GSTN.
error_cd:
type: string
description: The error cd value returned by GSTN.
error_msg:
type: string
description: The error msg value returned by GSTN.
etin:
type: string
description: The etin value returned by GSTN.
iamt:
type: number
description: The iamt value returned by GSTN.
pos:
type: string
description: The pos value returned by GSTN.
rt:
type: number
description: The rt value returned by GSTN.
sply_ty:
type: string
description: The sply ty value returned by GSTN.
txval:
type: number
description: The txval value returned by GSTN.
typ:
type: string
description: The typ value returned by GSTN.
cdnr:
type: array
description: The cdnr value returned by GSTN.
items:
type: object
properties:
ctin:
type: string
description: The ctin value returned by GSTN.
error_cd:
type: string
description: The error cd value returned by GSTN.
error_msg:
type: string
description: The error msg value returned by GSTN.
nt:
type: array
description: The nt value returned by GSTN.
items:
type: object
properties:
idt:
type: string
description: The idt value returned by GSTN.
inum:
type: string
description: The inum value returned by GSTN.
itms:
type: array
description: The itms value returned by GSTN.
items:
type: object
properties:
itm_det:
type: object
description: The itm det value returned by GSTN.
properties:
csamt:
type: number
description: The csamt value returned by GSTN.
iamt:
type: number
description: The iamt value returned by GSTN.
rt:
type: number
description: The rt value returned by GSTN.
txval:
type: number
description: The txval value returned by GSTN.
num:
type: number
description: The num value returned by GSTN.
nt_dt:
type: string
description: The nt dt value returned by GSTN.
nt_num:
type: string
description: The nt num value returned by GSTN.
ntty:
type: string
description: The ntty value returned by GSTN.
p_gst:
type: string
description: The p gst value returned by GSTN.
rsn:
type: string
description: The rsn value returned by GSTN.
val:
type: number
description: The val value returned by GSTN.
cdnur:
type: array
description: The cdnur value returned by GSTN.
items:
type: object
properties:
error_cd:
type: string
description: The error cd value returned by GSTN.
error_msg:
type: string
description: The error msg value returned by GSTN.
idt:
type: string
description: The idt value returned by GSTN.
inum:
type: string
description: The inum value returned by GSTN.
itms:
type: array
description: The itms value returned by GSTN.
items:
type: object
properties:
itm_det:
type: object
description: The itm det value returned by GSTN.
properties:
csamt:
type: number
description: The csamt value returned by GSTN.
iamt:
type: number
description: The iamt value returned by GSTN.
rt:
type: number
description: The rt value returned by GSTN.
txval:
type: number
description: The txval value returned by GSTN.
num:
type: number
description: The num value returned by GSTN.
nt_dt:
type: string
description: The nt dt value returned by GSTN.
nt_num:
type: string
description: The nt num value returned by GSTN.
ntty:
type: string
description: The ntty value returned by GSTN.
p_gst:
type: string
description: The p gst value returned by GSTN.
rsn:
type: string
description: The rsn value returned by GSTN.
typ:
type: string
description: The typ value returned by GSTN.
val:
type: number
description: The val value returned by GSTN.
doc_issue:
type: object
description: The doc issue value returned by GSTN.
properties:
doc_det:
type: array
description: The doc det value returned by GSTN.
items:
type: object
properties:
doc_num:
type: number
description: The doc num value returned by GSTN.
docs:
type: array
description: The docs value returned by GSTN.
items:
type: object
properties:
cancel:
type: number
description: The cancel value returned by GSTN.
from:
type: string
description: The from value returned by GSTN.
net_issue:
type: number
description: The net issue value returned by GSTN.
num:
type: number
description: The num value returned by GSTN.
to:
type: string
description: The to value returned by GSTN.
totnum:
type: number
description: The totnum value returned by GSTN.
error_cd:
type: string
description: The error cd value returned by GSTN.
error_msg:
type: string
description: The error msg value returned by GSTN.
exp:
type: array
description: The exp value returned by GSTN.
items:
type: object
properties:
error_cd:
type: string
description: The error cd value returned by GSTN.
error_msg:
type: string
description: The error msg value returned by GSTN.
exp_typ:
type: string
description: The exp typ value returned by GSTN.
inv:
type: array
description: The inv value returned by GSTN.
items:
type: object
properties:
idt:
type: string
description: The idt value returned by GSTN.
inum:
type: string
description: The inum value returned by GSTN.
itms:
type: array
description: The itms value returned by GSTN.
items:
type: object
properties:
iamt:
type: number
description: The iamt value returned by GSTN.
rt:
type: number
description: The rt value returned by GSTN.
txval:
type: number
description: The txval value returned by GSTN.
sbdt:
type: string
description: The sbdt value returned by GSTN.
sbnum:
type: number
description: The sbnum value returned by GSTN.
sbpcode:
type: string
description: The sbpcode value returned by GSTN.
val:
type: number
description: The val value returned by GSTN.
hsn:
description: >-
The HSN error report. GSTN can return one report object or a
list of report objects.
oneOf:
- type: object
properties:
chksum:
type: string
description: The chksum value returned by GSTN.
data:
type: array
description: The data value returned by GSTN.
items:
type: object
properties:
camt:
type: integer
description: The camt value returned by GSTN.
csamt:
type: integer
description: The csamt value returned by GSTN.
desc:
type: string
description: The desc value returned by GSTN.
hsn_sc:
type: string
description: The hsn sc value returned by GSTN.
iamt:
type: number
description: The iamt value returned by GSTN.
num:
type: integer
description: The num value returned by GSTN.
qty:
type: number
description: The qty value returned by GSTN.
rt:
type: integer
description: The rt value returned by GSTN.
samt:
type: integer
description: The samt value returned by GSTN.
txval:
type: number
description: The txval value returned by GSTN.
uqc:
type: string
description: The uqc value returned by GSTN.
error_cd:
type: string
description: The error cd value returned by GSTN.
error_msg:
type: string
description: The error msg value returned by GSTN.
- type: array
description: The hsn value returned by GSTN.
items:
type: object
properties:
chksum:
type: string
description: The chksum value returned by GSTN.
data:
type: array
description: The data value returned by GSTN.
items:
type: object
properties:
camt:
type: integer
description: The camt value returned by GSTN.
csamt:
type: integer
description: The csamt value returned by GSTN.
desc:
type: string
description: The desc value returned by GSTN.
hsn_sc:
type: string
description: The hsn sc value returned by GSTN.
iamt:
type: number
description: The iamt value returned by GSTN.
num:
type: integer
description: The num value returned by GSTN.
qty:
type: number
description: The qty value returned by GSTN.
rt:
type: integer
description: The rt value returned by GSTN.
samt:
type: integer
description: The samt value returned by GSTN.
txval:
type: number
description: The txval value returned by GSTN.
uqc:
type: string
description: The uqc value returned by GSTN.
error_cd:
type: string
description: The error cd value returned by GSTN.
error_msg:
type: string
description: The error msg value returned by GSTN.
nil:
type: object
description: The nil value returned by GSTN.
properties:
error_cd:
type: string
description: The error cd value returned by GSTN.
error_msg:
type: string
description: The error msg value returned by GSTN.
inv:
type: array
description: The inv value returned by GSTN.
items:
type: object
properties:
expt_amt:
type: number
description: The expt amt value returned by GSTN.
ngsup_amt:
type: number
description: The ngsup amt value returned by GSTN.
nil_amt:
type: number
description: The nil amt value returned by GSTN.
sply_ty:
type: string
description: The sply ty value returned by GSTN.
txpd:
type: array
description: The txpd value returned by GSTN.
items:
type: object
properties:
error_cd:
type: string
description: The error cd value returned by GSTN.
error_msg:
type: string
description: The error msg value returned by GSTN.
itms:
type: array
description: The itms value returned by GSTN.
items:
type: object
properties:
ad_amt:
type: number
description: The ad amt value returned by GSTN.
csamt:
type: number
description: The csamt value returned by GSTN.
iamt:
type: number
description: The iamt value returned by GSTN.
rt:
type: number
description: The rt value returned by GSTN.
pos:
type: string
description: The pos value returned by GSTN.
sply_ty:
type: string
description: The sply ty value returned by GSTN.
error_cd:
type: string
description: The error cd value returned by GSTN.
example: RET191106
error_msg:
type: string
description: The error msg value returned by GSTN.
example: Error in Json structure validation.
table17:
type: object
description: The table17 value returned by GSTN.
properties:
items:
type: array
description: The items value returned by GSTN.
example:
- camt: 48287.66
csamt: 0
error_cd: RET91708
error_msg: >-
The reported tax amount differs with the computed value
by more than Rs. 10/-. Please report the correct tax
amount within the acceptable range to proceed with the
record
hsn_sc: '997331'
iamt: 0
isconcesstional: 'N'
rt: 18
samt: 48287.66
txval: 536762
- camt: 207620.5
csamt: 0
error_cd: RET91708
error_msg: >-
The reported tax amount differs with the computed value
by more than Rs. 10/-. Please report the correct tax
amount within the acceptable range to proceed with the
record
hsn_sc: '998232'
iamt: 5676040.91
isconcesstional: 'N'
rt: 18
samt: 207620.5
txval: 33840209.41
items:
type: object
properties:
camt:
type: number
description: The camt value returned by GSTN.
example: 48287.66
csamt:
type: number
description: The csamt value returned by GSTN.
example: 0
error_cd:
type: string
description: The error cd value returned by GSTN.
example: RET91708
error_msg:
type: string
description: The error msg value returned by GSTN.
example: >-
The reported tax amount differs with the computed
value by more than Rs. 10/-. Please report the correct
tax amount within the acceptable range to proceed with
the record
hsn_sc:
type: string
description: The hsn sc value returned by GSTN.
example: '997331'
iamt:
type: number
description: The iamt value returned by GSTN.
example: 0
isconcesstional:
type: string
description: The isconcesstional value returned by GSTN.
example: 'N'
rt:
type: number
description: The rt value returned by GSTN.
example: 18
samt:
type: number
description: The samt value returned by GSTN.
example: 48287.66
txval:
type: number
description: The txval value returned by GSTN.
example: 536762
form_typ:
type: string
description: The form typ value returned by GSTN.
status_cd:
type: string
description: The status cd value returned by GSTN.
action:
type: string
description: The action value returned by GSTN.
example: SAVE
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.
````