Merge Fields Glossary - Standard Fields

Plan: Available: All plans 

Users: Available: All users

Practice Management Source: Available: All sources

Merge Fields allow practices to add placeholders to dynamically insert content, for example, when creating a document from a template.

For more information on Merge Fields, refer to Merge Fields Overview.

This article displays the Merge Field code when used within FYI, for example, when setting up an email template. If the Merge Field is available to use in Microsoft Word or Excel, an additional Merge Field code will be provided.

For instructions on implementing Merge Fields, refer to the following articles:

Additional Merge Fields available to Automations only can be found in Merge Fields Glossary - Automation Fields.

Standard Merge Fields

Use Ctrl+F to quickly search for a specific Merge Field in this article.

General

Field Details Merge Field Code
Current Date

Inserts the current date, formatted as using numbers e.g. 17/09/2024.

Refer to Formatting Merge Fields for Word and Excel documents to insert the current date.

 In FYI:
{{ "now" | date: "%d/%m/%Y" }}
End of Month Determines the last day of the month based on the current date. In FYI:
{{ "now" | end_of: "month" | date: "%d/%m/%Y" }}

Practice

Information specific to your practice.

Field Details Merge Field Code
Collaborate Site Link

Inserts a link to the home page of the Collaborate site where the client's folder is located, either the default Client Collaborate site, or the dedicated Client Secured Collaborate site if configured.

If Personalised Links has been enabled in the Client - Collaborate app, sending emails using the Collaborate Site Link Merge Field will append a login hint to the URL to select the relevant user's account automatically. If there are multiple recipients, a separate link will be displayed for each recipient.

Note: Microsoft Merge Field tools must be used in Excel to ensure the link is clickable.

In FYI:
{{ PracticeCollaborateSiteLink | web_link }}

Word:
PracticeCollaborateSiteLink | web_link

Word/Excel:
PracticeCollaborateSiteLink
Email The practice's email address.

In FYI:
{{ PracticeEmail }}

Word/Excel:
PracticeEmail
Legal Name The Legal Name for the practice (Xero Practice Manager integrations only).

In FYI:
{{ PracticeLegalName }}

Word/Excel:
PracticeLegalName
Name The name of the Practice as per Practice Settings.

In FYI:
{{ PracticeName }}

Word/Excel:
PracticeName

Client

The following Merge Fields retrieve information that is held for the client in FYI as per the Client - Summary tab. For practices integrated with a Practice Management solution, this will include data synced from practice management software such as Xero Practice Manager, MYOB Practice Management (formerly GreatSoft), or via Practice Sync integrations.

Note: Client Custom Fields will be available to select in the Client Merge Field section. These fields are unique to each practice, and not included in the list below.

Field Details Merge Field Code
Addressee Addressee (as held for the primary contact)

In FYI:
{{ ClientAddressee }}

Word/Excel:
ClientAddressee
 
Balance Month

The last month of the client's financial period.

Using this merge field will return the month name, for example 'June'.

In FYI:
{{ ClientBalanceMonth }}

Word/Excel:
ClientBalanceMonth
 
Bank Account Name Bank Account Name

In FYI:
{{ ClientBankAccountName }}

Word/Excel:
ClientBankAccountName
 
Bank Account Number Account Number

In FYI:
{{ ClientBankAccountNumber }}

Word/Excel:
ClientBankAccountNumber
 
Bank BSB BSB Number

In FYI:
{{ ClientBankBSB }}

Word/Excel:
ClientBankBSB
 
Business Number

Typically, this is the unique number that identifies a business or organisation.

In Australia, this is the ABN (Australian Business Number).

In FYI:
{{ ClientBusinessNumber }}

Word/Excel:
ClientBusinessNumber
 
Business Structure Business Structure, for example, Individual, Partnership etc. 

In FYI:
{{ ClientBusinessStructure }}

Word/Excel:
ClientBusinessStructure
 
Client Code Client Code can be used when searching for a client in FYI. This is manually entered by the practices.

In FYI:
{{ ClientClientCode }}

Word/Excel:
ClientClientCode
 
Company Number

Unique company registration number. 

This field is used by BGL and NowInfinity integrations to match the client. 

In Australia, this is the ACN (Australian Company Number).

In FYI:
{{ ClientCompanyNumber }}

Word/Excel:
ClientCompanyNumber
 
Contact Name Contact Name as per the Primary Contact

In FYI:
{{ ClientContactName }}

Word/Excel:
ClientContactName
 
Country Physical Country

In FYI:
{{ ClientCountry }}

Word/Excel:
ClientCountry
 
Date of Birth The client's date of birth

