Change an income record
update_incomeChanges an income record that is already there, by its id from list_income: when the money arrived, how much, who paid it, the contractor, property, tenancy, the bill a reimbursement pays back, or its notes. Its income type never changes. Send only what the person tells you: taxapp works out GST, KiwiSaver, the ACC levy, income tax and take-home from the amount again, exactly as the app does. Give only what changes: every parameter left out keeps the value the record has now. Read the record first, and confirm the change with the person before making it. A record sent to Xero keeps its amount and date. Only for an organisation where this connection may add and change records (list_organisations says which). The answer is the changed record as list_income shows it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| paid | No | The amount received in NZD, as it arrived (including any GST). | |
| clear | No | Optional fields to empty, by parameter name, any of: property_id, tenancy_id, reimbursed_expense_id, notes. | |
| notes | No | Free text kept with the record, such as the invoice number ("Invoice number: 1234"). | |
| income_id | Yes | The income record's id, from list_income. | |
| contact_id | No | The contact who paid, from list_contacts. | |
| tenancy_id | No | Rent and reimbursements: the tenancy, from list_properties. | |
| income_date | No | The New Zealand date the money was received, yyyy-MM-dd. | |
| property_id | No | Rent and reimbursements: the 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 | Commission only: the contractor who earned it, from list_contacts. | |
| reimbursed_expense_id | No | Tenant reimbursements only: the rental bill it pays back, from list_expenses. |