List of Employee Tokens

Letter Management Guide

Version
R2024.1.0
List of Employee Tokens

The following is an alphabetical list of tokens that are available to insert into letter templates that have the Other Letters category. These templates are used to send letters to employees in Letter Management > Distribution.

Tokens that reference fields with effective dates are populated based on the effective date that users enter for the letter in Letter Management > Distribution. See Define Required Information for Employee Letters.

Employee tokens
Token Name Description
Employee: Address City Returns the value from the City field of the employee's primary residence as of the effective date defined for the letter.
Employee: Address Country Returns the value from the Country field of the employee's primary residence as of the effective date defined for the letter.
Employee: Address Line 1 Returns the value from the Address Line 1 field of the employee's primary residence as of the effective date defined for the letter.
Employee: Address Line 2 Returns the value from the Address Line 2 field of the employee's primary residence as of the effective date defined for the letter.
Employee: Address Line 3 Returns the value from the Address Line 3 field of the employee's primary residence as of the effective date defined for the letter.
Employee: Address State Returns the value from the State/Province drop-down list of the employee's primary residence as of the effective date defined for the letter.
Employee: Alternate Rate Returns the value from the Alternate Rate field in the employee's employment status record.
Employee: Annual Salary Returns the value from the Annual Salary field in the employee's employment status record as of the effective date defined for the letter.
Employee: Annual Vacation Entitlement (Editable) Editable token for entering the amount of vacation the employee is entitled to in the current year.
Employee: Average Daily Hours Returns the value from the Average Daily Hours field in the employee's employment status record as of the effective date defined for the letter.
Employee: Base Rate Returns the value from the Base Rate field in the employee's employment status record as of the effective date defined for the letter.
Employee: Birth Date

Returns the employee's date of birth from the Personal > Confidential Information screen of People.

Employee: Business Title Returns the value from the Business Title field in the employee's primary work assignment as of the effective date defined for the letter.
Employee: Common Name Returns the value from the Common Name field in the employee's profile.
Employee: Continuous Employment Start Date (Australia only) Returns the value from the Continuous Employment Start Date field of the Key Information tab in the Employment > Employment Settings screen of People.
Employee: Current Vacation Accrued (Editable)

Editable token for entering the amount of vacation the employee has accrued so far this year.

Employee: Current Vacation Remaining (Editable)

Editable token for entering the amount of vacation the employee has remaining in their balance for the year.

Employee: Current Vacation Taken (Editable)

Editable token for entering the amount of vacation the employee has taken already this year.

Employee: Custom Text (Editable)

Editable token for entering custom information. This field can be used when the user who is generating the letter doesn't have the Allow Edit At Preview feature enabled (under Letter Management > Distribution in the Features tab of System Admin > Roles).

Employee: Daily Rate Returns the value from the Daily Rate field in the employee's employment status record.
Employee: Days Per Week (Editable) Editable token for entering the number of days per week that the normal hours per week are worked over. There is no corresponding field in the employee record. See Define Required Information for Employee Letters.
Employee: Default Target Bonus % Returns the value from the Default Target Bonus % field in the employee's employment status record.
Employee: Effective From (Editable)

Editable token for entering the effective date of the change for the employee. This value also determines which values are populated for tokens that have effective dates. See Define Required Information for Employee Letters.

Employee: Effective To (Editable) Editable token for entering the date that the change concludes, such as if the change is for a fixed term. See Define Required Information for Employee Letters.
Employee: Entitlement Override Date Returns the value from the Entitlement Override Date field of the Key Information tab in the Employment > Employment Settings screen of People.
Employee: First Date Worked Returns the value from the First Date Worked field of the Key Information tab in the Employment > Employment Settings screen of People.
Employee: First Name Returns the value from the First Name field of the employee's profile.
Employee: German Legal Entity Address

Returns the value from the Address Line 1 field of the German legal entity's address.

Employee: German Legal Entity Address Addition

Returns the value from the Address Line 2 field of the German legal entity's address.

Employee: German Legal Entity City

Returns the value from the City field of the German legal entity in the Address tab in Org Setup > Org Payroll Setup > Legal Entity.

