Creates a void payroll that zeros out items on an existing payroll.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
PreviewThis endpoint is not yet available. This page is a preview of what the API will look like, and details may change before release.
Creates a void payroll — a payroll that exactly zeros out payroll items and contractor payments on an existing payroll — and attaches it to a draft correction.
Pass the ID of a draft correction in correction. By default, all payroll items and contractor payments on the payroll are voided. To void a subset, pass a subset object with payroll_items and/or contractor_payments lists of item IDs. Omit subset or set it to null to void the entire payroll.
Validations
- The payroll being voided must be in the
paidorpartially_paidstatus. - An item cannot be voided if an existing void of it is in
pendingor later. - An item cannot be voided twice on the same correction.
- The correction must be in
draft, and must belong to the same company and tax year as the payroll being voided.
Identifying voidsVoids are represented on payrolls and payroll items in three places:
is_voidon the payroll,void_ofon the void payroll item (pointing at the original item), andvoided_byon the original item (pointing at the void). See Voiding a Payroll Item for details.