Skip to content

Latest commit

 

History

History
52 lines (46 loc) · 2.84 KB

Dependent.md

File metadata and controls

52 lines (46 loc) · 2.84 KB

MergeHRISClient::Dependent

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]
first_name String The dependents's first name. [optional]
middle_name String The dependents's middle name. [optional]
last_name String The dependents's last name. [optional]
relationship RelationshipEnum The dependent's relationship to the employee. * `CHILD` - CHILD * `SPOUSE` - SPOUSE * `DOMESTIC_PARTNER` - DOMESTIC_PARTNER [optional]
employee String The employee this person is a dependent of. [optional]
date_of_birth Time The dependent's date of birth. [optional]
gender GenderEnum The dependent's gender. * `MALE` - MALE * `FEMALE` - FEMALE * `NON-BINARY` - NON-BINARY * `OTHER` - OTHER * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE [optional]
phone_number String The dependent's phone number. [optional]
home_location String The dependents's home address. [optional]
is_student Boolean Whether or not the dependent is a student [optional]
ssn String The dependents's social security number. [optional]
remote_was_deleted Boolean Indicates whether or not this object has been deleted in the third party platform. [optional][readonly]
field_mappings Object [optional][readonly]
remote_data Array<RemoteData> [optional][readonly]

Example

require 'merge_hris_client'

instance = MergeHRISClient::Dependent.new(
  id: null,
  remote_id: 19202940,
  created_at: 2021-09-15T00:00Z,
  modified_at: 2021-10-16T00:00Z,
  first_name: Greg,
  middle_name: A,
  last_name: Hirsch,
  relationship: CHILD,
  employee: 0958cbc6-6040-430a-848e-aafacbadf4ae,
  date_of_birth: 1990-11-10T00:00Z,
  gender: MALE,
  phone_number: +1234567890,
  home_location: d2f972d0-2526-434b-9409-4c3b468e08f0,
  is_student: null,
  ssn: 1234567890,
  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;/dependent&quot;,&quot;data&quot;:[&quot;Varies by platform&quot;]}]
)