Employee: German Legal Entity Company Type

Returns the value from the Company Type field of the German legal entity in the Address tab in Org Setup > Org Payroll Setup > Legal Entity.

Employee: German Legal Entity Contact Email

Returns the value from the Email field of the German legal entity in the Address tab (under Contact Details) in Org Setup > Org Payroll Setup > Legal Entity.

Employee: German Legal Entity Contact Name

Returns the value from the Name field of the German legal entity in the Address tab (under Contact Details) in Org Setup > Org Payroll Setup > Legal Entity.

Employee: German Legal Entity Contact Phone

Returns the value from the Telephone Number field of the German legal entity in the Address tab (under Contact Details) in Org Setup > Org Payroll Setup > Legal Entity.

Employee: German Legal Entity Contact Title

Returns the value from the Title field of the German legal entity's address.

Employee: German Legal Entity Country Code

Returns the value from the Country Code field of the German legal entity in the Address tab in Org Setup > Org Payroll Setup > Legal Entity.

Employee: German Legal Entity Name 1

Returns the value from the Name 1 field of the German legal entity in the Address tab in Org Setup > Org Payroll Setup > Legal Entity.

Employee: German Legal Entity Name 2

Returns the value from the Name 2 field of the German legal entity in the Address tab in Org Setup > Org Payroll Setup > Legal Entity.

Employee: German Legal Entity Name 3

Returns the value from the Name 3 field of the German legal entity in the Address tab in Org Setup > Org Payroll Setup > Legal Entity.

Employee: German Legal Entity Postal Code

Returns the value from the Postcode field of the German legal entity in the Address tab in Org Setup > Org Payroll Setup > Legal Entity.

Employee: German Legal Entity State

Returns the value from the State field of the German legal entity in the Address tab in Org Setup > Org Payroll Setup > Legal Entity.

Employee: Home Phone

Returns the value from the Home Phone field of the Personal > Contact Information screen in People.

Employee: ID Number Returns the value of the employee's employee ID number.
Employee: Last Name Returns the value from the Last Name field in the employee's profile.
Employee: Last Name Prefix

(Germany only) Returns the value from the Last Name Prefix field of the Personal > Contact Information screen in People.

Employee: Legal Entity Address

Returns the value from the Address field of the legal entity's address.

Employee: Legal Entity Address Line 2

Returns the value from the Address Line 2 field of the legal entity's address.

Employee: Legal Entity City

Returns the value from the City field of the legal entity in the Address tab in Org Setup > Org Payroll Setup > Legal Entity.

Employee: Legal Entity Country Code

Returns the value from the Country Code field of the legal entity in the Address tab in Org Setup > Org Payroll Setup > Legal Entity.

Employee: Legal Entity Federal/Business ID Number

Returns the value from the Federal/Business ID Number field of the legal entity in Org Setup > Org Payroll Setup > Legal Entity.

Employee: Legal Entity Postcode

Returns the value from the Postcode field of the legal entity in the Address tab in Org Setup > Org Payroll Setup > Legal Entity.

Employee: Legal Entity State

Returns the value from the State field of the legal entity in the Address tab in Org Setup > Org Payroll Setup > Legal Entity.

Employee: Letter Submission Date

Returns the system date that the letter is submitted to workflow. This day can be before the day that the letter is sent to the employee if the workflow takes more than a day to approve.

Employee: Location Returns the value from the Location field in the employee's primary work assignment as of the effective date defined for the letter.
Employee: Long Service Leave Eligibility Date (Australia and New Zealand only) Returns the value from the Long Service Leave Eligibility Date field of the Key Information tab in the Employment > Employment Settings screen of People.
Employee: Manager First Name

Returns the value from the First Name field in the profile of the employee's manager. This is the employee's manager as of the effective date defined for the letter.

Employee: Manager Last Name Returns the value from the Last Name field in the profile of the employee's manager. This is the employee's manager as of the effective date defined for the letter.
Employee: Manager Job Assignment

Returns the value from the Job Assignment field in the primary work assignment of the employee's manager. This is the employee's manager as of the effective date defined for the letter.

