MagicDoorAPI
SupportOpen MagicDoor
Reports

Prepaid rent report

Lists the leases that are in credit, that is, where the tenant has paid ahead. One row is one lease, grouped under its property and portfolio.

GET
https://api.portal.magicdoor.com/company-app/reports/prepaid-rent

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.

includeEndedLeasesboolean

Whether to include leases that have been closed out but still hold a credit.

default: false

Response

200 · The leases in credit, grouped by property.

groupsobject[]

One group 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.