Get a property's balance
Returns the property's income, expenses and net position over its whole history — one line of accounting, with no dates or line items.
Authorization
AuthorizationstringrequiredBearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.
Path parameters
propertyIdstringrequiredSnowflake id of the property, as a decimal string.
example: 1830472847398404097
Response
200 · The property's totals.
incomenumberEverything booked against the property as income.
expensenumberEverything booked against the property as an expense, including management fees and service bills that have been charged but not yet settled.
balancenumberincome minus expense.
401 · The access token is missing, expired, or not for this company.
404 · No property with that id, or it belongs to another company.
422 · The accounting service could not produce the summary.
This is not the tenant balance
currentBalance on the property object is what tenants owe on their leases. The three figures here are the property's books: money that came in, money that went out, and the difference. They answer different questions and will not agree.