- Changelog
- API Status
- GETGet All Deductions
- POSTRegister Deduction
- POSTCreate Deduction
- GETGet Deduction
- POSTUpdate Deduction
- GETGet Enrolled Individuals
- GETGet Deductions for Individuals
- POSTEnroll Individuals in Deductions
- DELUnenroll Individuals from Deductions
- POSTCreate Access Token
- GETProviders
- GETIntrospect
- POSTDisconnect
- POSTRequest Forwarding
- GETList All Automated Jobs
- POSTEnqueue a New Automated Job
- GETRetrieve an Automated Job
- GETRetrieve a Manual Job
- POSTCreate a new Sandbox Connection
- POSTCreate a new sandbox account
- PUTUpdate a sandbox account
- GETGet configurations for sandbox jobs
- PUTUpdate configurations for sandbox jobs
- POSTAdd a new sandbox payment
- PUTUpdate sandbox individual
- PUTUpdate sandbox employment
- POSTAdd new individuals to a sandbox company
- PUTUpdate a sandbox company's data
- POSTEnqueue a new sandbox job
Deductions
Management
Sandbox
Providers
Return details on all available payroll and HR systems.
Header used to specify the version for a given API request. Current version is 2020-09-17.
curl --request GET \
--url https://api.tryfinch.com/providers \
--header 'Finch-API-Version: <finch-api-version>'
[
{
"id": "gusto",
"display_name": "Gusto",
"products": [
"company",
"directory"
],
"icon": "https://finch-assets.s3.us-west-2.amazonaws.com/provider-logos/gustoIcon.png",
"logo": "https://finch-assets.s3.us-west-2.amazonaws.com/provider-logos/gustoLogo.png",
"mfa_required": true,
"primary_color": "#f45d47",
"authentication_methods": [
{
"type": "api",
"benefits_support": {
"457": null,
"401k": {
"supported_features": {
"company_contribution": null,
"employee_deduction": [
"fixed",
"percent"
],
"frequencies": [
"one_time",
"every_paycheck"
],
"annual_maximum": false,
"catch_up": false,
"description": "401(k)"
},
"supported_operations": {
"company_benefits": {
"read": "not_supported_by_finch",
"create": "supported",
"update": "supported",
"delete": "not_supported_by_finch"
},
"individual_benefits": {
"read": "not_supported_by_finch",
"create": "supported",
"delete": "supported",
"update": "supported"
}
}
},
"401k_roth": null,
"401k_loan": null,
"403b": null,
"403b_roth": null,
"457_roth": null,
"s125_medical": null,
"s125_dental": null,
"s125_vision": null,
"hsa_pre": null,
"hsa_post": null,
"fsa_medical": null,
"fsa_dependent_care": null,
"simple_ira": null,
"simple": null,
"commuter": null,
"custom_post_tax": null,
"custom_pre_tax": null
},
"supported_fields": {
"company": {
"id": true,
"legal_name": true,
"entity": {
"type": true,
"subtype": false
},
"primary_email": true,
"primary_phone_number": true,
"ein": true,
"accounts": {
"routing_number": true,
"account_name": true,
"institution_name": true,
"account_type": true,
"account_number": true
},
"departments": {
"name": true,
"parent": {
"name": true
}
},
"locations": {
"line1": true,
"line2": true,
"city": true,
"state": true,
"postal_code": true,
"country": true
}
},
"directory": {
"paging": {
"count": true,
"offset": true
},
"individuals": {
"id": true,
"first_name": true,
"middle_name": true,
"last_name": true,
"is_active": true,
"department": null,
"manager": {
"id": true
}
}
},
"individual": {
"id": true,
"first_name": true,
"middle_name": true,
"last_name": true,
"preferred_name": true,
"dob": true,
"gender": false,
"ethnicity": false,
"ssn": true,
"encrypted_ssn": true,
"emails": {
"data": true,
"type": true
},
"phone_numbers": {
"data": true,
"type": true
},
"residence": {
"city": true,
"country": true,
"line1": true,
"line2": true,
"postal_code": true,
"state": true
}
},
"employment": {
"id": true,
"first_name": true,
"middle_name": true,
"last_name": true,
"title": true,
"start_date": true,
"end_date": true,
"is_active": true,
"income_history": false,
"class_code": true,
"custom_fields": false,
"department": {
"name": true
},
"employment": {
"type": true,
"subtype": true
},
"income": {
"amount": true,
"currency": true,
"unit": true
},
"location": {
"line1": true,
"line2": true,
"city": true,
"state": true,
"postal_code": true,
"country": true
},
"manager": null
},
"payment": {
"id": true,
"pay_date": true,
"debit_date": false,
"company_debit": true,
"gross_pay": true,
"net_pay": true,
"employer_taxes": true,
"employee_taxes": true,
"individual_ids": true,
"pay_period": {
"start_date": false,
"end_date": false
}
},
"pay_statement": {
"paging": {
"count": true,
"offset": true
},
"pay_statements": {
"individual_id": true,
"type": true,
"payment_method": true,
"total_hours": true,
"gross_pay": true,
"net_pay": true,
"earnings": {
"type": true,
"name": true,
"amount": true,
"currency": true
},
"employee_deductions": {
"name": true,
"amount": true,
"type": true,
"pre_tax": true,
"currency": true
},
"employer_contributions": {
"name": true,
"amount": true,
"currency": true
},
"employer_deductions": {
"name": true,
"amount": true,
"currency": true
},
"taxes": {
"type": true,
"name": true,
"employer": true,
"amount": true,
"currency": true
}
}
}
}
}
]
}
]
Headers
Header used to specify the version for a given API request. Current version is 2020-09-17.
Response
The id of the payroll provider used in Connect.
The display name of the payroll provider.
The list of Finch products supported on this payroll provider.
The url to the official icon of the payroll provider.
The url to the official logo of the payroll provider.
whether MFA is required for the provider.
The hex code for the primary color of the payroll provider.
[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.
The list of authentication methods supported by the provider.
The type of authentication method.
assisted
, credential
, api_token
, api_credential
, oauth
Each benefit type and their supported features. If the benefit type is not supported, the property will be null
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The list of frequencies supported by the provider for this benefit
one_time
, every_paycheck
, monthly
,
Supported deduction types. An empty array indicates deductions are not supported.
fixed
, percent
,
Supported contribution types. An empty array indicates contributions are not supported.
fixed
, percent
,
Whether the provider supports an annual maximum for this benefit.
Whether the provider supports catch up for this benefit. This field will only be true for retirement benefits.
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.
individual
, family
,
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
supported
: This operation is supported by both the provider and Finchnot_supported_by_finch
: This operation is not supported by Finch but supported by the providernot_supported_by_provider
: This operation is not supported by the provider, so Finch cannot supportclient_access_only
: This behavior is supported by the provider, but only available to the client and not to Finch
supported
, not_supported_by_finch
, not_supported_by_provider
, client_access_only
The supported data fields returned by our HR and payroll endpoints
[DEPRECATED] Use employer_contributions
instead
Was this page helpful?
curl --request GET \
--url https://api.tryfinch.com/providers \
--header 'Finch-API-Version: <finch-api-version>'
[
{
"id": "gusto",
"display_name": "Gusto",
"products": [
"company",
"directory"
],
"icon": "https://finch-assets.s3.us-west-2.amazonaws.com/provider-logos/gustoIcon.png",
"logo": "https://finch-assets.s3.us-west-2.amazonaws.com/provider-logos/gustoLogo.png",
"mfa_required": true,
"primary_color": "#f45d47",
"authentication_methods": [
{
"type": "api",
"benefits_support": {
"457": null,
"401k": {
"supported_features": {
"company_contribution": null,
"employee_deduction": [
"fixed",
"percent"
],
"frequencies": [
"one_time",
"every_paycheck"
],
"annual_maximum": false,
"catch_up": false,
"description": "401(k)"
},
"supported_operations": {
"company_benefits": {
"read": "not_supported_by_finch",
"create": "supported",
"update": "supported",
"delete": "not_supported_by_finch"
},
"individual_benefits": {
"read": "not_supported_by_finch",
"create": "supported",
"delete": "supported",
"update": "supported"
}
}
},
"401k_roth": null,
"401k_loan": null,
"403b": null,
"403b_roth": null,
"457_roth": null,
"s125_medical": null,
"s125_dental": null,
"s125_vision": null,
"hsa_pre": null,
"hsa_post": null,
"fsa_medical": null,
"fsa_dependent_care": null,
"simple_ira": null,
"simple": null,
"commuter": null,
"custom_post_tax": null,
"custom_pre_tax": null
},
"supported_fields": {
"company": {
"id": true,
"legal_name": true,
"entity": {
"type": true,
"subtype": false
},
"primary_email": true,
"primary_phone_number": true,
"ein": true,
"accounts": {
"routing_number": true,
"account_name": true,
"institution_name": true,
"account_type": true,
"account_number": true
},
"departments": {
"name": true,
"parent": {
"name": true
}
},
"locations": {
"line1": true,
"line2": true,
"city": true,
"state": true,
"postal_code": true,
"country": true
}
},
"directory": {
"paging": {
"count": true,
"offset": true
},
"individuals": {
"id": true,
"first_name": true,
"middle_name": true,
"last_name": true,
"is_active": true,
"department": null,
"manager": {
"id": true
}
}
},
"individual": {
"id": true,
"first_name": true,
"middle_name": true,
"last_name": true,
"preferred_name": true,
"dob": true,
"gender": false,
"ethnicity": false,
"ssn": true,
"encrypted_ssn": true,
"emails": {
"data": true,
"type": true
},
"phone_numbers": {
"data": true,
"type": true
},
"residence": {
"city": true,
"country": true,
"line1": true,
"line2": true,
"postal_code": true,
"state": true
}
},
"employment": {
"id": true,
"first_name": true,
"middle_name": true,
"last_name": true,
"title": true,
"start_date": true,
"end_date": true,
"is_active": true,
"income_history": false,
"class_code": true,
"custom_fields": false,
"department": {
"name": true
},
"employment": {
"type": true,
"subtype": true
},
"income": {
"amount": true,
"currency": true,
"unit": true
},
"location": {
"line1": true,
"line2": true,
"city": true,
"state": true,
"postal_code": true,
"country": true
},
"manager": null
},
"payment": {
"id": true,
"pay_date": true,
"debit_date": false,
"company_debit": true,
"gross_pay": true,
"net_pay": true,
"employer_taxes": true,
"employee_taxes": true,
"individual_ids": true,
"pay_period": {
"start_date": false,
"end_date": false
}
},
"pay_statement": {
"paging": {
"count": true,
"offset": true
},
"pay_statements": {
"individual_id": true,
"type": true,
"payment_method": true,
"total_hours": true,
"gross_pay": true,
"net_pay": true,
"earnings": {
"type": true,
"name": true,
"amount": true,
"currency": true
},
"employee_deductions": {
"name": true,
"amount": true,
"type": true,
"pre_tax": true,
"currency": true
},
"employer_contributions": {
"name": true,
"amount": true,
"currency": true
},
"employer_deductions": {
"name": true,
"amount": true,
"currency": true
},
"taxes": {
"type": true,
"name": true,
"employer": true,
"amount": true,
"currency": true
}
}
}
}
}
]
}
]