--- title: "Providers" method: GET path: "/providers" tags: ["Management"] --- # Providers `GET /providers` Return details on all available payroll and HR systems. ## Headers - `Finch-API-Version` string, date, required ## Response `200` OK - object[] - `id` string — The id of the payroll provider used in Connect. - `display_name` string — The display name of the payroll provider. - `products` string[] — The list of Finch products supported on this payroll provider. - `icon` string — The url to the official icon of the payroll provider. - `logo` string — The url to the official logo of the payroll provider. - `mfa_required` boolean — whether MFA is required for the provider. - `primary_color` string — The hex code for the primary color of the payroll provider. - `manual` boolean — [DEPRECATED] Whether the Finch integration with this provider uses the Assisted Connect Flow by default. This field is now deprecated. Please check for a `type` of `assisted` in the `authentication_methods` field instead. - `beta` boolean — `true` if the integration is in a beta state, `false` otherwise - `authentication_methods` AuthenticationMethod[] — The list of authentication methods supported by the provider. - `type` 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' — The type of authentication method. - `benefits_support` BenefitsSupport, nullable — Each benefit type and their supported features. If the benefit type is not supported, the property will be null - `s125_medical` BenefitFeaturesAndOperations, nullable - `supported_features` BenefitFeature - `description` string, nullable - `frequencies` BenefitFrequency[] — The list of frequencies supported by the provider for this benefit - `employee_deduction` string[], nullable — Supported deduction types. An empty array indicates deductions are not supported. - `company_contribution` string[], nullable — Supported contribution types. An empty array indicates contributions are not supported. - `annual_maximum` boolean, nullable — Whether the provider supports an annual maximum for this benefit. - `catch_up` boolean, nullable — Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits. - `hsa_contribution_limit` string[], nullable — 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. - `supported_operations` SupportPerBenefitType - `company_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `individual_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `s125_dental` BenefitFeaturesAndOperations, nullable - `supported_features` BenefitFeature - `description` string, nullable - `frequencies` BenefitFrequency[] — The list of frequencies supported by the provider for this benefit - `employee_deduction` string[], nullable — Supported deduction types. An empty array indicates deductions are not supported. - `company_contribution` string[], nullable — Supported contribution types. An empty array indicates contributions are not supported. - `annual_maximum` boolean, nullable — Whether the provider supports an annual maximum for this benefit. - `catch_up` boolean, nullable — Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits. - `hsa_contribution_limit` string[], nullable — 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. - `supported_operations` SupportPerBenefitType - `company_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `individual_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `s125_vision` BenefitFeaturesAndOperations, nullable - `supported_features` BenefitFeature - `description` string, nullable - `frequencies` BenefitFrequency[] — The list of frequencies supported by the provider for this benefit - `employee_deduction` string[], nullable — Supported deduction types. An empty array indicates deductions are not supported. - `company_contribution` string[], nullable — Supported contribution types. An empty array indicates contributions are not supported. - `annual_maximum` boolean, nullable — Whether the provider supports an annual maximum for this benefit. - `catch_up` boolean, nullable — Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits. - `hsa_contribution_limit` string[], nullable — 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. - `supported_operations` SupportPerBenefitType - `company_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `individual_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `hsa_pre` BenefitFeaturesAndOperations, nullable - `supported_features` BenefitFeature - `description` string, nullable - `frequencies` BenefitFrequency[] — The list of frequencies supported by the provider for this benefit - `employee_deduction` string[], nullable — Supported deduction types. An empty array indicates deductions are not supported. - `company_contribution` string[], nullable — Supported contribution types. An empty array indicates contributions are not supported. - `annual_maximum` boolean, nullable — Whether the provider supports an annual maximum for this benefit. - `catch_up` boolean, nullable — Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits. - `hsa_contribution_limit` string[], nullable — 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. - `supported_operations` SupportPerBenefitType - `company_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `individual_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `hsa_post` BenefitFeaturesAndOperations, nullable - `supported_features` BenefitFeature - `description` string, nullable - `frequencies` BenefitFrequency[] — The list of frequencies supported by the provider for this benefit - `employee_deduction` string[], nullable — Supported deduction types. An empty array indicates deductions are not supported. - `company_contribution` string[], nullable — Supported contribution types. An empty array indicates contributions are not supported. - `annual_maximum` boolean, nullable — Whether the provider supports an annual maximum for this benefit. - `catch_up` boolean, nullable — Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits. - `hsa_contribution_limit` string[], nullable — 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. - `supported_operations` SupportPerBenefitType - `company_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `individual_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `fsa_medical` BenefitFeaturesAndOperations, nullable - `supported_features` BenefitFeature - `description` string, nullable - `frequencies` BenefitFrequency[] — The list of frequencies supported by the provider for this benefit - `employee_deduction` string[], nullable — Supported deduction types. An empty array indicates deductions are not supported. - `company_contribution` string[], nullable — Supported contribution types. An empty array indicates contributions are not supported. - `annual_maximum` boolean, nullable — Whether the provider supports an annual maximum for this benefit. - `catch_up` boolean, nullable — Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits. - `hsa_contribution_limit` string[], nullable — 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. - `supported_operations` SupportPerBenefitType - `company_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `individual_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `fsa_dependent_care` BenefitFeaturesAndOperations, nullable - `supported_features` BenefitFeature - `description` string, nullable - `frequencies` BenefitFrequency[] — The list of frequencies supported by the provider for this benefit - `employee_deduction` string[], nullable — Supported deduction types. An empty array indicates deductions are not supported. - `company_contribution` string[], nullable — Supported contribution types. An empty array indicates contributions are not supported. - `annual_maximum` boolean, nullable — Whether the provider supports an annual maximum for this benefit. - `catch_up` boolean, nullable — Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits. - `hsa_contribution_limit` string[], nullable — 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. - `supported_operations` SupportPerBenefitType - `company_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `individual_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `simple_ira` BenefitFeaturesAndOperations, nullable - `supported_features` BenefitFeature - `description` string, nullable - `frequencies` BenefitFrequency[] — The list of frequencies supported by the provider for this benefit - `employee_deduction` string[], nullable — Supported deduction types. An empty array indicates deductions are not supported. - `company_contribution` string[], nullable — Supported contribution types. An empty array indicates contributions are not supported. - `annual_maximum` boolean, nullable — Whether the provider supports an annual maximum for this benefit. - `catch_up` boolean, nullable — Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits. - `hsa_contribution_limit` string[], nullable — 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. - `supported_operations` SupportPerBenefitType - `company_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `individual_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `simple` BenefitFeaturesAndOperations, nullable - `supported_features` BenefitFeature - `description` string, nullable - `frequencies` BenefitFrequency[] — The list of frequencies supported by the provider for this benefit - `employee_deduction` string[], nullable — Supported deduction types. An empty array indicates deductions are not supported. - `company_contribution` string[], nullable — Supported contribution types. An empty array indicates contributions are not supported. - `annual_maximum` boolean, nullable — Whether the provider supports an annual maximum for this benefit. - `catch_up` boolean, nullable — Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits. - `hsa_contribution_limit` string[], nullable — 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. - `supported_operations` SupportPerBenefitType - `company_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `individual_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `commuter` BenefitFeaturesAndOperations, nullable - `supported_features` BenefitFeature - `description` string, nullable - `frequencies` BenefitFrequency[] — The list of frequencies supported by the provider for this benefit - `employee_deduction` string[], nullable — Supported deduction types. An empty array indicates deductions are not supported. - `company_contribution` string[], nullable — Supported contribution types. An empty array indicates contributions are not supported. - `annual_maximum` boolean, nullable — Whether the provider supports an annual maximum for this benefit. - `catch_up` boolean, nullable — Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits. - `hsa_contribution_limit` string[], nullable — 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. - `supported_operations` SupportPerBenefitType - `company_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `individual_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `custom_post_tax` BenefitFeaturesAndOperations, nullable - `supported_features` BenefitFeature - `description` string, nullable - `frequencies` BenefitFrequency[] — The list of frequencies supported by the provider for this benefit - `employee_deduction` string[], nullable — Supported deduction types. An empty array indicates deductions are not supported. - `company_contribution` string[], nullable — Supported contribution types. An empty array indicates contributions are not supported. - `annual_maximum` boolean, nullable — Whether the provider supports an annual maximum for this benefit. - `catch_up` boolean, nullable — Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits. - `hsa_contribution_limit` string[], nullable — 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. - `supported_operations` SupportPerBenefitType - `company_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `individual_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `custom_pre_tax` BenefitFeaturesAndOperations, nullable - `supported_features` BenefitFeature - `description` string, nullable - `frequencies` BenefitFrequency[] — The list of frequencies supported by the provider for this benefit - `employee_deduction` string[], nullable — Supported deduction types. An empty array indicates deductions are not supported. - `company_contribution` string[], nullable — Supported contribution types. An empty array indicates contributions are not supported. - `annual_maximum` boolean, nullable — Whether the provider supports an annual maximum for this benefit. - `catch_up` boolean, nullable — Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits. - `hsa_contribution_limit` string[], nullable — 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. - `supported_operations` SupportPerBenefitType - `company_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `individual_benefits` OperationSupportMatrix - `create` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `update` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `delete` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `read` 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' — - `supported`: This operation is supported by both the provider and Finch - `not_supported_by_finch`: This operation is not supported by Finch but supported by the provider - `not_supported_by_provider`: This operation is not supported by the provider, so Finch cannot support - `client_access_only`: This behavior is supported by the provider, but only available to the client and not to Finch - `supported_fields` SupportedFields, nullable — The supported data fields returned by our HR and payroll endpoints - `company` SupportedCompanyFields - `id` boolean - `legal_name` boolean - `entity` object - `type` boolean - `subtype` boolean - `primary_email` boolean - `primary_phone_number` boolean - `ein` boolean - `accounts` object - `routing_number` boolean - `account_name` boolean - `institution_name` boolean - `account_type` boolean - `account_number` boolean - `departments` object - `name` boolean - `parent` object - `name` boolean - `locations` object - `line1` boolean - `line2` boolean - `city` boolean - `state` boolean - `postal_code` boolean - `country` boolean - `directory` SupportedDirectoryFields - `paging` object - `count` boolean - `offset` boolean - `individuals` object - `id` boolean - `first_name` boolean - `middle_name` boolean - `last_name` boolean - `is_active` boolean - `department` boolean - `manager` object - `id` boolean - `individual` SupportedIndividualFields - `id` boolean - `first_name` boolean - `middle_name` boolean - `last_name` boolean - `preferred_name` boolean - `dob` boolean - `gender` boolean - `ethnicity` boolean - `ssn` boolean - `encrypted_ssn` boolean - `emails` object - `data` boolean - `type` boolean - `phone_numbers` object - `data` boolean - `type` boolean - `residence` object - `city` boolean - `country` boolean - `line1` boolean - `line2` boolean - `postal_code` boolean - `state` boolean - `employment` SupportedEmploymentFields - `id` boolean - `first_name` boolean - `middle_name` boolean - `last_name` boolean - `title` boolean - `start_date` boolean - `end_date` boolean - `is_active` boolean - `employment_status` boolean - `income_history` boolean - `class_code` boolean - `custom_fields` boolean - `department` object - `name` boolean - `employment` object - `type` boolean - `subtype` boolean - `income` object - `amount` boolean - `currency` boolean - `unit` boolean - `location` object - `line1` boolean - `line2` boolean - `city` boolean - `state` boolean - `postal_code` boolean - `country` boolean - `manager` object - `id` boolean - `payment` SupportedPaymentFields - `id` boolean - `pay_date` boolean - `debit_date` boolean - `company_debit` boolean - `gross_pay` boolean - `net_pay` boolean - `employer_taxes` boolean - `employee_taxes` boolean - `individual_ids` boolean - `pay_period` object - `start_date` boolean - `end_date` boolean - `pay_group_ids` boolean - `pay_frequencies` boolean - `pay_statement` SupportedPayStatementFields - `paging` object - `count` boolean, required - `offset` boolean, required - `pay_statements` object - `individual_id` boolean - `type` boolean - `payment_method` boolean - `total_hours` boolean - `gross_pay` boolean - `net_pay` boolean - `earnings` object - `type` boolean - `name` boolean - `amount` boolean - `currency` boolean - `employee_deductions` object - `name` boolean - `amount` boolean - `type` boolean - `pre_tax` boolean - `currency` boolean - `employer_contributions` object - `name` boolean - `amount` boolean - `currency` boolean - `taxes` object - `type` boolean - `name` boolean - `employer` boolean - `amount` boolean - `currency` boolean - `pay_group` SupportedPayGroupFields - `id` boolean - `name` boolean - `pay_frequencies` boolean - `individual_ids` boolean --- [API](https://skmtc.dev/finch-api/apis/api-reference.md) · [All operations](https://skmtc.dev/finch-api/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/finch-api/api-reference/revisions/bf858f37d7ab/schema)