Owner Data
Retrieve all financial data for a specific owner across a given date range: reservations with line-level financials, expenses and transactions marked "to owner", resolution payouts, and a full list of owner statements.
Request
Send a JSON body with the following fields. All fields are required.
| Field | Type | Description |
|---|---|---|
| owner-id | string | Unique owner identifier. Found by opening owner details in Clearing — copy the ID from the URL or detail panel. You can also query the owners endpoint to get the list of owners. |
| startDate | number | Start of the date range in YYYYMMDD format. Example: 20260301 for March 1, 2026. |
| endDate | number | End of the date range in YYYYMMDD format. Example: 20260331 for March 31, 2026. |
| key | string | API authentication key. Provided by Clearing. Treat this like a password — never expose it in client-side code. |
| orga-id | string | Your organization ID. Found in Clearing under Settings → Profile. |
20260331
Where to find your values
Example request
A sample request fetching owner data for the month of March 2026.
curl -X POST https://app.getclearing.co/api/1.1/wf/owner-data \ -H "Content-Type: application/json" \ -d '{ "owner-id": "own_0001x000000000000000000000001", "startDate": 20260301, "endDate": 20260331, "key": "X7kPmQ2vN8rT4wY6zA1bC3dE5fG9hJ0kL2mN4oP6qR8sT0uV2wX4y...", "orga-id": "org_0001x000000000000000000000001" '}'
Response
A successful request returns HTTP 200 with a JSON object containing four top-level arrays: transactions, bookings, resolution_payouts, and owner_statements. owner_statements includes all statements available for the owner and is not filtered by startDate/endDate. Below is a representative example — truncated for readability.
{
"transactions": [
{
"id": "txn_0001x000000000000000000000001",
"amount": -175,
"date": 20260301,
"category": {
"id": "cat_0001x000000000000000000000001",
"name": "Tech Fee"
},
"asset": {
"id": "ast_0001x000000000000000000000001",
"name": "Sunset Villa"
},
"owner": {
"id": "own_0001x000000000000000000000001",
"name": "Jane Smith"
},
"reimbursable": true,
"locked": true,
"account": {
"id": "acc_0001x000000000000000000000001",
"name": "Journal Entry"
},
"merchant": "Management",
"memo": "AC Filter Change",
"markup": 0
}
// ...more transactions
],
"bookings": [
{
"id": "bkg_0001x000000000000000000000001",
"pms_id": "10000001",
"channel_code": "HMXXXXXXXX1",
"checkin": 20260306,
"checkout": 20260310,
"recognized_date": 20260310,
"reservation_date": 20260303,
"asset": {
"id": "ast_0001x000000000000000000000002",
"name": "Harbor House"
},
"owner": {
"id": "own_0001x000000000000000000000001",
"name": "Jane Smith"
},
"channel": "Airbnb",
"status": "active",
"lock": true,
"commission": 73.62,
"financials": [
{
"amount": 67.45,
"category": { "id": "cat_0002x000000000000000000000001", "name": "Resort Fee" },
"allocation": "To management",
"memo": "Resort Fee",
"recognized_date": 20260310
},
{
"amount": 301.76,
"category": { "id": "cat_0002x000000000000000000000002", "name": "Cleaning Fee (Collected)" },
"allocation": "To management",
"memo": "Cleaning Fee",
"recognized_date": 20260310
},
{
"amount": 272.81,
"category": { "id": "cat_0002x000000000000000000000003", "name": "Accommodation Revenue" },
"allocation": "To owner",
"memo": "Net Accommodation Revenue",
"recognized_date": 20260310
},
{
"amount": 440,
"category": { "id": "cat_0002x000000000000000000000004", "name": "Accommodation Fare" },
"allocation": "Exclude",
"memo": "rent",
"recognized_date": 20260310
},
{
"amount": -123.19,
"category": { "id": "cat_0002x000000000000000000000005", "name": "Host Fee" },
"allocation": "Exclude",
"memo": "Host Fee",
"recognized_date": 20260310
}
// ...more financial lines
]
}
// ...more bookings
],
"resolution_payouts": [
{
"id": "rpt_0001x000000000000000000000001",
"recognized_date": 20260315,
"asset": {
"id": "ast_0001x000000000000000000000002",
"name": "Harbor House"
},
"owner": {
"id": "own_0001x000000000000000000000001",
"name": "Jane Smith"
},
"lock": true,
"amount_to_owner": 125.50,
"reservation_id": "HMXXXXXXXX2",
"category": {
"id": "cat_0003x000000000000000000000001",
"name": "Guest Damage"
},
"reason": "Damage to property",
"airbnb_resolution_id": "RES-0001-0001"
}
// ...more resolution payouts (empty array if none for the period)
],
"owner_statements": [
{
"unique_id": "1762963946849x529468496348871800",
"type": "By owner",
"assets": [],
"start": 20251201,
"end": 20251231,
"net": 0,
"pdf": "https://example.cdn.com/owner-statement-2025-12.pdf"
},
{
"unique_id": "1762874556055x306565730354150700",
"type": "By asset",
"assets": [
{
"id": "1727271442999x670760258751734300",
"name": "Villa Capri 1"
}
],
"start": 20251101,
"end": 20251130,
"net": 100,
"pdf": "https://example.cdn.com/owner-statement-2025-11.pdf"
}
// ...all owner statements for this owner, regardless of requested date range
]
}
Transaction
Each item in the transactions array represents a single financial transaction for the owner.
| Field | Type | Description |
|---|---|---|
| id | string | Unique transaction ID. |
| amount | number | Transaction amount, rounded to 2 decimal places. |
| date | string | Formatted transaction date. |
| category | object | { id, name } — transaction category. |
| asset | object | { id, name } — associated property. |
| owner | object | { id, name } — homeowner. |
| reimbursable | boolean | Whether the transaction is reimbursable. |
| locked | boolean | Whether the transaction is locked. |
| account | object | { id, name } — account associated with the transaction. |
| merchant | string | To/from merchant name. |
| memo | string | Transaction memo or note. |
| markup | number | Markup amount, rounded to 2 decimal places. |
Booking
Each item in the bookings array represents a reservation. Each booking contains a nested financials array with line-level breakdown.
| Field | Type | Description |
|---|---|---|
| id | string | Unique booking ID. |
| pms_id | string | PMS booking ID. |
| channel_code | string | OTA external channel code. |
| checkin | string | Formatted check-in date. |
| checkout | string | Formatted check-out date. |
| recognized_date | string | Formatted recognized date. |
| reservation_date | string | Formatted reservation date. |
| asset | object | { id, name } — associated property. |
| owner | object | { id, name } — homeowner. |
| channel | string | OTA display name. |
| status | string | Booking status text. |
| lock | boolean | Whether the booking is fully locked. |
| commission | number | Management commission, rounded to 2 decimal places. |
| financials | array | List of booking financial line objects (see below). |
| Field | Type | Description |
|---|---|---|
| amount | number | Line amount, rounded to 2 decimal places. |
| category | object | { id, name } — Category. |
| allocation | string | Trust allocation. |
| memo | string | Line memo. |
| recognized_date | string | Formatted recognized date. |
Owner Statement
Each item in the owner_statements array represents a generated owner statement. This array always returns all statements available for the owner, regardless of the request date range.
| Field | Type | Description |
|---|---|---|
| unique_id | string | Unique owner statement ID. |
| type | string | Statement grouping type (for example, By owner or By asset). |
| assets | array | List of assets included in the statement. Empty when the statement type is not asset-specific. |
| start | number | Statement start date in YYYYMMDD format. |
| end | number | Statement end date in YYYYMMDD format. |
| net | number | Net statement amount. |
| string | Direct URL to the statement PDF. |
| Field | Type | Description |
|---|---|---|
| id | string | Unique asset ID included in the statement. |
| name | string | Display name of the asset included in the statement. |
Resolution Payout
Each item in the resolution_payouts array represents a payout resolution (e.g. Airbnb resolution payouts) for the owner.
| Field | Type | Description |
|---|---|---|
| id | string | Unique resolution payout ID. |
| recognized_date | string | Formatted recognized date. |
| asset | object | { id, name } — associated property. |
| owner | object | { id, name } — homeowner. |
| lock | boolean | Whether the payout is locked. |
| amount_to_owner | number | Payout amount to the owner, rounded to 2 decimal places. |
| reservation_id | string | External reservation code. |
| category | object | { id, name } — payout category. |
| reason | string | Reason name for the payout. |
| airbnb_resolution_id | string | Airbnb resolution ID, if applicable. |
Owners
List all owners in your Clearing account, along with each owner's assets.
Owners
Returns a list of homeowners in your Clearing account. For each owner, the response includes their core profile fields and a nested array of assets (properties) they own.
Request
Send a JSON body with the following fields. All fields are required.
| Field | Type | Description |
|---|---|---|
| key | string | API authentication key. Provided by Clearing. Treat this like a password — never expose it in client-side code. |
| orga-id | string | Your organization ID. Found in Clearing under Settings → Profile. |
Example request
A sample request to fetch all owners and their assets.
curl -X POST https://app.getclearing.co/api/1.1/wf/owners \ -H "Content-Type: application/json" \ -d '{ "key": "X7kPmQ2vN8rT4wY6zA1bC3dE5fG9hJ0kL2mN4oP6qR8sT0uV2wX4y...", "orga-id": "org_0001x000000000000000000000001" '}'
Example response
A successful request returns HTTP 200 with an array of owner objects.
[
{
"unique_id": "own_0001x000000000000000000000001",
"first": "Jane",
"last": "Smith",
"company": "Smith Properties LLC",
"inactive?": false,
"assets": [
{
"unique_id": "ast_0001x000000000000000000000001",
"name": "Sunset Villa",
"inactive?": false
},
{
"unique_id": "ast_0001x000000000000000000000002",
"name": "Harbor House",
"inactive?": false
}
]
},
{
"unique_id": "own_0001x000000000000000000000002",
"first": "John",
"last": "Doe",
"company": "",
"inactive?": false,
"assets": [
{
"unique_id": "ast_0001x000000000000000000000003",
"name": "Mountain Retreat",
"inactive?": false
}
]
}
// ...more owners
]
Owner
Each item in the response array represents a homeowner in your Clearing account.
| Field | Type | Description |
|---|---|---|
| unique_id | string | Unique homeowner ID. |
| first | string | Homeowner's first name. |
| last | string | Homeowner's last name. |
| company | string | Homeowner's company name. Empty string if none. |
| inactive? | boolean | Whether the homeowner is disabled/inactive. |
| assets | array | List of asset objects belonging to this owner (see below). |
Asset
Each item in the assets array represents a property associated with the owner.
| Field | Type | Description |
|---|---|---|
| unique_id | string | Unique asset (property) ID. |
| name | string | Display name of the asset. |
| inactive? | boolean | Whether the asset is inactive. |
Get Assets
List all assets in your Clearing account, including each asset's assigned homeowner.
Get Assets
Returns all assets (properties) in your Clearing account. Each asset includes its display name, inactive status, and the homeowner assigned to it (if any).
Request
Send a JSON body with the following fields. All fields are required.
| Field | Type | Description |
|---|---|---|
| key | string | API authentication key. Provided by Clearing. Treat this like a password — never expose it in client-side code. |
| orga-id | string | Your organization ID. Found in Clearing under Settings → Profile. |
Example request
A sample request to fetch all assets and their assigned homeowners.
curl -X POST https://app.getclearing.co/api/1.1/wf/get-assets \ -H "Content-Type: application/json" \ -d '{ "key": "X7kPmQ2vN8rT4wY6zA1bC3dE5fG9hJ0kL2mN4oP6qR8sT0uV2wX4y...", "orga-id": "org_0001x000000000000000000000001" '}'
Example response
A successful request returns HTTP 200 with a JSON object containing an assets array.
{
"assets": [
{
"id": "ast_0001x000000000000000000000001",
"name": "Sunset Villa",
"inactive": "no",
"homeowner": {
"id": "own_0001x000000000000000000000001",
"first_name": "Jane",
"last_name": "Smith"
}
},
{
"id": "ast_0001x000000000000000000000002",
"name": "Harbor House",
"inactive": "no",
"homeowner": {
"id": "",
"first_name": "",
"last_name": ""
}
}
// ...more assets
]
}
Asset
Each item in the assets array represents a property in your Clearing account.
| Field | Type | Description |
|---|---|---|
| id | string | Unique asset (property) ID. |
| name | string | Display name of the asset. |
| inactive | string | Whether the asset is inactive. Returns no or yes. |
| homeowner | object | Homeowner assigned to this asset (see below). Fields are empty strings when no homeowner is assigned. |
Homeowner
The nested homeowner object on each asset contains the assigned homeowner's ID and name.
| Field | Type | Description |
|---|---|---|
| id | string | Unique homeowner ID. Empty string if no homeowner is assigned. |
| first_name | string | Homeowner's first name. Empty string if none. |
| last_name | string | Homeowner's last name. Empty string if none. |
Get Transactions
List transactions across your organization for a date range, with optional filters by owner, asset, or account.
Get Transactions
Returns financial transactions for your organization within the requested date range. Optionally filter results to a specific owner, asset, or account.
Request
Send a JSON body with the following fields. startDate, endDate, key, and orga-id are required; all other fields are optional filters.
| Field | Type | Description |
|---|---|---|
| startDate | number | Required. Start of the date range in YYYYMMDD format. Example: 20260101 for January 1, 2026. |
| endDate | number | Required. End of the date range in YYYYMMDD format. Example: 20260410 for April 10, 2026. |
| key | string | Required. API authentication key. Provided by Clearing. Treat this like a password — never expose it in client-side code. |
| orga-id | string | Required. Your organization ID. Found in Clearing under Settings → Profile. |
| owner-id | string | Optional. Filter to transactions for a single owner. Use the owners endpoint or owner details in Clearing to find the ID. |
| asset-id | string | Optional. Filter to transactions for a single asset (property). |
| account-id | string | Optional. Filter to transactions for a single account. |
20260410
Example request
A sample request fetching all transactions for an organization between January 1 and April 10, 2026. Optional filter fields are shown commented out.
curl -X POST https://app.getclearing.co/api/1.1/wf/get-transactions \ -H "Content-Type: application/json" \ -d '{ // "owner-id": "own_0001x000000000000000000000001", // "asset-id": "ast_0001x000000000000000000000001", // "account-id": "acc_0001x000000000000000000000001", "startDate": 20260101, "endDate": 20260410, "key": "X7kPmQ2vN8rT4wY6zA1bC3dE5fG9hJ0kL2mN4oP6qR8sT0uV2wX4y...", "orga-id": "org_0001x000000000000000000000001" '}'
Example response
A successful request returns HTTP 200 with a JSON object containing a transactions array.
{
"transactions": [
{
"id": "txn_0001x000000000000000000000001",
"amount": -175,
"date": 20260301,
"category": {
"id": "cat_0001x000000000000000000000001",
"name": "Tech Fee"
},
"asset": {
"id": "ast_0001x000000000000000000000001",
"name": "Sunset Villa"
},
"owner": {
"id": "own_0001x000000000000000000000001",
"name": "Jane Smith"
},
"reimbursable": "yes",
"locked": "yes",
"account": {
"id": "acc_0001x000000000000000000000001",
"name": "Journal Entry"
},
"merchant": "Management",
"memo": "AC Filter Change",
"markup": 0,
"level": "Main",
"has_sub_transactions?": "no",
"allocation": "To owner",
"parent_unique_id": "txn_0001x000000000000000000000001"
}
// ...more transactions
]
}
Transaction
Each item in the transactions array represents a single financial transaction.
| Field | Type | Description |
|---|---|---|
| id | string | Unique transaction ID. |
| amount | number | Transaction amount, rounded to 2 decimal places. |
| date | number | Transaction date in YYYYMMDD format. |
| category | object | { id, name } — transaction category. |
| asset | object | { id, name } — associated property. |
| owner | object | { id, name } — homeowner. |
| reimbursable | string | Whether the transaction is reimbursable. Returns yes or no. |
| locked | string | Whether the transaction is locked. Returns yes or no. |
| account | object | { id, name } — account associated with the transaction. |
| merchant | string | To/from merchant name. |
| memo | string | Transaction memo or note. |
| markup | number | Markup amount, rounded to 2 decimal places. |
| level | string | Transaction level. Returns Main or Sub. |
| has_sub_transactions? | string | Whether the transaction has sub-transactions. Returns yes or no. |
| allocation | string | Trust allocation (for example, To owner, To management, or Exclude). |
| parent_unique_id | string | Unique ID of the parent transaction. |
Get Bookings
List reservations across your organization for a date range, with optional filters by owner or asset.
Get Bookings
Returns bookings (reservations) for your organization within the requested date range. Each booking includes line-level financials. Optionally filter results to a specific owner or asset.
Request
Send a JSON body with the following fields. startDate, endDate, key, and orga-id are required; all other fields are optional filters.
| Field | Type | Description |
|---|---|---|
| startDate | number | Required. Start of the date range in YYYYMMDD format. Example: 20260101 for January 1, 2026. |
| endDate | number | Required. End of the date range in YYYYMMDD format. Example: 20260410 for April 10, 2026. |
| key | string | Required. API authentication key. Provided by Clearing. Treat this like a password — never expose it in client-side code. |
| orga-id | string | Required. Your organization ID. Found in Clearing under Settings → Profile. |
| owner-id | string | Optional. Filter to bookings for a single owner. |
| asset-id | string | Optional. Filter to bookings for a single asset (property). |
20260410
Example request
A sample request fetching all bookings between January 1 and April 10, 2026. Optional filter fields are shown commented out.
curl -X POST https://app.getclearing.co/api/1.1/wf/get-bookings \ -H "Content-Type: application/json" \ -d '{ // "owner-id": "own_0001x000000000000000000000001", // "asset-id": "ast_0001x000000000000000000000001", "startDate": 20260101, "endDate": 20260410, "key": "X7kPmQ2vN8rT4wY6zA1bC3dE5fG9hJ0kL2mN4oP6qR8sT0uV2wX4y...", "orga-id": "org_0001x000000000000000000000001" '}'
Example response
A successful request returns HTTP 200 with a JSON object containing a bookings array.
{
"bookings": [
{
"id": "bkg_0001x000000000000000000000001",
"pms_id": "10000001",
"channel_code": "HMXXXXXXXX1",
"checkin": 20260306,
"checkout": 20260310,
"recognized_date": 20260310,
"reservation_date": 20260303,
"asset": {
"id": "ast_0001x000000000000000000000002",
"name": "Harbor House"
},
"owner": {
"id": "own_0001x000000000000000000000001",
"name": "Jane Smith"
},
"channel": "Airbnb",
"status": "active",
"lock": "yes",
"commission": 73.62,
"financials": [
{
"amount": 67.45,
"category": { "id": "cat_0002x000000000000000000000001", "name": "Resort Fee" },
"allocation": "To management",
"memo": "Resort Fee",
"recognized_date": 20260310
},
{
"amount": 272.81,
"category": { "id": "cat_0002x000000000000000000000003", "name": "Accommodation Revenue" },
"allocation": "To owner",
"memo": "Net Accommodation Revenue",
"recognized_date": 20260310
}
// ...more financial lines
]
}
// ...more bookings
]
}
Booking
Each item in the bookings array represents a reservation. Each booking contains a nested financials array with line-level breakdown.
| Field | Type | Description |
|---|---|---|
| id | string | Unique booking ID. |
| pms_id | string | PMS booking ID. |
| channel_code | string | OTA external channel code. |
| checkin | number | Check-in date in YYYYMMDD format. |
| checkout | number | Check-out date in YYYYMMDD format. |
| recognized_date | number | Recognized date in YYYYMMDD format. |
| reservation_date | number | Reservation date in YYYYMMDD format. |
| asset | object | { id, name } — associated property. |
| owner | object | { id, name } — homeowner. |
| channel | string | OTA display name. |
| status | string | Booking status text. |
| lock | string | Whether the booking is fully locked. Returns yes or no. |
| commission | number | Management commission, rounded to 2 decimal places. |
| financials | array | List of booking financial line objects (see below). |
| Field | Type | Description |
|---|---|---|
| amount | number | Line amount, rounded to 2 decimal places. |
| category | object | { id, name } — line category. |
| allocation | string | Trust allocation (for example, To owner, To management, or Exclude). |
| memo | string | Line memo. |
| recognized_date | number | Recognized date in YYYYMMDD format. |
Get Resolution Payout
List resolution payouts across your organization for a date range, with optional filters by owner or asset.
Get Resolution Payout
Returns resolution payouts (for example, Airbnb resolution payouts) for your organization within the requested date range. Optionally filter results to a specific owner or asset.
Request
Send a JSON body with the following fields. startDate, endDate, key, and orga-id are required; all other fields are optional filters.
| Field | Type | Description |
|---|---|---|
| startDate | number | Required. Start of the date range in YYYYMMDD format. Example: 20260101 for January 1, 2026. |
| endDate | number | Required. End of the date range in YYYYMMDD format. Example: 20260410 for April 10, 2026. |
| key | string | Required. API authentication key. Provided by Clearing. Treat this like a password — never expose it in client-side code. |
| orga-id | string | Required. Your organization ID. Found in Clearing under Settings → Profile. |
| owner-id | string | Optional. Filter to resolution payouts for a single owner. |
| asset-id | string | Optional. Filter to resolution payouts for a single asset (property). |
20260410
Example request
A sample request fetching all resolution payouts between January 1 and April 10, 2026. Optional filter fields are shown commented out.
curl -X POST https://app.getclearing.co/api/1.1/wf/get-resolution-payout \ -H "Content-Type: application/json" \ -d '{ // "owner-id": "own_0001x000000000000000000000001", // "asset-id": "ast_0001x000000000000000000000001", "startDate": 20260101, "endDate": 20260410, "key": "X7kPmQ2vN8rT4wY6zA1bC3dE5fG9hJ0kL2mN4oP6qR8sT0uV2wX4y...", "orga-id": "org_0001x000000000000000000000001" '}'
Example response
A successful request returns HTTP 200 with a JSON object containing a resolution_payouts array.
{
"resolution_payouts": [
{
"id": "rpt_0001x000000000000000000000001",
"recognized_date": 20260315,
"asset": {
"id": "ast_0001x000000000000000000000002",
"name": "Harbor House"
},
"owner": {
"id": "own_0001x000000000000000000000001",
"name": "Jane Smith"
},
"lock": "yes",
"amount_to_owner": 125.50,
"reservation_id": "HMXXXXXXXX2",
"category": {
"id": "cat_0003x000000000000000000000001",
"name": "Guest Damage"
},
"reason": "Damage to property",
"airbnb_resolution_id": "RES-0001-0001",
"amount_to_management": 0
}
// ...more resolution payouts
]
}
Resolution Payout
Each item in the resolution_payouts array represents a payout resolution (for example, an Airbnb resolution payout).
| Field | Type | Description |
|---|---|---|
| id | string | Unique resolution payout ID. |
| recognized_date | number | Recognized date in YYYYMMDD format. |
| asset | object | { id, name } — associated property. |
| owner | object | { id, name } — homeowner. |
| lock | string | Whether the payout is locked. Returns yes or no. |
| amount_to_owner | number | Payout amount to the owner, rounded to 2 decimal places. |
| reservation_id | string | External reservation code. |
| category | object | { id, name } — payout category. |
| reason | string | Reason name for the payout. |
| airbnb_resolution_id | string | Airbnb resolution ID, if applicable. |
| amount_to_management | number | Payout amount to management, rounded to 2 decimal places. |