GST APIEnvironment:
Default OTP575757
API Reference
Overview
Public
Authentication
GSTR
GSTR1
GSTR1A
Get GSTR1A SummaryGET
Get GSTR1A Document IssuedGET
Get CDNRA InvoicesGET
Get B2CL InvoicesGET
Get B2BA InvoicesGET
Get ATAGET
Get TXPGET
Get Supplier ECO invoicesGET
Get Supplier ECOA invoicesGET
Get ECOM InvoicesGET
Get ECOMA InvoicesGET
Save GSTR1A dataPUT
Get B2B InvoicesGET
Get B2CLA InvoicesGET
Get B2CSA InvoicesGET
Get CDNR InvoicesGET
Get ATGET
Get EXPAGET
Get B2CS InvoicesGET
Get EXPGET
Get Nil Rated SuppliesGET
Get HSN Summary detailsGET
API call for getting all Credit/ Debit Notes issued to un-registered persons for a return period.GET
API call for getting all amended Credit/ Debit Notes issued to un-registered persons for a return period.GET
Reset GSTR1A DataPOST
File GSTR1A dataPOST
File GSTR1A dataPOST
Proceed To FileGET
Get TXPAGET
GSTR2A
GSTR2B
GSTR2X
GSTR3B
GSTR4
GSTR4A
GSTR4Annual
GSTR5
GSTR6
GSTR6A
GSTR7
GSTR8
GSTR9
GSTR9A
GSTR9C
SPIKE
ALL
IMS
ITC03
ITC04
CMP
Payment
Ledger
e-Invoice
Notices
GST APIGSTR1ASave GSTR1A data

Save GSTR1A data

PUThttps://apisandbox.whitebooks.in/gstr1a/retsave

Used to save entire GSTR1A invoices.

Parameters

