Skip to main content
GET
List invoices
Requires scope: view:billing — see Required scopes. Reads your invoices live from our billing system — Finance stores none. Only issued (SENT) invoices are visible. To read them, open the billing portal at billingUrl on your company profile — the per-invoice sequenceUrl is an internal reference, not a page you can open. The PDF is available through Download an invoice PDF.
This endpoint uses cursor pagination, not page/size. Send nextPageCursor / previousPageCursor back exactly as received. Until Venly has linked your company to a billing customer it answers 422 billing-not-configured.
See Billing.

Authorizations

FlowClient Credentials
Token URL
https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token

Headers

x-tenant-id
string<uuid>

Which tenant the request is scoped to, among those your token grants. Omit it when the token grants exactly one tenant; it is required when the token grants more than one. A supplied value must exactly match a tenant the token grants.

Absent when required, blank, malformed, or naming a tenant the token does not grant — each gets the same generic 403 forbidden, which reveals neither whether a tenant exists nor which ones you may use. Send the header once: a repeated header is rejected the same way.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Query Parameters

size
integer
default:100

Page size

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

Opaque cursor from a previous page, to move forward. Send it back exactly as received — it is not a stable identifier and must not be constructed by hand. Supply either this or previousPageCursor, never both.

Maximum string length: 1024
previousPageCursor
string

Opaque cursor from a previous page, to move back

Maximum string length: 1024

Response

One page of invoices; content is empty when the company has no invoices yet

success
boolean

Indicates whether the request was successful

result
object

One cursor-delimited page of invoices. Deliberately not the result/pagination/sort envelope the other list endpoints return — the billing system paginates by opaque cursor, so page/size cannot be honoured.