Skip to main content
Every pay line, whether in an employee’s standing pay or in a payroll run, names a wage type by its wage_type_code. The wage type says how HMRC treats the amount: whether it is taxable, which National Insurance applies, whether it counts for pension and minimum wage, and where it appears on the payslip. Wage types come from two places:
  • The GB catalog. Intermezzo maintains it, and every organization can use it. Catalog codes start with UK-, for example UK-E-001 for basic salary. List them with List Catalog Wage Types (GET /gb/wage-types).
  • The organization’s own types, for pay elements the catalog doesn’t cover. Their codes must not start with UK-.
When a pay line names a code, Intermezzo looks for it among the organization’s own types first, then in the catalog.

Add an organization wage type

Create Wage Type takes the code and three satellites:
Request
Request body
The API reference lists every treatment field; fields you leave out take the default shown there. A new wage type starts as DRAFT. Payroll doesn’t use it yet, so you can check the type and correct it before any payroll pays it.

Check a computation

Before you write a computation, check it with Dry-Run Wage Type Computation. It validates the computation as a PUT on that date would, explains it, and runs it against sample inputs you send. Nothing is written. Explain Wage Type Computation describes the computation that applies on a date in words.

Approve, deprecate and close

A wage type moves through these states. Each change is recorded in its read-only lifecycle satellite, from a valid_from date.
Request
Request body
Deprecate a type when the employer stops paying that element from a date: earlier payrolls keep it, later ones can’t use it. Close a type only when the record is finished: after you deprecated it, and once no other type’s computation reads it. If-Match carries the edition of the lifecycle edition that valid_from falls in, read from Get Lifecycle. Once a type is approved, payrolls may already have paid it, so:
  • Its category can’t change.
  • A deprecation is refused while a live employee’s standing pay still uses the code on or after valid_from. Move those lines to another code first.
  • A close is refused while another open wage type’s computation reads the code.