Add an income record
create_incomeAdds one income record: money the organisation received. Commission income names the contractor who earned it (contractor_contact_id) and the business that paid it (contact_id). Rent and tenant reimbursements name the tenant who paid (contact_id) and the tenancy or property; a tenant reimbursement can also name the rental bill it pays back (reimbursed_expense_id, from list_expenses). Match the income type with list_choices, and look every id up first with list_contacts, list_properties and list_expenses; When the person's words match more than one, or none, show them the closest and ask which they mean; never guess an id. Add a missing payer with create_contact. Only for an organisation where this connection may add and change records (list_organisations says which). The answer is the saved record with its organisation's name; tell the person what was added and where. Send only the amount received: taxapp works out GST, KiwiSaver, the ACC levy, income tax and take-home from it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| paid | Yes | The amount received in NZD, as it arrived (including any GST). | |
| notes | No | Free text kept with the record, such as the invoice number ("Invoice number: 1234"). | |
| contact_id | Yes | The contact who paid: the paying business for commission, the tenant for rent. | |
| tenancy_id | No | Rent and reimbursements: the tenancy the payment is under, from list_properties. | |
| income_date | Yes | The New Zealand date the money was received, yyyy-MM-dd. | |
| income_type | Yes | commission (a contractor's commission income), rental (rent from a tenancy) or tenantReimbursement (a tenant repaying a bill the owner paid). | |
| property_id | No | Rent and reimbursements: the rental property, from list_properties. | |
| allow_duplicate | No | Adding is safe to repeat: the same details sent again return the record already made. Set true only when the person confirms they really want a second, identical record. | |
| 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 | Commission only: the contractor who earned it, from list_contacts. | |
| reimbursed_expense_id | No | Tenant reimbursements only: the rental bill the tenant is paying back, an expense record from list_expenses (expense type rental, same property). |