The company benefit object

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",
  "description": "Guideline 401(k)",
  "effective_start": "2020-01-01",
  "effective_end": null,
  "company_contribution_amount": null,
  "company_contribution_percent": 1.0,
  "employee_contribution_amount": null,
  "employee_contribution_percent": 1.0,
  "metadata": {}
}

Attribute	Description
id string	Unique identifier for the company benefit.
company string	ID of the company that this company benefit relates to.
benefit string	The benefit type. See types of benefits for a complete list of supported benefit types.
description string	Human-readable name identifying the company benefit.
effective_start YYYY-MM-DD	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 YYYY-MM-DD	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 string	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 float	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.
employee_contribution_amount string	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 float	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.
metadata object	Additional loosely structured information to associate with this company benefit.