Parent API: GST API Quickstart guide Authentication guide

Save GSTR-2X TDS/TCS Return as a Draft

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

Requests are submitted via HTTP PUT to '/gstr2x/retsave'. 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 GSTR2X data return?

For Save GSTR2X data (PUT '/gstr2x/retsave'), 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/gstr2x/retsave

Used to save entire GSTR2X invoices.

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

gstinstringoptional

Supplier GSTIN

Example: "27AHQPA7588L1ZJ"

fpstringoptional

Financial Period

Example: "022024"

tdsarray<object>optional

Array items:

flagstringoptional

Flag for identifying New/Modified

Example: "R"

ctinstringoptional

GSTIN of Deductor

Example: "08AUGGC1893FDD5"

monthstringoptional

TDS Period

Example: "08AUGGC1893FDD5`"

chksumstringoptional

Checksum Value

Example: "e019706b5c029430c81cc4f620c72adf0fc43ceb1805099abe0f1a41a79cfbc5"

tdsaarray<object>optional

Array items:

flagstringoptional

Flag for identifying New/Modified

Example: "A"

ctinstringoptional

GSTIN of Deductor

Example: "08AUGGC1893FDD5"

omonthstringoptional

Original TDS Period

Example: "08AUGGC1893FDD5`"

chksumstringoptional

Checksum Value

Example: "e019706b5c029430c81cc4f620c72adf0fc43ceb1805099abe0f1a41a79cfbc5"

tcsarray<object>optional

Array items:

flagstringoptional

Flag for identifying New/Modified

Example: "R"

ctinstringoptional

GSTIN of Deductor

Example: "08AUGGC1893FDD5"

monthstringoptional

TDS Period

Example: "08AUGGC1893FDD5`"

chksumstringoptional

Checksum Value

Example: "e019706b5c029430c81cc4f620c72adf0fc43ceb1805099abe0f1a41a79cfbc5"

tcsaarray<object>optional

Array items:

flagstringoptional

Flag for identifying New/Modified

Example: "A"

ctinstringoptional

GSTIN of Deductor

Example: "08AUGGC1893FDD5"

omonthstringoptional

Original TDS Period

Example: "08AUGGC1893FDD5`"

chksumstringoptional

Checksum Value

Example: "e019706b5c029430c81cc4f620c72adf0fc43ceb1805099abe0f1a41a79cfbc5"

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 /gstr2x/retsave. 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 GSTR2X data (PUT /gstr2x/retsave), 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 GSTR2X invoices.

Get 2B generate status

File GSTR2X data

PUT/gstr2x/retsave

1const response = await fetch('https://apisandbox.whitebooks.in/gstr2x/retsave?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 "gstin": "27AHQPA7588L1ZJ",

16 "fp": "022024",

17 "tds": [

18 {

19 "flag": "R",

20 "ctin": "08AUGGC1893FDD5",

21 "month": "08AUGGC1893FDD5`",

22 "chksum": "e019706b5c029430c81cc4f620c72adf0fc43ceb1805099abe0f1a41a79cfbc5"

23 }

24 ],

25 "tdsa": [

26 {

27 "flag": "A",

28 "ctin": "08AUGGC1893FDD5",

29 "omonth": "08AUGGC1893FDD5`",

30 "chksum": "e019706b5c029430c81cc4f620c72adf0fc43ceb1805099abe0f1a41a79cfbc5"

31 }

32 ],

33 "tcs": [

34 {

35 "flag": "R",

36 "ctin": "08AUGGC1893FDD5",

37 "month": "08AUGGC1893FDD5`",

38 "chksum": "e019706b5c029430c81cc4f620c72adf0fc43ceb1805099abe0f1a41a79cfbc5"

39 }

40 ],

41 "tcsa": [

42 {

43 "flag": "A",

44 "ctin": "08AUGGC1893FDD5",

45 "omonth": "08AUGGC1893FDD5`",

46 "chksum": "e019706b5c029430c81cc4f620c72adf0fc43ceb1805099abe0f1a41a79cfbc5"

47 }

48 ]

49}),

50});

52const data = await response.json();

53console.log(data);

No example available.