Parent API: GST API Quickstart guide Authentication guide

Save GST Portal User Masters

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

Requests are submitted via HTTP POST to '/all/savemasters'. 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 User Masters return?

For Save User Masters (POST '/all/savemasters'), 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).

POSThttps://apisandbox.whitebooks.in/all/savemasters

This API is used to Save or Update or Delete the User Masters

Parameters

query parameters

emailstringrequired

header parameters

gstinstringrequired

GSTIN of the taxpayer

ret_periodstringrequired

Return Period

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

userGstinstringoptional

User GSTIN

Example: "16SSATR0031A1ZV"

productsMastersarray<object>optional

Array items:

productNamestringoptional

Product Name given by user

Example: "Test01"

hsnstringoptional

HSN code

Example: "0604"

igstnumberoptional

Integrated Tax (₹)

Example: 5

uqcstringoptional

Unit of the product

Example: "BAG"

actionFlagstringoptional

Flag to denote Action : I for Addition , D for Deletion & U for Update

Example: "I"

supplierRecipientMastersarray<object>optional

Array items:

gstinstringoptional

Supplier/Recipient GSTIN

Example: "27AAGCB1286Q7ZY"

supplierRecipientNamestringoptional

Vendor Name given by the user

Example: "Charles"

supplierRecipientFlagstringoptional

Flag to denote how the added gstin is related to the user : S for Supplier , R for Recipient , SR for Supplier & Recipient

Example: "S"

actionFlagstringoptional

Flag to denote Action : I for Addition , D for Deletion & U for Update

Example: "I"

Response

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

Frequently Asked Questions

Requests are submitted via HTTP POST to /all/savemasters. 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 User Masters (POST /all/savemasters), 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).

This API is used to Save or Update or Delete the User Masters

File SPIKE data

Get User Masters

POST/all/savemasters

1const response = await fetch('https://apisandbox.whitebooks.in/all/savemasters?email=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 "userGstin": "16SSATR0031A1ZV",

16 "productsMasters": [

17 {

18 "productName": "Test01",

19 "hsn": "0604",

20 "igst": 5,

21 "uqc": "BAG",

22 "actionFlag": "I"

23 }

24 ],

25 "supplierRecipientMasters": [

26 {

27 "gstin": "27AAGCB1286Q7ZY",

28 "supplierRecipientName": "Charles",

29 "supplierRecipientFlag": "S",

30 "actionFlag": "I"

31 }

32 ]

33}),

34});

36const data = await response.json();

37console.log(data);

No example available.