Skip to main content
Welcome to the Intermezzo API documentation. Intermezzo runs payroll from gross to net and files the results with each country’s tax authority, so you don’t have to. You use one API for every country you pay in, and Intermezzo applies each country’s rules for you. In the UK, for example, that means PAYE tax, National Insurance, student loans and pensions, with Real Time Information (RTI) submissions sent to HMRC on the employer’s behalf. You send employee data and pay through the API. Intermezzo keeps the history of every change, so a payroll for a past period always uses the data that applied then.

Getting started

First, Intermezzo gives you OAuth 2.0 client credentials (client ID and client secret) for the preview environment. You use them to get an access token; see Authentication. From there, setup takes four steps:
1

You create the organization

Create the organization: the employer, with its tax registration and the login it files with.
2

Intermezzo sets up pay and pension

For now, Intermezzo sets up how the organization is paid and its workplace pension scheme, and gives you a pay_group_id to put on each employee.
3

You add wage types

Add wage types for pay elements the country’s catalog doesn’t cover.
4

You create employees

The guides for these steps cover the UK today.

What’s in these guides

These guides take you from your first call to an employer with employees, ready for payroll. Each page covers one task and links to the API reference for the details of every field. Many endpoints are being refactored, so for now the guides cover organizations, wage types and employees. Running payroll, payslips and filing with tax authorities aren’t covered here yet.

Conventions

The few rules every request follows.

Hubs, satellites and editions

How Intermezzo keeps the history of your data.

Set up an organization

Get your employer ready for payroll.

Create employees

Add your first employee, or load a whole payroll at once.

Change an employee

Keep employee details up to date, from any date.