CHcheckhq

Update a payroll item

Updates the specified payroll item.

patch/payroll_items/{payroll_item}

Request

Path parameters

payroll_itemstring required

Request body

payrollstring

The payroll ID associated with the payroll item.

payment_methodstring

May be manual, or direct_deposit if the employee has a linked bank account.

pto_balance_hoursnumber 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_hoursnumber 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_hoursnumber float

The employee's remaining sick hour balance from state COVID relief bills, for display on the paystub

supplemental_tax_calc_methodstring

Controls the method used by Check to calculate tax on supplemental earnings. May be flat or aggregate

paper_check_numberstring

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.

paystub_infostring 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).

metadatastring json

Additional loosely structured information to associate with the payroll item

Response

200

Changes

No recorded changes to this operation across all 2 revisions of this API.