Employee: Manager Middle Name Returns the value from the Middle Name field of the profile of the employee's manager.
Employee: Manager Name Affix

(Germany only) Returns the value from the Name Affix field of the Personal > Contact Information screen in People.

Employee: Manager Name Suffix (Germany only) Returns the value from the Name Suffix field in the profile of the employee's manager.
Employee: Manager Last Name Prefix

(Germany only) Returns the value from the Last Name Prefix field in the profile of the employee's manager.

Employee: Manager Professional Title (Germany only) Returns the value from the Professional Title field of the profile of the employee's manager.
Employee: Manager Business Email Returns the value from the Business Email field of the profile of the employee's manager.
Employee: Manager Business Title

Returns the value from the Business Title field in the primary work assignment of the employee's manager.

Employee: Manager Site Legal Entity Name Returns the value from the Name field of the Legal Entity tab for the site-level org unit associated with the manager's primary work assignment.
Employee: Manager Site Public Name

Returns the value from the Public Name field of the Address tab for the site-level org unit associated with the manager's primary work assignment.

Employee: Manager Site Description Returns the value from the Description field of the General tab for the site-level org unit associated with the manager's primary work assignment.
Employee: Manager Site Establishment Name Returns the value from the Establishment Name field of the Compliance Properties tab for the site-level org unit associated with the manager's primary work assignment.
Employee: Manager Site Address Line 1 Returns the value from the Address Line 1 field of the Address tab for the site-level org unit associated with the manager's primary work assignment.
Employee: Manager Site Address Line 2 Returns the value from the Address Line 2 field of the Address tab for the site-level org unit associated with the manager's primary work assignment.
Employee: Manager Site City Returns the value from the City field of the Address tab for the site-level org unit associated with the manager's primary work assignment.
Employee: Manager Site Postal Code Returns the value from the Zip / Postal Code of the Address tab for the site-level org unit associated with the manager's primary work assignment.
Employee: Manager Site Contact Email Returns the value from the Email field of the Contact tab for the site-level org unit associated with the manager's primary work assignment.
Employee: Manager Site Business Phone Returns the value from the Business Phone field of the Contact tab for the site-level org unit associated with the manager's primary work assignment.
Employee: Manager Site State / Province Returns the value from the State / Province field of the Address tab for the site-level org unit associated with the manager's primary work assignment.
Employee: Manager Site County Returns the value from the County field of the Address tab for the site-level org unit associated with the manager's primary work assignment.
Employee: Manager Site Name Returns the value from the Name field of the General tab for the site-level org unit associated with the manager's primary work assignment as of the effective date for the letter.
Employee: Manager Site Country Returns the value from the Country field of the Address tab for the site-level org unit associated with the manager's primary work assignment.
Employee: Manager Site Contact Name Returns the value from the Name field of the Contact tab for the site-level org unit associated with the manager's primary work assignment.
Employee: Manager Site Contact Cell Phone Returns the value from the Cell Phone field of the Contact tab for the site-level org unit associated with the manager's primary work assignment.
Employee: Manager Site Contact Business Phone Returns the value from the Business Phone field of the Contact tab for the site-level org unit associated with the manager's primary work assignment.
Employee: Middle Name

Returns the value from the Middle Name field of the Personal > Contact Information screen in People.

Employee: Most Recent Hire Date Returns the value from the Most Recent Hire Date field of the Key Information tab in the Employment > Employment Settings screen of People.
Employee: Name Affix

(Germany only) Returns the value from the Name Affix field of the Personal > Contact Information screen in People.

Employee: Name Suffix

(Germany only) Returns the value from the Name Affix field of the Personal > Contact Information screen in People.

Employee: Onboarding Date Returns the value from the Onboarding Date field of the Key Information tab in the Employment > Employment Settings screen of People.
Employee: Original Hire Date

Returns the value from the Original Hire Date field of the Key Information tab in the Employment > Employment Settings screen of People.

Employee: Overtime Rate Returns the value from the Overtime Rate field in the employee's employment status record.
Employee: Pay Class Returns the value from the Pay Class field (for example, full-time or part-time) in the employee's employment status record as of the effective date defined for the letter.
Employee: Pay Grade

