Module: FinchAPI::Models::HRIS::Payment::PayFrequency

Extended by:
Internal::Type::Enum
Defined in:
lib/finch_api/models/hris/payment.rb

Constant Summary collapse

ANNUALLY = 
:annually
SEMI_ANNUALLY = 
:semi_annually
QUARTERLY = 
:quarterly
MONTHLY = 
:monthly
SEMI_MONTHLY = 
:semi_monthly
BI_WEEKLY = 
:bi_weekly
WEEKLY = 
:weekly
DAILY = 
:daily
OTHER = 
:other

Instance Method Summary collapse

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Instance Method 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) ⇒ Object

Parameters:

  • id (String) (defaults to: nil) —

    The unique id for the payment.

  • company_debit (FinchAPI::Money, nil) (defaults to: nil)
  • debit_date (String, nil) (defaults to: nil)
  • employee_taxes (FinchAPI::Money, nil) (defaults to: nil)
  • employer_taxes (FinchAPI::Money, nil) (defaults to: nil)
  • gross_pay (FinchAPI::Money, nil) (defaults to: nil)
  • individual_ids (Array<String>, nil) (defaults to: nil) —

    Array of every individual on this payment.

  • net_pay (FinchAPI::Money, nil) (defaults to: nil)
  • pay_date (String, nil) (defaults to: nil)
  • pay_frequencies (Array<Symbol, FinchAPI::HRIS::Payment::PayFrequency>, nil) (defaults to: nil) —

    List of pay frequencies associated with this payment.

  • pay_group_ids (Array<String>, nil) (defaults to: nil) —

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

  • pay_period (FinchAPI::HRIS::Payment::PayPeriod, nil) (defaults to: nil) —

    The pay period object.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/finch_api/models/hris/payment.rb', line 100

module PayFrequency
  extend FinchAPI::Internal::Type::Enum

  ANNUALLY = :annually
  SEMI_ANNUALLY = :semi_annually
  QUARTERLY = :quarterly
  MONTHLY = :monthly
  SEMI_MONTHLY = :semi_monthly
  BI_WEEKLY = :bi_weekly
  WEEKLY = :weekly
  DAILY = :daily
  OTHER = :other

  # @!method self.values
  #   @return [Array<Symbol>]
end