List owner transfers
Returns a page of the transfers that have moved one owner's money from one of their properties to another, with the owners, portfolios, properties, transactions, bank accounts and chart of accounts they touch.
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 transfers for these owners. Repeat the parameter for each id.
sourcePropertyIdsstring[]Return only transfers whose money left these properties. Repeat the parameter for each id.
destinationPropertyIdsstring[]Return only transfers whose money arrived at these properties. Repeat the parameter for each id.
sourcePortfolioIdsstring[]Return only transfers whose money left properties in these portfolios. Repeat the parameter for each id.
destinationPortfolioIdsstring[]Return only transfers whose money arrived at properties in these portfolios. Repeat the parameter for each id.
memostringReturn only transfers whose memo matches this text. 1 to 1000 characters.
referencestringReturn only transfers whose reference matches this text. 1 to 200 characters.
transferDate.startstring · date-timeReturn only transfers dated at or after this moment, read in the company's timezone. Give at least one of transferDate.start and transferDate.end.
transferDate.endstring · date-timeReturn only transfers dated at or before this moment, read in the company's timezone.
amount.fromnumberLower bound of the transfer amount. Give at least one of amount.from and amount.to.
amount.tonumberUpper bound of the transfer amount.
amount.includeFrombooleanWhether a transfer equal to amount.from is included.
amount.includeTobooleanWhether a transfer equal to amount.to is included.
Response
200 · A page of owner transfers plus the records they point at.
itemsOwnerTransfer[]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.