To download a bundle of sample Word (docx) documents click here.
To view a comprehensive list of placeholders, or “hooks”, click here.
To expand each section, click the headings below.
Top-level Placeholders
BDP Top-level placeholders
| Placeholder |
Type |
Example usage |
Description |
| vendorDetails |
Contact Group Array |
[var.vendorDetails.clientRef] |
All vendor and vendor contact data. See vendorDetails.primaryContact for main contact details. |
| vendorDetails.primaryContact |
Contact Array |
[var.vendorDetails.primaryContact.salutation] |
Primary contact of the property vendor. See Contacts section for full set of data available |
| propertyDetails |
Property Details Array |
[var.propertyDetails.postcode] |
All property details. See Property Details section for full information. |
| docDate |
String |
[var.docDate] |
Document creation date |
| preambleText |
String |
[var.preambleText] |
Preamble manually entered into input box |
| fees |
Fees array |
[var.fees.feeTotal] |
Full breakdown of fees calculated. |
| refDoc.docDate |
String |
[var.refDoc.docDate] |
Formatted date for the date of the referral document. Used in the case of a reminder letter referring to the date of original |
| askingPrice |
String |
[var.askingPrice] |
Asking price for the property |
Fees Placeholders
| Placeholder |
Type |
Example usage |
Description |
| saleLegalFees |
String |
[var.fees.saleLegalFees] |
Legal Fees (Sale) |
| vatSaleLegalFees |
String |
[var.fees.vatSaleLegalFees] |
|
| saleAgencyFees |
String |
[var.fees.saleAgencyFees] |
|
| vatSaleAgencyFees |
String |
[var.fees.vatSaleAgencyFees] |
VAT on agency sale fees |
| saleOutlays |
String |
[var.fees.saleOutlays] |
Total of all sale fee outlays |
| purchaseLegalFees |
String |
[var.fees.purchaseLegalFees] |
Legal fees on purchase |
| vatPurchaseLegalFees |
String |
[var.fees.vatPurchaseLegalFees] |
VAT on purchase legal fee |
| purchaseOutlays |
String |
[var.fees.purchaseOutlays] |
Total purchase outlays |
| purchaseGrandTotal |
String |
[var.fees.purchaseGrandTotal] |
Total of all purchase fees, legal and outlays |
| feeTotal |
String |
[var.fees.feeTotal] |
Total of all fees, both sale and purchase |
| bd |
Fee part array |
[var.fees.bd.registerDeeds.outputVal] |
See Fee Parts section below |
| purchasePrice |
String |
|
Base purchase price for all calculations |
Fee part placeholders
- Placeholders for each fee part can be specified as ‘hook’ in the Fee Configuration widget. Each part is called using [var.fees.bd.’hook’.placeHolder]. The examples below use the hook ‘registerDeeds’
| Placeholder |
Type |
Example usage |
Description |
| defaultInput |
String |
[var.fees.bd.registerDeeds.defaultInput] |
Default input for the part, say default comission is 1.5% |
| defaultVal |
String |
[var.fees.bd.registerDeeds.defaultVal] |
Value given, if the default value to be used |
| feeValInput |
String |
[var.fees.bd.registerDeeds.feeValInput] |
Input used to calculate the fee, this can be manually entered on the property and override the defaultInput |
| outputVal |
String |
[var.fees.bd.registerDeeds.outputVal] |
The actual value for the fee part. |
| partName |
String |
[var.fees.bd.registerDeeds.partName] |
The label for the fee part. Most likely ‘Register Title Deeds’ in this case |
Contact groups placeholders
| Placeholder |
Type |
Example usage |
Description |
| primaryContact |
Contacts array |
[var.vendorDetails.primaryContact.salutation] |
Primary contact of any given contact group |
| allContacts |
Array |
[var.vendorDetails.allContacts.1.fullName] |
Array containing the contact arrays for all contacts in a group |
| people |
Array |
[var.vendorDetails.allContacts.1.fullName] |
Array containing the contact arrays for all contacts in a group. This does not include the mail contact. |
| clientRef |
String |
[var.vendorDetails.clientRef] |
Internal reference for a client, often the id used by a case management system |
Contacts placeholders
| Placeholder |
Type |
Example usage |
Description |
| salutation |
String |
[var.vendorDetails.primaryContact.salutation] |
Salutation. Defaults to ‘title lastName’ if both title and lastName are present, otherwise ‘firstName lastName’. |
| cTitle |
String |
[var.vendorDetails.primaryContact.cTitle] |
Title – Mr., Mrs., Dr., etc. |
| foreName |
String |
[var.vendorDetails.primaryContact.foreName] |
First name |
| surname |
String |
[var.vendorDetails.primaryContact.surname] |
Last name |
| houseNo |
String |
[var.vendorDetails.primaryContact.houseNo] |
House name or number |
| StreetName |
String |
[var.vendorDetails.primaryContact.streetName] |
Street name |
| addrL2 |
String |
[var.vendorDetails.primaryContact.addrL2] |
Address line 2 |
| addrL3 |
String |
[var.vendorDetails.primaryContact.addrL3] |
Address line 3 |
| town |
String |
[var.vendorDetails.primaryContact.town] |
Post town or city |
| postcode |
String |
[var.vendorDetails.primaryContact.postcode] |
Post code |
| email1 |
String |
[var.vendorDetails.primaryContact.email1] |
Primary email address |
| email2 |
String |
[var.vendorDetails.primaryContact.email2] |
Secondary email address |
| tel1 |
String |
[var.vendorDetails.primaryContact.tel1] |
Primary telephone number |
| tel2 |
String |
[var.vendorDetails.primaryContact.tel2] |
Secondary telephone number |
| mobile |
String |
[var.vendorDetails.primaryContact.mobile] |
Mobile number |
Property placeholders
| Placeholder |
Type |
Example usage |
Description |
| houseNo |
String |
[var.propertyDetails.houseNo] |
House name or number |
| StreetName |
String |
[var.propertyDetails.streetName] |
Street name |
| addrL2 |
String |
[var.propertyDetails.addrL2] |
Address line 2 |
| addrL3 |
String |
[var.propertyDetails.addrL3] |
Address line 3 |
| town |
String |
[var.propertyDetails.town] |
Post town or city |
| postcode |
String |
[var.propertyDetails.postcode] |
Post code |
| dispAddress |
String |
[var.propertyDetails.dispAddress] |
Display address as entered in address widget |
| formatAddress |
String |
[var.propertyDetails.formatAddress] |
Full formatted address including post code |
Failed Emails and Deferred Emails