In FYI:
{{ ClientDateOfBirth }}

Word/Excel:
ClientDateOfBirth
 
Email

The client's email address.

The Email field will default to the Primary Contact's email address, or remain blank if a Primary Contact is not selected.

For practices where FYI as Primary is enabled, entering a Client Email Address on the Client - Summary tab will override the default Primary Contact details.

In FYI:
{{ ClientEmail }}

Word/Excel:
ClientEmail
 
Export Code Export Code

In FYI:
{{ ClientExportCode }}

Word/Excel:
ClientExportCode
 
Fax Client's Fax

In FYI:
{{ ClientFax }}

Word/Excel:
ClientFax
 
Financial Institution Name The client's Bank Name

In FYI:
{{ ClientBankName }}

Word/Excel:
ClientBankName
 
First Name Client’s First Name

In FYI:
{{ ClientFirstName }}

Word/Excel:
ClientFirstName
 
Last Name Client’s Last Name

In FYI:
{{ ClientLastName }}

Word/Excel:
ClientLastName
 
Mobile

The client's mobile phone number.

The Mobile field will default to the Primary Contact's mobile number or remain blank if no Primary Contact is selected.

For practices where FYI as Primary is enabled, entering a Client Mobile Number on the Client - Summary tab will override the default Primary Contact details.

In FYI:
{{ ClientMobile }}

Word/Excel:
ClientMobile
 
Name Entity Name, or the Display Name for individuals.

In FYI:
{{ ClientName }}

Word/Excel:
ClientName
 
Other Name Client's Middle or Other Name

In FYI:
{{ ClientOtherName }}

Word/Excel:
ClientOtherName
 
Phone Client’s Phone

In FYI:
{{ ClientPhone }}

Word/Excel:
ClientPhone
 
Post Code Physical Post Code

In FYI:
{{ ClientPostCode }}

Word/Excel:
ClientPostCode
 
Postal Address Client's postal address

In FYI:
{{ ClientPostalAddress }}

Word/Excel:
ClientPostalAddress
 
Postal City Postal City

In FYI:
{{ ClientPostalCity }}

Word/Excel:
ClientPostalCity
 
Postal Country Postal Country

In FYI:
{{ ClientPostalCountry }}

Word/Excel:
ClientPostalCountry
 
Postal Postcode Postal Postcode

In FYI:
{{ ClientPostalPostcode }}

Word/Excel:
ClientPostalPostcode
 
Postcode Region Postal State/Region

In FYI:
{{ ClientPostalRegion }}

Word/Excel:
ClientPostalRegion
 
Salutation

The preferred name for the client.

The Salutation field will default to the Primary Contact's Salutation, or remain blank if a Primary Contact is not selected.

For practices where FYI as Primary is enabled, entering a Client Salutation on the Client - Summary tab will override the default Primary Contact details.

In FYI:
{{ ClientSalutation }}

Word/Excel:
ClientSalutation
 
