CHcheckhq

Get a company benefit

Changed on

Get a company benefit

get/company_benefits/{company_benefit}

Request

Path parameters

company_benefitstring required

ID of the company benefit to return.

Response

200

idstring
companystring
benefitstring
sourceunknown
periodunknown
descriptionstring
effective_startstring
effective_endunknown
company_contribution_amountunknown
company_contribution_percentinteger
company_period_amountunknown
employee_contribution_amountunknown
employee_contribution_percentinteger
employee_period_amountunknown
metadataobject

Example response

{
  "id": "cbn_lrcYUhTk1FVZl2vSCOBP",
  "company": "cbn_kKTK4VafMNc5pIbI0G9x",
  "benefit": "401k",
  "description": "Guideline 401(k)",
  "effective_start": "2020-01-01",
  "company_contribution_percent": 1,
  "employee_contribution_percent": 1
}

Changes