Learn the definitions of MRI Vault merge fields for Word document templates.
This article covers:
- About merge fields
- Contact/Owner/Landlord
- Marketing Contact #1 (Contact/Owner/Landlord)
- Marketing Contact #12 (Contact/Owner/Landlord)
- Property
- Offers (UK and NZ only)
- Tenant/Purchaser
- Guarantor (UK)
- Financials: Sales
- Financials: Sales (inc Commercial Leasing)
- Sample use of Offer Conditions
- Vendor solicitor
- Purchaser solicitor
- Basic details
- Current user
- Agent #1
- Agent #2
- Owner report specific fields
- Date fields
- Available date formats
- Appendix A - Image placeholders
- Appendix B - Change graph format
About merge fields
- Merge fields must be in lower case
- The list of merge fields below is currently a subset of those found in cloud Letters; however, over time, there will be parity between cloud letter merge fields and Word document merge fields
- Owner/vendor report templates must be placed into the owner reports folder for visibility (in Owner Feedback) when creating such a report
MRI Vault merge fields for Word document templates
Contact/Owner/Landlord
| Title | $$title$$ |
| First Name | $$firstname$$ |
| Last Name | $$lastname$$ |
| Company | $$company$$ |
| Greeting | $$greeting$$ |
| EnvGreeting | $$envgreeting$$ |
| Position | $$position$$ |
| Legal Description | $$legaldescription$$ |
| Partner Title | $$partnertitle$$ |
| Partner First Name | $$partnerfirstname$$ |
| Partner Last Name | $$partnerlastname$$ |
| Bank Details | $$bankdetails$$ |
| Landlords Details Tab (UK) | $$landlordstyle1$$ |
| Australia/New Zealand (ONLY) | |
| ABN | $$abn$$ |
| ACN | $$acn$$ |
| Unit | $$unit$$ |
| Street Number | $$streetnum$$ |
| Street Name | $$streetname$$ |
| Suburb | $$suburb$$ |
| State/Territory | $$cstate$$ |
| Full Address | $$fulladdress$$ |
| Postal Unit | $$punit$$ |
| Postal Street Number | $$pstreetnum$$ |
| Postal Street Name | $$pstreetname$$ |
| Postal Suburb | $$psuburb$$ |
| Postal Postcode | $$ppostcode$$ |
| State/Territory | $$pstate$$ |
| Full Address (AU/NZ/UK) | $$fulladdress$$ |
| Postal Full Address (AU/NZ/UK) | $$pfulladdress$$ |
| UK Full Address (formatted with line breaks) | $$fulladdressf$$ |
| UK Postal Full Address (with line breaks) | $$pfulladdressf$$ |
| Fax | $$fax$$ |
| Home Phone | $$home$$ |
| Mobile | $$mobile$$ |
| Work Phone | $$work$$ |
| $$email$$ | |
| Next Appointment | $$nextappointment$$ |
| Additional Owners full name | $$owner1$$, $$ownert2$$, $$owner3$$... etc. (Up to eight) |
| Additional Owners email | $$oemail1$$, $$oemail2$$, $$oemail3$$... etc. (Up to eight) |
| Additional Owners phone | $$ophone1$$, $$ophone2$$, $$ophone3$$... etc. (Up to eight) |
Marketing Contact #1 (Contact/Owner/Landlord)
| First Name | $$mfirstname1$$ |
| Last Name | $$mlastname1$$ |
| Position | $$mposition1$$ |
| Mobile | $$mmobile1$$ |
| $$memail1$$ | |
| Telephone | $$mtelephone1$$ |
… Caters for Marketing Contact #2 → #12
Marketing Contact #12 (Contact/Owner/Landlord)
| First Name | $$mfirstname12$$ |
| Last Name | $$mlastname12$$ |
| Position | $$mposition12$$ |
| Mobile | $$mmobile12$$ |
| $$memail12$$ | |
| Telephone | $$mtelephone12$$ |
Property
| Australia / New Zealand (ONLY) | |
| Unit | $$propunit$$ |
| Street Number | $$propstreetnum$$ |
| Street Name | $$propstreetname$$ |
| Street Number & Name | $$propstreetaddress$$ |
| Suburb | $$propsuburb$$ |
| State/Territory | $$propstate$$ |
| Postcode | $$proppostcode$$ |
| Full Property Address (single line AU/NZ/UK) | $$propfulladdress$$ |
| UK Property Address (formatted with line breaks) | $$ukaddressf$$ |
| Publish Address - Display Address | $$publishaddress$$ |
| Property ID | $$propertyid$$ |
| Life ID | $$lifeid$$ |
| Ref ID | $$propertyrefid$$ |
| Web ID (NZ) | $$propertywebid$$ |
| Property Class (e.g. Residential, Commercial, Rural...) | $$propertyclass$$ |
| Bedrooms | $$bed$$ |
| Bathrooms | $$bath$$ |
| Carspaces | $$carspaces$$ |
| KeyID | $$keyid$$ |
| KeyID Details | $$keyiddetails$$ |
| Legal - Lot # | $$proplot$$ |
| Legal - Plan # | $$proprpdp$$ |
| Volume | $$propvolume$$ |
| Folio | $$propfolio$$ |
| Legal - Certificate of Title | $$propcertificate$$ |
| Rateable Value (NZ) | $$proprateablevalue$$ |
| Garages | $$garages$$ |
| Carports | $$carports$$ |
| Open Parking Spaces | $$openspaces$$ |
| Property Status | $$propertystatus$$ E.g. “For Sale”, “For Lease”, “Auction”, etc. |
| Price | $$price$$ Visible Price |
| Price Formatted | $$pricef$$ E.g. $250,000 |
| Visible Price | $$visibleprice$$ |
| Year Built | $$yearbuilt$$ |
| Main Photo | $$mainphoto$$ |
| Main Photo (Placeholder) | $$mainphotoplaceholder$$ If using this merge field, refer to the instructions in Section “Image Placeholders” |
| Publishing Heading Description | $$heading$$ |
| Publishing Description | $$description$$ |
| Publish Price From | $$publishpricefrom$$ |
| Price Text | $$pricetext$$ |
| POA | $$poa$$ |
| Auction Date | $$auctiondate$$ |
| Auction Time | $$auctiontime$$ |
| Auction Venue | $$auctionvenue$$ |
| Auctioneer | $$auctioneer$$ |
| Appraisal Price (lower) | $$appraisalprice$$ |
| Appraisal Price (upper) | $$appraisalpriceupper$$ |
| Appraisal Date | $$appraisaldate$$ |
| Appraisal Time | $$appraisaltime$$ |
| Council Rates | $$councilrates$$ |
| Water Rates | $$waterrates$$ |
| Strata Rates | $$stratarates$$ |
| Land Area | $$landarea$$ |
| Land Area Type | $$landareatype$$ |
| Building/Floor Area | $$buildingarea$$ |
| Building/Floor Area Type | $$buildingareatype$$ |
| UK Price Qualifier | $$pricequalifier$$ |
| Agreed Selling Fee % Inc GST | $$sellingfeepercent$$ |
| Agreed Selling Fee Fixed Inc GST | $$sellingfeefixed$$ |
| Agreed Selling Fee % Exc GST | $$sellingfeepercentexc$$ |
| Agreed Selling Fee Fixed Exc GST | $$sellingfeefixedlessgst$$ |
| Estimated Commission based on Fee and List price (Inc GST) | $$estcommissioninc$$ |
| Estimated Commission based on Fee and List price (Exc GST) | $$estcommissionexc$$ |
| UK Tenure Type | $$tenuretype$$ |
| Tender Date | $$tenderdate$$ |
| Tender Time | $$tendertime$$ |
| Tender DateTime | $$tenderdatetime$$ e.g 19/04/2022 16:30:00 |
| Sale DateTime | $$setsaledatetime$$ e.g 19/04/2022 16:30:00 |
| UK Local Authority | $$localauthority$$ |
| Arrears | $$arrears$$ If the vacate date is defined and the vacate date is greater than the “Rent Paid Until” date, the arrears amount will be calculated up to the Vacate Date |
| Paid To Date | $$paidtodate$$ |
| Vacate Date | $$vacatedate$$ |
| Tenancy Outstanding Amount (if Vacate Date defined) |
$$tenancyoutstanding$$ |
| Tenancy Outstanding Breakdown (if Vacate Date defined) |
$$tenancyoutstandingbreakdown$$ |
| Rent Amount | $$baserent$$ |
| Tenancy Start | $$tenancystart$$ |
| Original Tenancy Start | $$originaltenancystart$$ |
| Tenancy End | $$tenancyend$$ |
| Electricity Meter reading - Start | $$electricitymeterreadingstart$$ |
| Electricity Meter reading - End | $$electricitymeterreadingend$$ |
| Gas Meter reading - Start | $$gasmeterreadingstart$$ |
| Gas Meter reading - End | $$gasmeterreadingend$$ |
| Water Meter reading - Start | $$watermeterreadingstart$$ |
| Water Meter reading - End | $$watermeterreadingend$$ |
| Next Routine Inspection Date | $$routineinspection$$ E.g. Fri 07 Feb 2020 (morning) |
| Outgoing Inspection | $$outgoinginspection$$ |
| Rent Frequency | $$rentfrequency$$ |
| Has Pets | $$haspets$$ |
| Pet Details | $$petdetails$$ |
| Rental Type (E.g. Management) | $$rentaltype$$ |
| Holding Fee 1 week (UK) | $$holdingfee1week$$ |
| Break Lease Date | $$breakleasedate$$ |
| Furnished | $$furnished$$ |
| Renewal Fee | $$renewalfee$$ |
| Deposit | $$deposit$$ |
| Tenancy Length | $$tenancylength$$ |
| Offer Conditions | $$offerconditions$$ |
| Rent Review | $$rentreview$$ |
| Total Invoices Due | $$totalinvoicesdue$$ |
| Tenant Invoices | $$tenantinvoices$$ |
Offers (UK and NZ only)
| Offer Date | $$offerdate$$ |
| Offer Price | $$offerprice$$ |
| Offer Details / Conditions | $$offerdetails$$ |
| Offer - Applicant Title | $$atitle$$ |
| Offer - Applicant First Name | $$afirstname$$ |
| Offer - Applicant Last Name | $$alastname$$ |
| Offer - Applicant Company | $$acompany$$ |
| Offer - Applicant Greeting | $$agreeting$$ |
| Offer - Applicant Envelope Greeting | $$aenvgreeting$$ |
| Offer - Applicant Position | $$aposition$$ |
| Offer - Applicant Legal Description | $$alegaldescription$$ |
| Offer - Applicant Partner Title | $$apartnertitle$$ |
| Offer - Applicant Partner First Name | $$apartnerfirstname$$ |
| Offer - Applicant Partner Last Name | $$apartnerlastname$$ |
| Applicant Email | $$aemail$$ |
| Applicant Home Phone No. | $$ahome$$ |
| Applicant Mobile Phone No. | $$amobile$$ |
| Applicant Work Phone No. | $$awork$$ |
| Applicant Fax Phone No. | $$afax$$ |
| Offer - Applicant Residential Address | $$aukaddress$$ |
| Offer - Formatted Residential Address | $$aukaddressf$$ (Single line) |
| Offer - Applicant Postal Address | $$apukaddress$$ |
| Offer - Formatted Postal Address | $$apukaddressf$$ (Single line) |
Tenant/Purchaser
| Title | $$ptitle$$ |
| First Name | $$pfirstname$$ |
| Last Name | $$plastname$$ |
| Company | $$pcompany$$ |
| Greeting | $$pgreeting$$ |
| EnvGreeting | $$penvgreeting$$ |
| Position | $$pposition$$ |
| Legal Description | $$plegaldescription$$ |
| Partner Title | $$ppartnertitle$$ |
| Partner First Name | $$ppartnerfirstname$$ |
| Partner Last Name | $$ppartnerlastname$$ |
| Bank Details | $$pbankdetails$$ |
| Tenants Detials table | $$tenantstyle1$$ |
| Australia / New Zealand (ONLY) | |
| ABN | $$abn$$ |
| ACN | $$acn$$ |
| Unit | $$puunit$$ |
| Street Number | $$pustreetnum$$ |
| Street Name | $$pustreetname$$ |
| Suburb | $$pusuburb$$ |
| State/Territory | $$pustate$$ |
| Full Address | $$pufulladdress$$ |
| Postal Unit | $$ppuunit$$ |
| Postal Street Number | $$ppustreetnum$$ |
| Postal Street Name | $$ppustreetname$$ |
| Postal Suburb | $$ppusuburb$$ |
| State/Territory | $$ppustate$$ |
| Postal Full Address (AU/NZ/UK) | $$ppufulladdress$$ |
| UK Postal Full Address (formatted with line breaks) | $$ppufulladdressf$$ |
| Fax | $$pfax$$ |
| Home Phone | $$phome$$ |
| Mobile | $$pmobile$$ |
| Work Phone | $$pwork$$ |
| $$pemail$$ | |
| Additional Tenants full name | $$ptenant1$$, $$ptenant2$$, $$ptenant3$$... etc. (Up to eight) |
| Additional Tenants email | $$ptemail1$$, $$ptemail2$$, $$ptemail3$$... etc. (Up to eight) |
| Additional Tenants phone | $$ptphone1$$, $$ptphone2$$, $$ptphone3$$... etc. (Up to eight) |
Guarantor (UK)
| Title | $$gtitle$$ |
| First Name | $$gfirstname$$ |
| Last Name | $$glastname$$ |
| Company | $$gcompany$$ |
| Position | $$gposition$$ |
| UK Residential Full Address (formatted with line breaks) | $$gaddress$$ |
| Fax | $$gfax$$ |
| Home Phone | $$ghome$$ |
| Mobile | $$gmobile$$ |
| Work Phone | $$gwork$$ |
| $$gemail$$ |
Financials: Sales
| Authority Start Date | $$authoritystart$$ |
| Authority End Date | $$authorityend$$ |
| Method of Sale e.g. Private Treaty | $$methodofsale$$ |
| Authority Type e.g. Exclusive | $$authoritytype$$ |
| Conditional Date | $$conditionaldate$$ |
| Unconditional Date | $$unconditionaldate$$ |
| Section27 / Early Release Date | $$section27date$$ |
| Release Date (NZ) | $$releasedate$$ |
| Settlement Date | $$settlementdate$$ |
| Deposit Due | $$depositdue$$ |
| Deposit Amount | $$depositamount$$ |
| Finance Due | $$financedue$$ |
| Gross Commission | $$grosscommission$$ |
| Gross Commission Inc GST | $$grosscommissioninc$$ |
| Gross Commission GST component | $$grosscommissiongst$$ |
| Gross Commission Structure | $$gcstructure$$ |
| GST Rate Used | $$gstrateused$$ |
| VPA | $$vpa$$ |
| Sale Price | $$saleprice$$ |
| Conjuncting Agent - Name | $$conjagentname$$ |
| Conjuncting Agent - Address | $$conjagentaddress$$ |
| Conjuncting Agent - Commission (inc GST) | $$conjcommission$$ |
| Marketing Unpaid | $$marketingunpaid$$ |
| Agent Commission Net Less GST | $$agentcommissionnetlessgst$$ |
| Agent Commission Net Plus GST | $$agentcommissionnetplusgst$$ |
| Agent Commission Tax | $$agentcommissiontax$$ |
| Agent Commission Net GST | $$agentcommissionnetgst$$ |
| Agent Net Owed | $$agentnetowed$$ |
| Agent Withholding Tax | $$agentwithholdingtax$$ |
| Agent Price Opinion | $$agentpriceopinion$$ |
| Super Rate | $$superrate$$ |
| Super Amount | $$superamount$$ |
| Super Amount Inc | $$superamountinc$$ |
| Agent Net Owed Inc Super | $$agentnetowedincsuper$$ |
| YTD Income | $$ytdincome$$ |
| YTD GST | $$ytdgst$$ |
| YTD Income (plus GST) | $$ytdincomeplusgst$$ |
| YTD Net | $$ytdnetamount$$ |
| YTD Net (Exc GST) | $$ytdnetamountexcgst$$ |
| YTD Tax Amount | $$ytdtaxamount$$ |
| YTD Super Amount | $$ytdsuperamount$$ |
| Agent Net Owed Inc Super Exc GST | $$agentnetowedincsuperexcgst$$ |
| Agent Commission Breakdown | $$agentcommissionbreakdown$$ |
Financials: Sales (inc Commercial Leasing)
| Offer Conditions | $$offerconditionslist$$ |
| Offer Conditions (including Deposit and Finance details) | $$offerconditionslist2$$ |
Sample use of Offer Conditions
| A list with no bullets points | $$offerconditionslist$$ |
| A list wth bullet points |
|
| An ordinal list |
|
| Another type of list which includes Deposit and Finance (if applicable) |
|
| And more advanced used |
|
Vendor solicitor
| Title | $$vstitle$$ |
| First Name | $$vsfirstname$$ |
| Last Name | $$vslastname$$ |
| Company | $$vscompany$$ |
| Greeting | $$vsgreeting$$ |
| EnvGreeting | $$vsenvgreeting$$ |
| Australia / New Zealand (ONLY) | |
| Postal Unit | $$vsunit$$ |
| Postal Street Number | $$vsstreetnum$$ |
| Postal Street Name | $$vsstreetname$$ |
| Postal Suburb | $$vssuburb$$ |
| State/Territory | $$vsstate$$ |
| Postal Full Address (AU/NZ/UK) | $$vsfulladdress$$ |
| UK Residential Full Address (formatted with line breaks) | $$vsrfulladdressf$$ |
| UK Postal Full Address (formatted with line breaks) | $$vsfulladdressf$$ |
| Fax | $$vsfax$$ |
| Home Phone | $$vshome$$ |
| Mobile | $$vsmobile$$ |
| Work Phone | $$vswork$$ |
| $$vsemail$$ | |
Purchaser solicitor
| Title | $$pstitle$$ |
| First Name | $$psfirstname$$ |
| Last Name | $$pslastname$$ |
| Company | $$pscompany$$ |
| Greeting | $$psgreeting$$ |
| EnvGreeting | $$psenvgreeting$$ |
| Australia / New Zealand (ONLY) | |
| Postal Unit | $$psunit$$ |
| Postal Street Number | $$psstreetnum$$ |
| Postal Street Name | $$psstreetname$$ |
| Postal Suburb | $$pssuburb$$ |
| State/Territory | $$psstate$$ |
| Postal Full Address (AU/NZ/UK) | $$psfulladdress$$ |
| UK Residential Full Address (formatted with line breaks) | $$psrfulladdressf$$ |
| UK Postal Full Address (formatted with line breaks) | $$psfulladdressf$$ |
| Fax | $$psfax$$ |
| Home Phone | $$pshome$$ |
| Mobile | $$psmobile$$ |
| Work Phone | $$pswork$$ |
| $$psemail$$ | |
Basic details
| Date (DD MMM YYYY) | $$todayddmmmyyyy$$ |
| Date (DD MMMM YYYY) | $$todayddmmmmyyyy$$ |
| Now date/time (YYYY-MM-DD hh:mm:ss) | $$now$$ |
| Office Logo | $$officelogo$$ This displays a 100 pixel height logo |
| User Logo | $$userlogo$$ Only applicable for accounts that have a logo assigned to each user in User Management |
| Office/Account Address (UK only) | $$officefulladdresssingleline$$ |
| Office/Account Address (UK only) | $$officefulladdress$$ |
| Office Telephone | $$officetelephone$$ |
| Office Email | $$officeemail$$ |
| Office Name | $$officename$$ |
| Office ABN | $$officeabn$$ |
| Office Website | $$officewebsite$$ |
| Company Name | $$companyname$$ |
| Company Address | $$companyaddress$$ |
Current user
| First Name | $$userfirstname$$ |
| Last Name | $$userlastname$$ |
| Position | $$userposition$$ |
| Mobile | $$usermobile$$ |
| $$useremail$$ | |
| Telephone | $$usertelephone$$ |
| User Photo | $$userphoto$$ |
| User Logo | $$userlogo$$ Only applicable for accounts that have a logo assigned to each user in User Management |
Agent #1
| First Name | $$agentfirstname$$ |
| Last Name | $$agentlastname$$ |
| Position | $$agentposition$$ |
| Mobile | $$agentmobile$$ |
| $$agentemail$$ | |
| Telephone | $$agenttelephone$$ |
| Photo | $$agentphoto$$ |
Agent #2
| First Name | $$agentfirstname2$$ |
| Last Name | $$agentlastname2$$ |
| Position | $$agentposition2$$ |
| Mobile | $$agentmobile2$$ |
| $$agentemail2$$ | |
| Telephone | $$agenttelephone2$$ |
| Photo | $$agentphoto2$$ |
Owner report specific fields
| Start Date | $$startdate$$ E.g. 12/04/2019 |
| End Date | $$enddate$$ E.g. 12/05/2019 |
| Days on Market | $$dom$$ |
| Qty of Open Homes (during date range) | $$opens$$ |
| Graph: Hot/Warm/Cold | $$hotwarmcoldgraph$$ Example: |
| Graph: Source of Enquiry | $$soegraph$$ |
| All Feedback |
$$allfeedback$$ This will display all Note Types |
| Advertising Ledger | $$advertisingledger$$ |
| Portal Stats |
$$portalstats$$ Note: Currently limited to the following sites:
|
| Portal Stats Style 2 |
$$portalstats2$$ Same as Portal Stats however there is a page break after each portal |
| Price Feedback Graph | $$pricegraph$$ |
| Amplify Stats | $$amplifystats$$ |
| Integrator Stats | $$integratorstats$$ |
| Email Campaigns | $$emailcampaigns$$ |
|
Number of repeat inspections/feedback Shows a count of how many contacts have repeat feedback/inspections on the property |
$$noofrepeatfeedback$$ |
Date fields
Any “date” field (e.g. $$settlementdseveralate$$) can be formatted in a number of different ways.
To customise the date format for a date merge field, enter the merge field as follows:
$$<merge field>_dateFormat_<date format>$$
Example:
$$settlementdate_dateFormat_l jS F Y$$
Will merge as “Friday 29th March 2019”
$$settlementdate_dateFormat_j/n/y$$
Will merge as “29/3/19”
Available date formats
| Format character | Description | Example output |
|---|---|---|
| Day | ||
| d | Day of the month, 2 digits with leading zeros | 01 to 31 |
| D | A textual representation of a day, three letters | Mon through Sun |
| j | Day of the month without leading zeros | 1 to 31 |
| l (lowercase 'L') | A full textual representation of the day of the week | Sunday through Saturday |
| S | English ordinal suffix for the day of the month, 2 characters | st, nd, rd or th. Works well with j |
| Month | ||
| F | A full textual representation of a month, such as January or March | January through December |
| m | Numeric representation of a month, with leading zeros | 01 through 12 |
| M | A short textual representation of a month, three letters | Jan through Dec |
| n | Numeric representation of a month, without leading zeros | 1 through 12 |
| Year | ||
| Y | A full numeric representation of a year, 4 digits | Examples: 1999 or 2003 |
| t | A two digit representation of a year | Examples: 99 or 03 |
Appendix A - Image placeholders
In your Word document, you may wish to insert a placeholder image as shown below:
- The placeholder image will be replaced with content from MRI Vault (for example, Property Photo). For this to occur, you must assign a merge field to the placeholder image
Procedure:
- Right-click on the placeholder image and select Format Picture
- Click the tab shown and add $$mainphotoplaceholder$$ into the Description box:
Appendix B - Change graph format
If using merge fields (in an Owner Report) such as $$hotwarmcoldgraph$$, a graph similar to the one below will appear:
You can change the format of this graph by following these steps:
- Right-click on the graph > Select Change Series Data Type
- Change to a doughnut graph:
Result:
Next, change the colour:
- Click on the Graph > Select Chart Design from the top menu
- Click Change Colour
Result: