The correction receipt object

Tax rollup for a previewed correction, split by remittance party.

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

A correction receipt summarizes how a previewed correction changes tax liabilities. It mirrors the tax-by-tax breakdown in the downloadable PDF receipt, but as structured JSON suitable for rendering in your product.

Returned by Get a correction receipt. Use Download a correction receipt for a short-lived PDF link.

{
  "totals": {
    "cash_requirement": "23.50",
    "cash_requirement_waived": "0.00",
    "agency_refundable": "0.00",
    "company_responsibility": "0.00"
  },
  "taxes": [
    {
      "tax": "tax_8kQm2pLxNvRwYhJdFsAe",
      "tax_label": "Federal Income Tax",
      "jurisdiction": "US",
      "agency": null,
      "agency_label": null,
      "voided": {
        "check": "-235.00",
        "company": "0.00"
      },
      "added": {
        "check": "258.50",
        "company": "0.00"
      },
      "balanced": {
        "check": "0.00",
        "company": "0.00"
      },
      "reassigned": {
        "check": "0.00",
        "company": "0.00"
      },
      "cash_requirement": "23.50",
      "cash_requirement_waived": "0.00",
      "agency_refundable": "0.00",
      "company_responsibility": "0.00"
    }
  ]
}

Attribute	Description
`totals` object	Money-movement totals across all taxes on the correction. Uses the same field names as correction totals, plus `company_responsibility`.
`taxes` array	One entry per tax with net movement from the correction. Taxes with no net change are omitted.

`totals` attributes

Attribute	Description
`cash_requirement` string	Net amount Check would debit from or credit to the employer for this correction. May be negative.
`cash_requirement_waived` string	Portion of the cash requirement waived by Check. May be negative.
`agency_refundable` string	Amount that may be refundable from tax agencies. May be negative.
`company_responsibility` string	Change in tax liability the company remits outside Check as a result of this correction. Positive adds responsibility; negative removes it. May be negative.

`taxes[]` attributes

Attribute	Description
`tax` string	ID of the tax.
`tax_label` string	Human-readable label for the tax.
`jurisdiction` string or null	Jurisdiction abbreviation for the tax, when available.
`agency` string or null	ID of the remittance agency, when applicable.
`agency_label` string or null	Human-readable label for the agency.
`voided`, `added`, `balanced`, `reassigned` object	Change in liability for that operation, split by remittance party. Each object has `check` and `company` decimal strings. Positive adds responsibility; negative removes it.
`cash_requirement`, `cash_requirement_waived`, `agency_refundable`, `company_responsibility` string	Per-tax totals for the same fields described on `totals`. May be negative.