Create a payroll item

Creates a payroll item.

Body Params
string
required

The payroll ID associated with the payroll item.

string
required

The employee ID associated with the payroll item.

string

May be manual or direct_deposit if the employee has a linked bank 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 post-tax deduction override objects associated with this payroll item.

post_tax_deduction_overrides
float

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

float

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

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

string

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

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.

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

json

Additional loosely structured information to associate with the payroll item.

Response

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here!