MagicDoorAPI
SupportOpen MagicDoor
Company payouts

List company payouts

Returns a page of the transfers that have moved money from property and owner trust accounts into the management company's own account, with the transactions, bank accounts and chart of accounts they touch.

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

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 payouts to return per page. Between 1 and 100.

default: 50
transferDate.startstring · date-time

Return only payouts transferred at or after this moment, read in the company's timezone. Give at least one of transferDate.start and transferDate.end.

transferDate.endstring · date-time

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

amount.fromnumber

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

amount.tonumber

Upper bound of the payout amount.

amount.includeFromboolean

Whether a payout equal to amount.from is included.

default: true
amount.includeToboolean

Whether a payout equal to amount.to is included.

default: true

Response

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

itemsCompanyPayout[]

The payouts on this page.

currentPageinteger

The page this response is.

totalPagesinteger

How many pages the filter produces.

pageSizeinteger

How many payouts a page holds.

totalCountinteger

How many payouts match the filter across all pages.

transactionsobject[]

Every accounting transaction named by items[].outTransactionId and items[].inTransactionId, resolved.

bankAccountsobject[]

Every bank account those transactions moved money through, resolved. Account and routing numbers are masked.

chartOfAccountsobject[]

Every chart of account those transactions post to, resolved.

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