query parameters
emailstringrequired
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 number
Example: "27AHQPA7588L1ZJ"
fpstringoptional
Fp Type
Example: "122016"
gtnumberoptional
gt Type
Example: 3782969.01
cur_gtnumberoptional
Document Number (Alphanumeric with / and - are allowed)
Example: 3782969.01
b2barray<object>optional
Array items:
ctinstringoptional
Challan Temporary Identification Number
Example: "01AABCE2207R1Z5"
invarray<object>optional
Array items:
inumstringoptional
Invoice Number
Example: "S008400"
idtstringoptional
Invoice Date
Example: "24-11-2016"
valnumberoptional
Invoice Value
Example: 729248.16
posstringoptional
Place of Supply
Example: "06"
rchrgstringoptional
Reverse Charge
Example: "N"
etinstringoptional
etin Number
Example: "01AABCE5507R1C4"
inv_typstringoptional
Invoice Type
Example: "R"
diff_percentnumberoptional
Differencial Percentage
Example: 0.65
itmsarray<object>optional
b2baarray<object>optional
Array items:
ctinstringoptional
Challan Temporary Identification Number
Example: "01AABCE2207R1Z5"
invarray<object>optional
Array items:
oinumstringoptional
Original Invoice Number
Example: "S008400"
oidtstringoptional
Original Invoice Date
Example: "24-11-2016"
inumstringoptional
Invoice Number
Example: "S008400"
idtstringoptional
Invoice Date
Example: "24-11-2016"
valnumberoptional
Invoice Amount
Example: 729248.16
posstringoptional
Place Of Supply
Example: "06"
rchrgstringoptional
Reverse Charge
Example: "N"
etinstringoptional
etin number
Example: "01AABCE5507R1C4"
inv_typstringoptional
Invoice Type
Example: "R"
diff_percentnumberoptional
Differencial Percentage
Example: 0.65
itmsarray<object>optional
b2clarray<object>optional
Array items:
posstringoptional
Place Of Supply
Example: "05"
invarray<object>optional
Array items:
inumstringoptional
Invoice Number
Example: "92661"
idtstringoptional
Invoice Date
Example: "10-01-2016"
valnumberoptional
Invoice Value
Example: 784586.33
inv_typstringoptional
Invoice Type
Example: "CBW"
etinstringoptional
etin
Example: "27AHQPA8875L1CU"
diff_percentnumberoptional
Differencial Percentage
Example: 0.65
itmsarray<object>optional
b2claarray<object>optional
Array items:
posstringoptional
Place of Supply
Example: "06"
invarray<object>optional
Array items:
oinumstringoptional
Original Invoice Number
Example: "9266"
oidtstringoptional
Original Invoice Date
Example: "10-02-2016"
inv_typstringoptional
Invoice Type
Example: "CBW"
diff_percentnumberoptional
Differencial percentage
Example: 0.65
inumstringoptional
Invoice Number
Example: "92661"
idtstringoptional
Invoice Date
Example: "10-01-2016"
valnumberoptional
Invoice Value
Example: 784586.33
etinstringoptional
etin number
Example: "01AABCE5507R1C4"
itmsarray<object>optional
cdnrarray<object>optional
Array items:
ctinstringoptional
ctin Number
Example: "01AAAAP1208Q1ZS"
ntarray<object>optional
Array items:
nttystringoptional
Note Type
Example: "C"
nt_numstringoptional
Note Number
Example: "533515"
nt_dtstringoptional
Note Date
Example: "23-09-2016"
p_gststringoptional
Pre GST
Example: "N"
posstringoptional
Place of Supply
Example: "01"
rchrgstringoptional
Reverse Charge
Example: "N"
inv_typstringoptional
Invoice Type
Example: "R"
valnumberoptional
Invoice Value
Example: 123123
diff_percentnumberoptional
Differencial Percentage
Example: 0.65
itmsarray<object>optional
cdnraarray<object>optional
Array items:
ctinstringoptional
ctin number
Example: "01AAAAP1208Q1ZS"
ntarray<object>optional
Array items:
nttystringoptional
Note Type
Example: "C"
ont_numstringoptional
Original Note Number
Example: "533515"
ont_dtstringoptional
Original Note Date
Example: "23-09-2016"
nt_numstringoptional
Note Number
Example: "533515"
nt_dtstringoptional
Note Date
Example: "23-09-2016"
p_gststringoptional
Pre GST
Example: "N"
posstringoptional
Place of Supply
Example: "01"
rchrgstringoptional
Reverse Charge
Example: "N"
inv_typstringoptional
Invoice Type
Example: "R"
diff_percentnumberoptional
Differencial Percentage
Example: 0.65
valnumberoptional
Invoice Value
Example: 123123
itmsarray<object>optional
b2csarray<object>optional
Array items:
sply_tystringoptional
Supply Type
Example: "INTER"
diff_percentnumberoptional
Differencial Percentage
Example: 0.65
rtnumberoptional
Rate
Example: 5
typstringoptional
Type
Example: "E"
etinstringoptional
etin
Example: "01AABCE5507R1C4"
posstringoptional
Place Of Supply
Example: "05"
txvalnumberoptional
Taxable Value
Example: 110
iamtnumberoptional
igst Amount
Example: 10
csamtnumberoptional
Cess Amount
Example: 10
b2csaarray<object>optional
Array items:
omonstringoptional
Original Month Of Invoice
Example: "122016"
sply_tystringoptional
Supply Type
Example: "INTER"
diff_percentnumberoptional
Differencial Percentage
Example: 0.65
typstringoptional
Type
Example: "E"
etinstringoptional
etin number
Example: "01AABCE5507R1C4"
posstringoptional
Place Of Supply
Example: "05"
itmsarray<object>optional
Array items:
rtnumberoptional
Product / Item Rate
Example: 5
txvalnumberoptional
Taxable Value
Example: 110
iamtnumberoptional
Igst Amount
Example: 10
camtnumberoptional
CGST Amount
Example: 0
samtnumberoptional
SGST Amount
Example: 0
csamtnumberoptional
Cess Amount
Example: 10
exparray<object>optional
Array items:
exp_typstringoptional
Export Type
Example: "WPAY"
invarray<object>optional
Array items:
inumstringoptional
Invoice Number
Example: "81542"
idtstringoptional
Invoice Date
Example: "12-02-2016"
valnumberoptional
Invoice Value
Example: 995048.36
diff_percentnumberoptional
Differencial Percentage
Example: 0.65
sbpcodestringoptional
prort Code
Example: "ASB991"
sbnumstringoptional
Shipping Bill Number
Example: "7896542"
sbdtstringoptional
Shipping Bill Date
Example: "04-10-2016"
itmsarray<object>optional
expaarray<object>optional
Array items:
exp_typstringoptional
Export Type
Example: "WPAY"
invarray<object>optional
Array items:
oinumstringoptional
Original Invoice Number
Example: "81542"
oidtstringoptional
Original Invoice Date
Example: "12-02-2016"
inumstringoptional
Invoice Number
Example: "81542"
idtstringoptional
Invoice Date
Example: "12-02-2016"
diff_percentnumberoptional
Differencial Percentage
Example: 0.65
valnumberoptional
Invoice Value
Example: 995048.36
sbpcodestringoptional
prort Code
Example: "ASB995"
sbnumstringoptional
Shipping Bill Number
Example: "1234567"
sbdtstringoptional
Shipping Bill Date
Example: "04-10-2016"
itmsarray<object>optional
hsnobjectoptional
dataarray<object>optional
Array items:
numnumberoptional
Product / Item number
Example: 1
hsn_scstringoptional
HSN/SAC CODE
Example: "1009"
descstringoptional
Goods Description
Example: "Goods Description"
uqcstringoptional
uqc
Example: "kg"
qtynumberoptional
Quantity
Example: 2.05
rtnumberoptional
Invoice Value
Example: 0.1
txvalnumberoptional
Taxable Value
Example: 10.23
iamtnumberoptional
Igst Amount
Example: 14.52
csamtnumberoptional
Cess Amount
Example: 500
nilobjectoptional
invarray<object>optional
Array items:
sply_tystringoptional
Supply Type
Example: "INTRB2B"
expt_amtnumberoptional
Exempted Amount
Example: 123.45
nil_amtnumberoptional
Total Nil rated outward supplies
Example: 1470.85
ngsup_amtnumberoptional
Total Non GST outward supplies
Example: 1258.5
txpdarray<object>optional
Array items:
posstringoptional
Place Of Supply
Example: "05"
sply_tystringoptional
Supply Type
Example: "INTER"
diff_percentnumberoptional
Differencial Percentage
Example: 0.65
itmsarray<object>optional
Array items:
rtnumberoptional
Product / Item Rate
Example: 5
ad_amtnumberoptional
Advance to be adjusted
Example: 100
iamtnumberoptional
Igst Amount
Example: 9400
csamtnumberoptional
Cess Amount
Example: 500
txpdaarray<object>optional
Array items:
omonstringoptional
Original Month
Example: "122016"
posstringoptional
Place Of Supply
Example: "05"
sply_tystringoptional
Supply Type
Example: "INTER"
diff_percentnumberoptional
Differencial Percentage
Example: 0.65
itmsarray<object>optional
Array items:
rtnumberoptional
Product / Item Rate
Example: 5
ad_amtnumberoptional
Advance to be adjusted
Example: 100
iamtnumberoptional
Igst Amount
Example: 9400
csamtnumberoptional
Cess Amount
Example: 500
atarray<object>optional
Array items:
posstringoptional
Place Of Supply
Example: "05"
sply_tystringoptional
Supply Type
Example: "INTER"
diff_percentnumberoptional
Differencial Percentage
Example: 0.65
itmsarray<object>optional
Array items:
rtnumberoptional
Product / Item Rate
Example: 5
ad_amtnumberoptional
Advance to be adjusted
Example: 100
iamtnumberoptional
Igst Amount
Example: 9400
csamtnumberoptional
Cess Amount
Example: 500
ataarray<object>optional
Array items:
omonstringoptional
Original Month
Example: "022017"
posstringoptional
Place Of Supply
Example: "05"
sply_tystringoptional
Supply Type
Example: "INTER"
diff_percentnumberoptional
Differencial Percentage
Example: 0.65
itmsarray<object>optional
Array items:
rtnumberoptional
Product / Item Rate
Example: 5
ad_amtnumberoptional
Advance to be adjusted
Example: 100
iamtnumberoptional
Igst Amount
Example: 9400
csamtnumberoptional
Cess Amount
Example: 500
doc_issueobjectoptional
doc_detarray<object>optional
Array items:
doc_numnumberoptional
Document Number
Example: 1
docsarray<object>optional
cdnurarray<object>optional
Array items:
typstringoptional
EXPWP/ EXPWOP/ B2CL
Example: "B2CL"
nttystringoptional
Credit/debit note type/ Refund Voucher
Example: "C"
nt_numstringoptional
Credit note/debit note / Refund Voucher Number
Example: "533515"
nt_dtstringoptional
Credit Note/Debit Note/ Refund Voucher date
Example: "23-09-2016"
p_gststringoptional
Pre GST Regime Dr./ Cr. Notes
Example: "N"
posstringoptional
Place Of Supply
Example: "05"
valnumberoptional
Invoice Value
Example: 64646
diff_percentnumberoptional
Differencial Percentage
Example: 0.65
itmsarray<object>optional
Array items:
numnumberoptional
Product / Item number
Example: 1
itm_detobjectoptional
cdnuraarray<object>optional
Array items:
ont_numstringoptional
Original Credit note/debit note / Refund Voucher Number
Example: "533515"
ont_dtstringoptional
Original Credit Note/Debit Note/ Refund Voucher date
Example: "23-09-2016"
nt_numstringoptional
Credit note/debit note / Refund Voucher Number
Example: "533515"
nt_dtstringoptional
Credit Note/Debit Note/ Refund Voucher date
Example: "23-09-2016"
nttystringoptional
Credit/debit note type/ Refund Voucher
Example: "C"
typstringoptional
EXPWP/ EXPWOP/ B2CL
Example: "B2CL"
p_gststringoptional
Pre GST Regime Dr./ Cr. Notes
Example: "N"
inumstringoptional
Invoice Number
Example: "915914"
valnumberoptional
Invoice Value
Example: 123123
idtstringoptional
Invoice Date
Example: "23-09-2016"
diff_percentnumberoptional
Differencial Percentage
Example: 0.65
itmsarray<object>optional
Array items:
numnumberoptional
Product / Item number
Example: 1
itm_detobjectoptional

