Skip to main content
POST
/
v1
/
owner_balance_transactions
Create an owner balance transaction
curl --request POST \
  --url https://api.yorlet.com/v1/owner_balance_transactions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "currency": "gbp",
  "description": "<string>",
  "owner": "<string>",
  "available_on": 123,
  "metadata": {},
  "unit": "<string>"
}
'
{
  "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".

Body

application/json
​
amount
integer
required

The amount of the owner balance transaction, in the smallest currency unit.

​
currency
enum<string>
required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

Available options:
gbp,
usd,
eur,
sek
Example:

"gbp"

​
description
string
required

An arbitrary string attached to the object. Often useful for displaying to users.

​
owner
string
required

The ID of the owner the transaction is for.

​
available_on
integer | null

The date the transaction becomes available in the owner balance.

​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

​
unit
string | null

The ID of the unit the transaction is associated with.

Response

200 - application/json

Returns an owner balance transaction object if the request succeeded.

​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

​
object
enum<string>
required
Available options:
owner_balance_transaction
​
amount
integer
required

The amount of the owner balance transaction, in the smallest currency unit.

​
available_on
integer | null
required

The date the transaction becomes available in the owner balance.

​
balance_type
string | null
required

The type of balance this transaction affects.

​
building
string | null
required

The ID of the building the transaction is associated with.

​
currency
enum<string>
required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

Available options:
gbp,
usd,
eur,
sek
Example:

"gbp"

​
description
string | null
required

An arbitrary string attached to the object. Often useful for displaying to users.

​
net
integer | null
required

The net amount of the transaction after taxes.

​
owner
required

The owner the transaction is for.

​
owner_payout
required

The owner payout this transaction belongs to, if any.

​
reconciled_owner_payout
required

The owner payout this transaction was reconciled against, if any.

​
reconciled_owner_payout_paid_at
integer | null
required

The time at which the reconciled payout was paid.

​
reporting_subtype
string | null
required

The reporting subtype used to categorize this transaction.

​
reporting_type
string | null
required

The reporting type used to categorize this transaction.

​
source
required

The source object the transaction is associated with.

​
source_object
string | null
required

The type of source object the transaction is associated with.

​
type
string
required

The type of the owner balance transaction.

​
unit
string | null
required

The ID of the unit the transaction is associated with.

​
workspace
string | null
required

The workspace the transaction belongs to.

​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.

​
created_from_owner_payout
boolean
default:false

Whether this transaction was created automatically from an owner payout.

​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

​
tax
integer
default:0

The amount of tax on the transaction.

​
tax_percent
number
default:0

The tax percentage applied to the transaction.

​
visible_to_owner
boolean
default:true

Whether this transaction is visible in the owner portal.