Add tenant
add_tenantCreate a tenant record for a Lendlord property, capturing contact details, lease dates, rent schedule, deposit scheme, and optional guarantor or compliance fields.
Instructions
Add a tenant to a property. Optional fields may include: phone, mobile, dob, notes, unitName, tenancyStartDate, tenancyEndDate, firstPaymentDate, rentReviewDate (dates YYYY-MM-DD), rentReviewFrequency (Quarterly|Semi-Annually|Annually|Every 2 Years|Every 3 Years|Every 5 Years), generatePaymentScheduleFor (3 months|6 months|12 months|24 months), depositScheme (TDS|DPS|Mydeposits|Zerodeposits|FlatFair|SafeDeposits|Other), depositAmount, guarantor/rollingTenancy/inventoryUndertaken/legionellaInspectionRequired (Yes|No).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| No | |||
| fields | No | ||
| status | No | Actual | |
| confirm | No | Set true once the user has approved writes for this session | |
| propertyId | Yes | ||
| rentPayment | No | Rent amount per payment | |
| paymentFrequency | No |