MagicDoorAPI
SupportOpen MagicDoor
Company invoices

List MagicDoor credits

Returns a page of the credits MagicDoor has granted the management company against its invoices, and which invoices each has been used on. Credits are created by MagicDoor staff; there is no endpoint here to create, change or delete one.

GET
https://api.portal.magicdoor.com/company-app/invoices/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
creditDate.startstring · date

Return only credits granted 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 granted 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.

itemsMagicDoorBillCredit[]

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 to their last four digits.

chartOfAccountsobject[]

Every chart of account referenced by the credits, resolved.

magicDoorBillsobject[]

Every invoice the credits have been applied to, resolved.

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