kombo-ruby-sdk/docs/GetHrisEmployeesPositiveResponseDataResultsInner.md

Kombo::GetHrisEmployeesPositiveResponseDataResultsInner

Properties

Name	Type	Description	Notes
id	String	The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
remote_id	String	The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.
employee_number	String	The employee’s organization-internal employee number.
first_name	String	The employee’s first name.
last_name	String	The employee’s last name.
nationality	String	The employee’s nationality.
display_full_name	String	The employee’s full name, including any middle names. Not all HR systems provide an explicit display name, so we recommend falling back to `first_name` and `last_name`.
job_title	String	The employee’s job title.
work_email	String	The employee’s work email address. If the email address is invalid, we will set this to `null`.	[optional]
personal_email	String	The employee’s personal email address. If the email address is invalid, we will set this to `null`.	[optional]
mobile_phone_number	String	The employee’s mobile phone number.
ssn	String	The employee’s social security number
tax_id	String	The employee’s tax ID.
gender	GetHrisEmployeesPositiveResponseDataResultsInnerGender		[optional]
ethnicity	GetHrisEmployeesPositiveResponseDataResultsInnerEthnicity		[optional]
marital_status	GetHrisEmployeesPositiveResponseDataResultsInnerMaritalStatus		[optional]
employment_status	GetHrisEmployeesPositiveResponseDataResultsInnerEmploymentStatus		[optional]
employment_type	GetHrisEmployeesPositiveResponseDataResultsInnerEmploymentType		[optional]
weekly_hours	Float	The employee’s weekly working hours.
avatar	String	URL to the employee’s avatar. This is either the raw URL from the HR system (in cases where it can be requested without short-lived authentication) or a URL to a temporarily cached version of the file hosted by Kombo. Kombo will delete the cached file after its deletion in the source system.
work_location_id	String	The Kombo ID of the employee’s work location. The ID can be used to retrieve the work location from the `get work locations` endpoint.
legal_entity_id	String	The Kombo ID of the employee’s legal entity. The ID can be used to retrieve the legal entity from the `get legal entities` endpoint.
manager_id	String	The Kombo ID of the employee’s manager. The ID can be used to retrieve the manager from the `get employees` endpoint.
home_address	GetHrisEmployeesPositiveResponseDataResultsInnerHomeAddress		[optional]
bank_accounts	Array<GetHrisEmployeesPositiveResponseDataResultsInnerBankAccountsInner>	The employee’s bank accounts.	[optional]
date_of_birth	Time	The employee’s date of birth.
start_date	Time	The date the employee started working for the organization.
termination_date	Time	The date when the employment ends. Can be in the past or future.
remote_created_at	Time	The date and time the object was created in the remote system.
changed_at	Time	The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the `updated_after` parameter which will return records when either the record itself OR its related models have been updated.
remote_deleted_at	Time	The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear.
custom_fields	Hash<String, Object>	A key-value store of fields not covered by the schema. Read more
integration_fields	Array<GetHrisEmployeesPositiveResponseDataResultsInnerIntegrationFieldsInner>	An array of selected passthrough integration fields. Read more
remote_data	Hash<String, Object>	Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set. Remote data always has the endpoint path that we got the data from as the top level key. For example, it could look like: `{ &quot;/companies&quot;: { ... }}` This is not available on all plans. Reach out to Kombo if you need it.
employments	Array<GetHrisEmployeesPositiveResponseDataResultsInnerEmploymentsInner>
time_off_balances	Array<GetHrisEmployeesPositiveResponseDataResultsInnerTimeOffBalancesInner>
manager	GetHrisEmployeesPositiveResponseDataResultsInnerManager
groups	Array<GetHrisEmployeesPositiveResponseDataResultsInnerGroupsInner>
legal_entity	GetHrisEmployeesPositiveResponseDataResultsInnerLegalEntity
teams	Array<GetHrisEmployeesPositiveResponseDataResultsInnerGroupsInner>	(⚠️ Deprecated - Please use `groups` instead. It includes the same data and the naming is less confusing.) Maintained field for backwards compatibility.
work_location	GetHrisEmployeesPositiveResponseDataResultsInnerWorkLocation

Example

require 'kombo_client'

instance = Kombo::GetHrisEmployeesPositiveResponseDataResultsInner.new(
  id: null,
  remote_id: null,
  employee_number: null,
  first_name: null,
  last_name: null,
  nationality: null,
  display_full_name: null,
  job_title: null,
  work_email: null,
  personal_email: null,
  mobile_phone_number: null,
  ssn: null,
  tax_id: null,
  gender: null,
  ethnicity: null,
  marital_status: null,
  employment_status: null,
  employment_type: null,
  weekly_hours: null,
  avatar: null,
  work_location_id: null,
  legal_entity_id: null,
  manager_id: null,
  home_address: null,
  bank_accounts: null,
  date_of_birth: null,
  start_date: null,
  termination_date: null,
  remote_created_at: null,
  changed_at: null,
  remote_deleted_at: null,
  custom_fields: null,
  integration_fields: null,
  remote_data: null,
  employments: null,
  time_off_balances: null,
  manager: null,
  groups: null,
  legal_entity: null,
  teams: null,
  work_location: null
)