GST APIEnvironment:
Default OTP575757
API Reference
Overview
Public
Authentication
GSTR
GSTR1
GSTR1A
GSTR2A
GSTR2B
GSTR2X
GSTR3B
GSTR4
Save GSTR4 dataPUT
Get B2B InvoicesGET
Get B2B Unregistered InvoiceGET
Get IMPSGET
Get CDNR InvoicesGET
API call for getting all Credit/ Debit Notes issued to un-registered persons for a return period.GET
API call for getting invoices for Tax on Outward Supplies for a return period. GET
Get ATGET
Get TXPGET
Get GSTR1 SummaryGET
Submit GSTR4 dataPOST
Get TDSGET
File GSTR4 dataPOST
File GSTR4 dataPOST
API call for offsetting the liabilities and interest from GSTR4POST
Get B2BA InvoicesGET
Get B2BUR AmendmentGET
Get Imports of Services AmendmentGET
Get CDNR AmendmentGET
Get CDNUR AmendmentGET
Get TXOS AmendmentGET
Get Advances Paid AmendmentGET
Get Advances Adjusted AmendmentGET
GSTR4A
GSTR4Annual
GSTR5
GSTR6
GSTR6A
GSTR7
GSTR8
GSTR9
GSTR9A
GSTR9C
SPIKE
ALL
IMS
ITC03
ITC04
CMP
Payment
Ledger
e-Invoice
Notices
GST APIGSTR4File GSTR4 data

File GSTR4 data

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

Used to file entire GSTR1 invoices.

Parameters

query parameters
emailstringrequired
API Developer User Email
panstringrequired
PAN Number
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
Supplier GSTIN
Example: "27AHQPA7588L1ZJ"
ret_periodstringoptional
Return Period
Example: "022024"
chksumstringoptional
Checksum Value
Example: "e019706b5c029430c81cc4f620c72adf0fc43ceb1805099abe0f1a41a79cfbc5"
sec_sumarray<object>optional
Array items:
ttl_igstnumberoptional
Total igst amount
Example: 10
ttl_liabnumberoptional
Total liability
Example: 10
ttl_rchrgobjectoptional
ttl_igstnumberoptional
Total IGST
Example: 0
ttl_cgstnumberoptional
Total CGST
Example: 0
ttl_cessnumberoptional
Total cess
Example: 0
ttl_taxnumberoptional
Total tax
Example: 0
ttl_valnumberoptional
Total value
Example: 0
ttl_recnumberoptional
Total Rec amount
Example: 0
ttl_sgstnumberoptional
Total SGST
Example: 0
ttl_non_rchrgobjectoptional
ttl_igstnumberoptional
Total IGST
Example: 10
ttl_cgstnumberoptional
Total CGST
Example: 0
ttl_cessnumberoptional
Total cess
Example: 0
ttl_taxnumberoptional
Total tax
Example: 200
ttl_valnumberoptional
Total value
Example: 3000
ttl_recnumberoptional
Total Rec amount
Example: 2
ttl_sgstnumberoptional
Total SGST
Example: 0
gross_adv_pdnumberoptional
Gross Advance
Example: 0
cpty_sumarray<object>optional
Array items:
ttl_igstnumberoptional
Total IGST
Example: 10
ttl_liabnumberoptional
Total Liability
Example: 10
ttl_cgstnumberoptional
Total CGST
Example: 0
ttl_cessnumberoptional
Total cess
Example: 0
ttl_taxnumberoptional
Total tax
Example: 200
ttl_valnumberoptional
Total value
Example: 3000
ttl_recnumberoptional
Total Rec amount
Example: 2
ttl_sgstnumberoptional
Total SGST
Example: 0
chksumstringoptional
Check sum
Example: "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
ctinstringoptional
GSTIN
Example: "33CCCTN9418C1ZL"
ttl_cgstnumberoptional
Total CGST
Example: 0
ttl_cessnumberoptional
Total cess
Example: 0
ttl_taxnumberoptional
Total tax
Example: 200
ttl_valnumberoptional
Total value
Example: 3000
ttl_recnumberoptional
Total Rec amount
Example: 2
ttl_sgstnumberoptional
Total SGST
Example: 0
chksumstringoptional
Check sum
Example: "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
gross_adv_adjnumberoptional
gross Advance
Example: 0
sec_nmstringoptional
Section name
Example: "b2b"
ttl_invnumberoptional
Total invoice
Example: 10
liabDetlobjectoptional
nonRevobjectoptional
sgstobjectoptional
tran_cdintegeroptional
transaction code
Example: 30002
cgstobjectoptional
cessobjectoptional
igstobjectoptional
revobjectoptional
sgstobjectoptional
tran_cdintegeroptional
transaction code
Example: 30002
cgstobjectoptional
cessobjectoptional
igstobjectoptional
utilizeCashReqVOobjectoptional
gstinstringoptional
Supplier GSTIN
Example: "27AHQPA7588L1ZJ"
ret_typestringoptional
return type
Example: "R4"
ret_periodstringoptional
return Period
Example: "022024"
op_liabarray<object>optional
Array items:
liab_idintegeroptional
liability id
Example: 0
tran_cdintegeroptional
transaction code
Example: 30002
sgstobjectoptional
cgstobjectoptional
cessobjectoptional
igstobjectoptional

