Skip to main content
GET
Get IMS supplier sales invoices

Response body schema

View response body schema

Authorizations

authorization
string
header
required

GST taxpayer access token returned by Verify OTP.

x-api-key
string
header
required

Sandbox API key from your Sandbox account.

Headers

x-api-version
string

Sandbox API version.

Path Parameters

year
integer<int32>
required

Calendar year containing the return period.

month
integer<int32>
required

Month containing the return period.

Query Parameters

section
string
required

IMS invoice section to retrieve.

return_type
string
required

GST return type associated with the supplier invoices.

Response

200 - application/json

GSTN success or business-error response. GSTN returns both variants with HTTP 200.

A GSTN success or GSTN business-failure response. Both variants use HTTP 200.

code
enum<integer>
required

The HTTP status code reported in the response body.

Available options:
200
Example:

200

timestamp
integer<int64>
required

The response timestamp in Unix epoch milliseconds.

Example:

1763446641000

transaction_id
string
required

The transaction identifier used to trace the request.

Example:

"41bb8041-fb83-4654-8d75-85a19f329158"

data
object
required

The GSTN success wrapper.