Represents benefits available to employees.
Use the benefit object to capture benefit types, start and end dates, and employee and company contributions. Benefits will be taken into consideration when calculating a particular employee's net pay.
{
"id": "ben_lrcYUhTk1FVZl2vSCOBP",
"employee": "emp_kKTK4VafMNc5pIbI0G9x",
"benefit": "401k",
"company_benefit": null,
"source": null,
"period": null,
"description": "Guideline 401(k)",
"effective_start": "2020-01-01",
"effective_end": null,
"company_contribution_amount": null,
"company_contribution_percent": 1.0,
"company_period_amount": null,
"employee_contribution_amount": null,
"employee_contribution_percent": 1.0,
"employee_period_amount": null,
"hsa_contribution_limit": null,
"metadata": {}
}
Attribute | Description |
---|---|
id | Unique identifier for the employee benefit. |
employee | ID of the employee that this employee benefit relates to. |
benefit | The benefit type. See types of benefits for a complete list of supported benefit types. |
company_benefit | (Optional) The company benefit associated with this employee benefit. |
source | Read-only field that indicates the source that created the object. Will be |
period | The period over which a period amount is distributed. Can be “monthly” or null. See the Period Benefits guide for more information. |
description | Human-readable name identifying the employee benefit. |
effective_start | The date this benefit should be considered effective. Payrolls with a payday before this date will not include the benefit. |
effective_end | The date this benefit should be no longer be considered effective. Payrolls with a payday after this date will not include the benefit. |
company_contribution_amount | How much the company should contribute toward this employee benefit every payroll, expressed as a dollar amount. |
company_contribution_percent | How much the company should contribute toward this employee benefit every payroll, expressed as a percentage of employee earnings. |
company_period_amount | How much the company should contribute towards this employee benefit across a |
employee_contribution_amount | How much the employee should contribute from their paycheck toward this employee benefit every payroll, expressed as a dollar amount. |
employee_contribution_percent | How much the employee should contribute from their paycheck toward this employee benefit every payroll, expressed as a percentage of employee earnings. |
employee_period_amount | How much the employee should contribute towards this employee benefit across a |
hsa_contribution_limit | The contribution limit for a HSA benefit. Only applicable for benefits of type |
metadata | Additional loosely structured information to associate with this employee benefit. |