v1

latestOpenAPI 3.1.02026-07-22733584.5 KB

Payroll

Update an employee's tax card

NOT available to API keys — requires an interactive admin/approver session. Updates the withholding tax-card values for one employee: base and additional withholding rates in basis points, income ceiling in integer cents, effective-from date, and prior year-to-date gross in cents.

patch/payroll/employees/tax-card

Request body

customer_idstring

Target company. Optional for API keys.

periodstring

Payroll period, YYYY-MM.

employee_idstring required

contract_idstring

withholding_basis_pointsinteger

Base withholding rate in basis points.

tax_card_additional_basis_pointsinteger

Additional withholding rate in basis points.

tax_card_income_ceiling_centsinteger

Tax-card income ceiling in integer cents.

tax_card_effective_fromstring

Effective-from date, YYYY-MM-DD.

tax_card_prior_ytd_gross_centsinteger

Prior year-to-date gross earnings in integer cents.

Response

Updated payroll workspace.

PayrollWorkspaceData required

The payroll workspace for a period: employees, employer settings, and runs. Amounts are integer cents; rates are basis points. Interior shapes beyond the top level vary and are returned as-is.