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
GSTR9C
SPIKE
ALL
IMS
ITC03
ITC04
CMP
Get CMPGET
Save CMPPOST
File CMP dataPOST
File CMP dataPOST
Get validate turnover for CMPGET
Payment
Ledger
e-Invoice
Notices
GST APICMPFile CMP data

File CMP data

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

Used to file entire CMP 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
GST Number
Example: "01AAAAB1726H1ZI"
ret_periodstringoptional
Return Period
Example: "032018"
isnilstringoptional
Is Nil Return
Example: "N"
table3objectoptional
out_supobjectoptional
tax_valnumberoptional
Value of goods
Example: 40
camtnumberoptional
CGST payable
Example: 20
samtnumberoptional
SGST payable
Example: 20
in_supobjectoptional
tax_valnumberoptional
Value of goods
Example: 40
iamtnumberoptional
IGST payable
Example: 10
camtnumberoptional
CGST payable
Example: 20
samtnumberoptional
SGST payable
Example: 20
csamtnumberoptional
CESS payable
Example: 10
intr_payobjectoptional
iamtnumberoptional
IGST payable
Example: 10
camtnumberoptional
CGST payable
Example: 20
samtnumberoptional
SGST payable
Example: 20
csamtnumberoptional
CESS payable
Example: 10
tax_payobjectoptional
tax_valnumberoptional
Value of goods
Example: 1000
iamtnumberoptional
IGST payable
Example: 20
camtnumberoptional
CGST payable
Example: 10
samtnumberoptional
SGST payable
Example: 10
csamtnumberoptional
CESS payable
Example: 5
table4objectoptional
rchrgobjectoptional
iamtnumberoptional
IGST payable
Example: 10
camtnumberoptional
CGST payable
Example: 10
samtnumberoptional
SGST payable
Example: 10
csamtnumberoptional
CESS payable
Example: 10
otr_rchrgobjectoptional
iamtnumberoptional
IGST payable
Example: 10
camtnumberoptional
CGST payable
Example: 10
samtnumberoptional
SGST payable
Example: 10
csamtnumberoptional
CESS payable
Example: 10
neg_liabobjectoptional
rchrgobjectoptional
otr_rchrgobjectoptional
intr_payobjectoptional
iamtnumberoptional
IGST payable
Example: 10
camtnumberoptional
CGST payable
Example: 10
samtnumberoptional
SGST payable
Example: 10
csamtnumberoptional
CESS payable
Example: 10
tax_payarray<object>optional
Array items:
igstobjectoptional
intrnumberoptional
Interest Amount
Example: 0.4
othnumberoptional
other Amount
Example: 0
txnumberoptional
Tax Amount
Example: 60
feenumberoptional
Fee Amount
Example: 0
totnumberoptional
Total Amount
Example: 60
pennumberoptional
Penalty Amount
Example: 0
cgstobjectoptional
intrnumberoptional
Interest Amount
Example: 0.4
othnumberoptional
other Amount
Example: 0
txnumberoptional
Tax Amount
Example: 60
feenumberoptional
Fee Amount
Example: 0
totnumberoptional
Total Amount
Example: 60
pennumberoptional
Penalty Amount
Example: 0
sgstobjectoptional
intrnumberoptional
Interest Amount
Example: 0.4
othnumberoptional
other Amount
Example: 0
txnumberoptional
Tax Amount
Example: 60
feenumberoptional
Fee Amount
Example: 0
totnumberoptional
Total Amount
Example: 60
pennumberoptional
Penalty Amount
Example: 0
cessobjectoptional
intrnumberoptional
Interest Amount
Example: 0.4
othnumberoptional
other Amount
Example: 0
txnumberoptional
Tax Amount
Example: 60
feenumberoptional
Fee Amount
Example: 0
totnumberoptional
Total Amount
Example: 60
pennumberoptional
Penalty Amount
Example: 0
trancdintegeroptional
tran code
Example: 30003
offsetarray<object>optional
Array items:
tran_cdintegeroptional
tran code
Example: 30003
sgstobjectoptional
intrnumberoptional
Interest Amount
Example: 0.4
txnumberoptional
Tax Amount
Example: 60
feenumberoptional
Fee Amount
Example: 0
totnumberoptional
Total Amount
Example: 60
cgstobjectoptional
intrnumberoptional
Interest Amount
Example: 0.4
txnumberoptional
Tax Amount
Example: 60
feenumberoptional
Fee Amount
Example: 0
totnumberoptional
Total Amount
Example: 60
igstobjectoptional
intrnumberoptional
Interest Amount
Example: 0.4
txnumberoptional
Tax Amount
Example: 60
feenumberoptional
Fee Amount
Example: 0
totnumberoptional
Total Amount
Example: 60
cessobjectoptional
intrnumberoptional
Interest Amount
Example: 0.4
txnumberoptional
Tax Amount
Example: 60
feenumberoptional
Fee Amount
Example: 0
totnumberoptional
Total Amount
Example: 60

