Owner transfers

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.

GET
https://api.portal.magicdoor.com/company-app/owners/contributions

Authorization

Authorizationstringrequired
Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Query parameters

pageinteger

Which page to return. The first page is 1.

default: 1
pageSizeinteger

How many records to return per page. Between 1 and 100.

default: 50
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.

memostring

Return only contributions whose memo matches this text. 1 to 1000 characters.

referencestring

Return only contributions whose reference matches this text. 1 to 200 characters.

contributionDate.startstring · date-time

Return 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-time

Return only contributions dated at or before this moment, read in the company's timezone.

totalAmount.fromnumber

Lower bound of the contribution amount. Give at least one of totalAmount.from and totalAmount.to.

totalAmount.tonumber

Upper bound of the contribution amount.

totalAmount.includeFromboolean

Whether a contribution equal to totalAmount.from is included.

default: true
totalAmount.includeToboolean

Whether a contribution equal to totalAmount.to is included.

default: true

Response

200 · A page of contributions plus the records they point at.

itemsOwnerContribution[]

The records on this page.

currentPageinteger

The page this response is.

totalPagesinteger

How many pages the filter produces.

pageSizeinteger

How many records a page holds.

totalCountinteger

How 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.

401 · The access token is missing, expired, or does not belong to a property manager.