Response

Not Found. If requested entity is not found or if requested API is not found.
PUT/gstr1a/retsave
1const response = await fetch('https://apisandbox.whitebooks.in/gstr1a/retsave?email=value', {
2 method: 'PUT',
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": "27AHQPA7588L1ZJ",
16 "fp": "122016",
17 "gt": 3782969.01,
18 "cur_gt": 3782969.01,
19 "b2b": [
20 {
21 "ctin": "01AABCE2207R1Z5",
22 "inv": [
23 {
24 "inum": "S008400",
25 "idt": "24-11-2016",
26 "val": 729248.16,
27 "pos": "06",
28 "rchrg": "N",
29 "etin": "01AABCE5507R1C4",
30 "inv_typ": "R",
31 "diff_percent": 0.65,
32 "itms": [
33 "..."
34 ]
35 }
36 ]
37 }
38 ],
39 "b2ba": [
40 {
41 "ctin": "01AABCE2207R1Z5",
42 "inv": [
43 {
44 "oinum": "S008400",
45 "oidt": "24-11-2016",
46 "inum": "S008400",
47 "idt": "24-11-2016",
48 "val": 729248.16,
49 "pos": "06",
50 "rchrg": "N",
51 "etin": "01AABCE5507R1C4",
52 "inv_typ": "R",
53 "diff_percent": 0.65,
54 "itms": [
55 "..."
56 ]
57 }
58 ]
59 }
60 ],
61 "b2cl": [
62 {
63 "pos": "05",
64 "inv": [
65 {
66 "inum": "92661",
67 "idt": "10-01-2016",
68 "val": 784586.33,
69 "inv_typ": "CBW",
70 "etin": "27AHQPA8875L1CU",
71 "diff_percent": 0.65,
72 "itms": [
73 "..."
74 ]
75 }
76 ]
77 }
78 ],
79 "b2cla": [
80 {
81 "pos": "06",
82 "inv": [
83 {
84 "oinum": "9266",
85 "oidt": "10-02-2016",
86 "inv_typ": "CBW",
87 "diff_percent": 0.65,
88 "inum": "92661",
89 "idt": "10-01-2016",
90 "val": 784586.33,
91 "etin": "01AABCE5507R1C4",
92 "itms": [
93 "..."
94 ]
95 }
96 ]
97 }
98 ],
99 "cdnr": [
100 {
101 "ctin": "01AAAAP1208Q1ZS",
102 "nt": [
103 {
104 "ntty": "C",
105 "nt_num": "533515",
106 "nt_dt": "23-09-2016",
107 "p_gst": "N",
108 "pos": "01",
109 "rchrg": "N",
110 "inv_typ": "R",
111 "val": 123123,
112 "diff_percent": 0.65,
113 "itms": [
114 "..."
115 ]
116 }
117 ]
118 }
119 ],
120 "cdnra": [
121 {
122 "ctin": "01AAAAP1208Q1ZS",
123 "nt": [
124 {
125 "ntty": "C",
126 "ont_num": "533515",
127 "ont_dt": "23-09-2016",
128 "nt_num": "533515",
129 "nt_dt": "23-09-2016",
130 "p_gst": "N",
131 "pos": "01",
132 "rchrg": "N",
133 "inv_typ": "R",
134 "diff_percent": 0.65,
135 "val": 123123,
136 "itms": [
137 "..."
138 ]
139 }
140 ]
141 }
142 ],
143 "b2cs": [
144 {
145 "sply_ty": "INTER",
146 "diff_percent": 0.65,
147 "rt": 5,
148 "typ": "E",
149 "etin": "01AABCE5507R1C4",
150 "pos": "05",
151 "txval": 110,
152 "iamt": 10,
153 "csamt": 10
154 }
155 ],
156 "b2csa": [
157 {
158 "omon": "122016",
159 "sply_ty": "INTER",
160 "diff_percent": 0.65,
161 "typ": "E",
162 "etin": "01AABCE5507R1C4",
163 "pos": "05",
164 "itms": [
165 {
166 "rt": 5,
167 "txval": 110,
168 "iamt": 10,
169 "camt": 0,
170 "samt": 0,
171 "csamt": 10
172 }
173 ]
174 }
175 ],
176 "exp": [
177 {
178 "exp_typ": "WPAY",
179 "inv": [
180 {
181 "inum": "81542",
182 "idt": "12-02-2016",
183 "val": 995048.36,
184 "diff_percent": 0.65,
185 "sbpcode": "ASB991",
186 "sbnum": "7896542",
187 "sbdt": "04-10-2016",
188 "itms": [
189 "..."
190 ]
191 }
192 ]
193 }
194 ],
195 "expa": [
196 {
197 "exp_typ": "WPAY",
198 "inv": [
199 {
200 "oinum": "81542",
201 "oidt": "12-02-2016",
202 "inum": "81542",
203 "idt": "12-02-2016",
204 "diff_percent": 0.65,
205 "val": 995048.36,
206 "sbpcode": "ASB995",
207 "sbnum": "1234567",
208 "sbdt": "04-10-2016",
209 "itms": [
210 "..."
211 ]
212 }
213 ]
214 }
215 ],
216 "hsn": {
217 "data": [
218 {
219 "num": 1,
220 "hsn_sc": "1009",
221 "desc": "Goods Description",
222 "uqc": "kg",
223 "qty": 2.05,
224 "rt": 0.1,
225 "txval": 10.23,
226 "iamt": 14.52,
227 "csamt": 500
228 }
229 ]
230 },
231 "nil": {
232 "inv": [
233 {
234 "sply_ty": "INTRB2B",
235 "expt_amt": 123.45,
236 "nil_amt": 1470.85,
237 "ngsup_amt": 1258.5
238 }
239 ]
240 },
241 "txpd": [
242 {
243 "pos": "05",
244 "sply_ty": "INTER",
245 "diff_percent": 0.65,
246 "itms": [
247 {
248 "rt": 5,
249 "ad_amt": 100,
250 "iamt": 9400,
251 "csamt": 500
252 }
253 ]
254 }
255 ],
256 "txpda": [
257 {
258 "omon": "122016",
259 "pos": "05",
260 "sply_ty": "INTER",
261 "diff_percent": 0.65,
262 "itms": [
263 {
264 "rt": 5,
265 "ad_amt": 100,
266 "iamt": 9400,
267 "csamt": 500
268 }
269 ]
270 }
271 ],
272 "at": [
273 {
274 "pos": "05",
275 "sply_ty": "INTER",
276 "diff_percent": 0.65,
277 "itms": [
278 {
279 "rt": 5,
280 "ad_amt": 100,
281 "iamt": 9400,
282 "csamt": 500
283 }
284 ]
285 }
286 ],
287 "ata": [
288 {
289 "omon": "022017",
290 "pos": "05",
291 "sply_ty": "INTER",
292 "diff_percent": 0.65,
293 "itms": [
294 {
295 "rt": 5,
296 "ad_amt": 100,
297 "iamt": 9400,
298 "csamt": 500
299 }
300 ]
301 }
302 ],
303 "doc_issue": {
304 "doc_det": [
305 {
306 "doc_num": 1,
307 "docs": [
308 {
309 "num": "...",
310 "from": "...",
311 "to": "...",
312 "totnum": "...",
313 "cancel": "...",
314 "net_issue": "..."
315 }
316 ]
317 }
318 ]
319 },
320 "cdnur": [
321 {
322 "typ": "B2CL",
323 "ntty": "C",
324 "nt_num": "533515",
325 "nt_dt": "23-09-2016",
326 "p_gst": "N",
327 "pos": "05",
328 "val": 64646,
329 "diff_percent": 0.65,
330 "itms": [
331 {
332 "num": 1,
333 "itm_det": {
334 "rt": "...",
335 "txval": "...",
336 "iamt": "...",
337 "csamt": "..."
338 }
339 }
340 ]
341 }
342 ],
343 "cdnura": [
344 {
345 "ont_num": "533515",
346 "ont_dt": "23-09-2016",
347 "nt_num": "533515",
348 "nt_dt": "23-09-2016",
349 "ntty": "C",
350 "typ": "B2CL",
351 "p_gst": "N",
352 "inum": "915914",
353 "val": 123123,
354 "idt": "23-09-2016",
355 "diff_percent": 0.65,
356 "itms": [
357 {
358 "num": 1,
359 "itm_det": {
360 "rt": "...",
361 "txval": "...",
362 "iamt": "...",
363 "csamt": "..."
364 }
365 }
366 ]
367 }
368 ]
369}),
370});
371
372const data = await response.json();
373console.log(data);
No example available.