Returns the value defined in the job associated with the employee's primary work assignment as of the effective date for the letter.

Employee: Pay Grade Control Rate

Returns the rate that most employees earn (also known as the market rate) according to the employee's primary work assignment as of the effective date defined for the letter. Not necessarily the midpoint between the minimum and maximum, it represents the ideal amount that employees working job assignments with the pay grade should earn.

Employee: Pay Grade Control Salary

Returns the salary that most employees earn (also known as the market rate) according to the employee's primary work assignment as of the effective date defined for the letter. Not necessarily the midpoint between the minimum and maximum, it represents the ideal amount that employees working job assignments with the pay grade should earn.

Employee: Pay Grade Minimum Rate Returns the minimum rate, if applicable, defined in the employee's primary work assignment as of the effective date for the letter.
Employee: Pay Grade Minimum Salary

Returns the minimum salary, if applicable, defined in the employee's primary work assignment as of the effective date for the letter.

Employee: Pay Grade Midpoint Rate

Returns the midpoint rate, if applicable, defined in the employee's primary work assignment as of the effective date for the letter.

Employee: Pay Grade Midpoint Salary

Returns the midpoint salary, if applicable, defined in the employee's primary work assignment as of the effective date for the letter.

Employee: Pay Grade Maximum Rate Returns the maximum rate, if applicable, defined in the employee's primary work assignment as of the effective date for the letter.
Employee: Pay Grade Maximum Salary

Returns the maximum salary, if applicable, defined in the employee's primary work assignment as of the effective date for the letter.

Employee: Pay Group Returns the value from the Pay Group field in the employee's employment status record.
Employee: Pay Type Returns the value from the Pay Type field (for example, salaried or hourly) in the employee's employment status record as of the effective date defined for the letter.
Employee: Pension Deferral Date

(UK only) Returns the pension deferral date, if applicable, defined in the employee's pension record in the Payroll > Pension screen of People as of the effective date for the letter.

Employee: Pension Employee Contribution %

(UK only) Returns the employee pension contribution percentage defined in the employee's pension record in the Payroll > Pension screen of People as of the effective date for the letter.

Employee: Pension Employer Contribution %

(UK only) Returns the employer pension contribution percentage defined in the employee's pension record in the Payroll > Pension screen of People as of the effective date for the letter.

Employee: Pension First Enrolment Date

(UK only) Returns the first enrolment date defined in the employee's pension record in the Payroll > Pension screen of People as of the effective date for the letter.

Employee: Pension Member Status

(UK only) Returns the member status defined in the employee's pension record in the Payroll > Pension screen of People as of the effective date for the letter.

Employee: Pension Notification Comments

(UK only) Returns the notification comments defined in the employee's pension record in the Payroll > Pension screen of People as of the effective date for the letter.

Employee: Pension Notification Date

(UK only) Returns the notification date defined in the employee's pension record in the Payroll > Pension screen of People as of the effective date for the letter.

Employee: Pension Notification Type

(UK only) Returns the notification type defined in the employee's pension record in the Payroll > Pension screen of People as of the effective date for the letter.

Employee: Pension Pay Period End Date

(UK only) Returns the pay period end date defined in the employee's pension record in the Payroll > Pension screen of People as of the effective date for the letter.

Employee: Pension Pay Period Start Date

(UK only) Returns the pay period start date defined in the employee's pension record in the Payroll > Pension screen of People as of the effective date for the letter.

Employee: Pension Worker Category

(UK only) Returns the worker category defined in the employee's pension record in the Payroll > Pension screen of People as of the effective date for the letter.

Employee: Job Assignment Returns the value from the Job Assignment field in the employee's primary work assignment as of the effective date defined for the letter.
Employee: Position Term Returns the value from the Position Term field (for example, regular or temporary) in the employee's primary work assignment as of the effective date defined for the letter.
Employee: Postal Code Returns the value from the Zip/Postal Code field of the employee's primary residence as of the effective date defined for the letter.
Employee: PPACA Override Date (US only) Returns the value from the PPACA Override Date field of the Key Information tab in the Employment > Employment Settings screen of People.

