Sign in
Deductions

[Deprecated] Get Deductions Metadata

Get deductions metadata

get/employer/benefits/meta

Headers

Finch-API-Versionstring date required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Response

OK

type'401k' | '401k_roth' | '401k_loan' | '403b' | '403b_roth' | '457' | '457_roth' | 's125_medical' | 's125_dental' | 's125_vision' | 'hsa_pre' | 'hsa_post' | 'fsa_medical' | 'fsa_dependent_care' | 'simple_ira' | 'simple' | 'commuter' | 'custom_post_tax' | 'custom_pre_tax' | 'null' nullable

Type of benefit.

descriptionstring nullable
frequenciesBenefitFrequency[]

The list of frequencies supported by the provider for this benefit

employee_deductionstring[] nullable

Supported deduction types. An empty array indicates deductions are not supported.

company_contributionstring[] nullable

Supported contribution types. An empty array indicates contributions are not supported.

annual_maximumboolean nullable

Whether the provider supports an annual maximum for this benefit.

catch_upboolean nullable

Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.

hsa_contribution_limitstring[] 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.

Changes