Class: FinchAPI::Models::HRIS::Payment

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/finch_api/models/hris/payment.rb,
sig/finch_api/models/hris/payment.rbs

Overview

See Also:

  • FinchAPI::Resources::HRIS::Payments#list

Defined Under Namespace

Modules: PayFrequency Classes: PayPeriod

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 ⇒ Object 



45
 
# File 'sig/finch_api/models/hris/payment.rbs', line 45

def initialize: (

Instance Attribute Details

#company_debit ⇒ FinchAPI::Models::Money?

Parameters:

Returns:



17
 
# File 'lib/finch_api/models/hris/payment.rb', line 17

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

#debit_date ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


22
 
# File 'lib/finch_api/models/hris/payment.rb', line 22

required :debit_date, String, nil?: true

#employee_taxes ⇒ FinchAPI::Models::Money?

Parameters:

Returns:



27
 
# File 'lib/finch_api/models/hris/payment.rb', line 27

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

#employer_taxes ⇒ FinchAPI::Models::Money?

Parameters:

Returns:



32
 
# File 'lib/finch_api/models/hris/payment.rb', line 32

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

#gross_pay ⇒ FinchAPI::Models::Money?

Parameters:

Returns:



37
 
# File 'lib/finch_api/models/hris/payment.rb', line 37

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

#id ⇒ String

The unique id for the payment.

Parameters:

  • value (String)

Returns:

  • (String) 


12
 
# File 'lib/finch_api/models/hris/payment.rb', line 12

required :id, String

#individual_ids ⇒ Array<String>?

Array of every individual on this payment.

Parameters:

  • value (::Array[String], nil)

Returns:

  • (Array<String>, nil) 


43
 
# File 'lib/finch_api/models/hris/payment.rb', line 43

required :individual_ids, FinchAPI::Internal::Type::ArrayOf[String], nil?: true

#net_pay ⇒ FinchAPI::Models::Money?

Parameters:

Returns:



48
 
# File 'lib/finch_api/models/hris/payment.rb', line 48

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

#pay_date ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


53
 
# File 'lib/finch_api/models/hris/payment.rb', line 53

required :pay_date, String, nil?: true

#pay_frequencies ⇒ Array<Symbol, FinchAPI::Models::HRIS::Payment::PayFrequency>?

List of pay frequencies associated with this payment.

Parameters:

  • value (::Array[FinchAPI::Models::HRIS::Payment::pay_frequency], nil)

Returns:



59
60
61
 
# File 'lib/finch_api/models/hris/payment.rb', line 59

required :pay_frequencies,
-> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::Payment::PayFrequency] },
nil?: true

#pay_group_ids ⇒ Array<String>?

Array of the Finch id (uuidv4) of every pay group associated with this payment.

Parameters:

  • value (::Array[String], nil)

Returns:

  • (Array<String>, nil) 


67
 
# File 'lib/finch_api/models/hris/payment.rb', line 67

required :pay_group_ids, FinchAPI::Internal::Type::ArrayOf[String], nil?: true

#pay_period ⇒ FinchAPI::Models::HRIS::Payment::PayPeriod?

The pay period object.

Parameters:

  • value (FinchAPI::HRIS::Payment::PayPeriod, nil)

Returns:



73
 
# File 'lib/finch_api/models/hris/payment.rb', line 73

required :pay_period, -> { FinchAPI::HRIS::Payment::PayPeriod }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/finch_api/models/hris/payment.rb', line 113

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


60
 
# File 'sig/finch_api/models/hris/payment.rbs', line 60

def to_hash: -> {