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

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

Defined Under Namespace

Modules: PaymentMethod, Type Classes: Earning, EmployeeDeduction, EmployerContribution, Tax

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(metadata: ) ⇒ Object

Some parameter documentations has been truncated, see FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata for more details.

Parameters:

  • metadata (Hash{Symbol=>Object, nil}) (defaults to: ) —

    The metadata to be attached to the entity by existing rules. It is a key-value p




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

Instance Attribute Details

#earnings ⇒ Array<FinchAPI::Models::HRIS::PayStatement::Earning, nil>?

The array of earnings objects associated with this pay statement

Returns:



11
12
13
 
# File 'lib/finch_api/models/hris/pay_statement.rb', line 11

required :earnings,
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::Earning, nil?: true] },
nil?: true

#employee_deductions ⇒ Array<FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction, nil>?

The array of deductions objects associated with this pay statement.

Returns:



19
20
21
22
23
24
 
# File 'lib/finch_api/models/hris/pay_statement.rb', line 19

required :employee_deductions,
-> {
  FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::EmployeeDeduction,
                                    nil?: true]
},
nil?: true

#employer_contributions ⇒ Array<FinchAPI::Models::HRIS::PayStatement::EmployerContribution, nil>?

Returns:



29
30
31
32
33
34
 
# File 'lib/finch_api/models/hris/pay_statement.rb', line 29

required :employer_contributions,
-> {
  FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::EmployerContribution,
                                    nil?: true]
},
nil?: true

#gross_pay ⇒ FinchAPI::Models::Money?

Returns:



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

required :gross_pay, -> { FinchAPI::Money }, nil?: true

#individual_id ⇒ String

A stable Finch ‘id` (UUID v4) for an individual in the company

Returns:

  • (String) 


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

required :individual_id, String

#net_pay ⇒ FinchAPI::Models::Money?

Returns:



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

required :net_pay, -> { FinchAPI::Money }, nil?: true

#payment_method ⇒ Symbol, ...

The payment method.

Returns:



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

required :payment_method, enum: -> { FinchAPI::HRIS::PayStatement::PaymentMethod }, nil?: true

#taxes ⇒ Array<FinchAPI::Models::HRIS::PayStatement::Tax, nil>?

The array of taxes objects associated with this pay statement.

Returns:



62
63
64
 
# File 'lib/finch_api/models/hris/pay_statement.rb', line 62

required :taxes,
-> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatement::Tax, nil?: true] },
nil?: true

#total_hours ⇒ Float?

The number of hours worked for this pay period

Returns:

  • (Float, nil) 


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

required :total_hours, Float, nil?: true

#type ⇒ Symbol, ...

The type of the payment associated with the pay statement.

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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