Add a tenancy
create_tenancyAdds a tenancy: one or more tenants renting a rental property, or a room in it, from a start date at a weekly rent, with its bond. The property comes from list_properties (add a new one with create_property) and each tenant is a contact of type tenant from list_contacts (add a new tenant with create_contact first). A tenancy of the same property, tenants, room and start date is answered instead of added. Dates are New Zealand dates, yyyy-MM-dd; money is in NZD. 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 saved tenancy with its organisation's name; rent can then be added with create_income.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | No | Free text kept with the tenancy. | |
| end_date | No | The New Zealand date it ends, yyyy-MM-dd: a fixed term's end, or when a tenancy ended. Leave it out while it is ongoing. | |
| term_type | Yes | 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. Leave it out when the whole property is rented. | |
| start_date | Yes | The New Zealand date the tenancy starts, yyyy-MM-dd. | |
| bond_amount | No | The bond in NZD. Leave it out when there is none. | |
| bond_number | No | The Tenancy Services bond number, such as BN-12345678. | |
| bond_status | No | Where the bond stands: not-lodged (when left out), lodged (with Tenancy Services), refunded, or partially-refunded (give bond_refunded_amount). | |
| property_id | Yes | The rental property, from list_properties. When the person's words match more than one, or none, show them the closest and ask which they mean; never guess an id. | |
| weekly_rent | Yes | The weekly rent in NZD. | |
| 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. | |
| tenant_contact_ids | Yes | The tenants' 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 | The landlords on the bond: contact ids from list_contacts (contact type landlord). |