Skip to main content
GET
Get IMS 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
default:1.0.0

API version

Query Parameters

section
string
default:b2b
required

Section of the transaction. Possible values: B2B, B2BA, CN, CNA, DN, DNA, ECOM, ECOMA

Example:

"{{section}}"

status
enum<string>

Optional filter to fetch invoices of specific status. Possible values: accepted, rejected, pending, no_action_taken

Available options:
accepted,
rejected,
pending,
no_action_taken
Example:

"no_action_taken"

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.