v1

latestOpenAPI 3.1.02026-07-22733584.5 KB

Payroll

Update an employee

NOT available to API keys — requires an interactive admin/approver session. Partially updates an employee identified by employee_id or employee_key. Same units as creation: integer cents and basis points.

patch/payroll/employees

Request body

customer_idstring

Target company. Optional for API keys.

periodstring

Payroll period, YYYY-MM.

employee_idstring

employee_keystring

namestring

tax_identifierstring

Finnish personal identity code (henkilötunnus).

ibanstring

bicstring

start_datestring

Employment start, YYYY-MM-DD.

end_datestring

Employment end, YYYY-MM-DD.

contract_idstring

employment_typestring

monthly_salary_centsinteger

Monthly salary in integer cents.

hourly_rate_centsinteger

Hourly rate in integer cents.

weekly_hoursnumber

withholding_basis_pointsinteger

Base withholding rate in basis points.

pension_basis_pointsinteger

Employee pension 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

Tax card effective-from date, YYYY-MM-DD.

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.