Parent API: GST API Quickstart guide Authentication guide

Save GST IMS Actions (Accept, Reject, Pending)

Q: What parameters and payload format are required for Save IMS Data?

Requests are submitted via HTTP PUT to '/ims/save'. Required parameters: 'email' (query parameter), 'gstin' (header parameter), 'ret_period' (header parameter), 'gst_username' (header parameter), 'state_cd' (header parameter), 'ip_address' (header parameter), 'txn' (header parameter), 'client_id' (header parameter), 'client_secret' (header parameter). A JSON request body ('Content-Type: application/json') is accepted per the schema specifications shown in the request documentation.

Q: What response status codes and format does Save IMS Data return?

For Save IMS Data (PUT '/ims/save'), responses are returned in JSON format ('application/json'). Documented response codes in the specification include: HTTP 404 (Not Found. If requested entity is not found or if requested API is not found.), HTTP 500 (Internal server error).

PUThttps://apisandbox.whitebooks.in/ims/save

Used to Save IMS Data.

IMS Automation

Explore Feature

Invoice Management System (IMS) Action Hub

Accept, reject, or keep supplier invoices pending in bulk with our intuitive IMS dashboard connected live to GSTN.

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

rtinstringoptional

Receipient GSTIN

Example: "20MAYAS0100J1ZX"

reqtypstringoptional

Reset Flag

Example: "SAVE"

invdataobjectoptional

b2barray<object>optional

Array items:

stinstringoptional

GSTIN of supplier

Example: "24MAYAS0100J1JD"

rtnprdstringoptional

Return period of invoice

Example: "012023"

srcformstringoptional

Invoice source form

Example: "R1"

inumstringoptional

Invoice Number

Example: "b1"

idtstringoptional

Invoice Date

Example: "23-01-2023"

inv_typstringoptional

Invoice Type

Example: "R"

posstringoptional

Place of Supply

Example: "24"

valnumberoptional

Invoice Value

Example: 1000

txvalnumberoptional

Taxable value

Example: 100

iamtnumberoptional

iamt

Example: 20

camtnumberoptional

camt

Example: 20

samtnumberoptional

samt

Example: 20

cessnumberoptional

cess

Example: 0

actionstringoptional

Recipient action on invoice

Example: "A"

prev_statusstringoptional

Recipient action on invoice

Example: "A"

b2baarray<object>optional

Array items:

stinstringoptional

GSTIN of supplier

Example: "24MAYAS0100J1JD"

rtnprdstringoptional

Return period of invoice

Example: "012023"

srcformstringoptional

Invoice source form

Example: "R1"

inumstringoptional

Invoice Number

Example: "dn3"

oinumstringoptional

original invoice number

Example: "dn2"

idtstringoptional

Invoice Date

Example: "24-02-2023"

oidtstringoptional

original invoice date

Example: "24-02-2023"

inv_typstringoptional

Invoice Type

Example: "R"

posstringoptional

Place of Supply

Example: "07"

valnumberoptional

Invoice Value

Example: 1000.1

txvalnumberoptional

Taxable value

Example: 1000.1

iamtnumberoptional

iamt

Example: 20

camtnumberoptional

camt

Example: 20

samtnumberoptional

samt

Example: 20

cessnumberoptional

cess

Example: 0

actionstringoptional

Recipient action on invoice

Example: "A"

prev_statusstringoptional

Recipient action on invoice

Example: "A"

b2bdnarray<object>optional

Array items:

stinstringoptional

GSTIN of supplier

Example: "24MAYAS0100J1JD"

rtnprdstringoptional

Return period of invoice

Example: "012023"

srcformstringoptional

Invoice source form

Example: "R1"

nt_numstringoptional

Note Number

Example: "dn2"

nt_dtstringoptional

Note Date

Example: "24-02-2023"

inv_typstringoptional

Note Type

Example: "R"

posstringoptional

Place of Supply

Example: "07"

valnumberoptional

Invoice Value

Example: 1000.1

txvalnumberoptional

Taxable value

Example: 1000.1

iamtnumberoptional

iamt

Example: 20

camtnumberoptional

camt

Example: 20

samtnumberoptional

samt

Example: 20

cessnumberoptional

cess

Example: 0

actionstringoptional

Recipient action on invoice

Example: "A"

prev_statusstringoptional

Recipient action on invoice

Example: "A"

b2bdnaarray<object>optional

Array items:

stinstringoptional

GSTIN of supplier

Example: "24MAYAS0100J1JD"

rtnprdstringoptional

Return period of invoice

Example: "012023"

srcformstringoptional

Invoice source form

Example: "R1"

nt_numstringoptional

Note Number

Example: "dn2"

ont_numstringoptional

old note number

Example: "ca2"

nt_dtstringoptional

Note Date

Example: "24-02-2023"

ont_dtstringoptional

old note date

Example: "24-02-2023"

inv_typstringoptional

Note Type

Example: "R"

posstringoptional

