v1
latestOpenAPI 3.1.02026-07-241642423.7 KBCopy of Update a payroll item
Updates the specified payroll item.
Request body
Unique ID of the payroll item.
The payroll ID associated with the payroll item.
May be manual, or direct_deposit if the employee has a linked bank account.
The employee's remaining PTO hour balance, for display on the paystub. Can be updated even after the associated payroll has been approved.
The employee's remaining sick hour balance, for display on the paystub. Can be updated even after the associated payroll has been approved.
The employee's remaining sick hour balance from state COVID relief bills, for display on the paystub
Controls the method used by Check to calculate tax on supplemental earnings. May be flat or aggregate
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 for more details.
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).
Additional loosely structured information to associate with the payroll item
Response
Returns a list of payroll items that were modified by the PATCH request
Unique identifier for the payroll item
The payroll ID associated with the payroll item
The employee ID associated with the payroll item
Status of the payroll item. One of draft, pending, processing, failed, partially_paid, or paid
The ID of the payroll item this payroll item is voiding. Only applicable to voided items
The ID of the payroll item this payroll item was voided by. Only applicable to voided items
May be manual or direct_deposit if the employee has a linked bank account
Controls the method used by Check to calculate tax on supplemental earnings. May be flat or aggregate
Read only. The total amount of net pay earned by the employee for this payroll item
The net pay split ID associated with this payroll item
The employee's remaining PTO hour balance, for display on the paystub
The employee's remaining sick hour balance, for display on the paystub
The employee's remaining sick hour balance from state COVID relief bills, for display on the paystub
Read only. An array of benefits objects associated with the payroll item
Read only. An array of post_tax_deductions objects associated with the payroll item
Read only. An array of warnings objects associated with the payroll item
For accounting. The check number associated with any printed checks
Loosely structured information that will be returned on paystubs generated for this payroll item
Additional loosely structured information to associate with the payroll item