MagicDoorAPI
SupportOpen MagicDoor
Accounting dashboard

Get the online payments summary

Returns what share of the last 30 days of tenant payments came in online rather than by cash, check or money order.

GET
https://services.magicdoor.com/accounting/company-portal/dashboard/online-payments

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

skipCacheboolean

Set true to recompute instead of reading the cached figure. The fresh result is still written back to the cache, which holds for an hour.

default: false

Response

200 · The online payment figures.

totalLeasePaymentsinteger

How many incoming lease charge and lease deposit transactions there were in the last 30 days.

onlineLeasePaymentsinteger

How many of those arrived through an online channel.

onlinePercentagenumber

onlineLeasePayments over totalLeasePayments as a percentage, rounded to two decimals. 0 when totalLeasePayments is zero.

onlinePercentageAveragenumber

The fixed industry benchmark to compare against. Always 83.

401 · The access token is missing, expired, or not for this company.

403 · The access token is not for a property manager.

What counts as a lease payment, and what counts as online

Every incoming, non-deleted transaction dated in the last 30 days whose identity is a lease charge or a lease deposit is counted. A payment is online when it arrived through Plaid, Stripe, MagicDoor's own processing, or Zelle; anything else — including transactions recorded as offline — is not.

`onlinePercentageAverage` is a fixed benchmark

It is a constant 83, there for the dashboard to draw a comparison line against. It is not computed from any data, does not vary by company, and does not move over time.

Cached

The answer is cached per company for an hour, so it can lag activity by that much. Pass skipCache=true to force a recompute.