CHcheckhq

Gross up a payroll item

Changed on

Calculates the gross wage needed for the employee to receive the requested net_amount after taxes, then replaces the payroll item's earnings with that single earning and returns the updated payroll item.

The payroll item must belong to a draft off-cycle payroll with apply_benefits and apply_post_tax_deductions set to false. The request must contain exactly one bonus or commission earning. The calculation is synchronous: a 200 response means the gross has been calculated and saved, and the payroll's current preview has been invalidated. net_amount is not stored; the saved earning is an ordinary fixed-gross earning.

See the <a href="https://docs.checkhq.com/docs/gross-up-payments">Gross-up Payments</a> guide for the full workflow.

post/payroll_items/{payroll_item}/gross_up

Request

Path parameters

payroll_itemstring required

ID of the payroll item to gross up

Headers

X-Idempotency-Keystring

Recommended. Reuse the same key only when retrying this exact request after a timeout; a replay within 24 hours returns the original outcome instead of calculating again.

Request body

supplemental_tax_calc_methodstring

Controls the method used by Check to calculate tax on supplemental earnings. May be flat or aggregate. Omit to keep the item's saved value.

Response

200

Changes