Represents benefits associated with companies.
Use the company benefit object to capture benefit types, start and end dates, and default employee and company contributions. Benefits will be taken into consideration when calculating a particular employee's net pay.
{
"id": "cbn_lrcYUhTk1FVZl2vSCOBP",
"company": "com_kKTK4VafMNc5pIbI0G9x",
"benefit": "401k",
"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,
"metadata": {}
}
Attribute | Description |
---|---|
id | Unique identifier for the company benefit. |
company | ID of the company that this company benefit relates to. |
benefit | The benefit type. See types of benefits for a complete list of supported benefit types. |
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 company benefit. |
effective_start | The date this benefit should be considered effective. Payrolls with a payday before this date will not include employee benefits associated with this benefit. |
effective_end | The date this benefit should be no longer be considered effective. Payrolls with a payday before this date will not include employee benefits associated with this benefit. |
company_contribution_amount | How much the company should contribute by default toward employee benefits associated with this company benefit every payroll, expressed as a dollar amount. |
company_contribution_percent | How much the company should contribute by default toward employee benefits associated with this company benefit every payroll, expressed as a percentage of employee earnings. |
company_period_amount | The default value for |
employee_contribution_amount | How much the employee should contribute by default from their paycheck toward employee benefits associated with this company benefit every payroll, expressed as a dollar amount. |
employee_contribution_percent | How much the employee should contribute by default from their paycheck toward employee benefits associated with this company benefit every payroll, expressed as a percentage of employee earnings. |
employee_period_amount | The default value for |
metadata | Additional loosely structured information to associate with this company benefit. |