Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Query Parameters

status
enum<string> | null

Where an invoice is in its life. A draft changes; issuing locks it, payments move it on, and a credit note voids it.

Available options:
draft,
issued,
partially_paid,
paid,
void
customer_id
string<uuid> | null
order_id
string<uuid> | null
after
string<uuid> | null

The next_cursor of the page before.

Response

InvoicePageResource

data
InvoicePageResource · object
required