Summary
The engagement placeholder variables are containers for dynamically generated content that populate into an individual letter based on client or firm driven data. There are two areas that use these placeholder variables: Engagement Name and Engagement Letter. This article will provide a description and example of each placeholder variable.
Included in this article:
Engagement Name Placeholder Variables
You have the ability to use variables for standardizing the name of each engagement. This name is also the PDF file name when the engagement letter is downloaded from the portal.
Each variable should be formatted with two curly braces {{ }} on each side of the Placeholder Name.
For example {{client.name}}.
Review the table below for a description and example of each available placeholder variable available for the Engagement Name.
| Placeholder Name | Description | Example |
| client.name | The name of the client | Acme, Co |
| client.number | The client number | 123456.A |
| firm.name | The name of the firm | A-Team Accounting |
| letter_template.name | The name of the engagement letter template being used for the engagement | Income Tax Return |
| fiscal_year.long | The fiscal year date in long format | January 1, 2024 |
| fiscal_year.short | The fiscal year date in short format | 01/01/24 |
| fiscal_year.year | The fiscal year | 2024 |
When you select to create a new engagement, you have the ability to create the Engagement Letter Name using the available variables defined above.
Example of Engagement Name Variables
Engagement Letter Placeholder Variables
You have the ability to use variables for inserting dynamic content into the engagement letter itself.
Each Placeholder Name should be formatted with three curly braces {{{ }}} on each side of the Placeholder Name.
For example {{{client.name}}}
Note that this is different from the formatting for the variables that are used for the name of the engagement.
Review the table below for a description and example of each available placeholder variable available for the Engagement Letter.
| Placeholder Name | Description | Example |
| client.name | The name of the client | Acme, Co |
| client.number | The client number | 123456.A |
| client.address | The client address | 123 Somewhere St. Suite 45, Snazzy, JZ 12345 |
| client.address_block | The client address in a block format |
123 Somewhere St. Suite 45 Snazzy, JZ 12345 |
| client.signature_block |
This is where a client signs the letter. Each Engagement Letter Template must include at least once Client Signature Block placeholder variable Additional signature blocks are added automatically for each added Signatory when drafting Engagement Letter to Client(s) All Client Signature Blocks added must be signed - optional signature blocks are not available at this time. |
|
| client.initial_block |
This is where a client initials the letter. A Client Initial Block is not required to be on an Engagement Letter Template If added, all Client Initial Blocks must be signed by the Client Contact(s) - optional client initials are not available at this time |
|
| client.states.abbrevations_block | A numbered list of abbreviated states |
|
| client.states.abbrevations_inline | A list of abbreviated states separated by commas | AL, UT, WA |
| client.states.names_block |
A list of state names separated by commas |
Alabama, Utah, Washington |
| engagement.primary_contact.name | The name of the primary contact | Mr. Sidson Malarkison |
| engagement.primary_contact.email | The email for the primary contact | sidson.malarkison@exampleclient.com |
| firm.name | The name of the firm | A-Team Accounting |
| firm.address | The address of the firm | 987 Somewhere St., Snazzy, JZ 12345 |
| firm.address_block | The address of the firm in a block format |
987 Somewhere St. Snazzy, JZ 12345 |
| firm.email | The email for the firm email | contact_us@examplefirm.com |
| firm.logo | The horizontal firm logo | |
| partner.name | The name of the partner | Rebecca Vie |
| partner.email | The email for the partner as it is seen for the staff member in PM System | rebecca.vie@examplefirm.com |
| letter_date.long | The date of the letter in long format | January 1, 2024 |
| letter_date.short | The date of the letter in short format | 01/01/24 |
| letter_date.year | The year of the letter | 2024 |
| start_date.long |
The start date of the engagement in long format. Can only be used with a defined Start Date. Will not populate if Start Date is "On Acceptance" |
January 1, 2024 |
| start_date.short |
The start date of the engagement in short format Can only be used with a defined Start Date. Will not populate if Start Date is "On Acceptance" |
01/01/24 |
| start_date.year |
The start year for the engagement Can only be used with a defined Start Date. Will not populate if Start Date is "On Acceptance" |
2024 |
|
fiscal_year.long |
The fiscal year date in long format |
January 1, 2024 |
|
fiscal_year.short |
The fiscal year date in short format |
01/01/24 |
|
fiscal_year.year |
The fiscal year |
2024 |
|
renewal_date.long |
The renewal date in long format |
January 1, 2024 |
|
renewal_date.short |
The renewal date in short format |
01/01/24 |
|
renewal_date.year |
The renewal year for the engagement |
2024 |
|
billing.minimum_price |
Total value of fixed fee(s)/Fee Range for all Jobs included on letter |
$4000 |
|
billing.prepayment |
Total prepayment amount for all Jobs included on letter |
$400 |
|
scope_of_services.list_of_clients |
Bullet point list of all Clients |
|
|
scope_of_services.table_of_clients |
Automatic table built displaying Client Name, Service, Fee, and Subtotal for each Client and/or Job added. |
|
|
scope_of_services.list_of_clients_and_jobs |
Bullet point list of all Clients and their Jobs (if added) and total job amount (if added). |
|
|
scope_of_services.jobs_with_short_description |
List of all jobs added, no price or client(s) displayed |
|
|
scope_of_services.jobs_with_short_description_and_price |
List of all jobs added, with price displayed. No client name(s) displayed. |
|
When you creating or editing an engagement letter section, you have the ability to use the available variables defined above.
Example of Engagement Name Variables