What tags can I use in a custom tenancies document template?
When creating a Custom Document Template with 'generate for' set to 'Tenancy', you can use the tags below to automatically populate tenant, tenancy, and property details.
The following tags can be used in a Custom Document Template when 'generate for' is set to 'Tenancy'.
Important: Several tags marked below must be placed inside a table in your template. If used outside a table, the document will loop and repeat per the number of tenants or landlords linked to the tenancy.
Tenant tags
| Tag | What it displays | Notes |
|---|---|---|
[[Tenancy.DisplayTenants]] |
All tenant names displayed inline (e.g. John Davies, James Thomas, Lisa Brand) | |
[[Tenancy.Tenants]:GenerateName(Title/Forename/Surname)] |
All tenant names inline with title (e.g. Mr John Davies, Mr James Thomas, Miss Lisa Brand) | |
[[Tenancy.Tenants.DisplayName]] |
The individual tenant's name (e.g. James Davies) | Must be inside a table |
[[Tenancy.Tenants.EMailAddress]] |
The individual tenant's email address | Must be inside a table |
[[Tenancy.Tenants.MobilePhone]] |
The individual tenant's mobile number (e.g. 07546875982) | Must be inside a table |
[[Tenancy.Tenants.Title]] |
The individual tenant's title (e.g. Mr) | Must be inside a table |
[[Tenancy.Tenants.Forename]] |
The individual tenant's forename | Must be inside a table |
[[Tenancy.Tenants.Surname]] |
The individual tenant's surname | Must be inside a table |
Tenancy details tags
| Tag | What it displays |
|---|---|
[[Tenancy.GlobalReference]] |
The tenancy reference |
[[Tenancy.StartDate]] |
The tenancy start date |
[[Tenancy.EndDate]] |
The tenancy end date |
[[Tenancy.Rent]] |
The rent amount |
[[Tenancy.Deposit]] |
The deposit amount |
[[Tenancy.RentFrequency]] |
How often rent is charged (e.g. Monthly) |
Property tags
| Tag | What it displays |
|---|---|
[[Tenancy.TenancyProperty.Address1]] |
The first line of the property address |
[[Tenancy.TenancyProperty.Address2]] |
The second line of the property address |
[[Tenancy.TenancyProperty.Address3]] |
The third line of the property address |
[[Tenancy.TenancyProperty.Address4]] |
The fourth line of the property address |
[[Tenancy.TenancyProperty.Postcode]] |
The postcode of the property |
[[Tenancy.TenancyProperty.DisplayAddress]] |
The full address of the property displayed inline |
If you need assistance with custom tenancies document templates, contact support@agentos.com.