GST APIEnvironment:
Default OTP575757
API Reference
Overview
Public
Authentication
GSTR
GSTR1
GSTR1A
GSTR2A
GSTR2B
GSTR2X
GSTR3B
GSTR4
GSTR4A
GSTR4Annual
Save GSTR4Annual dataPUT
Get tdscmp InvoicesGET
Get txios InvoicesGET
Get validate turnover for GSTR4 Annual formGET
Get validate the liability provided in table 6 for GSTR4 Annual formGET
Get autopopulated data for table 4A/4B of GSTR4 Annual formGET
Get summary InvoicesGET
File GSTR4Annual dataPOST
File GSTR4 Annual dataPOST
GSTR5
GSTR6
GSTR6A
GSTR7
GSTR8
GSTR9
GSTR9A
GSTR9C
SPIKE
ALL
IMS
ITC03
ITC04
CMP
Payment
Ledger
e-Invoice
Notices
GST APIGSTR4AnnualFile GSTR4Annual data

File GSTR4Annual data

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

Used to file entire GSTR4Annual 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"
agg_turnoverintegeroptional
Aggregate Turnover
Example: 10000
fpstringoptional
Financial Period
Example: "022024"
isnilstringoptional
Action Type
Example: "N"
chksumstringoptional
Checksum Value
Example: "e019706b5c029430c81cc4f620c72adf0fc43ceb1805099abe0f1a41a79cfbc5"
impsupsmryobjectoptional
b2borobjectoptional
chksumstringoptional
Check sum
Example: "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
ttl_igstnumberoptional
Total IGST
Example: 0
ttl_cgstnumberoptional
Total CGST
Example: 0
ttl_cessnumberoptional
Total cess
Example: 0
ttl_valnumberoptional
Total value
Example: 0
ttl_recnumberoptional
Total Rec amount
Example: 0
ttl_sgstnumberoptional
Total SGST
Example: 0
b2brobjectoptional
chksumstringoptional
Check sum
Example: "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
ttl_igstnumberoptional
Total IGST
Example: 0
ttl_cgstnumberoptional
Total CGST
Example: 0
ttl_cessnumberoptional
Total cess
Example: 0
ttl_valnumberoptional
Total value
Example: 0
ttl_recnumberoptional
Total Rec amount
Example: 0
ttl_sgstnumberoptional
Total SGST
Example: 0
b2burobjectoptional
chksumstringoptional
Check sum
Example: "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
ttl_igstnumberoptional
Total IGST
Example: 0
ttl_cgstnumberoptional
Total CGST
Example: 0
ttl_cessnumberoptional
Total cess
Example: 0
ttl_valnumberoptional
Total value
Example: 0
ttl_recnumberoptional
Total Rec amount
Example: 0
ttl_sgstnumberoptional
Total SGST
Example: 0
impsobjectoptional
chksumstringoptional
Check sum
Example: "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
ttl_igstnumberoptional
Total IGST
Example: 21
ttl_cgstnumberoptional
Total CGST
Example: 0
ttl_cessnumberoptional
Total cess
Example: 0
ttl_valnumberoptional
Total value
Example: 700
ttl_recnumberoptional
Total Rec amount
Example: 1
ttl_sgstnumberoptional
Total SGST
Example: 0
cmpsmryobjectoptional
out_supobjectoptional
tax_valnumberoptional
tax Amount as per invoice
Example: 0
iamtnumberoptional
IGST Amount as per invoice
Example: 0
camtnumberoptional
CGST Amount as per invoice
Example: 0
samtnumberoptional
SGST Amount as per invoice
Example: 0
csamtnumberoptional
Cess Amount as per invoice
Example: 0
in_supobjectoptional
tax_valnumberoptional
tax Amount as per invoice
Example: 0
iamtnumberoptional
IGST Amount as per invoice
Example: 0
camtnumberoptional
CGST Amount as per invoice
Example: 0
samtnumberoptional
SGST Amount as per invoice
Example: 0
csamtnumberoptional
Cess Amount as per invoice
Example: 0
intr_payobjectoptional
tax_valnumberoptional
tax Amount as per invoice
Example: 0
iamtnumberoptional
IGST Amount as per invoice
Example: 0
camtnumberoptional
CGST Amount as per invoice
Example: 0
samtnumberoptional
SGST Amount as per invoice
Example: 0
csamtnumberoptional
Cess Amount as per invoice
Example: 0
tax_payobjectoptional
tax_valnumberoptional
tax Amount as per invoice
Example: 0
iamtnumberoptional
IGST Amount as per invoice
Example: 0
camtnumberoptional
CGST Amount as per invoice
Example: 0
samtnumberoptional
SGST Amount as per invoice
Example: 0
csamtnumberoptional
Cess Amount as per invoice
Example: 0
inoutsupobjectoptional
outsupplyobjectoptional
tax_valnumberoptional
tax Amount as per invoice
Example: 0
iamtnumberoptional
IGST Amount as per invoice
Example: 0
camtnumberoptional
CGST Amount as per invoice
Example: 0
samtnumberoptional
SGST Amount as per invoice
Example: 0
csamtnumberoptional
Cess Amount as per invoice
Example: 0
insupplyobjectoptional
tax_valnumberoptional
tax Amount as per invoice
Example: 0
iamtnumberoptional
IGST Amount as per invoice
Example: 0
camtnumberoptional
CGST Amount as per invoice
Example: 0
samtnumberoptional
SGST Amount as per invoice
Example: 0
csamtnumberoptional
Cess Amount as per invoice
Example: 0
tdstcssmryobjectoptional
ttlrecnumberoptional
Total Rec amount
Example: 0
gross_valnumberoptional
Gross amount
Example: 0
camtnumberoptional
CGST Amount as per invoice
Example: 0
samtnumberoptional
SGST Amount as per invoice
Example: 0
paymenttaxobjectoptional
tx_pyarray<object>optional
Array items:
trancdnumberoptional
trans code
Example: 30003
trans_descstringoptional
trans description
Example: "Reverse charge"
igstnumberoptional
IGST Amount as per invoice
Example: 42
cgstnumberoptional
CGST Amount as per invoice
Example: 0
sgstnumberoptional
SGST Amount as per invoice
Example: 0
cessnumberoptional
Cess Amount as per invoice
Example: 20
cmp_pdarray<object>optional
Array items:
trancdnumberoptional
trans code
Example: 30003
trans_descstringoptional
trans description
Example: "Reverse charge"
igstnumberoptional
IGST Amount as per invoice
Example: 42
cgstnumberoptional
CGST Amount as per invoice
Example: 0
sgstnumberoptional
SGST Amount as per invoice
Example: 0
cessnumberoptional
Cess Amount as per invoice
Example: 20
bal_payarray<object>optional
Array items:
trancdnumberoptional
trans code
Example: 30003
trandatenumberoptional
trans date
Example: "13-06-2024"
ipdnumberoptional
Igst Tax paid through cash
Example: 3517817
cpdnumberoptional
Cgst Tax paid through cash
Example: 3517817
spdnumberoptional
Sgst Tax paid through cash
Example: 3517817
cspdnumberoptional
Cgst Tax paid through cash
Example: 3517817
s_lfeepdnumberoptional
Sgst Late fee paid through cash
Example: 13
c_lfeepdnumberoptional
Cgst Late Fee paid through cash
Example: 13
offsetobjectoptional
bal_paidarray<object>optional
Array items:
trancdnumberoptional
trans code
Example: 30003
trandatenumberoptional
trans date
Example: "13-06-2024"
ipdnumberoptional
Igst Tax paid through cash
Example: 3517817
cpdnumberoptional
Cgst Tax paid through cash
Example: 3517817
spdnumberoptional
Sgst Tax paid through cash
Example: 3517817
cspdnumberoptional
Cgst Tax paid through cash
Example: 3517817
i_intrpdnumberoptional
Igst Interest paid through cash
Example: 20
c_intrpdnumberoptional
Cgst Interest paid through cash
Example: 30
s_intrpdnumberoptional
Sgst Interest paid through cash
Example: 10
cs_intrpdnumberoptional
Cess Interest paid through cash
Example: 15
s_lfeepdnumberoptional
Sgst Late fee paid through cash
Example: 13
c_lfeepdnumberoptional
Cgst Late Fee paid through cash
Example: 13

