Function TenancyData
Obtain the tenancy data
TenancyData([ID],[SOURCE],[OPTION],[DATA],[DELIMITER],[DATE])
Parameters
# | Type | Passing | Default | Name | Description/Comments |
---|---|---|---|---|---|
1 | string | required | n/a | ID | The identifier of the record to use |
2 | integer | optional | 1 | SOURCE | The source record where 1=Property, 2=Contract, 3=Client, 4=Tenant |
3 | integer | optional | 1 | OPTION | The filter option where 1=Tenants, 2=Lead Tenant, 3=Guarantors, 4=Lead Tenant Guarantors, 5=All, 6=Non Lead Tenants, 7=Non Lead Tenant Guarantors |
4 | integer | optional | 1 | DATA | The data to return 1=Email Address, 2=Mobile, 3=Client Code, 4=Client Code (Email Exists), 5=Client Code (Mobile Exists), 6=Names |
5 | string | optional | ; | DELIMITER | The delimiter to use in between each item found |
6 | datetime | optional | null | DATE | Filters against records where the date lies within the tenancy |
Example
The following example shows how to get the guarantor emails
{{TenancyData(ALIAS.CONCODE,2,3,1)}}