Skip to content

Latest commit

 

History

History
38 lines (34 loc) · 4.37 KB

EmployeeRequest.md

File metadata and controls

38 lines (34 loc) · 4.37 KB

Merge.HRISClient.Model.EmployeeRequest

The Employee Object ### Description The Employee object is used to represent any person who has been employed by a company. ### Usage Example Fetch from the LIST Employee endpoint and filter by ID to show all employees.

Properties

Name Type Description Notes
EmployeeNumber string The employee's number that appears in the third-party integration's UI. [optional]
Company Guid? The ID of the employee's company. [optional]
FirstName string The employee's first name. [optional]
LastName string The employee's last name. [optional]
DisplayFullName string The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name. [optional]
Username string The employee's username that appears in the remote UI. [optional]
Groups List<Guid?> [optional]
WorkEmail string The employee's work email. [optional]
PersonalEmail string The employee's personal email. [optional]
MobilePhoneNumber string The employee's mobile phone number. [optional]
Employments List<Guid?> Array of `Employment` IDs for this Employee. [optional]
HomeLocation Guid? The employee's home address. [optional]
WorkLocation Guid? The employee's work address. [optional]
Manager Guid? The employee ID of the employee's manager. [optional]
Team Guid? The employee's team. [optional]
PayGroup Guid? The employee's pay group [optional]
Ssn string The employee's social security number. [optional]
Gender GenderEnum The employee's gender. * `MALE` - MALE * `FEMALE` - FEMALE * `NON-BINARY` - NON-BINARY * `OTHER` - OTHER * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE [optional]
Ethnicity EthnicityEnum The employee's ethnicity. * `AMERICAN_INDIAN_OR_ALASKA_NATIVE` - AMERICAN_INDIAN_OR_ALASKA_NATIVE * `ASIAN_OR_INDIAN_SUBCONTINENT` - ASIAN_OR_INDIAN_SUBCONTINENT * `BLACK_OR_AFRICAN_AMERICAN` - BLACK_OR_AFRICAN_AMERICAN * `HISPANIC_OR_LATINO` - HISPANIC_OR_LATINO * `NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER` - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER * `TWO_OR_MORE_RACES` - TWO_OR_MORE_RACES * `WHITE` - WHITE * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE [optional]
MaritalStatus MaritalStatusEnum The employee's filing status as related to marital status. * `SINGLE` - SINGLE * `MARRIED_FILING_JOINTLY` - MARRIED_FILING_JOINTLY * `MARRIED_FILING_SEPARATELY` - MARRIED_FILING_SEPARATELY * `HEAD_OF_HOUSEHOLD` - HEAD_OF_HOUSEHOLD * `QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD` - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD [optional]
DateOfBirth DateTime? The employee's date of birth. [optional]
HireDate DateTime? The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field. [optional]
StartDate DateTime? The date that the employee started working. If an employee was rehired, the most recent start date will be returned. [optional]
EmploymentStatus EmploymentStatusEnum The employment status of the employee. * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE [optional]
TerminationDate DateTime? The employee's termination date. [optional]
Avatar string The URL of the employee's avatar image. [optional]
IntegrationParams Dictionary<string, Object> [optional]
LinkedAccountParams Dictionary<string, Object> [optional]

[Back to Model list] [Back to API list] [Back to README]