Skip to main content
PATCH
Update an employee's tax card

Authorizations

Authorization
string
header
required

Firebase ID token from an interactive portal session. Required for interactive operations (payroll, company settings, API-key management) and invoice decisions allowed by the member's review permissions.

Body

application/json
employee_id
string
required
customer_id
string

Target company. Optional for API keys.

period
string

Payroll period, YYYY-MM.

contract_id
string
withholding_basis_points
integer

Base withholding rate in basis points.

tax_card_additional_basis_points
integer

Additional withholding rate in basis points.

tax_card_income_ceiling_cents
integer

Tax-card income ceiling in integer cents.

tax_card_effective_from
string

Effective-from date, YYYY-MM-DD.

tax_card_prior_ytd_gross_cents
integer

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

Response

Updated payroll workspace.

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.