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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction

Defined in:

lib/finch_api/models/hris/pay_statement.rb

Defined Under Namespace

Classes: Attributes

Instance Attribute Summary

• #amount ⇒ Integer^?

  The deduction amount in cents.

• #attributes ⇒ FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes^?
• #currency ⇒ String^?

  The deduction currency.

• #name ⇒ String^?

  The deduction name from the pay statement.

• #pre_tax ⇒ Boolean^?

  Boolean indicating if the deduction is pre-tax.

• #type ⇒ Symbol, ...

  Type of benefit.

Instance Method Summary

• #initialize(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil) ⇒ Object constructor

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_yaml

Methods included from Internal::Type::Converter

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

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!

Constructor Details

#initialize(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil) ⇒ Object

Parameters:

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

  The deduction amount in cents.

• attributes (FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes, nil) (defaults to: nil)
• currency (String, nil) (defaults to: nil) —

  The deduction currency.

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

  The deduction name from the pay statement.

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

  Boolean indicating if the deduction is pre-tax.

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

  Type of benefit.

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

Instance Attribute Details

#amount ⇒ Integer^?

The deduction amount in cents.

Returns:

• (Integer, nil)

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

optional :amount, Integer, nil?: true

#attributes ⇒ FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes^?

Returns:

• (FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes, nil)

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

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

#currency ⇒ String^?

The deduction currency.

Returns:

• (String, nil)

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

optional :currency, String, nil?: true

#name ⇒ String^?

The deduction name from the pay statement.

Returns:

• (String, nil)

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

optional :name, String, nil?: true

#pre_tax ⇒ Boolean^?

Boolean indicating if the deduction is pre-tax.

Returns:

• (Boolean, nil)

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

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

#type ⇒ Symbol, ...

Type of benefit.

Returns:

• (Symbol, FinchAPI::HRIS::BenefitType, nil)

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

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