GET
List payments

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 (via linked invoice or room)

room_id
string<uuid>

Filter by room (payment or linked invoice room)

period
string

Filter by linked invoice billing period in YYYY-MM

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

Filter by linked invoice

method
enum<string>

Filter by payment method Manual payment method classification.

Available options:
cash,
bank_transfer,
other
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

Payments

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.