Get an owner statement
Builds the statement an owner receives: per property, the cash that came in and went out over a period, what is left, and optionally what is still unpaid. Requires the reports:read permission.
Authorization
AuthorizationstringrequiredBearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.
Query parameters
startDatestring · daterequiredFirst day of the period, read in the company's timezone.
example: 2026-07-01
endDatestring · daterequiredLast day of the period, read in the company's timezone.
example: 2026-07-31
ownerIdstringRestrict to the properties this owner owns. Sent as a plain number rather than a string on this endpoint.
withUnpaidBillsbooleanInclude the bills still outstanding on each property, and fold them into amountToPayOut.
default: false
portfolioIdsstring[]Only these portfolios.
propertyIdsstring[]Only these properties.
Response
200 · The owner statement.
entriesPropertyEntry[]One entry per property in scope.
summaryobjectThe whole statement's totals, in the shape described above.
400 · `startDate` or `endDate` is missing or not a date.
401 · The access token is missing, expired, or not for this company.
403 · The caller does not hold the `reports:read` permission.
404 · No properties matched the owner and property filters, so there is nothing to report on.
| Field | What it is |
|---|---|
beginningCashBalance | The property's cash at the start of the period. |
cashIn / cashOut | Cash movement over the period, both as positive numbers. |
ownerContributions / ownerDistributions | Money the owner put in and took out, both as positive numbers. |
endingCashBalance | The property's cash at the end of the period. |
unpaidBills | Bills still outstanding. Absent unless you asked for withUnpaidBills. |
amountToPayOut | What is available to send the owner. Absent unless you asked for withUnpaidBills. |
propertyReserve | The cash the property is required to hold back. |
netOwnerFunds | What is genuinely the owner's after the reserve. |
The top-level summary is the whole statement; each entry in entries carries the same summary shape for one property.