Parent API: GST API Quickstart guide Authentication guide

Submit GSTR-5 Non-Resident Return

Q: What parameters and payload format are required for Submit?

Requests are submitted via HTTP POST to '/gstr5/retsubmit'. 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 Submit return?

For Submit (POST '/gstr5/retsubmit'), 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/gstr5/retsubmit

This API call for submit all the invoices Saved

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

GSTIN number

Example: "0817GBR00014NRX"

fpstringoptional

Fp Type

Example: "082016"

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 /gstr5/retsubmit. 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 Submit (POST /gstr5/retsubmit), 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 call for submit all the invoices Saved

Get GSTR5 Summary

File GSTR5

POST/gstr5/retsubmit

1const response = await fetch('https://apisandbox.whitebooks.in/gstr5/retsubmit?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 "gstin": "0817GBR00014NRX",

16 "fp": "082016"

17}),

18});

20const data = await response.json();

21console.log(data);

No example available.