Class: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction

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

Defined Under Namespace

Classes: Attributes

Instance Attribute 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(amount: , currency: , name: , pre_tax: , type: , attributes: nil) ⇒ Object

Parameters:

  • amount (Integer, nil) (defaults to: )

    The deduction amount in cents.

  • currency (String, nil) (defaults to: )

    The deduction currency.

  • name (String, nil) (defaults to: )

    The deduction name from the pay statement.

  • pre_tax (Boolean, nil) (defaults to: )

    Boolean indicating if the deduction is pre-tax.

  • type (Symbol, FinchAPI::Models::HRIS::BenefitType, nil) (defaults to: )

    Type of benefit.

  • attributes (FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes, nil) (defaults to: nil)


# File 'lib/finch_api/models/hris/pay_statement.rb', line 227

Instance Attribute Details

#amountInteger?

The deduction amount in cents.

Returns:

  • (Integer, nil)


196
# File 'lib/finch_api/models/hris/pay_statement.rb', line 196

required :amount, Integer, nil?: true

#attributesFinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes?



225
# File 'lib/finch_api/models/hris/pay_statement.rb', line 225

optional :attributes, -> { FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes }, nil?: true

#currencyString?

The deduction currency.

Returns:

  • (String, nil)


202
# File 'lib/finch_api/models/hris/pay_statement.rb', line 202

required :currency, String, nil?: true

#nameString?

The deduction name from the pay statement.

Returns:

  • (String, nil)


208
# File 'lib/finch_api/models/hris/pay_statement.rb', line 208

required :name, String, nil?: true

#pre_taxBoolean?

Boolean indicating if the deduction is pre-tax.

Returns:

  • (Boolean, nil)


214
# File 'lib/finch_api/models/hris/pay_statement.rb', line 214

required :pre_tax, FinchAPI::Internal::Type::Boolean, nil?: true

#typeSymbol, ...

Type of benefit.

Returns:



220
# File 'lib/finch_api/models/hris/pay_statement.rb', line 220

required :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true