Invoices

List invoices

Cursor-paginated, scoped to the token's account and role.

Besides the filter[<field>_<predicate>] fields, these filters take a plain value:

  • filter[archived] — false (default) hides archived invoices, true returns only archived ones, all returns both.
get/v1/invoices

Request

  • Base URL: https://api.topkey.io
  • URL: https://api.topkey.io/v1/invoices
  • Auth: HTTP bearer

Query parameters

page[size]integer

Rows per page (max 100).

page[after]string

Opaque cursor from the previous page's meta.next_cursor.

archivedstring

false (default) hides archived invoices, true returns only archived ones, all returns both.

filter[field_predicate]=value (Ransack, per-resource allowlist), and the plain-value filters listed. Unknown filters return 400. Filterable fields: amount, created_at, customer_id, customer_name, due_date, id, invoice_date, invoice_number, memo, status, updated_at.

Comma-separated relationships to sideload into included.

Response

A page of invoices.

Changes

No recorded changes to this operation across all 1 revision of this API.