---
title: "Copy of Update a payroll item"
method: PATCH
path: "/payroll_items"
---

# Copy of Update a payroll item

`PATCH /payroll_items`

Updates the specified payroll item.

## Request body

- object[]
  - `id` string, required — Unique ID of the payroll item.
  - `payroll` string — The payroll ID associated with the payroll item.
  - `payment_method` string — May be `manual`, or `direct_deposit` if the employee has a linked bank account.
  - `earnings` object[] — The set of earnings objects associated with the payroll item.
    - `type` string, required — Type of earning. Can be one of the following earning types in <a href="https://docs.checkhq.com/reference/types-of-earnings">Types of earnings</a>
    - `workplace` string, required — ID of the workplace where work for this earning was performed
    - `earning_code` string — The earning code id which will be used to aggregate earnings on the paystub
    - `description` string — Readable description of the earning code that will show up on the paystub
    - `earning_rate` string — The earning rate id which will be used to calculate the gross wage. Required if type is “piece”
    - `amount` string, required — Amount earned for this earning<br><br>Must be greater than 0
    - `hours` number, float — Number of hours worked for this earning
    - `piece_units` number, float — Number of units of work produced. Required if type is “piece”
    - `metadata` string, json — Additional loosely structured information to associate with the earning
  - `reimbursements` object[] — The set of non-taxable reimbursements objects associated with the payroll item.
    - `amount` string, required — Amount of reimbursement<br><br>Must be greater than 0
    - `description` string — Description for the reimbursement that will show up on the paystub
    - `code` string — Unique code to identify the reimbursement that will be used to aggregate reimbursements on the paystub. Recommended to always be included to have explicit groupings on the paystub.
    - `metadata` string, json — Additional loosely structured information to associate with the reimbursement
  - `benefit_overrides` object[] — The set of benefit override objects associated with this payroll item.
    - `benefit` string, required — ID of the employee benefit that is being overridden for the payroll item
    - `employee_contribution_amount` string — Updated employee contribution amount to use for this payroll only
    - `company_contribution_amount` string — Updated company contribution amount to use for this payroll only
  - `post_tax_deduction_overrides` object[] — The set of benefit override objects associated with this payroll item.
    - `post_tax_deduction` string, required — ID of the miscellaneous post-tax deduction that is being overridden.
    - `amount` string, required — Updated deduction amount to use for this payroll only
  - `tax_overrides` object[] — The set of tax override objects associated with this payroll item.
    - `tax` string, required — ID of the tax being overridden. Only Federal Income Tax and State Income Taxes are eligible.
    - `amount` string, required — Updated withholding amount to use for this payroll only.
  - `pto_balance_hours` number, float — The employee's remaining PTO hour balance, for display on the paystub. Can be updated even after the associated payroll has been approved.
  - `sick_balance_hours` number, float — The employee's remaining sick hour balance, for display on the paystub. Can be updated even after the associated payroll has been approved.
  - `state_covid_sick_balance_hours` number, float — The employee's remaining sick hour balance from state COVID relief bills, for display on the paystub
  - `supplemental_tax_calc_method` string — Controls the method used by Check to calculate tax on supplemental earnings. May be `flat` or `aggregate`
  - `paper_check_number` string — For accounting. The check number associated with any printed checks. Can be updated even after the associated payroll has been approved. See [Get a paper check](https://docs.checkhq.com/reference/get-a-paper-check) for more details.
  - `paystub_info` string, json — Loosely structured information that will be returned on paystubs generated for this payroll item. Limited to 15 keys, and 500 total characters (combined length of keys and values).
  - `metadata` string, json — Additional loosely structured information to associate with the payroll item

## Response `200`

Returns a list of payroll items that were modified by the PATCH request

- object[]
  - `id` string — Unique identifier for the payroll item
  - `payroll` string — The payroll ID associated with the payroll item
  - `employee` string — The employee ID associated with the payroll item
  - `status` string — Status of the payroll item. One of `draft`, `pending`, `processing`, `failed`, `partially_paid`, or `paid`
  - `void_of` string, nullable — The ID of the payroll item this payroll item is voiding. Only applicable to voided items
  - `voided_by` string, nullable — The ID of the payroll item this payroll item was voided by. Only applicable to voided items
  - `payment_method` string — May be `manual` or `direct_deposit` if the employee has a linked bank account
  - `supplemental_tax_calc_method` string — Controls the method used by Check to calculate tax on supplemental earnings. May be `flat` or `aggregate`
  - `net_pay` string, nullable — Read only. The total amount of net pay earned by the employee for this payroll item
  - `net_pay_split` string, nullable — The net pay split ID associated with this payroll item
  - `pto_balance_hours` number, float, nullable — The employee's remaining PTO hour balance, for display on the paystub
  - `sick_balance_hours` number, float, nullable — The employee's remaining sick hour balance, for display on the paystub
  - `state_covid_sick_balance_hours` number, float, nullable — The employee's remaining sick hour balance from state COVID relief bills, for display on the paystub
  - `earnings` object[] — The set of earnings objects associated with the payroll item
    - `amount` string — Amount earned for this earning
    - `hours` number, float, nullable — Number of hours worked for this earning
    - `type` string, nullable — Type of earning
    - `code` string, nullable — Code for the earning
    - `description` string, nullable — Readable description of the earning code that will show up on the paystub
    - `earning_code` string, nullable — The earning code id which will be used to aggregate earnings on the paystub
    - `earning_rate` string, nullable — The earning rate id which will be used to calculate the gross wage
    - `workplace` string, nullable — ID of the workplace where work for this earning was performed
    - `tip_credit_amount` string, nullable — Amount of tip credit being taken by the employer. Required if the type is `tip_credit_adjustment_to_minimum_wage`
    - `metadata` object — Additional loosely structured information to associate with the earning
  - `reimbursements` object[] — The set of non-taxable reimbursements objects associated with the payroll item
    - `amount` string — Amount of reimbursement
    - `code` string, nullable — Unique code to identify the reimbursement
    - `description` string, nullable — Description for the reimbursement that will show up on the paystub
  - `taxes` object[], nullable — Read only. An array of taxes objects associated with the payroll item
    - `tax` string — The tax ID
    - `description` string, nullable — Description of the tax
    - `amount` string — Amount of tax
    - `payer` string, nullable — The payer of the tax (e.g., `company` or `employee`)
    - `remittable` boolean, nullable — Whether the tax is remittable
  - `benefits` object[], nullable — Read only. An array of benefits objects associated with the payroll item
  - `benefit_overrides` object[] — The set of benefit override objects associated with this payroll item
    - `benefit` string — ID of the employee benefit that is being overridden for the payroll item
    - `employee_contribution_amount` string, nullable — Updated employee contribution amount to use for this payroll only
    - `company_contribution_amount` string, nullable — Updated company contribution amount to use for this payroll only
  - `post_tax_deductions` object[], nullable — Read only. An array of post_tax_deductions objects associated with the payroll item
  - `post_tax_deduction_overrides` object[] — The set of post-tax deduction override objects associated with this payroll item
    - `post_tax_deduction` string — ID of the miscellaneous post-tax deduction that is being overridden
    - `amount` string — Updated deduction amount to use for this payroll only
  - `tax_overrides` object[] — The set of tax override objects associated with this payroll item
    - `tax` string — ID of the tax being overridden. Only Federal Income Tax and State Income Taxes are eligible.
    - `amount` string — Updated withholding amount to use for this payroll only.
  - `warnings` object[], nullable — Read only. An array of warnings objects associated with the payroll item
  - `paper_check_number` string, nullable — For accounting. The check number associated with any printed checks
  - `paystub_info` object, nullable — Loosely structured information that will be returned on paystubs generated for this payroll item
  - `metadata` object — Additional loosely structured information to associate with the payroll item

---

[API](https://skmtc.net/checkhq/apis/check-api.md) · [All operations](https://skmtc.net/checkhq/apis/check-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/checkhq/check-api/versions/f46e28134549/schema)