CHcheckhq

Benefit Aggregations

Changed on

Returns a list of benefit aggregations for the company

get/companies/{company}/benefit_aggregations

Request

Path parameters

companystring required

ID of the company

Query parameters

startstring date

Aggregate benefits deducted on payrolls with paydays on or after this day.

endstring date

Aggregate benefits deducted on payrolls with paydays on or before this day.

expand_benefitsboolean

If true, will return the full benefit configuration for each benefit. If false, will only return the benefit's ID

Response

200

nextunknown
previousunknown

Example response

{
  "results": [
    {
      "benefit": {
        "id": "ben_pQMNgBa3F0Y70rsbjfm6",
        "employee": "emp_oDOpbDLpQe5e9CAwEEqF",
        "benefit": "125_medical_other",
        "description": "Guideline 401(k)",
        "effective_start": "2020-01-01",
        "company_contribution_amount": "25.00",
        "employee_contribution_amount": "100.00"
      },
      "company_contribution_amount_to_date": "25.00",
      "employee_contribution_amount_to_date": "100.00"
    }
  ]
}

Changes