v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

Copy of Update a payroll item

Updates the specified payroll item.

patch/payroll_items

Request body

idstring required

Unique ID of the payroll item.

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

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

idstring

Unique identifier for the payroll item

payrollstring

The payroll ID associated with the payroll item

employeestring

The employee ID associated with the payroll item

statusstring

Status of the payroll item. One of draft, pending, processing, failed, partially_paid, or paid

void_ofstring nullable

The ID of the payroll item this payroll item is voiding. Only applicable to voided items

voided_bystring nullable

The ID of the payroll item this payroll item was voided by. Only applicable to voided items

payment_methodstring

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

supplemental_tax_calc_methodstring

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

net_paystring nullable

Read only. The total amount of net pay earned by the employee for this payroll item

net_pay_splitstring nullable

The net pay split ID associated with this payroll item

pto_balance_hoursnumber float nullable

The employee's remaining PTO hour balance, for display on the paystub

sick_balance_hoursnumber float nullable

The employee's remaining sick hour balance, for display on the paystub

state_covid_sick_balance_hoursnumber float nullable

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

benefitsobject[] nullable

Read only. An array of benefits objects associated with the payroll item

post_tax_deductionsobject[] nullable

Read only. An array of post_tax_deductions objects associated with the payroll item

warningsobject[] nullable

Read only. An array of warnings objects associated with the payroll item

paper_check_numberstring nullable

For accounting. The check number associated with any printed checks

paystub_infoobject nullable

Loosely structured information that will be returned on paystubs generated for this payroll item

metadataobject

Additional loosely structured information to associate with the payroll item