Parent API: GST API Quickstart guide Authentication guide

Save GST Monthly or Quarterly Filing Preference

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

Requests are submitted via HTTP PUT to '/all/savepref'. Required parameters: 'email' (query parameter), 'gstin' (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 Preference return?

For Save Preference (PUT '/all/savepref'), 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/all/savepref

Used to Save Preference

Parameters

query parameters

emailstringrequired

API Developer User Email

header parameters

gstinstringrequired

GST Number

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

GSTIN

Example: "02SUPHP0001A1ZI"

fystringoptional

Example: "2019-20"

quarterstringoptional

quarter value

Example: "Q1"

preferencestringoptional

Preference value

Example: "Q"

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 /all/savepref. Required parameters: email (query parameter), gstin (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 Preference (PUT /all/savepref), 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 Preference

Get Return Status

Get Preference

PUT/all/savepref

1const response = await fetch('https://apisandbox.whitebooks.in/all/savepref?email=value', {

2 method: 'PUT',

3 headers: {

4 gstin: "value",

5 gst_username: "value",

6 state_cd: "value",

7 ip_address: "value",

8 txn: "value",

9 client_id: "value",

10 client_secret: "value",

11 Content-Type: "application/json"

12},

13 body: JSON.stringify({

14 "gstin": "02SUPHP0001A1ZI",

15 "fy": "2019-20",

16 "quarter": "Q1",

17 "preference": "Q"

18}),

19});

21const data = await response.json();

22console.log(data);

No example available.