Parent API: GST API Quickstart guide Authentication guide

GSTR-5 Non-Resident Return Summary

Q: What parameters and payload format are required for Get GSTR5 Summary?

Requests are submitted via HTTP GET to '/gstr5/retsum'. Required parameters: 'gstin' (query parameter), 'retperiod' (query parameter), 'email' (query parameter), 'gst_username' (header parameter), 'state_cd' (header parameter), 'ip_address' (header parameter), 'txn' (header parameter), 'client_id' (header parameter), 'client_secret' (header parameter). No request body payload is required for this call.

Q: What response status codes and format does Get GSTR5 Summary return?

For Get GSTR5 Summary (GET '/gstr5/retsum'), 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).

GEThttps://apisandbox.whitebooks.in/gstr5/retsum

Get the table wise summary of GSTR5 data.

Parameters

query parameters

gstinstringrequired

GSTIN of the taxpayer

retperiodstringrequired

Return Period format MMYYYY

emailstringrequired

header parameters

gst_usernamestringrequired

GST UserName

state_cdstringrequired

State Code

ip_addressstringrequired

IP Address

txnstringrequired

Transaction

client_idstringrequired

Client ID

client_secretstringrequired

Client Secret

Response

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

Frequently Asked Questions

Requests are submitted via HTTP GET to /gstr5/retsum. Required parameters: gstin (query parameter), retperiod (query parameter), email (query parameter), gst_username (header parameter), state_cd (header parameter), ip_address (header parameter), txn (header parameter), client_id (header parameter), client_secret (header parameter). No request body payload is required for this call.

For Get GSTR5 Summary (GET /gstr5/retsum), 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).

Get the table wise summary of GSTR5 data.

Get CDNA Unregistered

Submit

GET/gstr5/retsum

1const response = await fetch('https://apisandbox.whitebooks.in/gstr5/retsum?gstin=value&retperiod=value&email=value', {

2 method: 'GET',

3 headers: {

4 gst_username: "value",

5 state_cd: "value",

6 ip_address: "value",

7 txn: "value",

8 client_id: "value",

9 client_secret: "value"

10},

11});

13const data = await response.json();

14console.log(data);

No example available.