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

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/finch-api/models/hris/payment.rb

Defined Under Namespace

Modules: PayFrequency Classes: PayPeriod

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: nil, company_debit: nil, debit_date: nil, employee_taxes: nil, employer_taxes: nil, gross_pay: nil, individual_ids: nil, net_pay: nil, pay_date: nil, pay_frequencies: nil, pay_group_ids: nil, pay_period: nil) ⇒ Payment

Returns a new instance of Payment.

Parameters:



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/finch-api/models/hris/payment.rb', line 14

def initialize(
  id: nil,
  company_debit: nil,
  debit_date: nil,
  employee_taxes: nil,
  employer_taxes: nil,
  gross_pay: nil,
  individual_ids: nil,
  net_pay: nil,
  pay_date: nil,
  pay_frequencies: nil,
  pay_group_ids: nil,
  pay_period: nil,
  **
)
  super
end

Instance Attribute Details

#company_debit ⇒ FinchAPI::Models::Money?

Returns:



20
 
# File 'lib/finch-api/models/hris/payment.rb', line 20

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

#debit_date ⇒ String?

Returns:

  • (String, nil) 


25
 
# File 'lib/finch-api/models/hris/payment.rb', line 25

optional :debit_date, String, nil?: true

#employee_taxes ⇒ FinchAPI::Models::Money?

Returns:



30
 
# File 'lib/finch-api/models/hris/payment.rb', line 30

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

#employer_taxes ⇒ FinchAPI::Models::Money?

Returns:



35
 
# File 'lib/finch-api/models/hris/payment.rb', line 35

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

#gross_pay ⇒ FinchAPI::Models::Money?

Returns:



40
 
# File 'lib/finch-api/models/hris/payment.rb', line 40

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

#id ⇒ String?

The unique id for the payment.

Returns:

  • (String, nil) 


11
 
# File 'lib/finch-api/models/hris/payment.rb', line 11

optional :id, String

#individual_ids ⇒ Array<String>?

Array of every individual on this payment.

Returns:

  • (Array<String>, nil) 


46
 
# File 'lib/finch-api/models/hris/payment.rb', line 46

optional :individual_ids, FinchAPI::ArrayOf[String], nil?: true

#net_pay ⇒ FinchAPI::Models::Money?

Returns:



51
 
# File 'lib/finch-api/models/hris/payment.rb', line 51

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

#pay_date ⇒ String?

Returns:

  • (String, nil) 


56
 
# File 'lib/finch-api/models/hris/payment.rb', line 56

optional :pay_date, String, nil?: true

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

List of pay frequencies associated with this payment.

Returns:



62
63
64
 
# File 'lib/finch-api/models/hris/payment.rb', line 62

optional :pay_frequencies,
-> { FinchAPI::ArrayOf[enum: FinchAPI::Models::HRIS::Payment::PayFrequency] },
nil?: true

#pay_group_ids ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


70
 
# File 'lib/finch-api/models/hris/payment.rb', line 70

optional :pay_group_ids, FinchAPI::ArrayOf[String], nil?: true

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

The pay period object.

Returns:



76
 
# File 'lib/finch-api/models/hris/payment.rb', line 76

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 


2
 
# File 'lib/finch-api/models/hris/payment.rb', line 2

def self.values; end