Skip to content

Latest commit

 

History

History
88 lines (82 loc) · 6.44 KB

Employee.md

File metadata and controls

88 lines (82 loc) · 6.44 KB

MergeHRISClient::Employee

Properties

Name Type Description Notes
id String [optional][readonly]
remote_id String The third-party API ID of the matching object. [optional]
created_at Time The datetime that this object was created by Merge. [optional][readonly]
modified_at Time The datetime that this object was modified by Merge. [optional][readonly]
employee_number String The employee's number that appears in the third-party integration's UI. [optional]
company String The ID of the employee's company. [optional]
first_name String The employee's first name. [optional]
last_name String The employee's last name. [optional]
preferred_name String The employee's preferred first name. [optional]
display_full_name 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 Array<String> [optional]
work_email String The employee's work email. [optional]
personal_email String The employee's personal email. [optional]
mobile_phone_number String The employee's mobile phone number. [optional]
employments Array<String> Array of `Employment` IDs for this Employee. [optional]
home_location String The employee's home address. [optional]
work_location String The employee's work address. [optional]
manager String The employee ID of the employee's manager. [optional]
team String The employee's team. [optional]
pay_group String 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]
marital_status 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]
date_of_birth Time The employee's date of birth. [optional]
hire_date Time 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]
start_date Time The date that the employee started working. If an employee was rehired, the most recent start date will be returned. [optional]
remote_created_at Time When the third party's employee was created. [optional]
employment_status EmploymentStatusEnum The employment status of the employee. * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE [optional]
termination_date Time The employee's termination date. [optional]
avatar String The URL of the employee's avatar image. [optional]
custom_fields Hash<String, AnyType> Custom fields configured for a given model. [optional]
remote_was_deleted Boolean [optional][readonly]
field_mappings Object [optional][readonly]
remote_data Array<RemoteData> [optional][readonly]

Example

require 'merge_hris_client'

instance = MergeHRISClient::Employee.new(
  id: 0958cbc6-6040-430a-848e-aafacbadf4ae,
  remote_id: 19202938,
  created_at: 2021-09-15T00:00Z,
  modified_at: 2021-10-16T00:00Z,
  employee_number: 2,
  company: 8d9fd929-436c-4fd4-a48b-0c61f68d6178,
  first_name: Greg,
  last_name: Hirsch,
  preferred_name: Greg the egg,
  display_full_name: Cousin Greg Hirsch,
  username: cousingreg,
  groups: [&quot;21a54124-397f-494d-985e-3c5b330b8a68&quot;],
  work_email: greg@merge.dev,
  personal_email: greg@gmail.com,
  mobile_phone_number: +1234567890,
  employments: [&quot;17a54124-287f-494d-965e-3c5b330c9a68&quot;],
  home_location: d2f972d0-2526-434b-9409-4c3b468e08f0,
  work_location: 9efbc633-3387-4306-aa55-e2c635e6bb4f,
  manager: 0048ea5b-911e-4dff-9364-92070dea62ff,
  team: 249c9faa-3045-4a31-953b-8f22d3613301,
  pay_group: ad1264e2-39be-4787-b749-f1aade9e3405,
  ssn: 1234567890,
  gender: MALE,
  ethnicity: WHITE,
  marital_status: SINGLE,
  date_of_birth: 1990-11-10T00:00Z,
  hire_date: 2020-10-10T00:00Z,
  start_date: 2020-10-11T00:00Z,
  remote_created_at: 2020-10-11T00:00Z,
  employment_status: INACTIVE,
  termination_date: 2021-10-12T00:00Z,
  avatar: http://alturl.com/h2h8m,
  custom_fields: null,
  remote_was_deleted: null,
  field_mappings: {&quot;organization_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;},&quot;linked_account_defined_targets&quot;:{&quot;custom_key&quot;:&quot;custom_value&quot;}},
  remote_data: [{&quot;path&quot;:&quot;/people&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
)