Create a correction

post

https://sandbox.checkhq.com/corrections

Creates a new draft correction.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
In preview
The Correction API is currently in limited preview, and is not yet generally available.

Creates a new correction in the draft status. A correction created webhook is sent.

company and year are required. You may optionally set settlement_date, bank_account, description, metadata, and simulation_mode (sandbox only). All payrolls attached to the correction must belong to the tax year set in year.

Once created, attach changes to the correction with Void a payroll and Create an external payroll.

Body Params

company

string

required

ID of the company whose pay history is being corrected.

year

integer

required

The tax year the correction applies to. All payrolls attached to the correction must belong to this tax year.

description

string

A human-readable description of the correction.

metadata

object

Arbitrary key-value data to attach to the correction.

settlement_date

date

The CFT settlement date for the correction's money movement. Must be a valid banking day on or after the earliest date ACH can still reach for settlement. Any later banking day is allowed. Optional at creation; if omitted, a date is chosen when the correction is approved.

bank_account

string

ID of the bank account to debit or credit at fulfillment. Must belong to the correction's company. Optional; if omitted or null, Check stamps the company's current default bank account.

simulation_mode

string

enum

Sandbox-only. How the correction moves through money movement after approval. One of automatic or manual. Omitted or null defaults to automatic. Returns a validation error in production.

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

In preview

201201