Update a company benefit

patch

https://sandbox.checkhq.com/company_benefits/{company_benefit}

Updates the specified company benefit.

Path Params

company_benefit

string

required

ID of the company benefit to update

Body Params

company

string

ID of the company associated with the benefit.

benefit

string

Type of supported benefit. See types of benefits.

period

string

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

description

string

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

company_contribution_amount

string

Default amount for company to contribute per payroll.

company_contribution_percent

string

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

company_period_amount

string

Default amount for company to contribute over a period.

employee_contribution_amount

string

Default amount for employee to contribute per payroll.

employee_contribution_percent

string

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

employee_period_amount

string

Default amount for employee to contribute over a period.

effective_start

string

Start date for the benefit.

effective_end

string

End date for the benefit.

metadata

json

Additional loosely structured information to associate with this company benefit.

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400