v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB
Property Management System
Payments

Get payments (PMS)

Returns a list of payments

get/consumers/{consumer_id}/pms/payments

Path parameters

consumer_idstring uuid required

Query parameters

pageinteger

Page number

sizeinteger

Page size

date_fromstring date required
date_tostring date required

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required

Example response

{
  "items": [
    {
      "id": "payment-123",
      "payment_method_id": "payment-method-123",
      "payment_method_name": "Cash",
      "total": 11,
      "tip": 1,
      "currency": "EUR",
      "date": "2025-01-01T00:00:00Z",
      "invoice_ref": "invoice-123",
      "description": "Payment for invoice INV-12345"
    }
  ]
}