List invoices
Lists invoices for the current organization with optional property, room, period, status, and overdue filters.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filter by property
Filter by room
Filter by an exact billing period (the month the invoice bills for), YYYY-MM. This is a billing month, NOT a calendar-date filter; use due_date_/issue_date_ for date ranges. Mutually exclusive with period_from/period_to.
7^\d{4}-\d{2}$Inclusive lower bound on the billing period (YYYY-MM). Distinct from due_date_/issue_date_ (calendar dates). Compose with period_to for a billing-month range; cannot be combined with the exact period param.
7^\d{4}-\d{2}$Inclusive upper bound on the billing period (YYYY-MM). Distinct from due_date_/issue_date_ (calendar dates). Compose with period_from for a billing-month range; cannot be combined with the exact period param.
7^\d{4}-\d{2}$Filter by invoice status Lifecycle status for an invoice.
DRAFT, ISSUED, PARTIALLY_PAID, PAID, OVERDUE, CANCELLED Filter overdue invoices
Case-insensitive match on invoice number, payment reference, payment code, renter, room, or property name
120Inclusive lower bound on due_date (YYYY-MM-DD)
Inclusive upper bound on due_date (YYYY-MM-DD)
Inclusive lower bound on issue_date (YYYY-MM-DD); invoices without an issue date are excluded
Inclusive upper bound on issue_date (YYYY-MM-DD); invoices without an issue date are excluded
Page size 1-500 (default 100)
1 <= x <= 500Page offset (default 0)
x >= 0Response
Invoices
Endpoint-specific response payload. See the referenced schema for the resource fields.
Request correlation identifier returned from X-Request-Id or generated by the API.
Optional response metadata such as pagination limits, counts, or export context.