MagicDoorAPI
SupportOpen MagicDoor
Reports

Property reserve report

Compares the cash each property is holding against the reserve its owner agreement requires, so you can see how much is actually free to distribute. One row is one property.

GET
https://api.portal.magicdoor.com/company-app/reports/property-reserve

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

portfolioIdsstring[]

Narrow the report to these portfolios. Repeat the parameter once per id. An id that does not exist returns 404.

propertyIdsstring[]

Narrow the report to these properties. Repeat the parameter once per id. An id that does not exist returns 404.

ownerIdsstring[]

Narrow the report to properties these owners have a stake in. Repeat the parameter once per id. An id that does not exist returns 404.

Response

200 · The reserve position for each property.

propertiesobject[]

One row per property.

metadataobject

Totals across every row.

401 · The access token is missing, expired, or not valid for this company.

404 · A portfolio, property or owner id in the query does not exist in the caller's company.

How scoping works

portfolioIds, propertyIds and ownerIds are all resolved down to one set of properties, and they narrow each other rather than adding up. Sending a portfolio and a property that is not in it returns nothing. Sending none of the three covers every property in the company.

A negative availableFunds means the property is holding less than its reserve requires, so nothing should be distributed from it.