Skip to main content
PATCH
Update an employee

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 create/update input. Salary and rate fields are integer cents; withholding and pension rates are basis points (10000 = 100%). Identify an existing employee with employee_id or employee_key when updating.

customer_id
string

Target company. Optional for API keys.

period
string

Payroll period, YYYY-MM.

employee_id
string
employee_key
string
name
string
tax_identifier
string

Finnish personal identity code (henkilötunnus).

iban
string
bic
string
start_date
string

Employment start, YYYY-MM-DD.

end_date
string

Employment end, YYYY-MM-DD.

contract_id
string
employment_type
string
monthly_salary_cents
integer

Monthly salary in integer cents.

hourly_rate_cents
integer

Hourly rate in integer cents.

weekly_hours
number
withholding_basis_points
integer

Base withholding rate in basis points.

pension_basis_points
integer

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

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

expected_party
object

The exact canonical person (business.party resource, at the revision you were shown) this payroll employee is. Once linked, a reimbursement for that person with no explicit reimbursement account of its own is paid at the account saved here, so the account is entered once. The reference is refused if its revision is stale, if the party is not an employee of this company, if it was merged into another record, or if it — or this employee — is already linked to a different counterpart. An update carrying only employee_id and expected_party links an existing employee without touching any employment term.

reuse_person_reimbursement_account
boolean

Save the linked person's existing reimbursement account as this employee's payment account instead of entering it again. Requires expected_party (or an already linked employee) and must not be sent together with iban. Refused when that person has no saved reimbursement account, or when this employee already has a different salary account.

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 documented payment evidence fields vary and are returned as-is.

known_people
object[]

The employee parties this company already reimburses, offered to the employee form so a new or existing payroll employee can be bound to the person they already are. Each entry carries the exact business.party reference — revision included — to send back as expected_party; a picker that showed one person cannot commit a link to whoever that id names by the time it is saved. Only the last four digits of a saved reimbursement account travel with this read, and only under the admin/approver payroll role this whole workspace already requires.

run
object | null