Class: FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes

Defined in:

lib/finch_api/models/hris/company/pay_statement_item_list_response.rb

Overview

See Also:

• #attributes

Instance Attribute Summary

• #employer ⇒ Boolean^?

  ‘true` if the amount is paid by the employers.

• #metadata ⇒ Hash{Symbol=>Object, nil}^?

  The metadata of the pay statement item derived by the rules engine if available.

• #pre_tax ⇒ Boolean^?

  ‘true` if the pay statement item is pre-tax.

• #type ⇒ String^?

  The type of the pay statement item.

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from FinchAPI::Internal::Type::BaseModel

Instance Attribute Details

#employer ⇒ Boolean^?

‘true` if the amount is paid by the employers. This field is only available for taxes.

Returns:

• (Boolean, nil)

# File 'lib/finch_api/models/hris/company/pay_statement_item_list_response.rb', line 50

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

#metadata ⇒ Hash{Symbol=>Object, nil}^?

The metadata of the pay statement item derived by the rules engine if available. Each attribute will be a key-value pair defined by a rule.

Returns:

• (Hash{Symbol=>Object, nil}, nil)

# File 'lib/finch_api/models/hris/company/pay_statement_item_list_response.rb', line 41

required :metadata,
FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true],
nil?: true

#pre_tax ⇒ Boolean^?

‘true` if the pay statement item is pre-tax. This field is only available for employee deductions.

Returns:

• (Boolean, nil)

# File 'lib/finch_api/models/hris/company/pay_statement_item_list_response.rb', line 57

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

#type ⇒ String^?

The type of the pay statement item.

Returns:

• (String, nil)

# File 'lib/finch_api/models/hris/company/pay_statement_item_list_response.rb', line 63

optional :type, String, nil?: true