Parent API: GST API Quickstart guide Authentication guide

Save GST DRC-01 Data (SPIKE)

Q: What parameters and payload format are required for Save SPIKE data?

Requests are submitted via HTTP PUT to '/spike/spikesave'. 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 SPIKE data return?

For Save SPIKE data (PUT '/spike/spikesave'), 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/spike/spikesave

Used to save entire SPIKE Data.

Parameters

query parameters

emailstringrequired

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

frmtypstringoptional

Form Type

Example: "DRC01B"

refidstringoptional

Reference Id for DRC01B

Example: "AA070922000131X"

rtnprdstringoptional

Return Period

Example: "092022"

gstinstringoptional

GSTIN

Example: "07CMNPV1083B1ZX"

drc03arnarray<string>optional

items: stringItems

reasonsarray<object>optional

Reasons

Array items:

rsnstringoptional

Reason

Example: "lbtohkhl"

rsncdstringoptional

Reason Code

deldrc03arnarray<string>optional

items: stringItems

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 /spike/spikesave. 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 SPIKE data (PUT /spike/spikesave), 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 entire SPIKE Data.

Generate Certificate

Get DRC01C/DRC01B Data

PUT/spike/spikesave

1const response = await fetch('https://apisandbox.whitebooks.in/spike/spikesave?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 "frmtyp": "DRC01B",

16 "refid": "AA070922000131X",

17 "rtnprd": "092022",

18 "gstin": "07CMNPV1083B1ZX",

19 "drc03arn": [

20 "AD070423000014X"

21 ],

22 "reasons": [

23 {

24 "rsn": "lbtohkhl",

25 "rsncd": "string"

26 }

27 ],

28 "deldrc03arn": [

29 "AD070423000014X"

30 ]

31}),

32});

34const data = await response.json();

35console.log(data);

No example available.