GET
List india gst invoices

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Query Parameters

financial_year
string

The Indian financial year as YYYY-YY, for example 2025-26 for 1 April 2025 to 31 March 2026. This is the filing period, and the invoice sequence restarts each year, so a number is only unique together with it. A value in any other shape is a 400 rather than an empty page, because "2025-2026" matching nothing would read as "this store issued no invoices that year".

Pattern: ^\d{4}-\d{2}$
order_id
string

EXACT match on one order, which is how you reconcile an order against its document. An order with no invoice returns an empty page. An order can have more than one row here over time: cancelling frees its slot, so a corrected order carries the void and the replacement.

status
enum<string>

active is an invoice that still stands, cancelled is one that was voided. A value outside the enum is a 400 rather than an unfiltered page, so a misspelled "canceled" cannot silently return everything. OMIT IT FOR A RETURN. Unfiltered includes the voided invoices, and they belong in the merchant's record: the number was really drawn from the series.

Available options:
active,
cancelled
limit
integer
default:20

Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.

Required range: 1 <= x <= 100
after
string

The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.

Response

Success

data
object[]
page
object