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

Extended by:

Internal::Type::Enum

Defined in:

lib/finch_api/models/hris/payment.rb

Constant Summary

ANNUALLY =

:annually

BI_WEEKLY =

:bi_weekly

DAILY =

:daily

MONTHLY =

:monthly

OTHER =

:other

QUARTERLY =

:quarterly

SEMI_ANNUALLY =

:semi_annually

SEMI_MONTHLY =

:semi_monthly

WEEKLY =

:weekly

Instance Method Summary

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

Methods included from Internal::Type::Enum

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

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Instance Method Details

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

Parameters:

• id (String) (defaults to: ) —

  The unique id for the payment.

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

  Array of every individual on this payment.

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

  List of pay frequencies associated with this payment.

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

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

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

  The pay period object.

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

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

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

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