The correction list entry object

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

The List corrections endpoint returns a paginated list of correction list entries. Each entry is a summary of a correction — use Get a correction for the full object, including operations and fulfillment details.

{
  "id": "cor_Bw6EkMDmxCPeVQ2eYzLu",
  "company": "com_sx3svU6K8c5ZkSFlOh5p",
  "year": 2026,
  "status": "draft",
  "settlement_date": "2026-07-15",
  "bank_account": "bnk_iPiAA7RDadr3gGMa2cvq",
  "description": "Void and replace 3/31 payroll for J. Smith",
  "metadata": {
    "external_id": "abc-123"
  },
  "created_at": "2026-06-24T18:26:56.848920Z",
  "updated_at": "2026-06-24T18:26:56.848920Z",
  "created_by": "[email protected]"
}

Attribute	Description
`id` string	Unique identifier for the correction.
`company` string	ID of the company whose pay history is being corrected.
`year` integer	The tax year the correction applies to, set at creation.
`status` string	One of `draft`, `pending`, `processing`, `settled`, or `failed`.
`settlement_date` string or null	The CFT settlement date for the correction's money movement. `null` until set at creation or updated on a draft.
`bank_account` string or null	ID of the bank account stamped for the correction's money movement. `null` only when the company had no default bank account to stamp.
`description` string or null	A human-readable description of the correction, set by you.
`metadata` object	Arbitrary key-value data you can attach to the correction.
`created_at` timestamp	Time at which the correction was created.
`updated_at` timestamp	Time at which the correction was last updated.
`created_by` string or null	Email of the user or integration that created the correction, when available.