Clearing API Documentation

Clearing API · 1.1

Owner Data

Retrieve financial data for a specific owner across a given date range. The response includes transactions, bookings (with line-level financials), and resolution payouts.

POST https://app.getclearing.co/api/1.1/wf/owner-data

Request

Send a JSON body with the following fields. All fields are required.

Request body — application/json

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

ℹ Dates must be plain numbers — no dashes, slashes, or quotes. March 31, 2026 → 20260331

Where to find your values

owner-id

Open the owner record in Clearing. The ID appears in the URL or details panel.

key

Your API key is issued by Clearing. Contact your account manager if you don't have one.

orga-id

In Clearing, go to Settings → Profile to find your organization ID.

startDate / endDate

Plain number in YYYYMMDD format. Both dates are inclusive.

Example request

A sample request fetching owner data for the month of March 2026.

curl

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 three top-level arrays: transactions, bookings, and resolution_payouts. Below is a representative example — truncated to one transaction and one booking for readability.

json — example response

{
  "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)
  ]
}

Response → transactions[]

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.

Response → 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	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	Clearing commission, rounded to 2 decimal places.
financials	array	List of booking financial line objects (see below).

Booking financial line object — financials[]

Field	Type	Description
amount	number	Line amount, rounded to 2 decimal places.
category	object	`{ id, name }` — sub-category.
allocation	string	OS_Trust display value.
memo	string	Line memo or note.
recognized_date	string	Formatted recognized date for this line.

Response → resolution_payouts[]

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.

Clearing API · 1.1

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.

POST https://app.getclearing.co/api/1.1/wf/owners

Request

Send a JSON body with the following fields. All fields are required.

Request body — application/json

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

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.

json — example response

[
  {
    "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
]

Response → array of objects

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).

Owner → assets[]

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.