You can use template variables to automatically insert dynamic employee or compensation details into your compensation letter templates.
To populate a value, add the corresponding template variable directly into your template letter. When a letter is generated, Workleap Compensation will replace each variable with the correct value for each recipient.
The tables below list all supported template variables.
Important: Only use supported variables, and format them exactly as they appear in the first column of the tables below. Any formatting errors could prevent the platform from generating your compensation letters correctly.
General
Template Variable | Variable Description | Example |
{letter_date} | Letter Date | April 14, 2023 |
{first_name} | Legal First Name | Stacey |
{last_name} | Legal Last Name | Adams |
{employee_number} | Employee # | 0235 |
{home_street_1} {#home_street_2}{home_street_2} {/}{home_city}, {home_state} {home_zip_code} | Employee Address | 123 ABC St. Suite 102 Toronto, Ontario A1A 2B3 |
{current_job_title} | Current Job Title | Software Engineer I |
{manager_name} | Manager Name | Bob Barley |
{employee_work_email} | Employee Work Email | |
{pay_zone_name} | Employee Pay Zone Name | Canada |
{company_name} | Company Name | Vandelay Industries |
{hire_date} | Hire Date | April 20, 2022 |
{rating_number} | Performance Rating Number | 3 |
{rating_description} | Performance Rating Description | Meets Expectations |
{current_pay_type} | Current Pay Type (Hourly or Salary) | Hourly |
{new_pay_type} | New Pay Type (Hourly or Salary) | Salary |
Base Pay, Variable Pay, Promotions, and Pay Bands
Template Variable | Variable Description | Example |
{currency_code} | Currency Code | USD |
{current_base_pay} | Current Base Pay | $55,000 |
{current_variable_pay} | Current Variable Pay | $5,000 |
{current_total_pay} | Current Total Pay | $60,000 |
{payroll_effective_date} | Effective Date of Increase or Promotion | August 1, 2023 |
{promoted_job_title} | New Job Title | Software Engineer II |
{base_pay_change_amount} | Base Pay Change Amount | $5,000 |
{base_pay_change_percent} | Base Pay Change % | 9.0% |
{new_base_pay} | New Base Pay | $60,000 |
{variable_pay_change_amount} | Variable Pay Change Amount | $2,000 |
{variable_pay_change_percent} | Variable Pay Change % | 5.0% |
{new_variable_pay_amount} | New Variable Pay Amount | $6,000 |
{new_variable_pay_percent} | New Variable Pay as a % of New Base Pay | 20% |
{base_pay_merit_increase_amount} | Base Pay Merit Increase Amount | $2,000 |
{base_pay_market_adjustment_amount} | Base Pay Market Adjustment Amount | $1,500 |
{base_pay_cost_of_living_adjustment_amount} | Base Pay Cost of Living Adjustment Amount | $500 |
{base_pay_pay_equity_adjustment_amount} | Base Pay Pay Equity Adjustment Amount | $0 |
{base_pay_promotion_amount} | Base Pay Promotion Amount | $800 |
{base_pay_lateral_move_amount} | Base Pay Lateral Move Amount | $0 |
{base_pay_other_amount} | Base Pay Other Amount | $200 |
{variable_pay_merit_increase_amount} | Variable Pay Merit Increase Amount | $500 |
{variable_pay_market_adjustment_amount} | Variable Pay Market Adjustment Amount | $250 |
{variable_pay_cost_of_living_adjustment_amount} | Variable Pay Cost of Living Adjustment Amount | $100 |
{variable_pay_pay_equity_adjustment_amount} | Variable Pay Pay Equity Adjustment Amount | $0 |
{variable_pay_promotion_amount} | Variable Pay Promotion Amount | $1,000 |
{variable_pay_lateral_move_amount} | Variable Pay Lateral Move Amount | $0 |
{total_pay_change_amount} | Total Pay Change Amount | $10,000 |
{total_pay_change_percent} | Total Pay Change % | 25.0% |
{new_total_pay} | New Total Pay | $80,000 |
{current_payband_low} | Current Pay Band Low | $50,000 |
{current_payband_mid} | Current Pay Band Mid | $55,000 |
{current_payband_high} | Current Pay Band High | $60,000 |
{new_payband_low} | New Pay Band Low (If Promoted) | $70,000 |
{new_payband_mid} | New Pay Band Mid (If Promoted) | $75,000 |
{new_payband_high} | New Pay Band High (If Promoted) | $80,000 |
{current_compa_ratio} | Current Compa-ratio | 0.98 |
{new_compa_ratio} | New Compa-ratio | 1.24 |
{current_level} | Current Level | M2 |
{new_level} | New Level (If Promoted) | M3 |
Note: These variables show the portion of the Base Pay or Variable Pay change attributed to each adjustment type. The values for applicable adjustment types total {base_pay_change_amount} and {variable_pay_change_amount}. If an adjustment type doesn’t apply, the value returns $0.
Hourly Pay
Template Variable | Variable Description | Example |
{current_hourly_pay} | Current Hourly Pay | $30.00 |
{hourly_pay_change_amount} | Hourly Pay Change Amount | $10.00 |
{hourly_pay_change_percent} | Hourly Pay Change Percent | 5.0% |
|
|
|
|
|
|
{hourly_pay_merit_increase_amount} | Hourly Pay Merit Increase Amount | $4.00 |
{hourly_pay_market_adjustment_amount} | Hourly Pay Market Adjustment Amount | $3.00 |
{hourly_pay_cost_of_living_adjustment_amount} | Hourly Pay Cost of Living Adjustment Amount | $1.00 |
{hourly_pay_pay_equity_adjustment_amount} | Hourly Pay Pay Equity Adjustment Amount | $0.00 |
{hourly_pay_promotion_amount} | Hourly Pay Promotion Amount | $1.50 |
{hourly_pay_lateral_move_amount} | Hourly Pay Lateral Move Amount | $0.00 |
|
|
|
{new_hourly_pay} | New Hourly Pay | $40.00 |
{new_hourly_pay_always_round_up} | New Hourly Pay | A New Hourly Pay value of $40.101 will be rounded to $40.11 |
{hours_per_week} | Hours per Week | 20 |
Note: These variables show the hourly rate change attributed to each adjustment type. Values add up to {hourly_pay_change_amount}; non-applicable types return $0.00.
Bonus Payouts
Template Variable | Variable Description | Example |
{bonus_plan_name} | Bonus Plan Name | Executive Bonus Plan |
{current_bonus_target} | Bonus Target (Amount or % of Base Pay) | If Amount: $20,000 If % of Base: 20% |
{bonus_payout} | Bonus Plan Payout | $15,000 |
{new_bonus_target} | New Bonus Target | If Amount: $25,000 If % of Base: 20% |
{one_time_bonus_amount} | One-time Bonus Amount | $2,500 |
{bonus_target_pay_change_amount} | Bonus Target Pay Change Amount | $5,000 |
Equity Grants
Template Variable | Variable Description | Example |
{new_equity_performance_grant_units} | Performance Grant Units | 2,500 |
{new_equity_promotion_grant_units} | Promotion Grant Units | 5,000 |
{new_equity_refresh_grant_units} | Refresh Grant Units | 2,000 |
Tip: To display pay or target values with decimals to the hundredth, add the suffix _two_decimals to variables just before the closing bracket.
Example:
For current base pay, you could add the following variable {current_base_pay_two_decimals}.
All hourly pay variables are always shown to two decimal places by default.