Response

Not Found. If requested entity is not found or if requested API is not found.
POST/gstr4annual/retfile
1const response = await fetch('https://apisandbox.whitebooks.in/gstr4annual/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 "agg_turnover": 10000,
17 "fp": "022024",
18 "isnil": "N",
19 "chksum": "e019706b5c029430c81cc4f620c72adf0fc43ceb1805099abe0f1a41a79cfbc5",
20 "impsupsmry": {
21 "b2bor": {
22 "chksum": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
23 "ttl_igst": 0,
24 "ttl_cgst": 0,
25 "ttl_cess": 0,
26 "ttl_val": 0,
27 "ttl_rec": 0,
28 "ttl_sgst": 0
29 },
30 "b2br": {
31 "chksum": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
32 "ttl_igst": 0,
33 "ttl_cgst": 0,
34 "ttl_cess": 0,
35 "ttl_val": 0,
36 "ttl_rec": 0,
37 "ttl_sgst": 0
38 },
39 "b2bur": {
40 "chksum": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
41 "ttl_igst": 0,
42 "ttl_cgst": 0,
43 "ttl_cess": 0,
44 "ttl_val": 0,
45 "ttl_rec": 0,
46 "ttl_sgst": 0
47 },
48 "imps": {
49 "chksum": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
50 "ttl_igst": 21,
51 "ttl_cgst": 0,
52 "ttl_cess": 0,
53 "ttl_val": 700,
54 "ttl_rec": 1,
55 "ttl_sgst": 0
56 }
57 },
58 "cmpsmry": {
59 "out_sup": {
60 "tax_val": 0,
61 "iamt": 0,
62 "camt": 0,
63 "samt": 0,
64 "csamt": 0
65 },
66 "in_sup": {
67 "tax_val": 0,
68 "iamt": 0,
69 "camt": 0,
70 "samt": 0,
71 "csamt": 0
72 },
73 "intr_pay": {
74 "tax_val": 0,
75 "iamt": 0,
76 "camt": 0,
77 "samt": 0,
78 "csamt": 0
79 },
80 "tax_pay": {
81 "tax_val": 0,
82 "iamt": 0,
83 "camt": 0,
84 "samt": 0,
85 "csamt": 0
86 }
87 },
88 "inoutsup": {
89 "outsupply": {
90 "tax_val": 0,
91 "iamt": 0,
92 "camt": 0,
93 "samt": 0,
94 "csamt": 0
95 },
96 "insupply": {
97 "tax_val": 0,
98 "iamt": 0,
99 "camt": 0,
100 "samt": 0,
101 "csamt": 0
102 }
103 },
104 "tdstcssmry": {
105 "ttlrec": 0,
106 "gross_val": 0,
107 "camt": 0,
108 "samt": 0
109 },
110 "paymenttax": {
111 "tx_py": [
112 {
113 "trancd": 30003,
114 "trans_desc": "Reverse charge",
115 "igst": 42,
116 "cgst": 0,
117 "sgst": 0,
118 "cess": 20
119 }
120 ],
121 "cmp_pd": [
122 {
123 "trancd": 30003,
124 "trans_desc": "Reverse charge",
125 "igst": 42,
126 "cgst": 0,
127 "sgst": 0,
128 "cess": 20
129 }
130 ],
131 "bal_pay": [
132 {
133 "trancd": 30003,
134 "trandate": "13-06-2024",
135 "ipd": 3517817,
136 "cpd": 3517817,
137 "spd": 3517817,
138 "cspd": 3517817,
139 "s_lfeepd": 13,
140 "c_lfeepd": 13
141 }
142 ]
143 },
144 "offset": {
145 "bal_paid": [
146 {
147 "trancd": 30003,
148 "trandate": "13-06-2024",
149 "ipd": 3517817,
150 "cpd": 3517817,
151 "spd": 3517817,
152 "cspd": 3517817,
153 "i_intrpd": 20,
154 "c_intrpd": 30,
155 "s_intrpd": 10,
156 "cs_intrpd": 15,
157 "s_lfeepd": 13,
158 "c_lfeepd": 13
159 }
160 ]
161 }
162}),
163});
164
165const data = await response.json();
166console.log(data);
No example available.