Change a tenancy
update_tenancyChanges a tenancy, by its id from list_properties: its tenants, landlords, term, dates, weekly rent, bond, room or notes, such as a rent rise, a tenancy ending, or the bond being lodged or refunded. Its property never changes. tenant_contact_ids and landlord_contact_ids replace the lists it has now. Dates are New Zealand dates, yyyy-MM-dd; money is in NZD. 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. Needs the rental module switched on. Only for an organisation where this connection may add and change records (list_organisations says which). The answer is the changed tenancy.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| clear | No | Optional fields to empty, by parameter name, any of: landlord_contact_ids, end_date, bond_refunded_amount, bond_number, room_label, notes. | |
| notes | No | Free text kept with the tenancy. | |
| end_date | No | The New Zealand date it ends or ended, yyyy-MM-dd. | |
| term_type | No | fixed (an agreement with an end date) or periodic (ongoing until notice is given). | |
| room_label | No | The room rented, for a room-by-room tenancy. | |
| start_date | No | The New Zealand date the tenancy starts, yyyy-MM-dd. | |
| tenancy_id | Yes | The tenancy's id, from list_properties. | |
| bond_amount | No | The bond in NZD. | |
| bond_number | No | The Tenancy Services bond number, such as BN-12345678. | |
| bond_status | No | Where the bond stands: not-lodged, lodged (with Tenancy Services), refunded, or partially-refunded (give bond_refunded_amount). | |
| weekly_rent | No | The weekly rent in NZD. | |
| 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. | |
| tenant_contact_ids | No | Every tenant from now on: contact ids from list_contacts (contact type tenant). | |
| bond_refunded_amount | No | For a partially refunded bond: how much was refunded, in NZD. | |
| landlord_contact_ids | No | Every landlord on the bond from now on: contact ids from list_contacts (contact type landlord). |