New Tenancy Setup Wizard
New Tenancy Setup Wizard
The tenancy setup wizard walks you through creating a new tenancy in five sequential stages. Your progress is automatically saved after every step, so you can exit and resume at any time without losing data.
Route: /dashboard/tenancies/new
Overview
| Stage | Name | Purpose |
|---|---|---|
| 1 | Property & Dates | Select property, tenancy type, start date, and contract length |
| 2 | Rent & Deposits | Set rent, auto-calculate deposits, preview rent schedule |
| 3 | Tenants & People | Add tenants, guarantors, and relevant persons |
| 4 | Costs & Payments | Review cost breakdown, manage holding deposit, configure task dispatch |
| 5 | Agreement | Choose contract template, add conditions, confirm and complete |
The stage indicator at the top of the page shows your current position and which stages are complete. You can click any stage in the indicator to jump to it — your current stage is saved automatically before navigating.
Stage 1 — Property & Dates
- Property: Search and select the property for this tenancy.
- Tenancy type: Choose one of:
- Assured Shorthold Tenancy (AST)
- Non-AST Tenancy
- Company Let
- HMO Tenancy
- Start date: The date the tenancy begins.
- Contract length: Duration in months (minimum 1).
Validation: A property, start date, and contract length are all required before you can proceed.
Stage 2 — Rent & Deposits
- Monthly rent: Enter the monthly rent in pounds. Deposits are calculated automatically:
- Holding deposit: 1 week's rent
- Security deposit: 5 weeks' rent
- Payment frequency: Monthly, weekly, or custom.
- Payment due day: The day of the month/week rent is due.
- Rent schedule preview: A pro-rata breakdown of the first and last months is shown before you commit.
Validation: A monthly rent greater than zero is required.
Stage 3 — Tenants & People
Tenants
Add one or more tenants. The first tenant is the lead tenant; additional tenants are joint tenants. Each tenant requires:
- First name
- Last name
- Email address
- Phone (optional)
Guarantors
Add guarantors with name, email, relationship to the tenant, and address (all optional except name).
Relevant Persons
Add any other relevant persons (e.g. local authority contacts) with a name, relationship, and optional notes.
All three lists support adding and removing entries freely.
Validation: At least one tenant with a valid first name, last name, and email is required.
Stage 4 — Costs & Payments
- Cost summary: A full breakdown of all charges associated with the tenancy.
- Holding deposit status: Choose one of:
- Request payment — sends a payment request to the lead tenant
- Mark as paid — record that the holding deposit has already been received (enter a reference)
- Waive — waive the holding deposit
- Todo task dispatch: Toggle whether todo tasks generated from your org's active templates are dispatched immediately on completion or deferred for later.
No validation is required to proceed from this stage.
Stage 5 — Agreement
- Contract template: Select from available templates. The list is filtered to templates compatible with the tenancy type you selected in Stage 1.
- Special conditions: Toggle to enable, then select from predefined conditions.
- Custom conditions: Add free-text custom clauses.
- Completion summary: A read-only review of all wizard data before you submit.
Click Complete Setup to finalise the tenancy.
What Happens on Completion
When you click Complete Setup, the following actions are performed atomically:
- Tenancy created in
pendingstatus. - Tenancy term created with landlord details resolved from the property record.
- Rent schedule generated — including pro-rata amounts for the first and last months.
- Deposit payment tasks created — for both the holding deposit and security deposit.
- Todo tasks dispatched — from your organisation's active todo templates (if immediate dispatch is enabled).
- Welcome emails sent — a branded welcome email is sent to every tenant via Resend.
- Audit trail recorded — all actions are logged for compliance.
- Redirect — you are taken directly to the new tenancy's overview page.
Draft Persistence
The wizard automatically saves your progress every time you navigate between stages. Drafts are stored per organisation, so:
- If you leave the page mid-way, the wizard will restore your last saved stage and data when you return to
/dashboard/tenancies/new. - Only one active draft exists at a time per organisation.
- A draft is marked completed once the tenancy is successfully created, or abandoned if you explicitly discard it.
Validation Rules Summary
| Stage | Required fields |
|---|---|
| 1 | Property, start date, contract length ≥ 1 month |
| 2 | Monthly rent > 0 |
| 3 | At least one tenant with first name, last name, and valid email |
| 4 | None |
| 5 | None |
Validation errors are displayed inline above the navigation buttons. You cannot advance to the next stage until all required fields for the current stage are valid.