Buildium List Lease Transactions
buildium_list_lease_transactionsRetrieve posted charges and payments for a lease to review its financial activity. Use all_pages for accurate totals and count_only for transaction counts.
Instructions
List financial transactions (posted charges and payments) for a lease.
For the lease's recurring rent amount use buildium_list_leases instead — it is already on every row under AccountDetails.Rent.
Set all_pages=true when totalling a ledger, and count_only=true to learn only how many transactions there are.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Records per page, 1-1000. | |
| fields | No | Keep only these top-level fields in each record, e.g. ["Id", "Name"]. Buildium records are large and carry tax IDs and addresses you may not need. | |
| offset | No | How many records to skip. Use next_offset from the previous page. | |
| lease_id | Yes | The lease's ID. | |
| all_pages | No | Follow pagination and return the records, up to 1000. Use it for totals and other aggregates; a figure from one page is wrong whenever there is more than one page. | |
| count_only | No | Follow every page, up to 100,000 records, and return only how many there are. Use it for "how many" questions. | |
| exclude_fixtures | No | Leave out test records, whose names start with the fixture prefix (see buildium_health). When any are present the response says so either way. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||