CHcheckhq

Update a company benefit

Changed on

Updates the specified company benefit.

patch/company_benefits/{company_benefit}

Request

Path parameters

company_benefitstring required

ID of the company benefit to update

Request body

companystring

ID of the company associated with the benefit.

benefitstring

Type of supported benefit. See types of benefits.

periodstring

The period over which a period amount is distributed. Can be "monthly" or null.

descriptionstring

Description to distinguish the benefit from other company benefits of the same type. Maximum length of 255 characters.

company_contribution_amountstring

Default amount for company to contribute per payroll.

company_contribution_percentstring

Default decimal percentage of gross pay for company to contribute per payroll from 0 to 100.

company_period_amountstring

Default amount for company to contribute over a period.

employee_contribution_amountstring

Default amount for employee to contribute per payroll.

employee_contribution_percentstring

Default decimal percentage of gross pay for company to contribute per payroll from 0 to 100.

employee_period_amountstring

Default amount for employee to contribute over a period.

effective_startstring

Start date for the benefit.

effective_endstring

End date for the benefit.

metadatastring json

Additional loosely structured information to associate with this company benefit.

Response

200

object required

Changes