finch-api 0.1.0.pre.alpha.5 → 0.1.0.pre.alpha.14

data/lib/finch_api/models/hris/payment.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      # @see FinchAPI::Resources::HRIS::Payments#list
+      class Payment < FinchAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique id for the payment.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute company_debit
+        #
+        #   @return [FinchAPI::Money, nil]
+        optional :company_debit, -> { FinchAPI::Money }, nil?: true
+
+        # @!attribute debit_date
+        #
+        #   @return [String, nil]
+        optional :debit_date, String, nil?: true
+
+        # @!attribute employee_taxes
+        #
+        #   @return [FinchAPI::Money, nil]
+        optional :employee_taxes, -> { FinchAPI::Money }, nil?: true
+
+        # @!attribute employer_taxes
+        #
+        #   @return [FinchAPI::Money, nil]
+        optional :employer_taxes, -> { FinchAPI::Money }, nil?: true
+
+        # @!attribute gross_pay
+        #
+        #   @return [FinchAPI::Money, nil]
+        optional :gross_pay, -> { FinchAPI::Money }, nil?: true
+
+        # @!attribute individual_ids
+        #   Array of every individual on this payment.
+        #
+        #   @return [Array<String>, nil]
+        optional :individual_ids, FinchAPI::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute net_pay
+        #
+        #   @return [FinchAPI::Money, nil]
+        optional :net_pay, -> { FinchAPI::Money }, nil?: true
+
+        # @!attribute pay_date
+        #
+        #   @return [String, nil]
+        optional :pay_date, String, nil?: true
+
+        # @!attribute pay_frequencies
+        #   List of pay frequencies associated with this payment.
+        #
+        #   @return [Array<Symbol, FinchAPI::HRIS::Payment::PayFrequency>, nil]
+        optional :pay_frequencies,
+                 -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::Payment::PayFrequency] },
+                 nil?: true
+
+        # @!attribute pay_group_ids
+        #   Array of the Finch id (uuidv4) of every pay group associated with this payment.
+        #
+        #   @return [Array<String>, nil]
+        optional :pay_group_ids, FinchAPI::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute pay_period
+        #   The pay period object.
+        #
+        #   @return [FinchAPI::HRIS::Payment::PayPeriod, nil]
+        optional :pay_period, -> { FinchAPI::HRIS::Payment::PayPeriod }, nil?: true
+
+        # @!method 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)
+        #   @param id [String] The unique id for the payment.
+        #
+        #   @param company_debit [FinchAPI::Money, nil]
+        #
+        #   @param debit_date [String, nil]
+        #
+        #   @param employee_taxes [FinchAPI::Money, nil]
+        #
+        #   @param employer_taxes [FinchAPI::Money, nil]
+        #
+        #   @param gross_pay [FinchAPI::Money, nil]
+        #
+        #   @param individual_ids [Array<String>, nil] Array of every individual on this payment.
+        #
+        #   @param net_pay [FinchAPI::Money, nil]
+        #
+        #   @param pay_date [String, nil]
+        #
+        #   @param pay_frequencies [Array<Symbol, FinchAPI::HRIS::Payment::PayFrequency>, nil] List of pay frequencies associated with this payment.
+        #
+        #   @param pay_group_ids [Array<String>, nil] Array of the Finch id (uuidv4) of every pay group associated with this payment.
+        #
+        #   @param pay_period [FinchAPI::HRIS::Payment::PayPeriod, nil] The pay period object.
+
+        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
+
+        # @see FinchAPI::HRIS::Payment#pay_period
+        class PayPeriod < FinchAPI::Internal::Type::BaseModel
+          # @!attribute end_date
+          #
+          #   @return [String, nil]
+          optional :end_date, String, nil?: true
+
+          # @!attribute start_date
+          #
+          #   @return [String, nil]
+          optional :start_date, String, nil?: true
+
+          # @!method initialize(end_date: nil, start_date: nil)
+          #   The pay period object.
+          #
+          #   @param end_date [String, nil]
+          #   @param start_date [String, nil]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/payment_list_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      # @see FinchAPI::Resources::HRIS::Payments#list
+      class PaymentListParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        # @!attribute end_date
+        #   The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
+        #   format.
+        #
+        #   @return [Date]
+        required :end_date, Date
+
+        # @!attribute start_date
+        #   The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
+        #   format.
+        #
+        #   @return [Date]
+        required :start_date, Date
+
+        # @!method initialize(end_date:, start_date:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::HRIS::PaymentListParams} for more details.
+        #
+        #   @param end_date [Date] The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` forma
+        #
+        #   @param start_date [Date] The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` for
+        #
+        #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/support_per_benefit_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class SupportPerBenefitType < FinchAPI::Internal::Type::BaseModel
+        # @!attribute company_benefits
+        #
+        #   @return [FinchAPI::OperationSupportMatrix, nil]
+        optional :company_benefits, -> { FinchAPI::OperationSupportMatrix }
+
+        # @!attribute individual_benefits
+        #
+        #   @return [FinchAPI::OperationSupportMatrix, nil]
+        optional :individual_benefits, -> { FinchAPI::OperationSupportMatrix }
+
+        # @!method initialize(company_benefits: nil, individual_benefits: nil)
+        #   @param company_benefits [FinchAPI::OperationSupportMatrix]
+        #   @param individual_benefits [FinchAPI::OperationSupportMatrix]
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/supported_benefit.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class SupportedBenefit < FinchAPI::Internal::Type::BaseModel
+        # @!attribute annual_maximum
+        #   Whether the provider supports an annual maximum for this benefit.
+        #
+        #   @return [Boolean, nil]
+        optional :annual_maximum, FinchAPI::Internal::Type::Boolean, nil?: true
+
+        # @!attribute catch_up
+        #   Whether the provider supports catch up for this benefit. This field will only be
+        #   true for retirement benefits.
+        #
+        #   @return [Boolean, nil]
+        optional :catch_up, FinchAPI::Internal::Type::Boolean, nil?: true
+
+        # @!attribute company_contribution
+        #   Supported contribution types. An empty array indicates contributions are not
+        #   supported.
+        #
+        #   @return [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::CompanyContribution, nil>, nil]
+        optional :company_contribution,
+                 -> {
+                   FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::SupportedBenefit::CompanyContribution,
+                                                     nil?: true]
+                 },
+                 nil?: true
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute employee_deduction
+        #   Supported deduction types. An empty array indicates deductions are not
+        #   supported.
+        #
+        #   @return [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction, nil>, nil]
+        optional :employee_deduction,
+                 -> {
+                   FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction,
+                                                     nil?: true]
+                 },
+                 nil?: true
+
+        # @!attribute frequencies
+        #   The list of frequencies supported by the provider for this benefit
+        #
+        #   @return [Array<Symbol, FinchAPI::HRIS::BenefitFrequency, nil>, nil]
+        optional :frequencies,
+                 -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::BenefitFrequency, nil?: true] }
+
+        # @!attribute hsa_contribution_limit
+        #   Whether the provider supports HSA contribution limits. Empty if this feature is
+        #   not supported for the benefit. This array only has values for HSA benefits.
+        #
+        #   @return [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit, nil>, nil]
+        optional :hsa_contribution_limit,
+                 -> {
+                   FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit,
+                                                     nil?: true]
+                 },
+                 nil?: true
+
+        # @!method initialize(annual_maximum: nil, catch_up: nil, company_contribution: nil, description: nil, employee_deduction: nil, frequencies: nil, hsa_contribution_limit: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::HRIS::SupportedBenefit} for more details.
+        #
+        #   @param annual_maximum [Boolean, nil] Whether the provider supports an annual maximum for this benefit.
+        #
+        #   @param catch_up [Boolean, nil] Whether the provider supports catch up for this benefit. This field will only be
+        #
+        #   @param company_contribution [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::CompanyContribution, nil>, nil] Supported contribution types. An empty array indicates contributions are not sup
+        #
+        #   @param description [String, nil]
+        #
+        #   @param employee_deduction [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::EmployeeDeduction, nil>, nil] Supported deduction types. An empty array indicates deductions are not supported
+        #
+        #   @param frequencies [Array<Symbol, FinchAPI::HRIS::BenefitFrequency, nil>] The list of frequencies supported by the provider for this benefit
+        #
+        #   @param hsa_contribution_limit [Array<Symbol, FinchAPI::HRIS::SupportedBenefit::HsaContributionLimit, nil>, nil] Whether the provider supports HSA contribution limits. Empty if this feature is
+
+        module CompanyContribution
+          extend FinchAPI::Internal::Type::Enum
+
+          FIXED = :fixed
+          PERCENT = :percent
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        module EmployeeDeduction
+          extend FinchAPI::Internal::Type::Enum
+
+          FIXED = :fixed
+          PERCENT = :percent
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        module HsaContributionLimit
+          extend FinchAPI::Internal::Type::Enum
+
+          INDIVIDUAL = :individual
+          FAMILY = :family
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/update_company_benefit_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      # @see FinchAPI::Resources::HRIS::Benefits#update
+      class UpdateCompanyBenefitResponse < FinchAPI::Internal::Type::BaseModel
+        # @!attribute benefit_id
+        #   The id of the benefit.
+        #
+        #   @return [String]
+        required :benefit_id, String
+
+        # @!attribute job_id
+        #
+        #   @return [String]
+        required :job_id, String
+
+        # @!method initialize(benefit_id:, job_id:)
+        #   @param benefit_id [String] The id of the benefit.
+        #
+        #   @param job_id [String]
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/w42005.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class W42005 < FinchAPI::Internal::Type::BaseModel
+        # @!attribute data
+        #   Detailed information specific to the 2005 W4 form.
+        #
+        #   @return [FinchAPI::HRIS::W42005::Data, nil]
+        optional :data, -> { FinchAPI::HRIS::W42005::Data }
+
+        # @!attribute type
+        #   Specifies the form type, indicating that this document is a 2005 W4 form.
+        #
+        #   @return [Symbol, FinchAPI::HRIS::W42005::Type, nil]
+        optional :type, enum: -> { FinchAPI::HRIS::W42005::Type }
+
+        # @!attribute year
+        #   The tax year this W4 document applies to.
+        #
+        #   @return [Float, nil]
+        optional :year, Float, nil?: true
+
+        # @!method initialize(data: nil, type: nil, year: nil)
+        #   A 2005 version of the W-4 tax form containing information on an individual's
+        #   filing status, dependents, and withholding details.
+        #
+        #   @param data [FinchAPI::HRIS::W42005::Data] Detailed information specific to the 2005 W4 form.
+        #
+        #   @param type [Symbol, FinchAPI::HRIS::W42005::Type] Specifies the form type, indicating that this document is a 2005 W4 form.
+        #
+        #   @param year [Float, nil] The tax year this W4 document applies to.
+
+        # @see FinchAPI::HRIS::W42005#data
+        class Data < FinchAPI::Internal::Type::BaseModel
+          # @!attribute additional_withholding
+          #   Additional withholding amount (in cents).
+          #
+          #   @return [Integer, nil]
+          optional :additional_withholding, Integer, nil?: true
+
+          # @!attribute exemption
+          #   Indicates exemption status from federal tax withholding.
+          #
+          #   @return [Symbol, FinchAPI::HRIS::W42005::Data::Exemption, nil]
+          optional :exemption, enum: -> { FinchAPI::HRIS::W42005::Data::Exemption }
+
+          # @!attribute filing_status
+          #   The individual's filing status for tax purposes.
+          #
+          #   @return [Symbol, FinchAPI::HRIS::W42005::Data::FilingStatus, nil]
+          optional :filing_status, enum: -> { FinchAPI::HRIS::W42005::Data::FilingStatus }, nil?: true
+
+          # @!attribute individual_id
+          #   The unique identifier for the individual associated with this 2005 W4 form.
+          #
+          #   @return [String, nil]
+          optional :individual_id, String
+
+          # @!attribute total_number_of_allowances
+          #   Total number of allowances claimed (in cents).
+          #
+          #   @return [Integer, nil]
+          optional :total_number_of_allowances, Integer, nil?: true
+
+          # @!method initialize(additional_withholding: nil, exemption: nil, filing_status: nil, individual_id: nil, total_number_of_allowances: nil)
+          #   Detailed information specific to the 2005 W4 form.
+          #
+          #   @param additional_withholding [Integer, nil] Additional withholding amount (in cents).
+          #
+          #   @param exemption [Symbol, FinchAPI::HRIS::W42005::Data::Exemption] Indicates exemption status from federal tax withholding.
+          #
+          #   @param filing_status [Symbol, FinchAPI::HRIS::W42005::Data::FilingStatus, nil] The individual's filing status for tax purposes.
+          #
+          #   @param individual_id [String] The unique identifier for the individual associated with this 2005 W4 form.
+          #
+          #   @param total_number_of_allowances [Integer, nil] Total number of allowances claimed (in cents).
+
+          # Indicates exemption status from federal tax withholding.
+          #
+          # @see FinchAPI::HRIS::W42005::Data#exemption
+          module Exemption
+            extend FinchAPI::Internal::Type::Enum
+
+            EXEMPT = :exempt
+            NON_EXEMPT = :non_exempt
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The individual's filing status for tax purposes.
+          #
+          # @see FinchAPI::HRIS::W42005::Data#filing_status
+          module FilingStatus
+            extend FinchAPI::Internal::Type::Enum
+
+            MARRIED = :married
+            MARRIED_BUT_WITHHOLD_AT_HIGHER_SINGLE_RATE = :married_but_withhold_at_higher_single_rate
+            SINGLE = :single
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Specifies the form type, indicating that this document is a 2005 W4 form.
+        #
+        # @see FinchAPI::HRIS::W42005#type
+        module Type
+          extend FinchAPI::Internal::Type::Enum
+
+          W4_2005 = :w4_2005
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/w42020.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      class W42020 < FinchAPI::Internal::Type::BaseModel
+        # @!attribute data
+        #   Detailed information specific to the 2020 W4 form.
+        #
+        #   @return [FinchAPI::HRIS::W42020::Data, nil]
+        optional :data, -> { FinchAPI::HRIS::W42020::Data }
+
+        # @!attribute type
+        #   Specifies the form type, indicating that this document is a 2020 W4 form.
+        #
+        #   @return [Symbol, FinchAPI::HRIS::W42020::Type, nil]
+        optional :type, enum: -> { FinchAPI::HRIS::W42020::Type }
+
+        # @!attribute year
+        #   The tax year this W4 document applies to.
+        #
+        #   @return [Float, nil]
+        optional :year, Float, nil?: true
+
+        # @!method initialize(data: nil, type: nil, year: nil)
+        #   A 2020 version of the W-4 tax form containing information on an individual's
+        #   filing status, dependents, and withholding details.
+        #
+        #   @param data [FinchAPI::HRIS::W42020::Data] Detailed information specific to the 2020 W4 form.
+        #
+        #   @param type [Symbol, FinchAPI::HRIS::W42020::Type] Specifies the form type, indicating that this document is a 2020 W4 form.
+        #
+        #   @param year [Float, nil] The tax year this W4 document applies to.
+
+        # @see FinchAPI::HRIS::W42020#data
+        class Data < FinchAPI::Internal::Type::BaseModel
+          # @!attribute amount_for_other_dependents
+          #   Amount claimed for dependents other than qualifying children under 17 (in
+          #   cents).
+          #
+          #   @return [Integer, nil]
+          optional :amount_for_other_dependents, Integer, nil?: true
+
+          # @!attribute amount_for_qualifying_children_under_17
+          #   Amount claimed for dependents under 17 years old (in cents).
+          #
+          #   @return [Integer, nil]
+          optional :amount_for_qualifying_children_under_17, Integer, nil?: true
+
+          # @!attribute deductions
+          #   Deductible expenses (in cents).
+          #
+          #   @return [Integer, nil]
+          optional :deductions, Integer, nil?: true
+
+          # @!attribute extra_withholding
+          #   Additional withholding amount (in cents).
+          #
+          #   @return [Integer, nil]
+          optional :extra_withholding, Integer, nil?: true
+
+          # @!attribute filing_status
+          #   The individual's filing status for tax purposes.
+          #
+          #   @return [Symbol, FinchAPI::HRIS::W42020::Data::FilingStatus, nil]
+          optional :filing_status, enum: -> { FinchAPI::HRIS::W42020::Data::FilingStatus }, nil?: true
+
+          # @!attribute individual_id
+          #   The unique identifier for the individual associated with this document.
+          #
+          #   @return [String, nil]
+          optional :individual_id, String
+
+          # @!attribute other_income
+          #   Additional income from sources outside of primary employment (in cents).
+          #
+          #   @return [Integer, nil]
+          optional :other_income, Integer, nil?: true
+
+          # @!attribute total_claim_dependent_and_other_credits
+          #   Total amount claimed for dependents and other credits (in cents).
+          #
+          #   @return [Integer, nil]
+          optional :total_claim_dependent_and_other_credits, Integer, nil?: true
+
+          # @!method initialize(amount_for_other_dependents: nil, amount_for_qualifying_children_under_17: nil, deductions: nil, extra_withholding: nil, filing_status: nil, individual_id: nil, other_income: nil, total_claim_dependent_and_other_credits: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::HRIS::W42020::Data} for more details.
+          #
+          #   Detailed information specific to the 2020 W4 form.
+          #
+          #   @param amount_for_other_dependents [Integer, nil] Amount claimed for dependents other than qualifying children under 17 (in cents)
+          #
+          #   @param amount_for_qualifying_children_under_17 [Integer, nil] Amount claimed for dependents under 17 years old (in cents).
+          #
+          #   @param deductions [Integer, nil] Deductible expenses (in cents).
+          #
+          #   @param extra_withholding [Integer, nil] Additional withholding amount (in cents).
+          #
+          #   @param filing_status [Symbol, FinchAPI::HRIS::W42020::Data::FilingStatus, nil] The individual's filing status for tax purposes.
+          #
+          #   @param individual_id [String] The unique identifier for the individual associated with this document.
+          #
+          #   @param other_income [Integer, nil] Additional income from sources outside of primary employment (in cents).
+          #
+          #   @param total_claim_dependent_and_other_credits [Integer, nil] Total amount claimed for dependents and other credits (in cents).
+
+          # The individual's filing status for tax purposes.
+          #
+          # @see FinchAPI::HRIS::W42020::Data#filing_status
+          module FilingStatus
+            extend FinchAPI::Internal::Type::Enum
+
+            HEAD_OF_HOUSEHOLD = :head_of_household
+            MARRIED_FILING_JOINTLY_OR_QUALIFYING_SURVIVING_SPOUSE =
+              :married_filing_jointly_or_qualifying_surviving_spouse
+            SINGLE_OR_MARRIED_FILING_SEPARATELY = :single_or_married_filing_separately
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Specifies the form type, indicating that this document is a 2020 W4 form.
+        #
+        # @see FinchAPI::HRIS::W42020#type
+        module Type
+          extend FinchAPI::Internal::Type::Enum
+
+          W4_2020 = :w4_2020
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/income.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class Income < FinchAPI::Internal::Type::BaseModel
+      # @!attribute amount
+      #   The income amount in cents.
+      #
+      #   @return [Integer, nil]
+      required :amount, Integer, nil?: true
+
+      # @!attribute currency
+      #   The currency code.
+      #
+      #   @return [String, nil]
+      required :currency, String, nil?: true
+
+      # @!attribute effective_date
+      #   The date the income amount went into effect.
+      #
+      #   @return [String, nil]
+      required :effective_date, String, nil?: true
+
+      # @!attribute unit
+      #   The income unit of payment. Options: `yearly`, `quarterly`, `monthly`,
+      #   `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.
+      #
+      #   @return [Symbol, FinchAPI::Income::Unit, nil]
+      required :unit, enum: -> { FinchAPI::Income::Unit }, nil?: true
+
+      # @!method initialize(amount:, currency:, effective_date:, unit:)
+      #   Some parameter documentations has been truncated, see {FinchAPI::Income} for
+      #   more details.
+      #
+      #   The employee's income as reported by the provider. This may not always be
+      #   annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
+      #   depending on what information the provider returns.
+      #
+      #   @param amount [Integer, nil] The income amount in cents.
+      #
+      #   @param currency [String, nil] The currency code.
+      #
+      #   @param effective_date [String, nil] The date the income amount went into effect.
+      #
+      #   @param unit [Symbol, FinchAPI::Income::Unit, nil] The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_mon
+
+      # The income unit of payment. Options: `yearly`, `quarterly`, `monthly`,
+      # `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.
+      #
+      # @see FinchAPI::Income#unit
+      module Unit
+        extend FinchAPI::Internal::Type::Enum
+
+        YEARLY = :yearly
+        QUARTERLY = :quarterly
+        MONTHLY = :monthly
+        SEMI_MONTHLY = :semi_monthly
+        BI_WEEKLY = :bi_weekly
+        WEEKLY = :weekly
+        DAILY = :daily
+        HOURLY = :hourly
+        FIXED = :fixed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end