Place of Supply

Example: "07"

valnumberoptional

Invoice Value

Example: 1000.1

txvalnumberoptional

Taxable value

Example: 1000.1

iamtnumberoptional

iamt

Example: 20

camtnumberoptional

camt

Example: 20

samtnumberoptional

samt

Example: 20

cessnumberoptional

cess

Example: 0

actionstringoptional

Recipient action on invoice

Example: "A"

prev_statusstringoptional

Recipient action on invoice

Example: "A"

b2bcnarray<object>optional

Array items:

stinstringoptional

GSTIN of supplier

Example: "24MAYAS0100J1JD"

rtnprdstringoptional

Return period of invoice

Example: "012023"

srcformstringoptional

Invoice source form

Example: "R1"

nt_numstringoptional

Note Number

Example: "dn2"

nt_dtstringoptional

Note Date

Example: "24-02-2023"

inv_typstringoptional

Note Type

Example: "R"

posstringoptional

Place of Supply

Example: "07"

valnumberoptional

Invoice Value

Example: 1000.1

txvalnumberoptional

Taxable value

Example: 1000.1

iamtnumberoptional

iamt

Example: 20

camtnumberoptional

camt

Example: 20

samtnumberoptional

samt

Example: 20

cessnumberoptional

cess

Example: 0

actionstringoptional

Recipient action on invoice

Example: "A"

prev_statusstringoptional

Recipient action on invoice

Example: "A"

b2bcnaarray<object>optional

Array items:

stinstringoptional

GSTIN of supplier

Example: "24MAYAS0100J1JD"

rtnprdstringoptional

Return period of invoice

Example: "012023"

srcformstringoptional

Invoice source form

Example: "R1"

nt_numstringoptional

Note Number

Example: "dn2"

ont_numstringoptional

old note number

Example: "ca2"

nt_dtstringoptional

Note Date

Example: "24-02-2023"

ont_dtstringoptional

old note date

Example: "24-02-2023"

inv_typstringoptional

Note Type

Example: "R"

posstringoptional

Place of Supply

Example: "07"

valnumberoptional

Invoice Value

Example: 1000.1

txvalnumberoptional

Taxable value

Example: 1000.1

iamtnumberoptional

iamt

Example: 20

camtnumberoptional

camt

Example: 20

samtnumberoptional

samt

Example: 20

cessnumberoptional

cess

Example: 0

actionstringoptional

Recipient action on invoice

Example: "A"

prev_statusstringoptional

Recipient action on invoice

Example: "A"

ecomarray<object>optional

Array items:

stinstringoptional

GSTIN of supplier

Example: "24MAYAS0100J1JD"

rtnprdstringoptional

Return period of invoice

Example: "012023"

srcformstringoptional

Invoice source form

Example: "R1"

inumstringoptional

Document Number

Example: "sd3"

idtstringoptional

Document Date

Example: "24-02-2023"

posstringoptional

Place of Supply

Example: "07"

valnumberoptional

Invoice Value

Example: 1000.1

txvalnumberoptional

Taxable value

Example: 1000.1

iamtnumberoptional

iamt

Example: 20

camtnumberoptional

camt

Example: 20

samtnumberoptional

samt

Example: 20

cessnumberoptional

cess

Example: 0

actionstringoptional

Recipient action on invoice

Example: "A"

prev_statusstringoptional

Recipient action on invoice

Example: "A"

ecomaarray<object>optional

Array items:

stinstringoptional

GSTIN of supplier

Example: "24MAYAS0100J1JD"

rtnprdstringoptional

Return period of invoice

Example: "012023"

srcformstringoptional

Invoice source form

Example: "R1"

inumstringoptional

Document Number

Example: "sd3"

oinumstringoptional

old document number

Example: "get5"

idtstringoptional

Document Date

Example: "24-02-2023"

oidtstringoptional

old document date

Example: "24-02-2023"

posstringoptional

Place of Supply

Example: "07"

valnumberoptional

Invoice Value

Example: 1000.1

txvalnumberoptional

Taxable value

Example: 1000.1

iamtnumberoptional

iamt

Example: 20

camtnumberoptional

camt

Example: 20

samtnumberoptional

samt

Example: 20

cessnumberoptional

cess

Example: 0

actionstringoptional

Recipient action on invoice

Example: "A"

prev_statusstringoptional

Recipient action on invoice

Example: "A"

Response

Not Found. If requested entity is not found or if requested API is not found.

Frequently Asked Questions

Requests are submitted via HTTP PUT to /ims/save. Required parameters: email (query parameter), gstin (header parameter), ret_period (header parameter), gst_username (header parameter), state_cd (header parameter), ip_address (header parameter), txn (header parameter), client_id (header parameter), client_secret (header parameter). A JSON request body (Content-Type: application/json) is accepted per the schema specifications shown in the request documentation.

