Get a list of invoices

get

https://api-dev.gettrx.com/onboard/v1/invoices

API used to retrieve a paginated list of invoices with filtering, search, and keyset pagination. IMPORTANT: - Results are always sorted by created date in descending order (newest first). - This endpoint MUST use keyset pagination. - The keyset pagination token (next_results_token) is only sent as part of the API response when there are more records to be retrieved from the backend. When there are no other records to be retrieved the next_results_token will be "null" in the API response. - The keyset pagination token (next_results_token) must be a base64 encoded version of the concatenation of key-value pairs that make up the pagination cursor (e.g. base64("cdt:timestamp|id:invoiceId"))

Query Params

limit

int32

Defaults to 10

Integer representing the number of records to retrieve at once

created_start

int64

Unix timestamp for created date start filter (inclusive). Must be less or equal to created_end.

created_end

int64

Unix timestamp for created date end filter (inclusive). Must be greater or equal to created_start.

customer

string

Customer ID to filter invoices by. Must be a valid customerId belonging to the merchant account.

status

string

Comma separated string of invoice status enums. Allowed values draft, open, paid, voided, uncollectible.

pastDue

boolean

Filter invoices marked as past due

subscription

string

Subscription ID to filter invoices by.

site_id

string

When set, restrict to invoices linked to this site id (strict match).

billing_reason

string

Filter invoices by billing reason. Allowed values are "manual" and "subscription_related".

string

Search term to filter by invoice number or customer name

next_results_token

string

(Optional) Base64 encoded pagination cursor. Decoded format: cdt:<created_timestamp>|id:<invoice_id> Example: base64("cdt:1732046457|id:inv_674240eebe94ddc95e044fd2")

order_by

string

Sort order. Format: field:direction. Default: created:desc. Only created is supported.

Headers

secretKey

string

required

Unique secretKey String e.g. sk_age14sf40sSwfchDsaetaqsgh3001e4gf2ed associated to the partner's account

onBehalfOf

string

(Optional) AccountId of the merchant. Only required when secretKey belongs to an "entity" account. (e.g. acm_********)

requestId

string

Unique Key String refNumber

Responses

200OK - Invoices retrieved successfully Response Codes: - ED999: System error occurred. Please contact the system administrator. - ED101: The value %s of element %s is not valid. - ED109: Merchant Authentication failed, please use valid credentials. - ED138: Merchant not found

401Unauthorized

402Error

403Forbidden

404Not Found