Useful merge codes

This guide has been reviewed against our global client base and classed as relevant to all regions

This page contains a list of merge codes that are not currently available in the Letter Template Editor (LTE)

Data	Merge code	Example output

Data	Merge code	Example output
Company attention name	<Applicant.CmpAttnName>	John Doe
Negotiator Image
Financial Services Permission Given	<Applicant.FSGiven ? "Yes" : "No">	Yes / No
Has made offers (sales only)	<Referral.Applicant.HasOffers ? "Yes" : "No">	Yes / No
Most Recent Offer Property Address	<Applicant.LastOffer.Property.Address.FullAddress>	Atlantic Terrace, New Polzeath, PL27 6UG

Contact related

Data	Merge Code	Example Output

Data

Merge Code

Example Output

Contact Categories

<Applicant.PrimaryContact.CategoryString.Replace("; ", Convert.ToChar(13).ToString())>

Age Range: 20-29, 30-39

Nationality: American Lists all ticked contact categories with each catagory on a seperate line. It is not possible to only list a specific category.

Requirements

Data	Merge Code	Example Output

Data	Merge Code	Example Output
List All Requirements	<Applicant.Requirements.ToString()>	House, 1+ Total Bedrooms, Share of freehold, Leasehold, Lease 30+ years, Areas: LEE,DEV
Areas List	<Applicant.Requirements.GetAreaOrAddressInfo()>	Areas: LEE,DEV
Lettings Tenure	<Applicant.Requirements.GetAttributeListValue (Applicant.Requirements.Department.LetTenureList, Applicant.Requirements.LetTenure, "tenure")>	Long Let
Sales Tenure	<Applicant.Requirements.GetAttributeListValue (Applicant.Requirements.Department.TenureList, Applicant.Requirements.Tenure, "tenure")>	Leasehold, Share of freehold

Landlord statement

Data	Merge Code	Example Output

Data	Merge Code	Example Output
Landlord's 1st property code	<Statement.Landlord.Properties[0].Code>	LDS140001
Individual item VAT rate	<VatRate.GetRate(StatItem.NomTran.VatCode, StatItem.NomTran.Date)>	20.00
Statement Notes - General statement notes	<Statement.Landlord.StatFloatNote>
Statement Notes - Per property note	<Statement.Layout == "PP" ? Statement.Landlord.GetPrpLldSettings (StatItem.PrpCode).GetValue("StmNote", "") : "">

Landlord & tenant invoices

Data	Merge Code	Example Output

Data

Merge Code

Example Output

Individual item VAT rate

<VatRate.GetRate(NomTran.VatCode,NomTran.Date)>

20.00

Associated Property Address

{script: if (Charge.Property != null && Charge.Property.IsPartial)

{ Charge.Property.Refresh(); } return (Charge.Property != null && String.IsNullOrEmpty(Charge.Property.Address.FullAddress) ? "Payment Receipt" : Charge.Property.Address.FullAddress);}

1 Park Court, 40 Park Cross Street, Leeds, LS1 2QH

Direct Debit

Data	Merge code	Example Output

Data	Merge code	Example Output
Tenant - Envelope Name	<DirectDebit.Tenant.EnvelopeName>	Mr J Doe
Tenant - All mailing salutations	<DirectDebit.Tenant.MailingSaltn>	Mr Doe
Tenant - Mailing Address (envelope format)	<DirectDebit.Tenant.MailingAddress.AddressWithReturns>	1 Park Court 40 Park Cross St Leeds LS1 2QH
Tenant - Bank Account Number	<DirectDebit.Tenant.MainAccount.AccountNum>	00000000
Tenant - Sort Code	<DirectDebit.Tenant.MainAccount.SortCode>	00-00-00
Direct Debit - Service User Number	<LoggedNegotiator.Config.DirectDebitServiceUserNo>	XXXXXX
Direct Debit - Next collection date	<DirectDebit.NextCollection.ToShortDateString()>	21/11/2016
Direct Debit - Amount	<Formatter.FormatPrice(DirectDebit.Amount, 2)>	£333.33
Direct Debit - Next Collection Date	<DirectDebit.Frequency == 1 ? (DirectDebit.FrequencyType == "M" ? "on or immediately after the " + Formatter.GetFullDateString(DirectDebit.NextCollection, "dd") + " day of each month" : "every " + DirectDebit.FreqTypeName.TrimEnd("s".ToCharArray())) : "every " + DirectDebit.Frequency.ToString() + " " + DirectDebit.FreqTypeName>	on or after the 21 day of the month
Direct Debit - Reference	<DirectDebit.Reference>	XXXXXXXX