For Save IMS Data (PUT /ims/save), responses are returned in JSON format (application/json). Documented response codes in the specification include: HTTP 404 (Not Found. If requested entity is not found or if requested API is not found.), HTTP 500 (Internal server error).

Used to Save IMS Data.

Get Preference

Reset IMS Data

PUT/ims/save

1const response = await fetch('https://apisandbox.whitebooks.in/ims/save?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 "rtin": "20MAYAS0100J1ZX",

16 "reqtyp": "SAVE",

17 "invdata": {

18 "b2b": [

19 {

20 "stin": "24MAYAS0100J1JD",

21 "rtnprd": "012023",

22 "srcform": "R1",

23 "inum": "b1",

24 "idt": "23-01-2023",

25 "inv_typ": "R",

26 "pos": "24",

27 "val": 1000,

28 "txval": 100,

29 "iamt": 20,

30 "camt": 20,

31 "samt": 20,

32 "cess": 0,

33 "action": "A",

34 "prev_status": "A"

35 }

36 ],

37 "b2ba": [

38 {

39 "stin": "24MAYAS0100J1JD",

40 "rtnprd": "012023",

41 "srcform": "R1",

42 "inum": "dn3",

43 "oinum": "dn2",

44 "idt": "24-02-2023",

45 "oidt": "24-02-2023",

46 "inv_typ": "R",

47 "pos": "07",

48 "val": 1000.1,

49 "txval": 1000.1,

50 "iamt": 20,

51 "camt": 20,

52 "samt": 20,

53 "cess": 0,

54 "action": "A",

55 "prev_status": "A"

56 }

57 ],

58 "b2bdn": [

59 {

60 "stin": "24MAYAS0100J1JD",

61 "rtnprd": "012023",

62 "srcform": "R1",

63 "nt_num": "dn2",

64 "nt_dt": "24-02-2023",

65 "inv_typ": "R",

66 "pos": "07",

67 "val": 1000.1,

68 "txval": 1000.1,

69 "iamt": 20,

70 "camt": 20,

71 "samt": 20,

72 "cess": 0,

73 "action": "A",

74 "prev_status": "A"

75 }

76 ],

77 "b2bdna": [

78 {

79 "stin": "24MAYAS0100J1JD",

80 "rtnprd": "012023",

81 "srcform": "R1",

82 "nt_num": "dn2",

83 "ont_num": "ca2",

84 "nt_dt": "24-02-2023",

85 "ont_dt": "24-02-2023",

86 "inv_typ": "R",

87 "pos": "07",

88 "val": 1000.1,

89 "txval": 1000.1,

90 "iamt": 20,

91 "camt": 20,

92 "samt": 20,

93 "cess": 0,

94 "action": "A",

95 "prev_status": "A"

96 }

97 ],

98 "b2bcn": [

99 {

100 "stin": "24MAYAS0100J1JD",

101 "rtnprd": "012023",

102 "srcform": "R1",

103 "nt_num": "dn2",

104 "nt_dt": "24-02-2023",

105 "inv_typ": "R",

106 "pos": "07",

107 "val": 1000.1,

108 "txval": 1000.1,

109 "iamt": 20,

110 "camt": 20,

111 "samt": 20,

112 "cess": 0,

113 "action": "A",

114 "prev_status": "A"

115 }

116 ],

117 "b2bcna": [

118 {

119 "stin": "24MAYAS0100J1JD",

120 "rtnprd": "012023",

121 "srcform": "R1",

122 "nt_num": "dn2",

123 "ont_num": "ca2",

124 "nt_dt": "24-02-2023",

125 "ont_dt": "24-02-2023",

126 "inv_typ": "R",

127 "pos": "07",

128 "val": 1000.1,

129 "txval": 1000.1,

130 "iamt": 20,

131 "camt": 20,

132 "samt": 20,

133 "cess": 0,

134 "action": "A",

135 "prev_status": "A"

136 }

137 ],

138 "ecom": [

139 {

140 "stin": "24MAYAS0100J1JD",

141 "rtnprd": "012023",

142 "srcform": "R1",

143 "inum": "sd3",

144 "idt": "24-02-2023",

145 "pos": "07",

146 "val": 1000.1,

147 "txval": 1000.1,

148 "iamt": 20,

149 "camt": 20,

150 "samt": 20,

151 "cess": 0,

152 "action": "A",

153 "prev_status": "A"

154 }

155 ],

156 "ecoma": [

157 {

158 "stin": "24MAYAS0100J1JD",

159 "rtnprd": "012023",

160 "srcform": "R1",

161 "inum": "sd3",

162 "oinum": "get5",

163 "idt": "24-02-2023",

164 "oidt": "24-02-2023",

165 "pos": "07",

166 "val": 1000.1,

167 "txval": 1000.1,

168 "iamt": 20,

169 "camt": 20,

170 "samt": 20,

171 "cess": 0,

172 "action": "A",

173 "prev_status": "A"

174 }

175 ]

176 }

177}),

178});

179

180const data = await response.json();

181console.log(data);

No example available.