Document Automation: Merge Fields

Document Automation: Merge Fields

Overview

The following section uses the notation«=client.name»to refer to Word MailMerge fields, which are available to be included as part of templates uploaded to Matters.Cloud

Fields: Document

The following merge fields are available for the current document:
Merge FieldDescription
«=document.date»Date when document was first created from a template (short format)
«=document.date_long»
Date when document was first created from a template (long format)
«=document.author_name»
Full name of the user who generated the document
«=document.author_email»
Email address of the user who generated the document
«=document.author_job_title»
Job title of the user who generated the document
«=document.author_business_phone»
Phone number of the user who generated the document
«=document.author_department»
Department of the user who generated the document

Fields: Entity

The following merge fields are available for the current entity:
Merge FieldDescription
«=entity.name»Unique identifier of the entity
«=entity.tax_number»
Tax or VAT registration number of the entity
«=entity.domain_name»URL for the entity's website
«=entity.business_phone»Business phone number of the entity
«=entity.email»Email address of the entity
«=entity.address_1»Address line 1 of the primary address for the entity
«=entity.address_2»Address line 2 of the primary address for the entity
«=entity.address_3»Address line 3 of the primary address for the entity
«=entity.address_city»City of of the primary address for the entity
«=entity.address_region»Region/state of the selected address
«=entity.address_country»Country of the selected address
«=entity.address_postcode»Postcode/zip code of the selected address
«=entity.full_address»
Full address in a single line
«=entity.full_address_block}»

Full address arranged in block format

Fields: Addressee

The following merge fields are available for the current address:
Merge FieldDescription
«=addressee.name»Name of the addressee (organization name or full name if contact)
«=addressee.reference»
Reference information for tracking or identification
«=addressee.salutation»How they like to be addressed (optional)
«=addressee.first_name»First name of addressee (contact only)
«=addressee.middle_name»
Middle name of addressee (contact only)
«=addressee.last_name»Last name of addressee (contact only)
«=addressee.email»Email address of the addressee (billing email or email if contact)
«=addressee.home_phone»
Home phone number of addressee (contact only)
«=addressee.business_phone»
Business phone number of addressee
«=addressee.mobile_phone»
Mobile phone number of addressee (contact only)
«=addressee.address_1»Address line 1 of the selected address
«=addressee.address_2»Address line 2 of the selected address
«=addressee.address_3»Address line 3 of the selected address
«=addressee.address_city»City of the selected address
«=addressee.address_region»Region/state of the selected address
«=addressee.address_country»Country of the selected address
«=addressee.address_postcode»Postcode/zipcode of the selected address
«=addressee.full_address»
Full address in a single line
«=addressee.full_address_block»
Full address arranged in block format

Fields: Client

The following merge fields are available for the current client:
Merge Field
Description
«=client.client_code»
Unique identifier of the client record
«=client.name»Name of the client
«=client.date_of_birth
Client's date of birth
«=client.salutation»
How the client should be addressed
«=client.party-type»
Contact or Organization
«=client.payment_days»Middle name of contact person
«=client.tax_number»
Tax or VAT registration number of the client
«=client.domain_name»URL for the client's website
«=client.business_phone»Business phone number of the client
«=client.business_phone»
Home phone number of the client
«=client.mobile_phone»
Mobile phone number of the client
«=client.email»Email address of the client
«=client.owner_name»
Owner of the client
«=client.address_1»
Address line 1 of the selected address
«=client.address_2»
Address line 2 of the selected address
«=client.address_3»
Address line 3 of the selected address
«=client.address_city»
City of the selected address
«=client.address_region»
Region/state of the selected address
«=client.address_country»
Country of the selected address
«=client.address_postcode»
Postcode/zipcode of the selected address
«=client.full_address»
Client's address in a full single line
«=client.full_address_block»
Client's full address formatted as block

Fields: Matter

The following merge fields are available for the current matter:
Merge Field
Description
«=matter.matter_code»Unique identifier of the matter record
«=matter.name»Name of the matter
«=matter.client_reference»
Unique client reference for the matter
«=matter.type»Type of the matter
«=matter.currency»
Currency of the matter
«=matter.open_date»Date when matter was first opened
«=matter.close_date»Date when matter was closed
«=matter.estimated_hours»Estimated hours for the matter
«=matter.estimated_expenses»Estimated expenses/disbursements for the matter
«=matter.estimated_fees»
Estimated fees for the matter
«=matter.billing_value
The billing value recorded against the matter
«=matter.owner_name»
Full name of the user assigned to the matter
«=matter.owner_email»
Email address of the user assigned to the matter
«=matter.owner_job_title»
Job title of the user assigned to the matter
«=matter.owner_business_phone»
Phone number of the matter owner
«=matter.owner_department»
Department of the matter owner

Fields: Opportunity

The following merge fields are available for the current opportunity:

Merge Field
Description
«=opportunity.opportunity_code»
Unique identifier of the opportunity record
«=opportunity.name»Name of the opportunity
«=opportunity.stage»Current stage of the opportunity
«=opportunity.open_date»Date when the opportunity was created
«=opportunity.close_date»Expected or actual close date of the opportunity
«=opportunity.estimated_hours»Estimated hours for the opportunity
«=opportunity.estimated_fees»Estimated fees for the opportunity
«=opportunity.estimated_expenses»Estimated expenses for the opportunity
«=opportunity.currency»Currency assigned to the opportunity
«=opportunity.owner_name»Full name of the user assigned to the opportunity
«=opportunity.owner_email»Email address of the user assigned to the opportunity
«=opportunity.owner_job_title»Job title of the user assigned to the opportunity
«=opportunity.owner_business_phone»Business phone number of the user assigned to the opportunity
«=opportunity.supervisor_signature»Signature of the opportunity supervisor
«=opportunity.opportunityable_name»Name of the client or entity associated with the opportunity
«=opportunity.client_reference»Client reference recorded against the opportunity

Fields: Custom

The following types of custom fields are supported for use in the merge process:
  1. Client (Organization/Contact)
  2. Matter
To include a custom merge field, you simply prefix the name of the custom field as follows:

«=client.industry_sector»

client = the name of the data type (e.g., client or matter)
industry_sector = the name of the custom field in lower case with an underscore between each word.