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:
- Including Merge Fields in Email Templates and Signatures
- Including Merge Fields in Word Templates and Stationery
- Including Merge Names in Excel Templates
- Including Merge Fields in Excel Templates
- Including Merge Fields in Automations
- Clients Bulk Update
- Jobs Bulk Update
- Including Advanced Tax-Related Merge Fields
Merge Fields can be customised to format the appearance, or to perform calculations. This article provides detail on standard merge fields, for information on how to customise Merge Fields refer to Formatting Merge Fields.
Use Ctrl+F to quickly search for a specific Merge Field in this article.
Standard Merge Fields
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: |
End of Month |
Determines the last day of the month based on the current date. |
In FYI: |
Practice
Information specific to your practice.
Field | Details | Merge Field Code |
Collaborate Site Link |
Inserts a link to the New Collaborate SharePoint site Home page. When inserted into an email in FYI, the link will be clickable. 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: Word/Excel: |
The practice's email address. |
In FYI: Word/Excel: |
|
Legal Name |
The Legal Name for the practice (Xero Practice Manager integrations only). |
In FYI: Word/Excel: |
Name |
The name of the Practice as per Practice Settings. |
In FYI: Word/Excel: |
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, 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: Word/Excel: |
Balance Month |
The last month of the client's financial period. |
In FYI: Word/Excel: |
Bank Account Name |
Bank Account Name |
In FYI: Word/Excel: |
Bank Account Number |
Account Number |
In FYI: Word/Excel: |
Bank BSB |
BSB Number |
In FYI: Word/Excel: |
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: Word/Excel: |
Business Structure |
Business Structure, for example, Individual, Partnership etc. |
In FYI: Word/Excel: |
Client Code |
Client Code can be used when searching for a client in FYI. This is manually entered by the practices. |
In FYI: Word/Excel: |
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: Word/Excel: |
Contact Name |
Contact Name as per the Primary Contact |
In FYI: Word/Excel: |
Country |
Physical Country |
In FYI: Word/Excel: |
Date of Birth |
The client's date of birth |
In FYI: Word/Excel: |
Client’s Email |
In FYI: Word/Excel: |
|
Export Code |
Export Code |
In FYI: Word/Excel: |
Fax |
Client's Fax |
In FYI: Word/Excel: |
Financial Institution Name |
The client's Bank Name |
In FYI: Word/Excel: |
First Name |
Client’s First Name |
In FYI: Word/Excel: |
Last Name |
Client’s Last Name |
In FYI: Word/Excel: |
Mobile |
Client’s Mobile |
In FYI: Word/Excel: |
Name |
Entity Name, or the Display Name for individuals. |
In FYI: Word/Excel: |
Other Name |
Client's Middle or Other Name |
In FYI: Word/Excel: |
Phone |
Client’s Phone |
In FYI: Word/Excel: |
Post Code |
Physical Post Code |
In FYI: Word/Excel: |
Postal Address |
Client's postal address |
In FYI: Word/Excel: |
Postal City |
Postal City |
In FYI: Word/Excel: |
Postal Country |
Postal Country |
In FYI: Word/Excel: |
Postal Postcode |
Postal Postcode |
In FYI: Word/Excel: |
Postcode Region |
Postal Region |
In FYI: Word/Excel: |
Salutation |
Salutation (from primary contact) |
In FYI: Word/Excel: |
Street Address |
Physical Address (client's address) |
In FYI: Word/Excel: |
Street City |
Physical City |
In FYI: Word/Excel: |
Street Country |
Physical Country |
In FYI: Word/Excel: |
Street Postcode |
Physical Postcode |
In FYI: Word/Excel: |
Street Region |
Physical Region |
In FYI: Word/Excel: |
Tax Number |
Client's Tax Number |
In FYI: Word/Excel: |
Title |
Client's Title (Mr, Mrs, etc) |
In FYI: Word/Excel: |
Upload Folder Link |
The URL to the client's Upload folder on the New Collaborate SharePoint site. When inserted into an email in FYI, the link will be clickable. 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: Word/Excel: |
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: Word/Excel: |
The user's email address. |
In FYI: Word/Excel: |
|
Mobile |
The user's Mobile Phone number. This is maintained in the integrated practice management solution e.g. Xero Practice Manager. |
In FYI: Word/Excel: |
Name |
The user's name, as per the User Settings in FYI. |
In FYI: Word/Excel: |
Phone |
The user's phone number. This is maintained in the integrated practice management solution e.g. Xero Practice Manager. |
In FYI: Word/Excel: |
Qualifications |
The user's qualifications, as per the User Settings in FYI e.g. ACCA, CIMA, CPA. |
In FYI: Word/Excel: |
Role |
The user's role within the practice, as per the User Settings in FYI, for example, Accountant. |
In FYI: Word/Excel: |
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: Word/Excel: |
The user's Email Address. |
In FYI: Word/Excel: |
|
Mobile |
The user's Mobile Phone number. This is maintained in the integrated practice management solution e.g. Xero Practice Manager. |
In FYI: Word/Excel: |
Name |
The user's name, as per the User Settings in FYI. |
In FYI: Word/Excel: |
Phone |
The user's phone number. This is maintained in the integrated practice management solution e.g. Xero Practice Manager. |
In FYI: Word/Excel: |
Qualifications |
The user's qualifications, as per the User Settings in FYI e.g. ACCA, CIMA, CPA. |
In FYI: Word/Excel: |
Role |
The user's role within the practice, as per the User Settings in FYI, for example, Accountant. |
In FYI: Word/Excel: |
Job
This section relates to fields from the Job, as displayed on the Job - Summary tab.
Note: Job Custom Fields will be available to select in the Job Merge Field section. These fields are unique to each practice, and 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. (Elite plan only) |
In FYI: Word/Excel: |
Actual Hours |
The number of hours assigned to the job from time entries. (Elite plan only) |
In FYI: Word/Excel: |
Assigned Users |
The users assigned to the job. |
In FYI: Word/Excel: |
Budget |
The estimated value for the job. (Pro plan only) |
In FYI: Word/Excel: |
Budget Amount |
The estimated value for the job. (Elite plan only) |
In FYI: Word/Excel: |
Budget Hours |
The estimated number of hours required for the Job. (Elite plan only) |
In FYI: Word/Excel: |
Description |
The Job Description. |
In FYI: Word/Excel: |
Due Date |
The date by which the job must be completed. |
In FYI: Word/Excel: |
Invoiced Amount |
The value invoiced to the client. (Elite plan only) |
In FYI: Word/Excel: |
Name |
The name of the Job. |
In FYI: Word/Excel: |
Number |
The Job Number |
In FYI: Word/Excel: |
Start Date |
The scheduled date when the job commences. |
In FYI: Word/Excel: |
WIP |
The value of work that has been started but not yet invoiced. (Elite plan only) |
In FYI: Word/Excel: |
Write On/Off |
The value that has been written on/off for the job. (Elite plan only) |
In FYI: Word/Excel: |
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: Word/Excel: |
The user's Email Address. |
In FYI: Word/Excel: |
|
Mobile |
The user's Mobile Phone number. This is maintained in the integrated practice management solution e.g. Xero Practice Manager. |
In FYI: Word/Excel: |
Name |
The name of the user nominated as the Job Manager, as per the User Settings in FYI. |
In FYI: Word/Excel: |
Phone |
The user's phone number. This is maintained in the integrated practice management solution e.g. Xero Practice Manager. |
In FYI: Word/Excel: |
Qualifications |
The user's qualifications as per the User Settings in FYI e.g. ACCA, CIMA, CPA. |
In FYI: Word/Excel: |
Role |
The user's role within the practice, as per the User Settings in FYI, for example, Accountant. |
In FYI: Word/Excel: |
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: Word/Excel: |
The Job Partner's Email Address. |
In FYI: Word/Excel: |
|
Mobile |
The user's mobile number. This is maintained in the integrated practice management solution e.g. Xero Practice Manager. |
In FYI: Word/Excel: |
Name |
The user's name, as per the User Settings in FYI. |
In FYI: Word/Excel: |
Phone |
The user's phone number. This is maintained in the integrated practice management solution e.g. Xero Practice Manager. |
In FYI: Word/Excel: |
Qualifications |
The user's qualifications, as per the User Settings in FYI e.g. ACCA, CIMA, CPA. |
In FYI: Word/Excel: |
Role |
The user's role within the practice, as per the User Settings in FYI, for example, Accountant. |
In FYI: Word/Excel: |
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 the document on the Collaborate Site. Required in Email Templates when sharing documents via New Collaborate. |
In FYI: Word/Excel: |
Created Date |
The date on which a document was created. |
In FYI: Word/Excel: |
Filename |
The name of the document in FYI |
In FYI: Word/Excel: |
Reference Number |
The unique identification number for the document within FYI. |
In FYI: Word/Excel: |
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: |
The author's Email Address |
In FYI: |
|
Mobile |
The Mobile Phone number for the sender of the email. This is maintained in the integrated practice management solution e.g. Xero Practice Manager. |
In FYI: |
Name |
The name of the user that sent the email. |
In FYI: |
Phone |
The phone number for the user that sent the email. This is maintained in the integrated practice management solution e.g. Xero Practice Manager. |
In FYI: |
Qualifications |
The qualifications for the user that sent the email, as per the User Settings in FYI e.g. ACCA, CIMA, CPA. |
In FYI: |
Role |
The role of the email sender as per the User Settings in FYI, for example, Accountant. |
In FYI: |
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: Word/Excel: |
The document creator's Email Address |
In FYI: Word/Excel: |
|
Mobile |
The Mobile Phone number for the creator of the document. This is maintained in the integrated practice management solution e.g. Xero Practice Manager. |
In FYI: Word/Excel: |
Name |
The name of the user that created the document. |
In FYI: Word/Excel: |
Phone |
The phone number for the user that created the document. This is maintained in the integrated practice management solution e.g. Xero Practice Manager. |
In FYI: Word/Excel: |
Qualifications |
The qualifications for the user that created the document, as per the User Settings in FYI e.g. ACCA, CIMA, CPA. |
In FYI: Word/Excel: |
Role |
The role of the document creator as per the User Settings in FYI, for example, Accountant. |
In FYI: Word/Excel: |
Automation Merge Fields
The following Merge Fields are specific to Automations, and not available within Microsoft Documents.
Invoicing
When creating a Custom Automation process using an Invoice View filter, Invoice Merge Fields will become available in the Trigger Invoice section. Refer to Trigger Fields below.
Note: Invoice Custom Fields will be available to select in the Trigger Invoice Merge Field section. These fields are unique to each practice, and not included in the list below.
Field | Details | Merge Field Code |
Due Date | The Due Date for the invoice. |
In FYI: |
Invoice Date | The invoice date. |
In FYI: |
Amount | The Invoice amount, excluding tax. |
In FYI: |
Amount Including Tax | The Invoice amount, including tax. |
In FYI: |
Amount Outstanding | The Invoice amount, minus any payments. |
In FYI: |
Amount Tax | The tax value. |
In FYI: |
Paid Amount | The amount paid. |
In FYI: |
Number | Invoice Number. |
In FYI: |
Total WIP |
Calculates all current WIP associated with the job. Available with the Create Invoice automation step. |
In FYI: |
Total Disbursements |
Aggregate total cost of all disbursements for the job (available for Billing and Standard Jobs only). Available with the Create Invoice automation step. |
In FYI: |
Time Entry and Disbursements
When creating a Custom Automation process using an Time Entry View filter, Invoice Merge Fields will become available in the Trigger Time Entry section. Refer to Trigger Fields below.
Note: Time and Disbursement Custom Fields will be available to select in the Trigger Time Entry Merge Field section. These fields are unique to each practice, and not included in the list below.
Field | Details | Merge Field Code |
Billable Amount | The Billable Amount for the time entry. |
In FYI: |
Entry Date | The date of the time entry or Disbursement. |
In FYI: |
Hours | Time will be displayed in a decimal format, converted using 6 minute increments. For example, 00:06 is converted to 0.1. Refer to Time Overview. |
In FYI: |
Name | The Disbursement Entry Name. |
In FYI: |
Quantity | The Disbursement Quantity. |
In FYI: |
Write On/Off | The Write On/Off value. |
In FYI: |
Automation Initiator
The following fields relate to the user that manually triggered an Automation process.
Field | Details | Merge Field Code |
User |
Selects the user, for example, when assigning a task. |
In FYI: |
Address |
The user's address. This is maintained in the integrated practice management solution e.g. Xero Practice Manager. |
In FYI: |
The user's email address. |
In FYI: |
|
Mobile |
The user's mobile number. This is maintained in the integrated practice management solution e.g. Xero Practice Manager. |
In FYI: |
Name |
The user's name. |
In FYI: |
Phone |
The user's phone number. This is maintained in the integrated practice management solution e.g. Xero Practice Manager. |
In FYI: |
Qualifications |
The user's qualifications, as per the User Settings in FYI e.g. ACCA, CIMA, CPA. |
In FYI: |
Role |
The user's role within the practice, as per the User Settings in FYI, for example, Accountant. |
In FYI: |
Alter Document
Field | Details | Merge Field Code |
Original File Name |
Used to select the existing Document Name, for example when altering a document and adding additional content to the end of the file name. Available with the Alter Document step. |
In FYI: |
Trigger Fields
When creating an automation, Trigger sections will be displayed depending on the Filter view, previous steps in the process, your practice integrations and your FYI subscription plan. For example, when the Automation Process uses a Job View, new sections will be displayed for the Trigger Job, Trigger Client (the client assigned to the Job), Client Partner, and more.
These fields will obtain information as per the described in this article. For example, the Merge Field {{ TriggerClientName }} is the Client Name, while {{ TriggerClientPartnerName }} is the name of the user nominated as the Partner for the client.
Refer to the definitions above for details on each of the merge field, and Including Merge Fields in Automations.
Integration Merge Fields
The following sections and Merge Fields are only available when FYI has been connected to specific third-party integrations.
Tax
The tax section is available when integrated with Xero Tax. The Tax Merge Fields only work after lodgement.
These fields are used in the FYI pre-figured processes for Tax Assessments which are triggered by tax returns and assessments from Xero Tax. If these Tax Merge Fields are used in any other processes (such as Custom Processes) or if a template with the Tax Merge Fields is used when creating a new Spreadsheet, they will retrieve the data from the most recent Tax Return or Assessment. Refer to Using Advanced Tax-Related Merge Fields.
Note: Tax Merge Fields are not available to use for Activity Statements.
Field | Details | Merge Field Code |
Est. Payable/Refundable |
The amount of the estimated refund that is payable or refundable. |
In FYI: Word/Excel: |
Estimated Income |
The amount of the estimated income tax. |
In FYI: Word/Excel: |
Income |
The amount of the income tax. |
In FYI: Word/Excel: |
Income variance |
The amount of the variance from the estimate of the income tax. |
In FYI: Word/Excel: |
Issue Date |
The date it was issued by the ATO. |
In FYI: Word/Excel: |
Lodgement Date |
The date it was logged to the ATO. |
In FYI: Word/Excel: |
Payable Date |
The date the refund is payable. |
In FYI: Word/Excel: |
Payable/Refundable |
The amount of the refund that is payable or refundable. |
In FYI: Word/Excel: |
Payable/Refundable Variance |
The amount of the variance from the estimate of the amount payable or refundable. |
In FYI: Word/Excel: |
Period From |
The From date of the period. |
In FYI: Word/Excel: |
Period To |
The To date of the period. |
In FYI: Word/Excel: |
State |
The state of the tax submission, that is, Draft, Filed, Completed. |
In FYI: Word/Excel: |
Type |
The Tax Type code. Refer to Using Advanced Tax-Related Merge Fields for a list of tax codes. |
In FYI: Word/Excel: |
Year |
The most recent dataset of the relevant client. Merge Fields can be customised to select a specific year. Refer to Using Advanced Tax-Related Merge Fields. |
In FYI: Word/Excel: |
Corporate Affairs
Available to practices integrated with BGL and NowInfinity.
For other additional Merge Fields available to these integrations, refer to the BGL and NowInfinity sections further below.
Field | Details | Merge Field Code |
Year |
The Year displayed in the Client - Corporate Affairs tab. |
In FYI: Word/Excel: |
Xero Ledger
Available to practices integrated with Xero Ledger.
Field | Details | Merge Field Code |
Period From |
The From Period for documents imported through the Client Ledger Reports AutoFile process. |
In FYI: Word/Excel: |
Period To |
The To Period for documents imported through the Client Ledger Reports AutoFile process. |
In FYI: Word/Excel: |
Year |
The Year for documents imported through the Client Ledger Reports AutoFile process. |
In FYI: Word/Excel: |
Annature
Available to practices integrated with Annature.
Field | Details | Merge Field Code |
Signature |
The Signature Merge Field is automatically detected as a placeholder where the recipient must sign. This does not show the sender's signature. When sending documents for signature via Annature, you must ensure the document you send has the Signature Merge Field included. Refer to Digital Signatures using Annature. Note: This Merge Field must be inserted without spaces between the brackets e.g. «Signature» |
Word/Excel: |
NowInfinity
Available to practices integrated with NowInfinity.
Field | Details | Merge Field Code |
Date of Annual Review |
The client's Annual Review Date as per NowInfinity. |
In FYI: |
Date of Due Time |
The client's Due Time Date as per NowInfinity. |
In FYI: |
Date of Registration |
The client's Date of Registration as per NowInfinity. |
In FYI: |
Debt Now Due |
The client's Debt Now Due value as per NowInfinity. |
In FYI: |
Status |
The client's status, for example, Deregistered, as per NowInfinity. |
In FYI: |
Total Amount Owing |
The client's total outstanding as per NowInfinity. |
In FYI: |
BGL
Available to practices integrated with BGL.
Field | Details | Merge Field Code |
Annual Review Date |
The client's Annual Review Date, as per BGL. |
In FYI: |
Company Class |
The Company Class as per BGL. |
In FYI: |
Company Type |
The client's Company Type, as per BGL. |
In FYI: |
Incorporation Date |
The date the client was incorporated, as per BGL. |
In FYI: |
Jurisdiction | The client's jurisdiction, as per BGL. |
In FYI: |
Registered |
The Registered information for the client, as per BGL. |
In FYI: |
Registration State |
The client's Registration State, as per BGL. |
In FYI: |
Companies House
Available to practices integrated with Companies House.
Field | Details | Merge Field Code |
Accounting Reference Day |
The client's Accounting Reference Day, as per Companies House. |
In FYI: |
Accounting Reference Month |
The Accounting Reference Month, as per Companies House. |
In FYI: |
Company Next Due |
The Company Next Due, as per Companies House. |
In FYI: |
Company Status |
The client's Company Status, as per Companies House. |
In FYI: |
Company Year End Date |
The client's Company Year End Date, as per Companies House. |
In FYI: |
Confirmation Last Field |
The Confirmation Last Field, as per Companies House. |
In FYI: |
Confirmation Statement Due |
The Confirmation Statement Due, as per Companies House. |
In FYI: |
Country |
The client's Country, as per Companies House. |
In FYI: |
Jurisdiction |
The client's Jurisdiction, as per Companies House. |
In FYI: |
Locality |
The client's Locality, as per Companies House. |
In FYI: |
Next Accounts Due |
The Next Accounts Due, as per Companies House. |
In FYI: |
Postal Code |
The client's Postal Code, as per Companies House. |
In FYI: |
Region |
The client's Region, as per Companies House. |
In FYI: |
Registered Office Is In Dispute |
The Registered Office Is In Dispute, as per Companies House. |
In FYI: |