v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

Create a payroll item

Creates a payroll item.

post/payroll_items

Request body

payrollstring required

The payroll ID associated with the payroll item.

employeestring required

The employee 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

sick_balance_hoursnumber float

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

state_covid_sick_balance_hoursnumber float

The employee's remaining sick hour balance from state COVID relief bills, for display on the paystub. This field is currently only applicable to California employers as per SB-95. When the requirement expires, this field will be removed in a future API version

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

201