Response

Not Found. If requested entity is not found or if requested API is not found.
POST/gstr4/retfile
1const response = await fetch('https://apisandbox.whitebooks.in/gstr4/retfile?email=value&pan=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": "27AHQPA7588L1ZJ",
16 "ret_period": "022024",
17 "chksum": "e019706b5c029430c81cc4f620c72adf0fc43ceb1805099abe0f1a41a79cfbc5",
18 "sec_sum": [
19 {
20 "ttl_igst": 10,
21 "ttl_liab": 10,
22 "ttl_rchrg": {
23 "ttl_igst": 0,
24 "ttl_cgst": 0,
25 "ttl_cess": 0,
26 "ttl_tax": 0,
27 "ttl_val": 0,
28 "ttl_rec": 0,
29 "ttl_sgst": 0
30 },
31 "ttl_non_rchrg": {
32 "ttl_igst": 10,
33 "ttl_cgst": 0,
34 "ttl_cess": 0,
35 "ttl_tax": 200,
36 "ttl_val": 3000,
37 "ttl_rec": 2,
38 "ttl_sgst": 0
39 },
40 "gross_adv_pd": 0,
41 "cpty_sum": [
42 {
43 "ttl_igst": 10,
44 "ttl_liab": 10,
45 "ttl_cgst": 0,
46 "ttl_cess": 0,
47 "ttl_tax": 200,
48 "ttl_val": 3000,
49 "ttl_rec": 2,
50 "ttl_sgst": 0,
51 "chksum": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
52 "ctin": "33CCCTN9418C1ZL"
53 }
54 ],
55 "ttl_cgst": 0,
56 "ttl_cess": 0,
57 "ttl_tax": 200,
58 "ttl_val": 3000,
59 "ttl_rec": 2,
60 "ttl_sgst": 0,
61 "chksum": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
62 "gross_adv_adj": 0,
63 "sec_nm": "b2b"
64 }
65 ],
66 "ttl_inv": 10,
67 "liabDetl": {
68 "nonRev": {
69 "sgst": {
70 "intr": 4,
71 "oth": 0,
72 "tx": 1,
73 "fee": 5000,
74 "tot": 5005,
75 "pen": 0
76 },
77 "tran_cd": 30002,
78 "cgst": {
79 "intr": 4,
80 "oth": 0,
81 "tx": 1,
82 "fee": 5000,
83 "tot": 5005,
84 "pen": 0
85 },
86 "cess": {
87 "intr": 4,
88 "oth": 0,
89 "tx": 1,
90 "fee": 5000,
91 "tot": 5005,
92 "pen": 0
93 },
94 "igst": {
95 "intr": 4,
96 "oth": 0,
97 "tx": 1,
98 "fee": 5000,
99 "tot": 5005,
100 "pen": 0
101 }
102 },
103 "rev": {
104 "sgst": {
105 "intr": 4,
106 "oth": 0,
107 "tx": 1,
108 "fee": 5000,
109 "tot": 5005,
110 "pen": 0
111 },
112 "tran_cd": 30002,
113 "cgst": {
114 "intr": 4,
115 "oth": 0,
116 "tx": 1,
117 "fee": 5000,
118 "tot": 5005,
119 "pen": 0
120 },
121 "cess": {
122 "intr": 4,
123 "oth": 0,
124 "tx": 1,
125 "fee": 5000,
126 "tot": 5005,
127 "pen": 0
128 },
129 "igst": {
130 "intr": 4,
131 "oth": 0,
132 "tx": 1,
133 "fee": 5000,
134 "tot": 5005,
135 "pen": 0
136 }
137 }
138 },
139 "utilizeCashReqVO": {
140 "gstin": "27AHQPA7588L1ZJ",
141 "ret_type": "R4",
142 "ret_period": "022024",
143 "op_liab": [
144 {
145 "liab_id": 0,
146 "tran_cd": 30002,
147 "sgst": {
148 "intr": 4,
149 "oth": 0,
150 "tx": 1,
151 "fee": 5000,
152 "tot": 5005,
153 "pen": 0
154 },
155 "cgst": {
156 "intr": 4,
157 "oth": 0,
158 "tx": 1,
159 "fee": 5000,
160 "tot": 5005,
161 "pen": 0
162 },
163 "cess": {
164 "intr": 4,
165 "oth": 0,
166 "tx": 1,
167 "fee": 5000,
168 "tot": 5005,
169 "pen": 0
170 },
171 "igst": {
172 "intr": 4,
173 "oth": 0,
174 "tx": 1,
175 "fee": 5000,
176 "tot": 5005,
177 "pen": 0
178 }
179 }
180 ]
181 }
182}),
183});
184
185const data = await response.json();
186console.log(data);
No example available.