List owner contributions
Returns a page of the money owners have put into their properties, with the owners, portfolios, properties, transactions, bank accounts and chart of accounts each contribution 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 contributions from these owners. Repeat the parameter for each id.
propertyIdsstring[]Return only contributions into these properties. Repeat the parameter for each id.
portfolioIdsstring[]Return only contributions into properties in these portfolios. Repeat the parameter for each id.
memostringReturn only contributions whose memo matches this text. 1 to 1000 characters.
referencestringReturn only contributions whose reference matches this text. 1 to 200 characters.
contributionDate.startstring · date-timeReturn only contributions dated at or after this moment, read in the company's timezone. Give at least one of contributionDate.start and contributionDate.end.
contributionDate.endstring · date-timeReturn only contributions dated at or before this moment, read in the company's timezone.
totalAmount.fromnumberLower bound of the contribution amount. Give at least one of totalAmount.from and totalAmount.to.
totalAmount.tonumberUpper bound of the contribution amount.
totalAmount.includeFrombooleanWhether a contribution equal to totalAmount.from is included.
totalAmount.includeTobooleanWhether a contribution equal to totalAmount.to is included.
Response
200 · A page of contributions plus the records they point at.
itemsOwnerContribution[]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.