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

Inherits:

BaseModel

• Object
• 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::Models::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) ⇒ EmployeeDeduction constructor

  A new instance of EmployeeDeduction.

Constructor Details

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

Returns a new instance of EmployeeDeduction.

Parameters:

• amount (Integer, nil) (defaults to: nil)
• attributes (FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes, nil) (defaults to: nil)
• currency (String, nil) (defaults to: nil)
• name (String, nil) (defaults to: nil)
• pre_tax (Boolean, nil) (defaults to: nil)
• type (Symbol, FinchAPI::Models::HRIS::BenefitType, nil) (defaults to: nil)

# File 'lib/finch-api/models/hris/pay_statement.rb', line 8

def initialize(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil, **) = super

Instance Attribute Details

#amount ⇒ Integer^?

The deduction amount in cents.

Returns:

• (Integer, nil)

# File 'lib/finch-api/models/hris/pay_statement.rb', line 225

optional :amount, Integer, nil?: true

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

Returns:

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

# File 'lib/finch-api/models/hris/pay_statement.rb', line 230

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

#currency ⇒ String^?

The deduction currency.

Returns:

• (String, nil)

# File 'lib/finch-api/models/hris/pay_statement.rb', line 238

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 244

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 250

optional :pre_tax, FinchAPI::BooleanModel, nil?: true

#type ⇒ Symbol, ...

Type of benefit.

Returns:

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

# File 'lib/finch-api/models/hris/pay_statement.rb', line 256

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