MagicDoorAPI
SupportOpen MagicDoor
Tenants

List a tenant's auto payments

Returns the standing instructions this tenant has for paying rent automatically, each with the lease, unit, property and portfolio it pays for. There is no paging.

GET
https://api.portal.magicdoor.com/company-app/tenants/{tenantId}/auto-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.

Path parameters

tenantIdstringrequired

The tenant. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

Response

200 · The tenant's auto payments. An empty array when they have none.

idstring

The auto payment instruction.

tenantPaymentAccountIdstringdeprecated

The tenant payment account the money is taken from.

paymentMethodIdstring

The payment method the money is taken from.

typeenum<string>

What gets paid: fixedAmount pays fixedAmount every time, postedBalance pays what has been posted to the ledger, currentBalance pays the whole current balance.

fixedAmountpostedBalancecurrentBalance
fixedAmountdecimal

The amount taken each time, when type is fixedAmount.

maximumAmountdecimal

A ceiling on what may be taken. Absent when there is no ceiling.

frequencyenum<string>

How often it runs.

monthlyweeklydailymonthly2XSplitquarterlyyearly
startstring · date

First date the instruction is in force.

endstring · date

Last date it is in force. Absent when it runs until cancelled.

lastPaymentstring · date

Date it last took money. Absent when it never has.

nextPaymentstring · date

Date it will next take money. Absent when nothing further is scheduled.

leaseobject

The lease being paid.

tenantobject

The tenant paying.

portfolioobject

The portfolio the lease sits in.

propertyobject

The property the lease is for.

unitobject

The unit the lease is for.

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