Appointments

Data	Merge Code	Example Output

Data	Merge Code	Example Output
Created date	<Entry.Register.ToShortDateString()>	16/05/2016
Created by	<Entry.MadeBy.Name>	John Doe
Start time	<Entry.DateTime.ToShortTimeString()>	13:51
End time	<Entry.DateTime.AddMinutes (Entry.Duration).ToShortTimeString()>	14:51
Appointment type (in lower case)	<Entry.TypeName.ToLower()>	market appraisal
Appointment type, including the word "Appointment"	<Entry.TypeName + (Entry.TypeName.ToLower().Contains("appointment") ? "" : " Appointment")>	Market Appraisal Appointment
Appointment type, including the word "Appointment" (in lower case)	<(Entry.TypeName + (Entry.TypeName.ToLower().Contains("appointment") ? "" : " Appointment")).ToLower()>	Market appraisal appointment
Accompanied?	<Entry.UnAcc ? "Accompanied" : "Unaccompanied">	Accompanied Unaccompanied
Negotiator Image
Associated Contact Salutation	<!String.IsNullOrEmpty(Entry.TableCode) ? Entry.AssociatedContact.MailingSaltn : Entry.Property.AllMailingSaltns>	Mr Doe
Property Address (if a property has been added)	<!String.IsNullOrEmpty(Entry.PrpCode) ? Property.Address.FullAddress : "">	1 Park Court, 40 Park Cross Street, Leeds, LS1 2QH
Property URL	<String.IsNullOrEmpty(Entry.Property.URL) ? MergeHelper.MergeString(LoggedNegotiator.Config.PrpUrl, Entry.Property) : Entry.Property.URL>	http:// www.example .com /sales/ LDS140003

Additional negotiators

Data	Merge Code	Example Output

Data	Merge Code	Example Output
List all additional negotiator names	<script: string ret = ""; foreach (Negotiator otherNegotiator in Entry.OtherNegotiators) { ret += otherNegotiator.Name + ", "; } ret = Formatter.CleanList(ret); return ret;>	John Doe, Joe Bloggs
Negotiator 1 - Name	<Entry.OtherNegotiators[0].Name>	John Doe
Negotiator 1 - Title	<Entry.OtherNegotiators[0].Title>	Senior Negotiator
Negotiator 1 - Phone	<Entry.OtherNegotiators[0].GetPhone("b")>	0113 288 2903
Negotiator 1 - Email	<Entry.OtherNegotiators[0].GetPhone("e")>	jdoe@ example.com
Negotiator 1 - Address	<Entry.OtherNegotiators[0].Office.Address.FullAddress>	1 Park Court, 40 Park Cross St, Leeds LS1 2QH
Negotiator 1 - Image file path	<Entry.OtherNegotiators[0].ImgFilePath>	jdoe@ example.com

Tenancy guarantors (arranging tenancy only)

Data	Merge Code	Example Output

