Lease charges

List recurring charges

Returns the repeating charges set up on the lease — rent, parking, pet rent and the like — each with when it last ran and when it runs next. Charges that have already finished are left out unless you ask for them.

GET
https://api.portal.magicdoor.com/company-app/leases/{leaseId}/charges/recurring-charges

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

leaseIdstringrequired

The lease whose recurring charges you want. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

Query parameters

includeEndedboolean

Set to true to include recurring charges that have already finished.

default: false
chartOfAccountIdsstring[]

Only recurring charges booked to any of these accounts.

Response

200 · The recurring charges on the lease.

recurringChargesRecurringLeaseCharge[]

The recurring charges.

400 · The request failed validation. `errors` maps each field name to what was wrong with it.

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

404 · No lease matched the id, or it belongs to another company.