Create a company benefit

Changed on

Create a company benefit

post/company_benefits

Request

Request body

companystring required

ID of the company associated with the benefit.

benefitstring required

Type of supported benefit. See types of benefits.

periodstring

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

descriptionstring required

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

201

Changes