Update a payroll item

patch https://sandbox.checkhq.com/payroll_items/{payroll_item}

Updates the specified payroll item.

Path Params

payroll_item

string

required

Body Params

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. direct_deposit if the employee has a linked Plaid account.

earnings

array of objects

The set of earnings objects associated with the payroll item.

earnings

reimbursements

array of objects

The set of non-taxable reimbursements objects associated with the payroll item.

reimbursements

benefit_overrides

array of objects

The set of benefit override objects associated with this payroll item.

benefit_overrides

post_tax_deduction_overrides

array of objects

The set of benefit override objects associated with this payroll item.

post_tax_deduction_overrides

pto_balance_hours

float

Defaults to null

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

float

Defaults to null

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

float

Defaults to null

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 for more details.

paystub_info

json

Loosely structured information that will be returned on paystubs generated for this payroll item. Limited to 7 keys, and 200 total characters (combined length of keys and values).

metadata

json

Additional loosely structured information to associate with the payroll item

Response

xxxxxxxxxx
curl --request PATCH \
     --url https://sandbox.checkhq.com/payroll_items/payroll_item \
     --header 'Authorization: Bearer YOUR_API_KEY' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "pto_balance_hours": null,
  "sick_balance_hours": null,
  "state_covid_sick_balance_hours": null
}
'

200200