Read Employee

ACA Status

The employee's ACA (Affordable Care Act) status.

This field can't be updated directly, but is calculated based on mappings for employment status found on the employmentStatus table.

Available states: contractor, full-time, intern-eligible, intern-ineligible, part-time-eligible, part-time-ineligible, or seasonal.

Address Line 1

The employee's first address line.

Address Line 2

The employee's second address line.

Age

The employee's age. Changing this value requires an update to the Birth Date field.

Best Email

The employee's work email if set, otherwise their home email.

Birth Date

The date the employee was born.

Birthday

The employee's month and day of birth. Changing this value requires an update to the Birth Date field.

Bonus Amount

The amount of the most recent bonus.

Bonus Comment

Comment about the most recent bonus.

Bonus Date

The date of the last bonus.

Bonus Reason

The reason for the most recent bonus.

City

The employee's city.

Commission Amount

The amount of the most recent commission.

Commission Comment

Comment about the most recent commission.

Commission Date

The date of the last commission.

Compensation Change Reason

Reason for the most recent compensation change.

Compensation: Date

The date of the last compensation.

Country

The employee's country.

Created By User ID

The identifier of the user who created the employee. This is a read-only value.

This may be null if the employee was created before this field was added.

Department

The employee's current department.

Display Name

The employee's name, displayed in a format configured by the user. This is a read-only value.

Division

The employee's current division.

EEO Job Category

The employee's EEO job category. The US Equal Employment Opportunity Commission defines these categories.

Employee #

The employee number assigned by your company.

Employment Status

The employee's current employment status. Options are customized by account. This is a read-only value.

Ethnicity

The employee's ethnicity.

First & Last Name

The employee's first and family name. For example, John Doe. This is a read-only value.

First Name

The employee's first name.

Full Name (First, Last)

The employee's full name without their preferred name, first name first. For example, John Quentin Doe. This is a read-only value.

Full Name (Last, First)

The employee's full name without their preferred name, family name first. For example, Doe, John Quentin. This is a read-only value.

Full Name (Last, First) & Preferred

The employee's full name and their preferred name. For example, Doe, John Quentin (JDog). This is a read-only value.

Gender

The employee's gender: Male or Female.

Hire Date

The date the employee was hired.

Home Email

The employee's home email address.

Home Phone

The employee's home phone number.

Include in Payroll

Should employee be included in payroll: Yes or No.

Is Photo Uploaded

Whether a photo has been uploaded for the employee. This is a read-only value.

Job Title

The current value of the employee's job title. Updating this field creates a new row in the position history.

Last & First Name

The employee's last and first name. For example, Doe, John. This is a read-only value.

Last Changed

The date and time of the last change to the employee record.

Last Name

The employee's family name.

Location

The employee's current location.

Marital Status

The employee's marital status: Single, Married, or Domestic Partnership.

Middle Name

The employee's middle name.

Mobile Phone

The employee's mobile phone number.

NIN

The employee's NIN number.

National ID

The employee's National ID number.

Nationality

The employee's nationality.

Original Hire Date

The date the employee was originally hired.

Overtime Status

The FLSA Overtime Status: Exempt or Non-exempt.

Pay Frequency

The employee's current pay frequency: Weekly, Every other week, Twice a month, Monthly, Quarterly, Twice a year, or Yearly.

Pay Group

The custom pay group to which the employee belongs.

Pay Group ID

The ID value corresponding to the pay group to which an employee belongs.

Pay Period

The employee's current pay per: Hour, Day, Week, Month, Quarter, or Year.

Pay Rate

The employee's current pay rate. For example, $8.25.

Pay Schedule

The employee's current pay schedule.

Pay Schedule ID

The ID value corresponding to the pay schedule that an employee belongs to.

Pay Type

The employee's current pay type: hourly, salary, commission, exception hourly, monthly, weekly, piece rate, contract, daily, or pro rata.

Preferred Name

The employee's preferred name.

SIN

The employee's Canadian Social Insurance Number.

SSN

The employee's Social Security number.

Standard Hours Per Week

The number of hours the employee works in a standard week.

State

The employee's state or province.

State Code

The 2 character abbreviation for the employee's state (US only). This is a read-only value.

Status

The employee's employee status: Active or Inactive.

Supervisor

The employee's current supervisor. This is a read-only value.

Supervisor Email

The email of the employee's current supervisor. This is a read-only value.

Supervisor Employee ID

The ID of the employee's current supervisor. This is a read-only value.

Supervisor Employee Number

The employee number of the employee's current supervisor. This is a read-only value.

Termination Date

The date the employee was terminated. Read-only.

Time Tracking Enabled

Should time tracking be enabled for the employee: Yes or No.

Work Email

The employee's work email address.

Work Ext.

The employee's work phone extension (if any).

Work Phone

The employee's work phone number, without extension.

Work Phone + Extension

The employee's work phone and extension. This is a read-only value.