GST APIEnvironment:
Default OTP575757
API Reference
Overview
Public
Authentication
GSTR
GSTR1
GSTR1A
GSTR2A
GSTR2B
GSTR2X
GSTR3B
GSTR4
GSTR4A
GSTR4Annual
GSTR5
GSTR6
GSTR6A
GSTR7
GSTR8
GSTR9
GSTR9A
File GSTR9APOST
File GSTR9A dataPOST
Save GSTR9APUT
Get GSTR9A DetailsGET
Get GSTR9A Auto Calculated DetailsGET
GSTR9C
SPIKE
ALL
IMS
ITC03
ITC04
CMP
Payment
Ledger
e-Invoice
Notices
GST APIGSTR9AFile GSTR9A

File GSTR9A

POSThttps://apisandbox.whitebooks.in/gstr9a/retfile

This API is to File GSTR9A

Parameters

query parameters
emailstringrequired
API Developer User Email
header parameters
gstinstringrequired
GST Number
ret_periodstringrequired
Return Period (MMYYYY)
gst_usernamestringrequired
GST UserName
state_cdstringrequired
State Code
ip_addressstringrequired
IP Address
txnstringrequired
Transaction
client_idstringrequired
Client ID
client_secretstringrequired
Client Secret

Request Body

application/jsonrequired
gstinstringoptional
GSTIN
Example: "04AJIPA1572EAZK"
fpstringoptional
Financial Year
Example: "032018"
cmp_frmdtstringoptional
Composition Start data
Example: "12-01-2018"
cmp_todtstringoptional
Composition Start data
Example: "12-01-2018"
isnilstringoptional
Is Nil Filing
Example: "N"
table5objectoptional
gtnumberoptional
Gross TrunOver
Example: 1000.12
chksumstringoptional
Checksum
Example: "ahshsjslslslss"
table6objectoptional
tx_trnovrarray<object>optional
Array items:
rtnumberoptional
Rate of Tax
Example: 1
trnovrnumberoptional
IGST Amount
Example: 20
camtnumberoptional
CGST Amount
Example: 20
samtnumberoptional
SGST Amount
Example: 20
exmpobjectoptional
trnovrnumberoptional
IGST Amount
Example: 20
camtnumberoptional
CGST Amount
Example: 20
samtnumberoptional
SGST Amount
Example: 20
totobjectoptional
trnovrnumberoptional
IGST Amount
Example: 20
camtnumberoptional
CGST Amount
Example: 20
samtnumberoptional
SGST Amount
Example: 20
table7objectoptional
b2bobjectoptional
txvalnumberoptional
Taxable value of Goods or Service as per invoice
Example: 10000
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
b2burobjectoptional
txvalnumberoptional
Taxable value of Goods or Service as per invoice
Example: 10000
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
impsobjectoptional
txvalnumberoptional
Taxable value of Goods or Service as per invoice
Example: 10000
iamtnumberoptional
IGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
totobjectoptional
txvalnumberoptional
Taxable value of Goods or Service as per invoice
Example: 10000
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
table8objectoptional
b2bobjectoptional
txvalnumberoptional
Taxable value of Goods or Service as per invoice
Example: 10000
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
impgobjectoptional
txvalnumberoptional
Taxable value of Goods or Service as per invoice
Example: 10000
iamtnumberoptional
IGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
chksumstringoptional
Checksum
Example: "ahshsjslslslss"
table9objectoptional
tx_payobjectoptional
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
intrnumberoptional
Interest Amount
Example: 20
feenumberoptional
Fee Amount
Example: 20
txpdobjectoptional
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
intrnumberoptional
Interest Amount
Example: 20
feenumberoptional
Fee Amount
Example: 20
chksumstringoptional
Checksum
Example: "ahshsjslslslss"
table10objectoptional
txosa_dnobjectoptional
trnovrnumberoptional
Total Turnover
Example: 1000
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
b2b_dnobjectoptional
trnovrnumberoptional
Total TurnOver
Example: 1000
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
txosa_cnobjectoptional
trnovrnumberoptional
Total Turnover
Example: 1000
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
b2b_cnobjectoptional
trnovrnumberoptional
Total Turnover
Example: 1000
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
chksumstringoptional
Checksum
Example: "ahshsjslslslss"
tot_trnovrobjectoptional
trnovrnumberoptional
Total Turnover
Example: 10000
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
table14objectoptional
payobjectoptional
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
intrnumberoptional
Interest Amount
Example: 0
paidobjectoptional
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
intrnumberoptional
Interest Amount
Example: 0
chksumstringoptional
Checksum
Example: "ahshsjslslslss"
table15objectoptional
rfd_clmdobjectoptional
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
intrnumberoptional
Interest Amount
Example: 0
feenumberoptional
Fee Amount
Example: 0
pennumberoptional
Penalty Amount
Example: 0
rfd_sancobjectoptional
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
intrnumberoptional
Interest Amount
Example: 0
feenumberoptional
Fee Amount
Example: 0
pennumberoptional
Penalty Amount
Example: 0
rfd_rejtobjectoptional
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
intrnumberoptional
Interest Amount
Example: 0
feenumberoptional
Fee Amount
Example: 0
pennumberoptional
Penalty Amount
Example: 0
rfd_pendobjectoptional
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
intrnumberoptional
Interest Amount
Example: 0
feenumberoptional
Fee Amount
Example: 0
pennumberoptional
Penalty Amount
Example: 0
tax_dmndobjectoptional
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
intrnumberoptional
Interest Amount
Example: 0
feenumberoptional
Fee Amount
Example: 0
pennumberoptional
Penalty Amount
Example: 0
txpdobjectoptional
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
intrnumberoptional
Interest Amount
Example: 0
feenumberoptional
Fee Amount
Example: 0
pennumberoptional
Penalty Amount
Example: 0
dmnd_pendobjectoptional
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
intrnumberoptional
Interest Amount
Example: 0
feenumberoptional
Fee Amount
Example: 0
pennumberoptional
Penalty Amount
Example: 0
chksumstringoptional
Checksum
Example: "ahshsjslslslss"
table16objectoptional
debitobjectoptional
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
creditobjectoptional
iamtnumberoptional
IGST Amount as per invoice
Example: 20
camtnumberoptional
CGST Amount as per invoice
Example: 20
samtnumberoptional
SGST Amount as per invoice
Example: 20
csamtnumberoptional
Cess Amount as per invoice
Example: 20
chksumstringoptional
Checksum
Example: "ahshsjslslslss"
tax_payarray<object>optional
Array items:
cgstobjectoptional
Central Tax
intrnumberoptional
Interest Amount
Example: 0
othnumberoptional
other Amount
Example: 0
txnumberoptional
Tax Amount
Example: 0
feenumberoptional
Fee Amount
Example: 0
totnumberoptional
Total Amount
Example: 0
pennumberoptional
Penalty Amount
Example: 0
sgstobjectoptional
State tax/UT Tax
intrnumberoptional
Interest Amount
Example: 0
othnumberoptional
other Amount
Example: 0
txnumberoptional
Tax Amount
Example: 0
feenumberoptional
Fee Amount
Example: 0
totnumberoptional
Total Amount
Example: 0
pennumberoptional
Penalty Amount
Example: 0
liab_idintegeroptional
Liab ID
Example: 8855
trancdintegeroptional
Transaction Code
Example: 30002
trandatestringoptional
Transaction Date
Example: "12-02-2018"
offsetarray<object>optional
Array items:
camtobjectoptional
Central Tax
intrnumberoptional
Interest Amount
Example: 0
txnumberoptional
Tax Amount
Example: 0
feenumberoptional
Fee Amount
Example: 0
totnumberoptional
Total Amount
Example: 0
samtobjectoptional
State tax/UT Tax
intrnumberoptional
Interest Amount
Example: 0
txnumberoptional
Tax Amount
Example: 0
feenumberoptional
Fee Amount
Example: 0
totnumberoptional
Total Amount
Example: 0
trancdintegeroptional
Transaction Code
Example: 30002