Employee: Professional Reference (Editable)

Editable token for entering custom professional reference information that can be included in a template with the Other Letters category. This field can be used when the user who is generating the letter doesn't have the Allow Edit At Preview feature enabled (under Letter Management > Distribution in the Features tab of System Admin > Roles).

Employee: Professional Title

(Germany only) Returns the value from the Professional Title field of the Personal > Contact Information screen in People.

Employee: Second Last Name Returns the value from the Second Last Name field in the employee's profile.
Employee: Seniority Date Returns the value from the Seniority Date field defined for the employee in the Key Information tab of the Employment > Employment Settings screen in People.
Employee: Site Address Business Phone Returns the value from the Business Phone field of the Address tab for the site-level org unit associated with the employee's primary work assignment as of the effective date for the letter.
Employee: Site Address Country Returns the value from the Country field of the Address tab for the site-level org unit associated with the employee's primary work assignment as of the effective date for the letter.

Employee: Site Address Line 1

Returns the value from the Address Line 1 field of the Address tab for the site-level org unit associated with the employee's primary work assignment as of the effective date for the letter.

Employee: Site Address Line 2

Returns the value from the Address Line 2 field of the Address tab for the site-level org unit associated with the employee's primary work assignment as of the effective date for the letter.

Employee: Site City

Returns the value from the City field of the Address tab for the site-level org unit associated with the employee's primary work assignment as of the effective date for the letter.

Employee: Site Contact Business Phone

Returns the value from the Business Phone field of the Contact tab for the site-level org unit associated with the employee's primary work assignment as of the effective date for the letter.

Employee: Site Contact Cell Phone

Returns the value from the Cell Phone field of the Contact tab for the site-level org unit associated with the employee's primary work assignment as of the effective date for the letter.

Employee: Site Contact Name

Returns the value from the Name field of the Contact tab for the site-level org unit associated with the employee's primary work assignment as of the effective date for the letter.

Employee: Site Contact Email

Returns the value from the Email field of the Contact tab for the site-level org unit associated with the employee's primary work assignment as of the effective date for the letter.

Employee: Site County

Returns the value from the County field of the Address tab for the site-level org unit associated with the employee's primary work assignment as of the effective date for the letter.

Employee: Site Description

Returns the value from the Description field of the General tab for the site-level org unit associated with the employee's primary work assignment as of the effective date for the letter.

Employee: Site Establishment Name

Returns the value from the Establishment Name field of the Compliance Properties tab for the site-level org unit associated with the employee's primary work assignment as of the effective date for the letter.
Employee: Site Legal Entity Name Returns the value from the Name field of the Legal Entity tab for the site-level org unit associated with the employee's primary work assignment as of the effective date for the letter.
Employee: Site Name Returns the value from the Name field of the General tab for the site-level org unit associated with the employee's primary work assignment as of the effective date for the letter.

Employee: Site Postal Code

Returns the value from the Zip / Postal Code of the Address tab for the site-level org unit associated with the employee's primary work assignment as of the effective date for the letter.

Employee: Site Public Name

Returns the value from the Public Name field of the Address tab for the site-level org unit associated with the employee's primary work assignment as of the effective date for the letter.

Employee: Site State / Province

Returns the value from the State / Province field of the Address tab for the site-level org unit associated with the employee's primary work assignment as of the effective date for the letter.
Employee: Target Bonus Override % Returns the value from the Target Bonus Override % field in the employee's employment status record.
Employee: Termination Date

Returns the value from the Most Recent Termination Date field in the Key Information tab of the Employment > Employment Settings screen in People.

Employee: Termination Reason Returns the value from the Reason field of the most recent terminated status following a non-terminated status in the Employment Status tab of the Employment > Employment Settings screen of People.
Employee: Title Returns the value from the Title field (for example, Mr. or Ms.) of the employee.

Employee: Vacation Rate

Returns the value from the Vacation Rate field in the employee's employment status record.

Employee: Weekly Hours Returns the value from the Normal Weekly Hours field in the employment status record of the employee as of the effective date defined for the letter.