Street Address Physical Address (client's address)

In FYI:
{{ ClientStreetAddress }}

Word/Excel:
ClientStreetAddress
 
Street City Physical City

In FYI:
{{ ClientStreetCity }}

Word/Excel:
ClientStreetCity
 
Street Country Physical Country

In FYI:
{{ ClientStreetCountry }}

Word/Excel:
ClientStreetCountry
 
Street Postcode Physical Postcode

In FYI:
{{ ClientStreetPostcode }}

Word/Excel:
ClientStreetPostcode
 
Street Region Physical State/Region

In FYI:
{{ ClientStreetRegion }}

Word/Excel:
ClientStreetRegion
 
Tax Number

Client's Tax Number

Populated with the Tax Number displayed in FYI.

In FYI:
{{ ClientTaxNumber }}

Word/Excel:
ClientTaxNumber
 
Title Client's Title (Mr, Mrs, etc)

In FYI:
{{ ClientTitle }}

Word/Excel:
ClientTitle
 
Upload Folder Link

The URL to the client's Upload folder on the Collaborate site where the client's folder is located, either the default Client Collaborate site, or the dedicated Client Secured Collaborate site if configured.

When inserted into an email in FYI, the link will be clickable.

If Personalised Links has been enabled in the Client - Collaborate app, sending emails using the Merge Field will append a login hint to the Upload Folder link to select the relevant user's account automatically. If there are multiple recipients, a separate link will be displayed for each recipient.

The URL will only be displayed as text in Microsoft Word and Excel.  Microsoft Merge Field tools must be used to insert a link into Word or Excel.

In FYI:
{{ ClientUploadFolderLink | web_link }}

Word:
ClientUploadFolderLink | web_link
 

Excel:
ClientUploadFolderLink

Client Manager

The Client Manager fields are used to insert information related to the practice user nominated as the Client Manager, displayed on the Client - Summary tab.

Field Details Merge Field Code
Address

The address.

This is maintained in the integrated practice management solution e.g. Xero Practice Manager.

In FYI:
{{ ClientManagerAddress }}

Word/Excel:
ClientManagerAddress
 
Email The user's email address.

In FYI:
{{ ClientManagerEmail }}

Word/Excel:
ClientManagerEmail
 
Mobile

The user's Mobile Phone number, as per the User Settings in FYI.

For practices integrated with Xero Practice Manager, the Mobile is maintained in XPM.

In FYI:
{{ ClientManagerMobile }}

Word/Excel:
ClientManagerMobile
 
Name The user's name, as per the User Settings in FYI.

In FYI:
{{ ClientManagerName }}

Word/Excel:
ClientManagerName
 
Phone

The user's phone number, as per the User Settings in FYI.

For practices integrated with Xero Practice Manager, the Phone is maintained in XPM.

In FYI:
{{ ClientManagerPhone }}

Word/Excel:
ClientManagerPhone
 
Qualifications The user's qualifications, as per the User Settings in FYI e.g. ACCA, CIMA, CPA.

In FYI:
{{ ClientManagerQualifications }}

Word/Excel:
ClientManagerQualifications
 
Role The user's role within the practice, as per the User Settings in FYI, for example, Accountant.

In FYI:
{{ ClientManagerRole }}

Word/Excel:
ClientManagerRole
 

Client Partner

The Client Partner fields are used to insert information related to the practice user nominated as the Client Partner, displayed on the Client - Summary tab.

Field Details Merge Field Code
Address

The user's address.

This is maintained in the integrated practice management solution e.g. Xero Practice Manager.

In FYI:
{{ ClientPartnerAddress }}

Word/Excel:
ClientPartnerAddress
Email The user's Email Address.

In FYI:
{{ ClientPartnerEmail }}

Word/Excel:
ClientPartnerEmail
 
Mobile

The user's Mobile Phone number, as per the User Settings in FYI.

For practices integrated with Xero Practice Manager, the Mobile is maintained in XPM.

In FYI:
{{ ClientPartnerMobile }}

Word/Excel:
ClientPartnerMobile
 
Name The user's name, as per the User Settings in FYI.

In FYI:
{{ ClientPartnerName }}

Word/Excel:
ClientPartnerName
 
Phone

The user's Phone number, as per the User Settings in FYI.

For practices integrated with Xero Practice Manager, the Phone Number is maintained in XPM.

In FYI:
{{ ClientPartnerPhone }}

Word/Excel:
ClientPartnerPhone
Qualifications The user's qualifications, as per the User Settings in FYI e.g. ACCA, CIMA, CPA.

In FYI:
{{ ClientPartnerQualifications }}

Word/Excel:
ClientPartnerQualifications
Role The user's role within the practice, as per the User Settings in FYI, for example, Accountant.

In FYI:
{{ ClientPartnerRole }}

Word/Excel:
ClientPartnerRole

Job

This section relates to fields from the Job, as displayed on the Job - Summary tab.

Certain Job Merge Fields are relevant to the source selected in the Practice Management Sync app. Where applicable, these are identified as "PM Source" in the table below.

Note: Job Custom Fields will be available to select in the Job Merge Field section. These fields are unique to each practice and are not included in the list below.

Field Details Merge Field Code
Actual Amount

The value of the hours assigned to the job from time entries.

(PM Source: FYI)

In FYI:
{{ JobActualAmount }}
 

Word/Excel:
JobActualAmount
Actual Hours

The number of hours assigned to the job from time entries.

(PM Source: FYI)

In FYI:
{{ JobActualHours }}

Word/Excel:
JobActualHours
Actual

The number of hours assigned to the job from time entries.

(PM Source: XPM)

In FYI:
{{ JobActualHours }}

Word/Excel:
JobActualHours
Assigned Users The users assigned to the job.

In FYI:
{{ JobAssigned }}
 

Word/Excel:
JobAssigned
 
Budget

The estimated value for the job. 

(PM Source: XPM)

In FYI:
{{ JobBudget }}

Word/Excel:
JobBudget
Budget Amount

The estimated value for the job.

(PM Source: FYI or Practice Sync such as MYOB, APS)

In FYI:
{{ JobBudgetAmount }}
 

Word/Excel:
JobBudgetAmount
 
Budget Hours

The estimated number of hours required for the Job.

(PM Source: FYI)

In FYI:
{{ JobBudgetHours }}
 

Word/Excel:
JobBudgetHours
 
Description The Job Description.

In FYI:
{{ JobDescription }}

Word/Excel:
JobDescription
Due Date The date by which the job must be completed.

In FYI:
{{ JobDueDate }}

Word/Excel:
JobDueDate
 
Estimated

The estimated number of hours required for the Job.

(PM Source: XPM)

In FYI:
{{ JobEstimatedHours }}
 

Word/Excel:
JobEstimatedHours
Invoiced Amount

The value invoiced to the client.

(PM Source: FYI)

In FYI:
{{ JobInvoicedAmount }}

Word/Excel:
JobInvoicedAmount
 
Name The name of the Job.

In FYI:
{{ JobName }}
 

Word/Excel:
JobName
Number The Job Number

In FYI:
{{ JobNumber }}
 

Word/Excel:
JobNumber
Start Date The scheduled date when the job commences.

In FYI:
{{ JobStartDate }}
 

Word/Excel:
JobStartDate
 
WIP

The value of work that has been started but not yet invoiced.

(PM Source: FYI)

In FYI:
{{ JobWIP }}
 

Word/Excel:
JobWIP
 
Write On/Off

The value that has been written on/off for the job.

(PM Source: FYI)

In FYI:
{{ JobWriteOnOff }}
 

Word/Excel:
JobWriteOnOff
 

Job Manager

The Job Manager fields are used to insert information related to the practice user nominated as the Job Manager, displayed on the Job - Summary tab.

Field Details Merge Field Code
Address

The user's address.

This is maintained in the integrated practice management solution e.g. Xero Practice Manager.

In FYI:
{{ JobManagerAddress }}

Word/Excel:
JobManagerAddress
Email The user's Email Address.

In FYI:
{{ JobManagerEmail }}

Word/Excel:
JobManagerEmail
Mobile

The user's Mobile number, as per the User Settings in FYI.

For practices integrated with Xero Practice Manager, the Mobile Number is maintained in XPM.

In FYI:
{{ JobManagerMobile }}

Word/Excel:
JobManagerMobile
Name The name of the user nominated as the Job Manager, as per the User Settings in FYI.

In FYI:
{{ JobManagerName }}

Word/Excel:
JobManagerName
Phone

The user's Phone number, as per the User Settings in FYI.

For practices integrated with Xero Practice Manager, the Phone Number is maintained in XPM.

In FYI:
{{ JobManagerPhone }}

Word/Excel:
JobManagerPhone
Qualifications The user's qualifications as per the User Settings in FYI e.g. ACCA, CIMA, CPA.

In FYI:
{{ JobManagerQualifications }}

Word/Excel:
JobManagerQualifications
Role The user's role within the practice, as per the User Settings in FYI, for example, Accountant.

In FYI:
{{ JobManagerRole }}

Word/Excel:
JobManagerRole

Job Partner

The Job Partner fields are used to insert information related to the practice user nominated as the Job Partner, displayed on the Job - Summary tab.

Field Details Merge Field Code
Address

The user's address.

This is maintained in the integrated practice management solution e.g. Xero Practice Manager.

In FYI:
{{ JobPartnerAddress }}

Word/Excel:
JobPartnerAddress
Email The Job Partner's Email Address.

In FYI:
{{ JobPartnerEmail }}

Word/Excel:
JobPartnerEmail
Mobile

The user's Mobile number, as per the User Settings in FYI.

For practices integrated with Xero Practice Manager, the Mobile Number is maintained in XPM.

In FYI:
{{ JobPartnerMobile }}

Word/Excel:
JobPartnerMobile
Name The user's name, as per the User Settings in FYI.

In FYI:
{{ JobPartnerName }}

Word/Excel:
JobPartnerName
Phone

The user's Phone number, as per the User Settings in FYI.

For practices integrated with Xero Practice Manager, the Phone Number is maintained in XPM.

In FYI:
{{ JobPartnerPhone }}

Word/Excel:
JobPartnerPhone
Qualifications The user's qualifications, as per the User Settings in FYI e.g. ACCA, CIMA, CPA.

In FYI:
{{ JobPartnerQualifications }}

Word/Excel:
JobPartnerQualifications
Role The user's role within the practice, as per the User Settings in FYI, for example, Accountant.

In FYI:
{{ JobPartnerRole }}

Word/Excel:
JobPartnerRole

Document

These fields relate to documents created in FYI, including Emails, Word, Excel, and PowerPoint files.

Field Details Merge Field Code
Attachment Links

A link to documents on the relevant Collaborate site where the client's folder is located, either the default Client Collaborate site, or the dedicated Client Secured Collaborate site if configured.

This Merge Field is required in Email Templates when sharing documents via New Collaborate.

If Personalised Links has been enabled in the Client - Collaborate app, sending emails using the Attachment Links Merge Field will append a login hint to the URL to select the relevant user's account automatically. If there are multiple recipients, a separate link will be displayed for each recipient.

In FYI:
{{ DocumentAttachmentLinks }}

Word/Excel:
DocumentAttachmentLinks
Created Date The date on which a document was created.

In FYI:
{{ DocumentCreatedDate }}

Word/Excel:
DocumentCreatedDate
Filename The name of the document in FYI

In FYI:
{{ DocumentFileName }}

Word/Excel:
DocumentFileName
 
Reference Number The unique identification number for the document within FYI.

In FYI:
{{ DocumentReferenceNumber }}

Word/Excel:
DocumentReferenceNumber
 

Document Author

Relates specifically to the sender of an email, not the user who created the email. For merge fields relating to the creator of the email, refer to Document Owner.

These merge fields are only applied when the email is sent i.e. the sender of the email has been determined. Author merge fields are not displayed when editing the email in FYI.

Note: Document Author merge fields are not available for Word or Excel documents.

Field Details Merge Field Code
Address

The address for user that sent the email.

This is maintained in the integrated practice management solution e.g. Xero Practice Manager.

 In FYI:
{{ AuthorAddress }}
Email The author's Email Address In FYI:
{{ AuthorEmail }}
Mobile

The Mobile Phone number for the sender of the email, as per the User Settings in FYI.

For practices integrated with Xero Practice Manager, the Mobile Number is maintained in XPM.

 In FYI:
{{ AuthorMobile }}
Name The name of the user that sent the email. In FYI:
{{ AuthorName }}
Phone

The phone number for the user that sent the email, as per the User Settings in FYI.

For practices integrated with Xero Practice Manager, the Phone Number is maintained in XPM.

 In FYI:
{{ AuthorPhone }}
Qualifications The qualifications for the user that sent the email, as per the User Settings in FYI e.g. ACCA, CIMA, CPA. In FYI:
{{ AuthorQualifications }}
Role The role of the email sender as per the User Settings in FYI, for example, Accountant. In FYI:
{{ AuthorRole }}

Document Owner

The creator of the email, different to the user that sent the email. For other documents, for example Word or Excel, this will be the user that created the document.

Note: If an email is edited and sent by someone after it is initially created, the Owner information does not change.

Field Details Merge Field Code
Address

The address for user that created the document.

This is maintained in the integrated practice management solution e.g. Xero Practice Manager.

In FYI:
{{ OwnerAddress }}

Word/Excel:
OwnerAddress
 
Email The document creator's Email Address

In FYI:
{{ OwnerEmail }}

Word/Excel:
OwnerEmail
Mobile

The Mobile Phone number for the creator of the document, as per the User Settings in FYI.

For practices integrated with Xero Practice Manager, the Mobile Number is maintained in XPM.

In FYI:
{{ OwnerMobile }}

Word/Excel:
OwnerMobile
 
Name The name of the user that created the document.

In FYI:
{{ OwnerName }}

Word/Excel:
OwnerName
 
Phone

The phone number for the user that created the document, as per the User Settings in FYI.

For practices integrated with Xero Practice Manager, the Phone Number is maintained in XPM.

In FYI:
{{ OwnerPhone }}

Word/Excel:
OwnerPhone
 
Qualifications The qualifications for the user that created the document, as per the User Settings in FYI e.g. ACCA, CIMA, CPA.

In FYI:
{{ OwnerQualifications }}

Word/Excel:
OwnerQualifications
 
Role The role of the document creator as per the User Settings in FYI, for example, Accountant.

In FYI:
{{ OwnerRole }}

Word/Excel:
OwnerRole
 

Automation Merge Fields

When creating custom Automation Processes, additional merge fields will be available to select, that are not available within Microsoft Documents.

For detailed information on the available Trigger Merge Fields, refer to Merge Fields Glossary - Automations

Integration Merge Fields

When FYI is connected to other platforms, additional Merge Fields may be available depending on the integration and the type of Automation Process being created. These Merge Fields can be used to insert information from integrated systems, such as practice management solutions, document signing platforms, and other connected apps.

For detailed information on integration-specific Merge Fields, refer to the relevant integration article in the Apps and Integrations section of the Help Centre.

Was this article helpful?
4 out of 8 found this helpful

Stay Up-To-Date

  • Events

    We host a range of product demos, training webinars, workshops and more.

  • Service Status

    Check for updates on the FYI Platform

  • What's New

    Round-up of new features, fixes, and other important announcements.