Response

Not Found. If requested entity is not found or if requested API is not found.
POST/gstr9a/retfile
1const response = await fetch('https://apisandbox.whitebooks.in/gstr9a/retfile?email=value', {
2 method: 'POST',
3 headers: {
4 gstin: "value",
5 ret_period: "value",
6 gst_username: "value",
7 state_cd: "value",
8 ip_address: "value",
9 txn: "value",
10 client_id: "value",
11 client_secret: "value",
12 Content-Type: "application/json"
13},
14 body: JSON.stringify({
15 "gstin": "04AJIPA1572EAZK",
16 "fp": "032018",
17 "cmp_frmdt": "12-01-2018",
18 "cmp_todt": "12-01-2018",
19 "isnil": "N",
20 "table5": {
21 "gt": 1000.12,
22 "chksum": "ahshsjslslslss"
23 },
24 "table6": {
25 "tx_trnovr": [
26 {
27 "rt": 1,
28 "trnovr": 20,
29 "camt": 20,
30 "samt": 20
31 }
32 ],
33 "exmp": {
34 "trnovr": 20,
35 "camt": 20,
36 "samt": 20
37 },
38 "tot": {
39 "trnovr": 20,
40 "camt": 20,
41 "samt": 20
42 }
43 },
44 "table7": {
45 "b2b": {
46 "txval": 10000,
47 "iamt": 20,
48 "camt": 20,
49 "samt": 20,
50 "csamt": 20
51 },
52 "b2bur": {
53 "txval": 10000,
54 "iamt": 20,
55 "camt": 20,
56 "samt": 20,
57 "csamt": 20
58 },
59 "imps": {
60 "txval": 10000,
61 "iamt": 20,
62 "csamt": 20
63 },
64 "tot": {
65 "txval": 10000,
66 "iamt": 20,
67 "camt": 20,
68 "samt": 20,
69 "csamt": 20
70 }
71 },
72 "table8": {
73 "b2b": {
74 "txval": 10000,
75 "iamt": 20,
76 "camt": 20,
77 "samt": 20,
78 "csamt": 20
79 },
80 "impg": {
81 "txval": 10000,
82 "iamt": 20,
83 "csamt": 20
84 },
85 "chksum": "ahshsjslslslss"
86 },
87 "table9": {
88 "tx_pay": {
89 "iamt": 20,
90 "camt": 20,
91 "samt": 20,
92 "csamt": 20,
93 "intr": 20,
94 "fee": 20
95 },
96 "txpd": {
97 "iamt": 20,
98 "camt": 20,
99 "samt": 20,
100 "csamt": 20,
101 "intr": 20,
102 "fee": 20
103 },
104 "chksum": "ahshsjslslslss"
105 },
106 "table10": {
107 "txosa_dn": {
108 "trnovr": 1000,
109 "camt": 20,
110 "samt": 20
111 },
112 "b2b_dn": {
113 "trnovr": 1000,
114 "iamt": 20,
115 "camt": 20,
116 "samt": 20,
117 "csamt": 20
118 },
119 "txosa_cn": {
120 "trnovr": 1000,
121 "camt": 20,
122 "samt": 20
123 },
124 "b2b_cn": {
125 "trnovr": 1000,
126 "iamt": 20,
127 "camt": 20,
128 "samt": 20,
129 "csamt": 20
130 },
131 "chksum": "ahshsjslslslss",
132 "tot_trnovr": {
133 "trnovr": 10000,
134 "camt": 20,
135 "samt": 20
136 }
137 },
138 "table14": {
139 "pay": {
140 "iamt": 20,
141 "camt": 20,
142 "samt": 20,
143 "csamt": 20,
144 "intr": 0
145 },
146 "paid": {
147 "iamt": 20,
148 "camt": 20,
149 "samt": 20,
150 "csamt": 20,
151 "intr": 0
152 },
153 "chksum": "ahshsjslslslss"
154 },
155 "table15": {
156 "rfd_clmd": {
157 "iamt": 20,
158 "camt": 20,
159 "samt": 20,
160 "csamt": 20,
161 "intr": 0,
162 "fee": 0,
163 "pen": 0
164 },
165 "rfd_sanc": {
166 "iamt": 20,
167 "camt": 20,
168 "samt": 20,
169 "csamt": 20,
170 "intr": 0,
171 "fee": 0,
172 "pen": 0
173 },
174 "rfd_rejt": {
175 "iamt": 20,
176 "camt": 20,
177 "samt": 20,
178 "csamt": 20,
179 "intr": 0,
180 "fee": 0,
181 "pen": 0
182 },
183 "rfd_pend": {
184 "iamt": 20,
185 "camt": 20,
186 "samt": 20,
187 "csamt": 20,
188 "intr": 0,
189 "fee": 0,
190 "pen": 0
191 },
192 "tax_dmnd": {
193 "iamt": 20,
194 "camt": 20,
195 "samt": 20,
196 "csamt": 20,
197 "intr": 0,
198 "fee": 0,
199 "pen": 0
200 },
201 "txpd": {
202 "iamt": 20,
203 "camt": 20,
204 "samt": 20,
205 "csamt": 20,
206 "intr": 0,
207 "fee": 0,
208 "pen": 0
209 },
210 "dmnd_pend": {
211 "iamt": 20,
212 "camt": 20,
213 "samt": 20,
214 "csamt": 20,
215 "intr": 0,
216 "fee": 0,
217 "pen": 0
218 },
219 "chksum": "ahshsjslslslss"
220 },
221 "table16": {
222 "debit": {
223 "iamt": 20,
224 "camt": 20,
225 "samt": 20,
226 "csamt": 20
227 },
228 "credit": {
229 "iamt": 20,
230 "camt": 20,
231 "samt": 20,
232 "csamt": 20
233 },
234 "chksum": "ahshsjslslslss"
235 },
236 "tax_pay": [
237 {
238 "cgst": {
239 "intr": 0,
240 "oth": 0,
241 "tx": 0,
242 "fee": 0,
243 "tot": 0,
244 "pen": 0
245 },
246 "sgst": {
247 "intr": 0,
248 "oth": 0,
249 "tx": 0,
250 "fee": 0,
251 "tot": 0,
252 "pen": 0
253 },
254 "liab_id": 8855,
255 "trancd": 30002,
256 "trandate": "12-02-2018"
257 }
258 ],
259 "offset": [
260 {
261 "camt": {
262 "intr": 0,
263 "tx": 0,
264 "fee": 0,
265 "tot": 0
266 },
267 "samt": {
268 "intr": 0,
269 "tx": 0,
270 "fee": 0,
271 "tot": 0
272 },
273 "trancd": 30002
274 }
275 ]
276}),
277});
278
279const data = await response.json();
280console.log(data);
No example available.