GST APIIMSReset IMS Data

Reset IMS Data

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

Used to Reset IMS Data.

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: "RESET"

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

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

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

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

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

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

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

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

prev_statusstringoptional

Recipient action on invoice

Example: "A"

Response

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

PUT/ims/reset

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

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 "prev_status": "A"

34 }

35 ],

36 "b2ba": [

37 {

38 "stin": "24MAYAS0100J1JD",

39 "rtnprd": "012023",

40 "srcform": "R1",

41 "inum": "dn3",

42 "oinum": "dn2",

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

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

45 "inv_typ": "R",

46 "pos": "07",

47 "val": 1000.1,

48 "txval": 1000.1,

49 "iamt": 20,

50 "camt": 20,

51 "samt": 20,

52 "cess": 0,

53 "prev_status": "A"

54 }

55 ],

56 "b2bdn": [

57 {

58 "stin": "24MAYAS0100J1JD",

59 "rtnprd": "012023",

60 "srcform": "R1",

61 "nt_num": "dn2",

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

63 "inv_typ": "R",

64 "pos": "07",

65 "val": 1000.1,

66 "txval": 1000.1,

67 "iamt": 20,

68 "camt": 20,

69 "samt": 20,

70 "cess": 0,

71 "prev_status": "A"

72 }

73 ],

74 "b2bdna": [

75 {

76 "stin": "24MAYAS0100J1JD",

77 "rtnprd": "012023",

78 "srcform": "R1",

79 "nt_num": "dn2",

80 "ont_num": "ca2",

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

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

83 "inv_typ": "R",

84 "pos": "07",

85 "val": 1000.1,

86 "txval": 1000.1,

87 "iamt": 20,

88 "camt": 20,

89 "samt": 20,

90 "cess": 0,

91 "prev_status": "A"

92 }

93 ],

94 "b2bcn": [

95 {

96 "stin": "24MAYAS0100J1JD",

97 "rtnprd": "012023",

98 "srcform": "R1",

99 "nt_num": "dn2",

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

101 "inv_typ": "R",

102 "pos": "07",

103 "val": 1000.1,

104 "txval": 1000.1,

105 "iamt": 20,

106 "camt": 20,

107 "samt": 20,

108 "cess": 0,

109 "prev_status": "A"

110 }

111 ],

112 "b2bcna": [

113 {

114 "stin": "24MAYAS0100J1JD",

115 "rtnprd": "012023",

116 "srcform": "R1",

117 "nt_num": "dn2",

118 "ont_num": "ca2",

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

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

121 "inv_typ": "R",

122 "pos": "07",

123 "val": 1000.1,

124 "txval": 1000.1,

125 "iamt": 20,

126 "camt": 20,

127 "samt": 20,

128 "cess": 0,

129 "prev_status": "A"

130 }

131 ],

132 "ecom": [

133 {

134 "stin": "24MAYAS0100J1JD",

135 "rtnprd": "012023",

136 "srcform": "R1",

137 "inum": "sd3",

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

139 "pos": "07",

140 "val": 1000.1,

141 "txval": 1000.1,

142 "iamt": 20,

143 "camt": 20,

144 "samt": 20,

145 "cess": 0,

146 "prev_status": "A"

147 }

148 ],

149 "ecoma": [

150 {

151 "stin": "24MAYAS0100J1JD",

152 "rtnprd": "012023",

153 "srcform": "R1",

154 "inum": "sd3",

155 "oinum": "get5",

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

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

158 "pos": "07",

159 "val": 1000.1,

160 "txval": 1000.1,

161 "iamt": 20,

162 "camt": 20,

163 "samt": 20,

164 "cess": 0,

165 "prev_status": "A"

166 }

167 ]

168 }

169}),

170});

171

172const data = await response.json();

173console.log(data);

No example available.