List expense records
list_expensesLists expense records. Each is one bill or cost with its date and due date, the supplier contact, its expense type, the expense account it is filed under (its category, with the IRD return line it feeds), the amount in NZD, the property for a rental cost, and the people liable for it (the contractors or property owners whose figures it reduces). Filter by tax year, type, account, contact, property or dates. Pages of up to 500: the answer gives items, total, offset and limit.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | The last New Zealand date to include, yyyy-MM-dd. | |
| from | No | The first New Zealand date to include, yyyy-MM-dd. | |
| limit | No | How many records to return, 1 to 500. The default is 100. | |
| offset | No | How many records to skip, to page through a long list: the answer's total says how many there are. The default is 0. | |
| tax_year | No | The New Zealand tax year, named by the year it ends in: 2026 is 1 April 2025 to 31 March 2026. Leave it out for the current tax year. | |
| contact_id | No | Only records with this contact (the payer or supplier), from list_contacts. | |
| property_id | No | Only records for this rental property, from list_properties. | |
| expense_type | No | Only this expense type: rental (a rental property's costs), commission (costs of a contractor's work) or household (the household's own costs). | |
| organisation_id | No | The id of the organisation to use, from list_organisations. Leave it out when the connection covers only one organisation; it is required when it covers more than one. | |
| expense_account_id | No | Only expenses filed under this expense account, from list_expense_accounts. |