post
https://sandbox.checkhq.com/corrections//preview
Calculates the full effects of a correction and creates a preview fulfillment.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Starts an asynchronous preview of a correction. Previewing a correction does two things:
- Rebalances each impacted closed quarter. If the correction changes pay history in a closed quarter, Check calculates the tax effects of rebalancing that quarter and attaches the resulting payrolls to the correction as
balance_quarteroperations. - Prices the correction without moving money. Once the preview succeeds,
totalsis populated with the money-movement totals that would be required to fulfill the correction, using the same shape as fulfillment totals.
The endpoint returns 202 Accepted with the correction's preview object set to calculating. Monitor the preview's progress via the preview object on the correction, the same way payroll previews are monitored. When the preview fails, preview.messages describes why. A correction updated webhook is sent when the preview completes.
The preview is invalidated if payrolls are added to or deleted from the correction.