Parent API: GST API Quickstart guide Authentication guide

GST IMS Supplier-Side Invoices

Q: What parameters and payload format are required for Get Supplier IMS Invoices data?

Requests are submitted via HTTP GET to '/ims/supplierInvoices'. Required parameters: 'gstin' (query parameter), 'email' (query parameter), 'retperiod' (query parameter), 'section' (query parameter), 'rtnTyp' (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 Supplier IMS Invoices data return?

For Get Supplier IMS Invoices data (GET '/ims/supplierInvoices'), 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/ims/supplierInvoices

Get the section wise supplier invoices in IMS based on rtn typ and section.

IMS Automation

Explore Feature

Invoice Management System (IMS) Action Hub

Accept, reject, or keep supplier invoices pending in bulk with our intuitive IMS dashboard connected live to GSTN.

Parameters

query parameters

gstinstringrequired

GSTIN of the taxpayer

emailstringrequired

retperiodstringrequired

Return Period format MMYYYY

sectionstringrequired

Section Type

rtnTypstringrequired

GSTR1/GSTR1A

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 /ims/supplierInvoices. Required parameters: gstin (query parameter), email (query parameter), retperiod (query parameter), section (query parameter), rtnTyp (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 Supplier IMS Invoices data (GET /ims/supplierInvoices), 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 section wise supplier invoices in IMS based on rtn typ and section.

Get IMS Count data

Get Added Back Liability Records

GET/ims/supplierInvoices

1const response = await fetch('https://apisandbox.whitebooks.in/ims/supplierInvoices?gstin=value&email=value&retperiod=value&section=value&rtnTyp=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.