Get Tenant Ledger
get_tenant_ledgerA resident's charge / payment / credit history with their current balance.
Use for "show this resident's payment history", "what has this tenant been
charged", "what does tenant X currently owe", "ledger for tenant X". Pulls
the tenant's transaction ledger and renders it newest-first with per-period
subtotals (charged / paid / credits), plus Rent Manager's authoritative
current balance. Find the TenantID with list_tenants. Optional
start_date / end_date (MM/DD/YYYY) window the history; limit
caps the lines shown (default 40, max 200).
``location`` (optional): a Rent Manager Location ID, a comma-separated
list, or ``"all"`` to run across every Location on this connection (see
``list_locations``). Blank = all Locations if the connection has several,
else its only Location. Output is labelled per Location; a Location that
can't be reached is listed as skipped. IDs (property, tenant, ...) belong
to one Location, so pass that Location when you filter by one.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| end_date | No | ||
| location | No | ||
| tenant_id | Yes | ||
| start_date | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |