List income records
list_incomeLists income records. Each is one amount received, with its date, the contact who paid it and its income type: commission income names the contractor who earned it; rent and tenant reimbursements name the property and tenancy. Amounts are what was received, in NZD; commission records also show the GST within the amount and taxapp's indicative KiwiSaver, ACC levy, income tax and take-home. Every record names its property (propertyId and propertyName). A short stay's paid is the payout that reached the bank: its income is shortStay.guestPaid, and its nights count once per booking (a deposit and its balance share one booking reference). Each short stay also has its platform fees, flat-rate credit, booking reference, check-in and check-out, guests, the main guest's name, whether it was cancelled, stayStarted (the guest's stay has begun) and gstTreatment (standard: the GST shown is in what the guest paid; zeroRated: a platform that charges guests GST sold it for a registered host; notRegistered: no GST). A short-stay refund takes its guestPaid off the income; it is never income itself. To list one property's stays, give property_id and income_type shortStay. Filter by tax year, type, contact, contractor, property, tenancy or dates. Pages of up to 500: the answer gives items, total, offset and limit.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_income"
}
}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. | |
| tenancy_id | No | Only rent and reimbursements under this tenancy, from list_properties. | |
| income_type | No | Only this income type: commission (a contractor's commission income), rental (rent from a tenancy), tenantReimbursement (a tenant repaying a bill the owner paid), shortStay (a payout for a stay booked through a platform such as Airbnb, or directly) or shortStayRefund (money given back to a short-stay guest). Short stays are offered only while the organisation has them switched on. | |
| property_id | No | Only records for this rental property, from list_properties. | |
| 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. | |
| contractor_contact_id | No | A contractor's contact id, from list_contacts (contact type contractor), for one contractor's figures. |