Data	Merge Code	Example Output
Additional tenant 1 - guarantor name	<Tenancy.GetTenantGuarantors()[1].Contact.Name>	John Doe
Additional tenant 1 - guarantor address	<Tenancy.GetTenantGuarantors()[1].Contact.Address.AddressWithReturns>	1 The Headrow Leeds LS1 1AA
Additional tenant 1 - guarantor email	<Tenancy.GetTenantGuarantors()[1].Contact.GetPhone("e")>	jdoe@ example.com
Additional tenant 1 - guarantor home	<Tenancy.GetTenantGuarantors()[1].Contact.GetPhone("h")>	0113 288 2903
Additional tenant 2 - guarantor name	<Tenancy.GetTenantGuarantors()[2].Contact.Name>	John Doe
Additional tenant 2 - guarantor address	<Tenancy.GetTenantGuarantors()[2].Contact.Address.AddressWithReturns>	1 The Headrow Leeds LS1 1AA
Additional tenant 2 - guarantor email	<Tenancy.GetTenantGuarantors()[1].Contact.GetPhone("e")>	jdoe@ example.com
Additional tenant 2 - guarantor home	<Tenancy.GetTenantGuarantors()[1].Contact.GetPhone("h")>	0113 288 2903

Tenancy guarantors (current tenancy only)

Data	Merge Code	Example Output

Data	Merge Code	Example Output
Additional tenant 1 - guarantor name	<Tenancy.GetTenantGuarantors(Tenancy.Tenants[1])[0].Contact.Name>	John Doe
Additional tenant 1 - guarantor address	<Tenancy.GetTenantGuarantors(Tenancy.Tenants[1])[0].Contact.Address.AddressWithReturns>	1 The Headrow Leeds LS1 1AA
Additional tenant 1 - guarantor email	<Tenancy.GetTenantGuarantors(Tenancy.Tenants[1])[0].Contact.GetPhone("e")>	jdoe@ example.com
Additional tenant 1 - guarantor home	<Tenancy.GetTenantGuarantors(Tenancy.Tenants[1])[0].Contact.GetPhone("h")>	0113 288 2903
Additional tenant 2 - guarantor name	<Tenancy.GetTenantGuarantors(Tenancy.Tenants[2])[0].Contact.Name>	John Doe
Additional tenant 2 - guarantor address	<Tenancy.GetTenantGuarantors(Tenancy.Tenants[2])[0].Contact.Address.AddressWithReturns>	1 The Headrow Leeds LS1 1AA
Additional tenant 2 - guarantor email	<Tenancy.GetTenantGuarantors(Tenancy.Tenants[2])[0].Contact.GetPhone("e")>	jdoe@ example.com
Additional tenant 2 - guarantor home	<Tenancy.GetTenantGuarantors(Tenancy.Tenants[2])[0].Contact.GetPhone("h")>	0113 288 2903

Guarantor screen letters

Data	Merge Code	Example Output

Data	Merge Code	Example Output
Guarantor name	<Extra.Contact.Name>	John Doe
Guarantor address	<Extra.Contact.Address.AddressWithReturns>	1 The Headrow Leeds LS1 1AA
Guarantor email	<Extra.Contact.GetPhone("e")>	jdoe@ example.com
Guarantor home phone	<Extra.Contact.GetPhone("h")>	0113 288 2903

Data	Merge Code	Example Output

Data	Merge Code	Example Output
Landlord Registration Details	<Property.Lettings.GetLandlordRegistration().ID1>	LL1456789
Joint Landlord Registration Number	`<script: Contact secLandlord =` `Property.Lettings.Landlord.` `GetJointLandlord(0); if` `(secLandlord != null && secLandlord.` `IDChecks.Count!= 0 &&` `Property.LocalAuthority != null)` `{ IDCheck idchk = (from ci in` `secLandlord.IDChecks` `orderby ci.ID1Expire descending` `where ci.IsRegistration` `&& ci.Active && ci.RegCode ==` `Property.LocalAuthority.Code` `select ci).FirstOrDefault();` `return idchk != null ? idchk.` `ID1 : ""; } return ""; >`	LL1456790
NOTES	`1.To pull though, the Property must exist 2.the property cannot be 'Newly Added' 3.the Property Must have a Local Authority 4.There must be a Landlord Primary Contact 5.ID Check must be a Landlord Registration 6.it must be ACTIVE`

Knowledge Base