List owner distributions
Returns a page of the money paid out of properties to their owners, with the owners, portfolios, properties, transactions, bank accounts and chart of accounts each distribution touches.
Authorization
AuthorizationstringrequiredQuery parameters
pageintegerWhich page to return. The first page is 1.
pageSizeintegerHow many records to return per page. Between 1 and 100.
ownerIdsstring[]Return only distributions to these owners. Repeat the parameter for each id.
propertyIdsstring[]Return only distributions out of these properties. Repeat the parameter for each id.
portfolioIdsstring[]Return only distributions out of properties in these portfolios. Repeat the parameter for each id.
memostringReturn only distributions whose memo matches this text. 1 to 1000 characters.
referencestringReturn only distributions whose reference matches this text. 1 to 200 characters.
distributionDate.startstring · date-timeReturn only distributions dated at or after this moment, read in the company's timezone. Give at least one of distributionDate.start and distributionDate.end.
distributionDate.endstring · date-timeReturn only distributions dated at or before this moment, read in the company's timezone.
totalAmount.fromnumberLower bound of the distribution amount. Give at least one of totalAmount.from and totalAmount.to.
totalAmount.tonumberUpper bound of the distribution amount.
totalAmount.includeFrombooleanWhether a distribution equal to totalAmount.from is included.
totalAmount.includeTobooleanWhether a distribution equal to totalAmount.to is included.
Response
200 · A page of distributions plus the records they point at.
itemsOwnerDistribution[]The records on this page.
currentPageintegerThe page this response is.
totalPagesintegerHow many pages the filter produces.
pageSizeintegerHow many records a page holds.
totalCountintegerHow many records match the filter across all pages.
ownersobject[]Every owner referenced by the records or by their creators, resolved.
portfoliosobject[]Every portfolio referenced by the lines, resolved.
propertiesobject[]Every property referenced by the lines, resolved.
transactionsobject[]Every accounting transaction behind the allocations, resolved.
bankAccountsobject[]Every bank account those transactions moved money through, resolved. Account and routing numbers are masked.
chartOfAccountsobject[]Every chart of account the lines book to, resolved.
propertyManagersobject[]Every property manager who created one of the records, resolved.
tenantsobject[]Every tenant who created one of the records, resolved.
vendorsobject[]Every vendor who created one of the records, resolved.