Approves a correction, scheduling its money movement for the settlement date.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
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. When it fails, approval.status is failed, the correction remains in draft, and approval.error_code is one of:
fulfillment_changed— the money movement changed since the last preview.totalsis refreshed to the new amounts. Re-run Preview a correction if needed, then call this endpoint again.balancing_changed— the balancing payrolls for an impacted closed quarter changed since the last preview. The refreshed balancing payrolls are on the correction. Reported instead offulfillment_changedwhen both changed.payroll_item_already_voided— another correction's void of the same payroll item was approved first.approval_failed— the approval failed for any other reason.
While an approval is in progress, the correction cannot be edited, deleted, or previewed.
Errors
The request is rejected before the approval starts when:
correction_not_draft— the correction is not indraft.correction_empty— the correction has no payrolls attached.preview_required— the correction has no succeeded preview. Run Preview a correction first.settlement_date_required— the correction will debit or refund the employer and has nosettlement_date.settlement_date_invalid— thesettlement_dateis no longer a banking day between the earliest date ACH can reach and 7 days from today. Update it and approve again.bank_account_invalid— the correction'sbank_accountis no longer active. Set it to another account, or tonullto stamp the company's current default.company_not_in_good_standing— the company is not in good standing.payroll_item_already_voided— another correction's void of a payroll item on this correction has already been approved.correction_not_session_managed— the correction's payrolls are not managed by the correction, so it cannot be approved through this endpoint.locked_resource_error(HTTP 409) — a calculation, preview, or approval is already in progress for the correction.