Lease charges

Get the charge ledger

Returns the running rent ledger for the lease: every charge, late fee, credit, payment and transfer in order, each with the balance after it, plus the totals at the top.

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

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 ledger you want. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

Query parameters

limitinteger

How many entries to return, between 1 and 300. Leave it out for the server default.

asOfstring · date-time

Only entries up to this instant, so you can see the ledger as it stood on a past date.

Response

200 · The ledger.

currentBalancenumber

What is owed right now, counting money that has not settled.

postedBalancenumber

What is owed counting only settled money.

currentlyProcessingInnumber

Money on its way in that has not settled.

currentlyProcessingOutnumber

Money on its way out that has not settled.

creditIssuednumber

Total credit ever issued on this lease.

creditAppliednumber

How much of that credit has been used.

creditAvailablenumber

How much credit is still unused.

lastPaymentDatestring · date

Date of the most recent payment.

earliestUnpaidChargeDueDatestring · date

Due date of the oldest charge still owing.

entriesLeaseChargeLedgerEntry[]

The ledger lines, in order.

bankAccountsBankAccount[]

Bank accounts referenced above.

chartOfAccountsChartOfAccount[]

Chart-of-account records referenced above.

tenantsTenant[]

The tenants referenced by the entries.

subsidizersSubsidizer[]

The subsidizers referenced by the entries.

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.