Run the Benefits and Deductions report

Reports total benefits and deductions per worker for the date range, along with each worker's benefit and deduction settings. It matches the "Benefits & deductions" report in the Everee admin portal.

Criteria. Send startDate and endDate (both yyyy-MM-dd, startDate not after endDate).

Totals come from paid and imported payments only, for payments whose pay period (forDate) falls within the date range.

This endpoint needs the integration_reports-benefits-and-deductions:read scope. See the Guide to the Reports API for how report runs work, including retrieving the download link.

Body Params
date
required

First day of the range, inclusive (yyyy-MM-dd).

date
required

Last day of the range, inclusive (yyyy-MM-dd). Must not be before startDate.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json