Response

Not Found. If requested entity is not found or if requested API is not found.
POST/cmp/retfile
1const response = await fetch('https://apisandbox.whitebooks.in/cmp/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": "01AAAAB1726H1ZI",
16 "ret_period": "032018",
17 "isnil": "N",
18 "table3": {
19 "out_sup": {
20 "tax_val": 40,
21 "camt": 20,
22 "samt": 20
23 },
24 "in_sup": {
25 "tax_val": 40,
26 "iamt": 10,
27 "camt": 20,
28 "samt": 20,
29 "csamt": 10
30 },
31 "intr_pay": {
32 "iamt": 10,
33 "camt": 20,
34 "samt": 20,
35 "csamt": 10
36 },
37 "tax_pay": {
38 "tax_val": 1000,
39 "iamt": 20,
40 "camt": 10,
41 "samt": 10,
42 "csamt": 5
43 }
44 },
45 "table4": {
46 "rchrg": {
47 "iamt": 10,
48 "camt": 10,
49 "samt": 10,
50 "csamt": 10
51 },
52 "otr_rchrg": {
53 "iamt": 10,
54 "camt": 10,
55 "samt": 10,
56 "csamt": 10
57 },
58 "neg_liab": {
59 "rchrg": {
60 "iamt": 10,
61 "camt": 10,
62 "samt": 10,
63 "csamt": 10
64 },
65 "otr_rchrg": {
66 "iamt": 10,
67 "camt": 10,
68 "samt": 10,
69 "csamt": 10
70 }
71 },
72 "intr_pay": {
73 "iamt": 10,
74 "camt": 10,
75 "samt": 10,
76 "csamt": 10
77 }
78 },
79 "tax_pay": [
80 {
81 "igst": {
82 "intr": 0.4,
83 "oth": 0,
84 "tx": 60,
85 "fee": 0,
86 "tot": 60,
87 "pen": 0
88 },
89 "cgst": {
90 "intr": 0.4,
91 "oth": 0,
92 "tx": 60,
93 "fee": 0,
94 "tot": 60,
95 "pen": 0
96 },
97 "sgst": {
98 "intr": 0.4,
99 "oth": 0,
100 "tx": 60,
101 "fee": 0,
102 "tot": 60,
103 "pen": 0
104 },
105 "cess": {
106 "intr": 0.4,
107 "oth": 0,
108 "tx": 60,
109 "fee": 0,
110 "tot": 60,
111 "pen": 0
112 },
113 "trancd": 30003
114 }
115 ],
116 "offset": [
117 {
118 "tran_cd": 30003,
119 "sgst": {
120 "intr": 0.4,
121 "tx": 60,
122 "fee": 0,
123 "tot": 60
124 },
125 "cgst": {
126 "intr": 0.4,
127 "tx": 60,
128 "fee": 0,
129 "tot": 60
130 },
131 "igst": {
132 "intr": 0.4,
133 "tx": 60,
134 "fee": 0,
135 "tot": 60
136 },
137 "cess": {
138 "intr": 0.4,
139 "tx": 60,
140 "fee": 0,
141 "tot": 60
142 }
143 }
144 ]
145}),
146});
147
148const data = await response.json();
149console.log(data);
No example available.