v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-2148120293.6 KB

Deductions

[Deprecated] Get Deductions Metadata

Get deductions metadata

get/employer/benefits/meta

Query parameters

entity_idsstring[]

The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted.

[
  "550e8400-e29b-41d4-a716-446655440000"
]

Headers

Finch-API-Versionstring date required

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

Response

descriptionstring nullable required

frequenciesBenefitFrequency[] required

The list of frequencies supported by the provider for this benefit

employee_deductionstring[] nullable required

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

company_contributionstring[] nullable required

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

annual_maximumboolean nullable required

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.