Skip to content

List invoices

GET
/api/invoices

Retrieve all invoices for your tenant, ordered by date descending.

All invoices for the tenant.

List of invoices for the tenant.

object
items
required
Array<object>
object
id
required
string format: uuid
Example
inv_11223344-5566-7788-99aa-bbccddeeff00
periodStart
required
string format: date-time
periodEnd
required
string format: date-time
status
required

Invoice status: paid, open, void, or uncollectible.

string
Example
paid
subtotal
required

Subtotal in smallest currency unit (cents).

integer
Example
14900
tax
required

Tax amount in smallest currency unit.

integer
Example
3129
total
required

Total in smallest currency unit.

integer
Example
18029
currency
required
string
Example
eur
stripeInvoiceUrl

Link to the Stripe-hosted invoice.

string | null
createdAt
required
string format: date-time
total
required

Total number of invoices.

integer
Example
2