Skip to main content
GET
List invoices

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:25

Items per page

Required range: 1 <= x <= 100
companyId
string<uuid>[]

Limit to these companies (repeat the key or comma-separate; at most 100)

Maximum array length: 100
status
string

Invoice status name

Maximum string length: 100
invoiceType
string
Maximum string length: 100

Full-text search across invoice fields

Maximum string length: 200
invoiceNumber
string

Invoice number (partial match)

Maximum string length: 100
dateFrom
string

Earliest invoice date (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$
dateTo
string

Latest invoice date (YYYY-MM-DD)

Pattern: ^\d{4}-\d{2}-\d{2}$
sortBy
enum<string>
default:invoice_date
Available options:
invoice_number,
reference,
customer_po,
company_name,
invoice_type,
status_name,
invoice_date,
due_date,
total,
balance,
billing_terms_name,
site_name
sortDir
enum<string>
default:desc
Available options:
asc,
desc

Response

Invoices

data
object[]
required
pagination
object
required