Approve a correction

Approves a correction, scheduling its money movement for the settlement date.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Preview

The Corrections API is not yet available. This page is a preview of what the API will look like, and details may change before release.

Approves a correction, scheduling its money movement to be processed on the correction's settlement_date.

The endpoint returns 202 Accepted with the correction's approval object set to calculating. Monitor the approval's progress via the approval object on the correction, the same way preview progress is monitored. A correction updated webhook is sent when the approval completes.

When the approval succeeds, status moves to pending and fulfillment processing begins asynchronously. If the approval fails with approval.error_code fulfillment_changed, the correction remains in draft with refreshed totals reflecting the drifted plan — re-run Preview a correction if needed, then call this endpoint again.

A correction cannot be approved if it has no payrolls attached, or if its preview is stale or has not been run. While an approval is in progress, the correction cannot be edited, deleted, or previewed.

Path Params
string
required

ID of the correction to approve

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json