Making changes to an individual’s deductions may have tax consequences based
on IRS regulations. Please consult a tax expert to ensure all changes being
made to the system are compliant with local, state, and federal law.
Enrollment Bodies
Enrollment bodies have a common format for each benefit type, with a differentconfiguration
schema based on the benefit type. The configurations for each type are outlined below. These are general configurations and may vary per provider. Please use the /provider
endpoint to view provider specific supported configurations.
Retirement Benefits
Includes 401(k), Roth 401(k), 403(b), Roth 403(b), 457, Roth 457, and Simple IRAField | Type | Description |
---|---|---|
employee_deduction.type | string | Deduction Type (fixed or percent ) |
employee_deduction.amount | integer | Deduction amount in cents (if fixed ) or basis points (if percent ) |
company_contribution.type | string | Contribution Type (fixed or percent ) |
company_contribution.amount | integer | Contribution amount in cents (if fixed ) or basis points |
catch_up | boolean | Whether to enable catch up for this individual |
annual_maximum | integer (nullable ) | The annual maximum in cents for this individual |
effective_date * | string (nullable ) | The date which the benefit should take effect by (mm/dd/yyyy ) |
HSA
Field | Type | Description |
---|---|---|
employee_deduction.type | string | Deduction Type (fixed or percent ) |
employee_deduction.amount | integer | Deduction amount in cents (if fixed ) or basis points (if percent ) |
company_contribution.type | string | Contribution Type (fixed or percent ) |
company_contribution.amount | integer | Contribution amount in cents (if fixed ) or basis points |
catch_up | boolean | Whether to enable catch up for this individual |
annual_maximum | integer (nullable ) | The annual maximum in cents for this individual |
annual_contribution_limit | string (nullable ) | Whether HSA is applied towards individual or family |
effective_date * | string (nullable ) | The date which the benefit should take effect by (mm/dd/yyyy ) |
Section 125 Benefits, FSA, Custom Benefits
Field | Type | Description |
---|---|---|
employee_deduction.type | string | Deduction Type (fixed or percent ) |
employee_deduction.amount | integer | Deduction amount in cents (if fixed ) or basis points (if percent ) |
company_contribution.type | string | Contribution Type (fixed or percent ) |
company_contribution.amount | integer | Contribution amount in cents (if fixed ) or basis points |
effective_date * | string (nullable ) | The date which the benefit should take effect by (mm/dd/yyyy ) |
- Note:
effective_date
s that are undefined or in the past will default to the date the request was made. We recommend grouping enrollments byeffective_date
for a request. If multiple distincteffective_date
s are included, the job will be in pending status until the latesteffective_date
enrollment is processed. Sandbox integrations do not currently support multiple distincteffective_date
s within the same request.
Authorizations
Please use your Access Token
Headers
Header used to specify the version for a given API request. Current version is 2020-09-17.
Used to indicate the original media type of the resource
Path Parameters
Body
application/json · object[]
Response
Successfully enqueued job to enroll individuals in the benefit