Run the Pay Correction by Earning Period report

post

https://api.everee.com/integration/v1/reports/pay-correction-by-earning-period

Reports on pay corrections whose earning period falls within the date range. It matches the pay corrections report in the Everee admin portal, filtered by earning period.

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

Correction amounts come from finalized payments only.

This endpoint needs the integration_reports-pay-correction-by-earning-period:read scope. See the Guide to the Reports API for how report runs work, including retrieving the download link.

Responses

200The report run was accepted. Wait for the report.completed webhook event, then retrieve the report run to get the download URL.

400The criteria are missing or invalid. errorMessage names the field.

403Your credentials lack the integration_reports-pay-correction-by-earning-period:read scope.