Class: VitableConnect::Models::Employee::Deduction

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/vitable_connect/models/employee.rb,
sig/vitable_connect/models/employee.rbs

Defined Under Namespace

Modules: Frequency, TaxClassification

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(benefit_name:, deduction_amount_in_cents:, deduction_category:, frequency:, period_end_date:, period_start_date:, tax_classification:) ⇒ Object

Some parameter documentations has been truncated, see VitableConnect::Models::Employee::Deduction for more details.

Parameters:




# File 'lib/vitable_connect/models/employee.rb', line 265

Instance Attribute Details

#benefit_name ⇒ String

Name of the benefit plan

Parameters:

  • value (String)

Returns:

  • (String) 


222
 
# File 'lib/vitable_connect/models/employee.rb', line 222

required :benefit_name, String

#deduction_amount_in_cents ⇒ Integer

Employee deduction amount in cents

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


228
 
# File 'lib/vitable_connect/models/employee.rb', line 228

required :deduction_amount_in_cents, Integer

#deduction_category ⇒ String?

Deduction category (reserved for future use)

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


234
 
# File 'lib/vitable_connect/models/employee.rb', line 234

required :deduction_category, String, nil?: true

#frequency ⇒ Symbol, VitableConnect::Models::Employee::Deduction::Frequency

  • weekly - Weekly
  • bi_weekly - Bi Weekly
  • semi_monthly - Semi Monthly
  • monthly - Monthly

Parameters:

  • value (VitableConnect::Models::Employee::Deduction::frequency)

Returns:



243
 
# File 'lib/vitable_connect/models/employee.rb', line 243

required :frequency, enum: -> { VitableConnect::Employee::Deduction::Frequency }

#period_end_date ⇒ Date

Period end date (YYYY-MM-DD)

Parameters:

  • value (Date)

Returns:

  • (Date) 


249
 
# File 'lib/vitable_connect/models/employee.rb', line 249

required :period_end_date, Date

#period_start_date ⇒ Date

Period start date (YYYY-MM-DD)

Parameters:

  • value (Date)

Returns:

  • (Date) 


255
 
# File 'lib/vitable_connect/models/employee.rb', line 255

required :period_start_date, Date

#tax_classification ⇒ Symbol, VitableConnect::Models::Employee::Deduction::TaxClassification

  • Unknown - Unknown
  • Pre-tax - Pre Tax
  • Post-tax - Post Tax

Parameters:

  • value (VitableConnect::Models::Employee::Deduction::tax_classification)

Returns:



263
 
# File 'lib/vitable_connect/models/employee.rb', line 263

required :tax_classification, enum: -> { VitableConnect::Employee::Deduction::TaxClassification }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/vitable_connect/models/employee.rb', line 297

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


176
 
# File 'sig/vitable_connect/models/employee.rbs', line 176

def to_hash: -> {