Class: FinchAPI::Models::HRIS::EmploymentData::CustomField

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/finch_api/models/hris/employment_data.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, dump, fields, hash, #hash, inspect, #inspect, known_fields, optional, required, #to_h, #to_json, #to_s, #to_yaml, walk

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Constructor Details

#initialize(id: nil, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, income: nil, income_history: nil, is_active: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, source_id: nil, start_date: nil, title: nil, work_id: nil) ⇒ Object

Some parameter documentations has been truncated, see FinchAPI::Models::HRIS::EmploymentData for more details.

…

…

…

Parameters:

  • id (String) (defaults to: nil) —

    A stable Finch ‘id` (UUID v4) for an individual in the company.

  • class_code (String, nil) (defaults to: nil) —

    Worker’s compensation classification code for this employee

  • custom_fields (Array<FinchAPI::Models::HRIS::EmploymentData::CustomField>, nil) (defaults to: nil) —

    Custom fields for the individual. These are fields which are defined by the empl

  • department (FinchAPI::Models::HRIS::EmploymentData::Department, nil) (defaults to: nil) —

    The department object.

  • employment (FinchAPI::Models::HRIS::EmploymentData::Employment, nil) (defaults to: nil) —

    The employment object.

  • employment_status (Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus, nil) (defaults to: nil) —

    The detailed employment status of the individual. Available options: ‘active`, `

  • end_date (String, nil) (defaults to: nil)
  • first_name (String, nil) (defaults to: nil) —

    The legal first name of the individual.

  • income (FinchAPI::Models::Income, nil) (defaults to: nil) —

    The employee’s income as reported by the provider. This may not always be annual

  • income_history (Array<FinchAPI::Models::Income, nil>, nil) (defaults to: nil) —

    The array of income history.

  • is_active (Boolean, nil) (defaults to: nil) —

    ‘true` if the individual an an active employee or contractor at the company.

  • last_name (String, nil) (defaults to: nil) —

    The legal last name of the individual.

  • latest_rehire_date (String, nil) (defaults to: nil)
  • location (FinchAPI::Models::Location, nil) (defaults to: nil)
  • manager (FinchAPI::Models::HRIS::EmploymentData::Manager, nil) (defaults to: nil) —

    The manager object representing the manager of the individual within the org.

  • middle_name (String, nil) (defaults to: nil) —

    The legal middle name of the individual.

  • source_id (String, nil) (defaults to: nil) —

    The source system’s unique employment identifier for this individual

  • start_date (String, nil) (defaults to: nil)
  • title (String, nil) (defaults to: nil) —

    The current title of the individual.

  • work_id (String, nil) (defaults to: nil) —

    This field is deprecated in favour of ‘source_id`



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/finch_api/models/hris/employment_data.rb', line 182

class CustomField < FinchAPI::Internal::Type::BaseModel
  # @!attribute name
  #
  #   @return [String, nil]
  optional :name, String

  # @!attribute value
  #
  #   @return [Object, nil]
  optional :value, FinchAPI::Internal::Type::Unknown

  # @!method initialize(name: nil, value: nil)
  #   @param name [String]
  #   @param value [Object]
end

Instance Attribute Details

#name ⇒ String?

Returns:

  • (String, nil) 


186
 
# File 'lib/finch_api/models/hris/employment_data.rb', line 186

optional :name, String

#value ⇒ Object?

Returns:

  • (Object, nil) 


191
 
# File 'lib/finch_api/models/hris/employment_data.rb', line 191

optional :value, FinchAPI::Internal::Type::Unknown