Run the Garnishment Withholding report

Reports garnishment amounts withheld from workers' pay in the date range, for all workers. It matches the garnishment withholding report in the Everee admin portal.

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

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

This endpoint needs the integration_reports-garnishment-withholding: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