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

data/lib/finch_api/models/hris/company/pay_statement_item/rule_update_response.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Company
+        module PayStatementItem
+          # @see FinchAPI::Resources::HRIS::Company::PayStatementItem::Rules#update
+          class RuleUpdateResponse < FinchAPI::Internal::Type::BaseModel
+            # @!attribute id
+            #   Finch id (uuidv4) for the rule.
+            #
+            #   @return [String, nil]
+            optional :id, String
+
+            # @!attribute attributes
+            #   Specifies the fields to be applied when the condition is met.
+            #
+            #   @return [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes, nil]
+            optional :attributes,
+                     -> { FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes }
+
+            # @!attribute conditions
+            #
+            #   @return [Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition>, nil]
+            optional :conditions,
+                     -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition] }
+
+            # @!attribute created_at
+            #   The datetime when the rule was created.
+            #
+            #   @return [Time, nil]
+            optional :created_at, Time
+
+            # @!attribute effective_end_date
+            #   Specifies when the rules should stop applying rules based on the date.
+            #
+            #   @return [String, nil]
+            optional :effective_end_date, String, nil?: true
+
+            # @!attribute effective_start_date
+            #   Specifies when the rule should begin applying based on the date.
+            #
+            #   @return [String, nil]
+            optional :effective_start_date, String, nil?: true
+
+            # @!attribute entity_type
+            #   The entity type to which the rule is applied.
+            #
+            #   @return [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType, nil]
+            optional :entity_type,
+                     enum: -> { FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType }
+
+            # @!attribute priority
+            #   The priority of the rule.
+            #
+            #   @return [Integer, nil]
+            optional :priority, Integer
+
+            # @!attribute updated_at
+            #   The datetime when the rule was last updated.
+            #
+            #   @return [Time, nil]
+            optional :updated_at, Time
+
+            # @!method initialize(id: nil, attributes: nil, conditions: nil, created_at: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, priority: nil, updated_at: nil)
+            #   @param id [String] Finch id (uuidv4) for the rule.
+            #
+            #   @param attributes [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes] Specifies the fields to be applied when the condition is met.
+            #
+            #   @param conditions [Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition>]
+            #
+            #   @param created_at [Time] The datetime when the rule was created.
+            #
+            #   @param effective_end_date [String, nil] Specifies when the rules should stop applying rules based on the date.
+            #
+            #   @param effective_start_date [String, nil] Specifies when the rule should begin applying based on the date.
+            #
+            #   @param entity_type [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType] The entity type to which the rule is applied.
+            #
+            #   @param priority [Integer] The priority of the rule.
+            #
+            #   @param updated_at [Time] The datetime when the rule was last updated.
+
+            # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse#attributes
+            class Attributes < FinchAPI::Internal::Type::BaseModel
+              # @!attribute metadata
+              #   The metadata to be attached in the entity. It is a key-value pairs where the
+              #   values can be of any type (string, number, boolean, object, array, etc.).
+              #
+              #   @return [Hash{Symbol=>Object}, nil]
+              optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
+
+              # @!method initialize(metadata: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes}
+              #   for more details.
+              #
+              #   Specifies the fields to be applied when the condition is met.
+              #
+              #   @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val
+              #   ...
+            end
+
+            class Condition < FinchAPI::Internal::Type::BaseModel
+              # @!attribute field
+              #   The field to be checked in the rule.
+              #
+              #   @return [String, nil]
+              optional :field, String
+
+              # @!attribute operator
+              #   The operator to be used in the rule.
+              #
+              #   @return [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator, nil]
+              optional :operator,
+                       enum: -> { FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator }
+
+              # @!attribute value
+              #   The value of the field to be checked in the rule.
+              #
+              #   @return [String, nil]
+              optional :value, String
+
+              # @!method initialize(field: nil, operator: nil, value: nil)
+              #   @param field [String] The field to be checked in the rule.
+              #
+              #   @param operator [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator] The operator to be used in the rule.
+              #
+              #   @param value [String] The value of the field to be checked in the rule.
+
+              # The operator to be used in the rule.
+              #
+              # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition#operator
+              module Operator
+                extend FinchAPI::Internal::Type::Enum
+
+                EQUALS = :equals
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            # The entity type to which the rule is applied.
+            #
+            # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse#entity_type
+            module EntityType
+              extend FinchAPI::Internal::Type::Enum
+
+              PAY_STATEMENT_ITEM = :pay_statement_item
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/company/pay_statement_item_list_params.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Company
+        # @see FinchAPI::Resources::HRIS::Company::PayStatementItem#list
+        class PayStatementItemListParams < FinchAPI::Internal::Type::BaseModel
+          extend FinchAPI::Internal::Type::RequestParameters::Converter
+          include FinchAPI::Internal::Type::RequestParameters
+
+          # @!attribute categories
+          #   Comma-delimited list of pay statement item categories to filter on. If empty,
+          #   defaults to all categories.
+          #
+          #   @return [Array<Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category>, nil]
+          optional :categories,
+                   -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category] }
+
+          # @!attribute end_date
+          #   The end date to retrieve pay statement items by via their last seen pay date in
+          #   `YYYY-MM-DD` format.
+          #
+          #   @return [Date, nil]
+          optional :end_date, Date
+
+          # @!attribute name
+          #   Case-insensitive partial match search by pay statement item name.
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute start_date
+          #   The start date to retrieve pay statement items by via their last seen pay date
+          #   (inclusive) in `YYYY-MM-DD` format.
+          #
+          #   @return [Date, nil]
+          optional :start_date, Date
+
+          # @!attribute type
+          #   String search by pay statement item type.
+          #
+          #   @return [String, nil]
+          optional :type, String
+
+          # @!method initialize(categories: nil, end_date: nil, name: nil, start_date: nil, type: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::Models::HRIS::Company::PayStatementItemListParams} for more details.
+          #
+          #   @param categories [Array<Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListParams::Category>] Comma-delimited list of pay statement item categories to filter on. If empty, de
+          #   ...
+          #
+          #   @param end_date [Date] The end date to retrieve pay statement items by via their last seen pay date in
+          #   ...
+          #
+          #   @param name [String] Case-insensitive partial match search by pay statement item name.
+          #
+          #   @param start_date [Date] The start date to retrieve pay statement items by via their last seen pay date (
+          #   ...
+          #
+          #   @param type [String] String search by pay statement item type.
+          #
+          #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+
+          module Category
+            extend FinchAPI::Internal::Type::Enum
+
+            EARNINGS = :earnings
+            TAXES = :taxes
+            EMPLOYEE_DEDUCTIONS = :employee_deductions
+            EMPLOYER_CONTRIBUTIONS = :employer_contributions
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/company/pay_statement_item_list_response.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      module Company
+        # @see FinchAPI::Resources::HRIS::Company::PayStatementItem#list
+        class PayStatementItemListResponse < FinchAPI::Internal::Type::BaseModel
+          # @!attribute attributes
+          #   The attributes of the pay statement item.
+          #
+          #   @return [FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes, nil]
+          optional :attributes, -> { FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes }
+
+          # @!attribute category
+          #   The category of the pay statement item.
+          #
+          #   @return [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category, nil]
+          optional :category, enum: -> { FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category }
+
+          # @!attribute name
+          #   The name of the pay statement item.
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(attributes: nil, category: nil, name: nil)
+          #   @param attributes [FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes] The attributes of the pay statement item.
+          #
+          #   @param category [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category] The category of the pay statement item.
+          #
+          #   @param name [String] The name of the pay statement item.
+
+          # @see FinchAPI::Models::HRIS::Company::PayStatementItemListResponse#attributes
+          class Attributes < FinchAPI::Internal::Type::BaseModel
+            # @!attribute employer
+            #   `true` if the amount is paid by the employers. This field is only available for
+            #   taxes.
+            #
+            #   @return [Boolean, nil]
+            optional :employer, FinchAPI::Internal::Type::Boolean, nil?: true
+
+            # @!attribute metadata
+            #   The metadata of the pay statement item derived by the rules engine if available.
+            #   Each attribute will be a key-value pair defined by a rule.
+            #
+            #   @return [Hash{Symbol=>Object, nil}, nil]
+            optional :metadata,
+                     FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true],
+                     nil?: true
+
+            # @!attribute pre_tax
+            #   `true` if the pay statement item is pre-tax. This field is only available for
+            #   employee deductions.
+            #
+            #   @return [Boolean, nil]
+            optional :pre_tax, FinchAPI::Internal::Type::Boolean, nil?: true
+
+            # @!attribute type
+            #   The type of the pay statement item.
+            #
+            #   @return [String, nil]
+            optional :type, String, nil?: true
+
+            # @!method initialize(employer: nil, metadata: nil, pre_tax: nil, type: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes} for
+            #   more details.
+            #
+            #   The attributes of the pay statement item.
+            #
+            #   @param employer [Boolean, nil] `true` if the amount is paid by the employers. This field is only available for
+            #   ...
+            #
+            #   @param metadata [Hash{Symbol=>Object, nil}, nil] The metadata of the pay statement item derived by the rules engine if available.
+            #   ...
+            #
+            #   @param pre_tax [Boolean, nil] `true` if the pay statement item is pre-tax. This field is only available for em
+            #   ...
+            #
+            #   @param type [String, nil] The type of the pay statement item.
+          end
+
+          # The category of the pay statement item.
+          #
+          # @see FinchAPI::Models::HRIS::Company::PayStatementItemListResponse#category
+          module Category
+            extend FinchAPI::Internal::Type::Enum
+
+            EARNINGS = :earnings
+            TAXES = :taxes
+            EMPLOYEE_DEDUCTIONS = :employee_deductions
+            EMPLOYER_CONTRIBUTIONS = :employer_contributions
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      # @see FinchAPI::Resources::HRIS::Company#retrieve
+      class HRISCompany < FinchAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   A stable Finch `id` (UUID v4) for the company.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute accounts
+        #   An array of bank account objects associated with the payroll/HRIS system.
+        #
+        #   @return [Array<FinchAPI::Models::HRIS::HRISCompany::Account>, nil]
+        required :accounts,
+                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::HRISCompany::Account] },
+                 nil?: true
+
+        # @!attribute departments
+        #   The array of company departments.
+        #
+        #   @return [Array<FinchAPI::Models::HRIS::HRISCompany::Department, nil>, nil]
+        required :departments,
+                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::HRISCompany::Department, nil?: true] },
+                 nil?: true
+
+        # @!attribute ein
+        #   The employer identification number.
+        #
+        #   @return [String, nil]
+        required :ein, String, nil?: true
+
+        # @!attribute entity
+        #   The entity type object.
+        #
+        #   @return [FinchAPI::Models::HRIS::HRISCompany::Entity, nil]
+        required :entity, -> { FinchAPI::Models::HRIS::HRISCompany::Entity }, nil?: true
+
+        # @!attribute legal_name
+        #   The legal name of the company.
+        #
+        #   @return [String, nil]
+        required :legal_name, String, nil?: true
+
+        # @!attribute locations
+        #
+        #   @return [Array<FinchAPI::Models::Location, nil>, nil]
+        required :locations,
+                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Location, nil?: true] },
+                 nil?: true
+
+        # @!attribute primary_email
+        #   The email of the main administrator on the account.
+        #
+        #   @return [String, nil]
+        required :primary_email, String, nil?: true
+
+        # @!attribute primary_phone_number
+        #   The phone number of the main administrator on the account. Format: E.164, with
+        #   extension where applicable, e.g. `+NNNNNNNNNNN xExtension`
+        #
+        #   @return [String, nil]
+        required :primary_phone_number, String, nil?: true
+
+        # @!method initialize(id:, accounts:, departments:, ein:, entity:, legal_name:, locations:, primary_email:, primary_phone_number:)
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::HRIS::HRISCompany} for more details.
+        #
+        #   @param id [String] A stable Finch `id` (UUID v4) for the company.
+        #
+        #   @param accounts [Array<FinchAPI::Models::HRIS::HRISCompany::Account>, nil] An array of bank account objects associated with the payroll/HRIS system.
+        #
+        #   @param departments [Array<FinchAPI::Models::HRIS::HRISCompany::Department, nil>, nil] The array of company departments.
+        #
+        #   @param ein [String, nil] The employer identification number.
+        #
+        #   @param entity [FinchAPI::Models::HRIS::HRISCompany::Entity, nil] The entity type object.
+        #
+        #   @param legal_name [String, nil] The legal name of the company.
+        #
+        #   @param locations [Array<FinchAPI::Models::Location, nil>, nil]
+        #
+        #   @param primary_email [String, nil] The email of the main administrator on the account.
+        #
+        #   @param primary_phone_number [String, nil] The phone number of the main administrator on the account. Format: E.164, with e
+        #   ...
+
+        class Account < FinchAPI::Internal::Type::BaseModel
+          # @!attribute account_name
+          #   The name of the bank associated in the payroll/HRIS system.
+          #
+          #   @return [String, nil]
+          required :account_name, String, nil?: true
+
+          # @!attribute account_number
+          #   10-12 digit number to specify the bank account
+          #
+          #   @return [String, nil]
+          required :account_number, String, nil?: true
+
+          # @!attribute account_type
+          #   The type of bank account.
+          #
+          #   @return [Symbol, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType, nil]
+          required :account_type, enum: -> { FinchAPI::Models::HRIS::HRISCompany::Account::AccountType }, nil?: true
+
+          # @!attribute institution_name
+          #   Name of the banking institution.
+          #
+          #   @return [String, nil]
+          required :institution_name, String, nil?: true
+
+          # @!attribute routing_number
+          #   A nine-digit code that's based on the U.S. Bank location where your account was
+          #   opened.
+          #
+          #   @return [String, nil]
+          required :routing_number, String, nil?: true
+
+          # @!method initialize(account_name:, account_number:, account_type:, institution_name:, routing_number:)
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::Models::HRIS::HRISCompany::Account} for more details.
+          #
+          #   @param account_name [String, nil] The name of the bank associated in the payroll/HRIS system.
+          #
+          #   @param account_number [String, nil] 10-12 digit number to specify the bank account
+          #
+          #   @param account_type [Symbol, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType, nil] The type of bank account.
+          #
+          #   @param institution_name [String, nil] Name of the banking institution.
+          #
+          #   @param routing_number [String, nil] A nine-digit code that's based on the U.S. Bank location where your account was
+          #   ...
+
+          # The type of bank account.
+          #
+          # @see FinchAPI::Models::HRIS::HRISCompany::Account#account_type
+          module AccountType
+            extend FinchAPI::Internal::Type::Enum
+
+            CHECKING = :checking
+            SAVINGS = :savings
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class Department < FinchAPI::Internal::Type::BaseModel
+          # @!attribute name
+          #   The department name.
+          #
+          #   @return [String, nil]
+          required :name, String, nil?: true
+
+          # @!attribute parent
+          #   The parent department, if present.
+          #
+          #   @return [FinchAPI::Models::HRIS::HRISCompany::Department::Parent, nil]
+          required :parent, -> { FinchAPI::Models::HRIS::HRISCompany::Department::Parent }, nil?: true
+
+          # @!method initialize(name:, parent:)
+          #   @param name [String, nil] The department name.
+          #
+          #   @param parent [FinchAPI::Models::HRIS::HRISCompany::Department::Parent, nil] The parent department, if present.
+
+          # @see FinchAPI::Models::HRIS::HRISCompany::Department#parent
+          class Parent < FinchAPI::Internal::Type::BaseModel
+            # @!attribute name
+            #   The parent department's name.
+            #
+            #   @return [String, nil]
+            required :name, String, nil?: true
+
+            # @!method initialize(name:)
+            #   The parent department, if present.
+            #
+            #   @param name [String, nil] The parent department's name.
+          end
+        end
+
+        # @see FinchAPI::Models::HRIS::HRISCompany#entity
+        class Entity < FinchAPI::Internal::Type::BaseModel
+          # @!attribute subtype
+          #   The tax payer subtype of the company.
+          #
+          #   @return [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype, nil]
+          required :subtype, enum: -> { FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype }, nil?: true
+
+          # @!attribute type
+          #   The tax payer type of the company.
+          #
+          #   @return [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Type, nil]
+          required :type, enum: -> { FinchAPI::Models::HRIS::HRISCompany::Entity::Type }, nil?: true
+
+          # @!method initialize(subtype:, type:)
+          #   The entity type object.
+          #
+          #   @param subtype [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype, nil] The tax payer subtype of the company.
+          #
+          #   @param type [Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Type, nil] The tax payer type of the company.
+
+          # The tax payer subtype of the company.
+          #
+          # @see FinchAPI::Models::HRIS::HRISCompany::Entity#subtype
+          module Subtype
+            extend FinchAPI::Internal::Type::Enum
+
+            S_CORPORATION = :s_corporation
+            C_CORPORATION = :c_corporation
+            B_CORPORATION = :b_corporation
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The tax payer type of the company.
+          #
+          # @see FinchAPI::Models::HRIS::HRISCompany::Entity#type
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            LLC = :llc
+            LP = :lp
+            CORPORATION = :corporation
+            SOLE_PROPRIETOR = :sole_proprietor
+            NON_PROFIT = :non_profit
+            PARTNERSHIP = :partnership
+            COOPERATIVE = :cooperative
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      # @see FinchAPI::Resources::HRIS::Benefits#retrieve
+      class CompanyBenefit < FinchAPI::Internal::Type::BaseModel
+        # @!attribute benefit_id
+        #   The id of the benefit.
+        #
+        #   @return [String]
+        required :benefit_id, String
+
+        # @!attribute company_contribution
+        #   The company match for this benefit.
+        #
+        #   @return [FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution, nil]
+        required :company_contribution,
+                 -> { FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution },
+                 nil?: true
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        required :description, String, nil?: true
+
+        # @!attribute frequency
+        #   The frequency of the benefit deduction/contribution.
+        #
+        #   @return [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil]
+        required :frequency, enum: -> { FinchAPI::Models::HRIS::BenefitFrequency }, nil?: true
+
+        # @!attribute type
+        #   Type of benefit.
+        #
+        #   @return [Symbol, FinchAPI::Models::HRIS::BenefitType, nil]
+        required :type, enum: -> { FinchAPI::Models::HRIS::BenefitType }, nil?: true
+
+        # @!method initialize(benefit_id:, company_contribution:, description:, frequency:, type:)
+        #   @param benefit_id [String] The id of the benefit.
+        #
+        #   @param company_contribution [FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution, nil] The company match for this benefit.
+        #
+        #   @param description [String, nil]
+        #
+        #   @param frequency [Symbol, FinchAPI::Models::HRIS::BenefitFrequency, nil] The frequency of the benefit deduction/contribution.
+        #
+        #   @param type [Symbol, FinchAPI::Models::HRIS::BenefitType, nil] Type of benefit.
+
+        # @see FinchAPI::Models::HRIS::CompanyBenefit#company_contribution
+        class CompanyContribution < FinchAPI::Internal::Type::BaseModel
+          # @!attribute tiers
+          #
+          #   @return [Array<FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier>, nil]
+          optional :tiers,
+                   -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier] }
+
+          # @!attribute type
+          #
+          #   @return [Symbol, FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type, nil]
+          optional :type, enum: -> { FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type }
+
+          # @!method initialize(tiers: nil, type: nil)
+          #   The company match for this benefit.
+          #
+          #   @param tiers [Array<FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Tier>]
+          #   @param type [Symbol, FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution::Type]
+
+          class Tier < FinchAPI::Internal::Type::BaseModel
+            # @!attribute match
+            #
+            #   @return [Integer, nil]
+            optional :match, Integer
+
+            # @!attribute threshold
+            #
+            #   @return [Integer, nil]
+            optional :threshold, Integer
+
+            # @!method initialize(match: nil, threshold: nil)
+            #   @param match [Integer]
+            #   @param threshold [Integer]
+          end
+
+          # @see FinchAPI::Models::HRIS::CompanyBenefit::CompanyContribution#type
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            MATCH = :match
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end