Get company benefit summary by company benefit id.
GET {{baseUrl}}/v1/company_benefits/:company_benefit_id/summary?start_date=<string>&end_date=<string>&detailed=<boolean>
Returns summary benefit data for the requested company benefit id.
Benefits containing PHI are only visible to applications with the company_benefits:read:phi scope.
scope: company_benefits:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
start_date | string | The start date for which to retrieve company benefit summary | |
end_date | string | The end date for which to retrieve company benefit summary. If left empty, defaults to today's date. | |
detailed | string | Display employee payroll item summary |
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. | |
Accept | string |
RESPONSES
status: OK
{"start_date":"2022-01-01","end_date":"2022-12-31","description":"Simple IRA","company_benefit_deduction":60,"company_benefit_contribution":30,"employees":[{"uuid":"54b7114f-f5e2-4f4b-911b-5cd5ad9032b0","company_benefit_deduction":60,"company_benefit_contribution":30,"benefit_deduction":660,"benefit_contribution":330,"gross_pay":18000,"payroll_benefits":[{"payroll_uuid":"8cc3471b-9da5-47df-88ea-f238c7cb968b","payroll_type":"Regular","check_date":"2022-03-01","gross_pay":3000,"company_benefit_deduction":10,"company_benefit_contribution":5,"pay_period":{"start_date":"2022-02-01","end_date":"2022-02-28"}},{"payroll_uuid":"d9d92786-722b-4bf7-bb32-79140418d349","payroll_type":"Bonus","check_date":"2022-12-31","gross_pay":3000,"company_benefit_deduction":20,"company_benefit_contribution":10,"pay_period":{"start_date":"nil","end_date":"nil"}}]}]}