Skip to main content
POST
india.gst.ims.invoices.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by india.gst.consent.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
section
enum<string>
required

Invoice section.

Available options:
b2b,
b2ba,
cdn,
cdna,
ecom,
ecoma
status
enum<string>

Recipient action filter.

Available options:
A,
R,
P,
N
limit
number

Rows per page, at most 500. Default 100.

Required range: x >= 1
cursor
string

Opaque continuation returned by this operation.

Required string length: 1 - 2048

Response

The result

results
object[]
required

Invoice identities, counterparties and tax values.

nextCursor
string

Next page continuation.

Required string length: 1 - 2048