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

Extended by:

Internal::Type::Enum

Defined in:

lib/finch_api/models/hris/payment.rb,
sig/finch_api/models/hris/payment.rbs

Constant Summary

ANNUALLY =

Returns:

• (:annually)

:annually

BI_WEEKLY =

Returns:

• (:bi_weekly)

:bi_weekly

DAILY =

Returns:

• (:daily)

:daily

MONTHLY =

Returns:

• (:monthly)

:monthly

OTHER =

Returns:

• (:other)

:other

QUARTERLY =

Returns:

• (:quarterly)

:quarterly

SEMI_ANNUALLY =

Returns:

• (:semi_annually)

:semi_annually

SEMI_MONTHLY =

Returns:

• (:semi_monthly)

:semi_monthly

WEEKLY =

Returns:

• (: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
• #self?.values ⇒ ::Array[FinchAPI::Models::HRIS::Payment::pay_frequency]

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values, 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) —

  The unique id for the payment.

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

  Array of every individual on this payment.

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

  List of pay frequencies associated with this payment.

• pay_group_ids (Array<String>, nil) —

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

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

  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

#self?.values ⇒ ::Array[FinchAPI::Models::HRIS::Payment::pay_frequency]

Returns:

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

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

def self?.values: -> ::Array[FinchAPI::Models::HRIS::Payment::pay_frequency]