Management fees

Calculate management fees

Works out, without charging anything, what management fee each property owes for each unbilled month — the fee the settings produce, what has already been billed, and the revenue it is based on — together with the credits available to offset it.

POST
https://api.portal.magicdoor.com/company-app/management-fees/calculate

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.

Body

application/json

managementFeeDateenum<string>required

How far to calculate up to. endOfLastMonth stops at the end of the previous calendar month; now includes the month in progress.

endOfLastMonthnow
propertyIdsstring[]

Only calculate for these properties. Every id must belong to the caller's company. Left out, every property is calculated.

Response

200 · What each property owes. Nothing was charged.

calculateFeesUntilstring · date-time

The cut-off the calculation used, in the company's timezone.

periodsobject[]

One entry per property and month that has an unbilled fee.

creditsobject[]

The management fee credits that exist for these properties, whether or not any is still available.

creditTotalsobject

How much credit is still available per property, as a map from property id to amount. Properties with nothing available are left out.

400 · A property id in `propertyIds` does not belong to the caller's company, or `managementFeeDate` is missing.

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