CHcheckhq

Create a correction

Changed on

Creates a new correction in the draft status.

post/corrections

Request

Request body

companystring required

ID of the company whose pay history is being corrected.

yearinteger required

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

descriptionstring

A human-readable description of the correction.

metadataobject

Arbitrary key-value data to attach to the correction.

settlement_datestring 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_accountstring

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'automatic' | 'manual'

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.

Response

201

Changes