Skip to main content
GET
/
v1
/
owner_balance_transactions
List all owner balance transactions
curl --request GET \
  --url https://api.yorlet.com/v1/owner_balance_transactions \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "owner_balance_transaction",
      "amount": 123,
      "available_on": 123,
      "balance_type": "<string>",
      "building": "<string>",
      "currency": "gbp",
      "description": "<string>",
      "net": 123,
      "owner": "<string>",
      "owner_payout": "<string>",
      "reconciled_owner_payout": "<string>",
      "reconciled_owner_payout_paid_at": 123,
      "reporting_subtype": "<string>",
      "reporting_type": "<string>",
      "source": "<string>",
      "source_object": "<string>",
      "type": "<string>",
      "unit": "<string>",
      "workspace": "<string>",
      "account": "<string>",
      "deleted": false,
      "created_from_owner_payout": false,
      "metadata": {},
      "tax": 0,
      "tax_percent": 0,
      "visible_to_owner": true
    }
  ]
}

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 balance transactions.

​
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