Create a company benefit
POST {{baseUrl}}/v1/companies/:company_id/company_benefits
Company benefits represent the benefits that a company is offering to employees. This ties together a particular supported benefit with the company-specific information for the offering of that benefit.
Note that company benefits can be deactivated only when no employees are enrolled.
scope: company_benefits:write
Request Body
{"description"=>"<string>", "benefit_type"=>"<number>", "active"=>true, "responsible_for_employer_taxes"=>"<boolean>", "responsible_for_employee_w2"=>"<boolean>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"uuid":"d2cec746-caee-464a-bcaf-00d93f7049c9","version":"98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872","company_uuid":"881ce3f2-e3e1-49c9-8ad4-0bcf515f5618","benefit_type":1,"active":true,"description":"Kaiser Permanente","deletable":true,"supports_percentage_amounts":true,"responsible_for_employer_taxes":false,"responsible_for_employee_w2":false}