Skip to main content
GET
List invoices

Authorizations

Authorization
string
header
required

A Custral API key, created in Settings → Developers → Applications, sent as Authorization: Bearer sk_…. The X-Api-Key header is also accepted and takes precedence. Use a secret key (sk_…) from your server; a publishable key (pk_…) may hold only objects:read and usage:write. Never expose a secret key in a browser.

Query Parameters

customer
string

One customer's invoices: your customer id or a record id.

period
enum<string>
default:90d

Workspace reads only.

Available options:
30d,
90d,
365d,
all
overdue
enum<string>

true for only invoices past their due date.

Available options:
true,
false

Response

200 - application/json

The invoices.

data
object

With customer: that customer's invoices. Without it: the workspace's receivables for period.

reqId
string

A per-request id (req_…). Quote it to support when reporting a problem.

Example:

"req_2a1f9c8e7b6d5"