MagicDoorAPI
SupportOpen MagicDoor
Reports

Delinquency report

Lists every lease that owes money, with what is owed split by chart of account, how many unpaid charges there are, and any notes recorded about the arrears. One row is one lease, grouped under its property and portfolio.

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

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.

minimumDuenumber

Only include leases owing at least this much, for example 50.00.

includeEmptyPropertiesboolean

Whether to list properties with no delinquent leases.

default: false
includeDeactivatedboolean

Whether to include deactivated properties and units.

default: false
statusenum<string>

Only include leases in this state.

activenoticemoveOuteviction

Response

200 · The delinquent leases, grouped by property.

groupsobject[]

One group per property.

metadataobject

The same totals across the whole report.

chartOfAccountsobject[]

Every account named in delinquencyAccounts, so the ids can be shown as names.

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.

Totals appear twice: once per property group, and once for the whole report at the top level. They are the same three figures computed over different sets of rows.