Management fees

List management fee credits

Returns a page of the credits that can be set against a property's management fees, and which fees each has already been used on.

GET
https://api.portal.magicdoor.com/company-app/management-fees/credits

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

default: 50
propertyIdsstring[]

Return only credits for these properties. Repeat the parameter for each id.

portfolioIdsstring[]

Return only credits for properties in these portfolios. Repeat the parameter for each id.

bankAccountIdsstring[]

Return only credits booked against these bank accounts. Repeat the parameter for each id.

chartOfAccountIdsstring[]

Return only credits booked to these chart of accounts. Repeat the parameter for each id.

creditDate.startstring · date

Return only credits issued on or after this day. Give at least one of creditDate.start and creditDate.end, and start must not be after end.

creditDate.endstring · date

Return only credits issued on or before this day.

amount.fromnumber

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

amount.tonumber

Upper bound of the credit amount.

amount.includeFromboolean

Whether a credit equal to amount.from is included.

default: true
amount.includeToboolean

Whether a credit equal to amount.to is included.

default: true

Response

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

itemsManagementFeeCredit[]

The credits on this page.

currentPageinteger

The page this response is.

totalPagesinteger

How many pages the filter produces.

pageSizeinteger

How many credits a page holds.

totalCountinteger

How many credits match the filter across all pages.

bankAccountsobject[]

Every bank account referenced by the credits, resolved. Account and routing numbers are masked.

chartOfAccountsobject[]

Every chart of account referenced by the credits, resolved.

portfoliosobject[]

Every portfolio referenced by the credits, resolved.

propertiesobject[]

Every property referenced by the credits, resolved.

managementFeesobject[]

Every management fee the credits have been applied to, resolved.

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