Skip to main content
GET
/
v1
/
owner_payments
List all owner payments
curl --request GET \
  --url https://api.yorlet.com/v1/owner_payments \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "owner_payment",
      "account_collection": "<string>",
      "amount": 123,
      "building": "<string>",
      "currency": "gbp",
      "description": "<string>",
      "owner": "<string>",
      "owner_balance_transaction": "<string>",
      "period": {
        "end": 123,
        "start": 123
      },
      "reporting_type": "<string>",
      "source_account_collection": "<string>",
      "source_invoice": "<string>",
      "source_invoice_item": "<string>",
      "source_transaction": "<string>",
      "source_transfer": "<string>",
      "tax_reporting": {
        "tax": 0,
        "tax_percent": 0
      },
      "unit": "<string>",
      "account": "<string>",
      "deleted": false,
      "amount_refunded": 0,
      "auto_advance": false,
      "metadata": {},
      "refunded": false
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

A object with a data property that contains an array of owner payments.

count
number
required

Total number of items in the list.

Example:

1

has_more
boolean
required

Whether more items are available.

Example:

false

object
enum<string>
required
Available options:
list
data
object[]
required