Exclude a payment from a payroll run

post

https://api.everee.com/integration/v1/payroll-runs/{id}/payments/{paymentId}/exclude

Leave a worker's payment out of an OPEN, CALCULATING, READY or BLOCKED run, with an optional reason. The payment stays listed with status EXCLUDED and your excludedReason, and its items are deleted. A payment can be excluded until it's approved. A READY or BLOCKED run goes back to OPEN. Excluding a payment that's already excluded does nothing.

Responses

204

The payment was excluded, or already was.

400The ID isn't numeric, limit is out of range, after isn't a cursor from this list, or page, size or sort was sent: these lists are in a fixed order and use cursor paging. The company isn't set up for Payroll Infrastructure: its payroll is run in the Everee admin portal.

404No payroll run with that ID exists for the company, or the payment isn't in it.

409The run isn't OPEN, CALCULATING, READY or BLOCKED, or the payment is too far along to exclude.