GET
List invoices

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

property_id
string<uuid>

Filter by property

room_id
string<uuid>

Filter by room

period
string

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.

Required string length: 7
Pattern: ^\d{4}-\d{2}$
period_from
string

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.

Required string length: 7
Pattern: ^\d{4}-\d{2}$
period_to
string

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.

Required string length: 7
Pattern: ^\d{4}-\d{2}$
status
enum<string>

Filter by invoice status Lifecycle status for an invoice.

Available options:
DRAFT,
ISSUED,
PARTIALLY_PAID,
PAID,
OVERDUE,
CANCELLED
overdue
boolean

Filter overdue invoices

Case-insensitive match on invoice number, payment reference, payment code, renter, room, or property name

Maximum string length: 120
due_date_from
string

Inclusive lower bound on due_date (YYYY-MM-DD)

due_date_to
string

Inclusive upper bound on due_date (YYYY-MM-DD)

issue_date_from
string

Inclusive lower bound on issue_date (YYYY-MM-DD); invoices without an issue date are excluded

issue_date_to
string

Inclusive upper bound on issue_date (YYYY-MM-DD); invoices without an issue date are excluded

limit
integer<int64>

Page size 1-500 (default 100)

Required range: 1 <= x <= 500
offset
integer<int64>

Page offset (default 0)

Required range: x >= 0

Response

Invoices

data
object
required

Endpoint-specific response payload. See the referenced schema for the resource fields.

request_id
string
required

Request correlation identifier returned from X-Request-Id or generated by the API.

meta
object

Optional response metadata such as pagination limits, counts, or export context.