Sign in

v1

latestOpenAPI 3.1.02026-07-22733584.5 KB
Payroll

Update employer payroll settings

NOT available to API keys — requires an interactive admin/approver session. Updates employer-level payroll rates — pension, side costs, holiday accrual — all in basis points, effective from a given date.

patch/payroll/settings

Request body

customer_idstring

Target company. Optional for API keys.

periodstring

Payroll period, YYYY-MM.

effective_fromstring

Effective-from date, YYYY-MM-DD.

employer_pension_basis_pointsinteger

Employer pension (TyEL) rate in basis points.

employer_side_cost_basis_pointsinteger

Employer side-cost rate in basis points.

holiday_accrual_basis_pointsinteger

Holiday pay accrual rate in basis points.

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.