PATCH
/
gb
/
organizations
/
{organization_id}
/
pension
/
schemes
/
{scheme_id}
Update pension scheme
curl --request PATCH \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/pension/schemes/{scheme_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "valid_from": "2023-12-25"
}
'
import requests

url = "https://dev.intermezzo.ai/gb/organizations/{organization_id}/pension/schemes/{scheme_id}"

payload = { "valid_from": "2023-12-25" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({valid_from: '2023-12-25'})
};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/pension/schemes/{scheme_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://dev.intermezzo.ai/gb/organizations/{organization_id}/pension/schemes/{scheme_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'valid_from' => '2023-12-25'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://dev.intermezzo.ai/gb/organizations/{organization_id}/pension/schemes/{scheme_id}"

payload := strings.NewReader("{\n \"valid_from\": \"2023-12-25\"\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://dev.intermezzo.ai/gb/organizations/{organization_id}/pension/schemes/{scheme_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"valid_from\": \"2023-12-25\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://dev.intermezzo.ai/gb/organizations/{organization_id}/pension/schemes/{scheme_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"valid_from\": \"2023-12-25\"\n}"

response = http.request(request)
puts response.read_body
{
  "valid_from": "2023-12-25",
  "scheme_id": "<string>",
  "is_default": true,
  "scheme_name": "<string>",
  "employee_rate": "<string>",
  "employer_rate": "<string>",
  "employee_cap": "<string>",
  "employer_cap": "<string>",
  "postponement_period_months": 123,
  "entitled_worker_employer_contributes": true,
  "re_enrolment_date": "2023-12-25",
  "re_enrolment_window_start": "2023-12-25",
  "re_enrolment_window_end": "2023-12-25",
  "wage_type_code": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "valid_to": "2023-12-25",
  "created_by": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
required
scheme_id
required

Body

application/json

Create a new version of the pension scheme configuration effective from valid_from.

Only include fields that should change — unset fields are inherited from the current version. valid_from is required and must be strictly later than the current version's valid_from.

valid_from
string<date>
required

Date from which the updated configuration takes effect; must be later than the current version's valid_from

scheme_name
string | null

Display name for the scheme; null = no change

provider
enum<string> | null

Pension provider (NEST, OTHER); null = no change

Available options:
NEST,
OTHER
tax_treatment
enum<string> | null

Tax treatment method; null = no change. If changed, wage_type_code must also be updated to a compatible type

Available options:
NET_PAY,
RELIEF_AT_SOURCE,
SALARY_SACRIFICE
pensionable_earnings_definition
enum<string> | null

Which earnings count as pensionable; null = no change

Available options:
QUALIFYING_EARNINGS,
PENSIONABLE_PAY
employee_rate

Employee contribution rate (minimum 0.05 = 5%); null = no change

Required range: 0.05 <= x <= 1
employer_rate

Employer contribution rate (minimum 0.03 = 3%); null = no change

Required range: 0.03 <= x <= 1
employee_cap

Maximum employee contribution per period (absolute amount); null = no change

employer_cap

Maximum employer contribution per period (absolute amount); null = no change

postponement_period_months
integer | null

Months to postpone auto-enrolment for new eligible jobholders (0–3); null = no change

Required range: 0 <= x <= 3
entitled_worker_employer_contributes
boolean | null

Whether employer voluntarily contributes for Entitled Workers who join; null = no change

re_enrolment_date
string<date> | null

Employer's chosen cyclical re-enrolment date (every ~3 years); null = no change

re_enrolment_window_start
string<date> | null

Earliest permissible re-enrolment date (3 months before anniversary); null = no change

re_enrolment_window_end
string<date> | null

Latest permissible re-enrolment date (3 months after anniversary); null = no change

wage_type_code
string | null

Wage type code for pension deduction line items; null = no change. Required when tax_treatment is changed

Response

Successful Response

Organisation's pension scheme configuration.

scheme_id is the stable handle identifier — use it in {scheme_id} path segments and in membership scheme_id fields. valid_from/valid_to describe the validity window of this particular configuration version.

valid_from
string<date>
required

Date from which this configuration version is effective

scheme_id
string
required

Stable handle UUID for the scheme; does not change when configuration is updated via PATCH. Use this in URL path segments and membership scheme_id fields

is_default
boolean
required

Whether this is the organisation's default scheme; only one scheme per org can be default. New eligible employees are auto-enrolled into the default scheme

scheme_name
string
required

Display name for the scheme

provider
enum<string>
required

Pension provider (NEST = National Employment Savings Trust, OTHER = any other provider)

Available options:
NEST,
OTHER
tax_treatment
enum<string>
required

Tax treatment method: NET_PAY (deducted pre-tax), RELIEF_AT_SOURCE (deducted post-tax, provider claims tax relief from HMRC), SALARY_SACRIFICE (employee gives up salary; saves NIC for both parties)

Available options:
NET_PAY,
RELIEF_AT_SOURCE,
SALARY_SACRIFICE
pensionable_earnings_definition
enum<string>
required

Earnings base for contribution calculation: QUALIFYING_EARNINGS (band £6,240–£50,270/year, 2025-26), PENSIONABLE_PAY (full pay, no lower threshold)

Available options:
QUALIFYING_EARNINGS,
PENSIONABLE_PAY
employee_rate
string
required

Employee contribution rate as a decimal (e.g. 0.05 = 5%); statutory minimum is 5% on qualifying earnings

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
employer_rate
string
required

Employer contribution rate as a decimal (e.g. 0.03 = 3%); statutory minimum is 3% on qualifying earnings

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
employee_cap
string | null
required

Maximum employee contribution per pay period as an absolute amount; null = no cap

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
employer_cap
string | null
required

Maximum employer contribution per pay period as an absolute amount; null = no cap

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
postponement_period_months
integer
required

Months to postpone auto-enrolment for newly eligible jobholders (0 = enrol immediately, max 3)

entitled_worker_employer_contributes
boolean
required

Whether the employer voluntarily contributes for Entitled Workers (earnings below £6,240/year) who choose to join the scheme

re_enrolment_date
string<date> | null
required

Employer's chosen cyclical re-enrolment date (every ~3 years); opted-out employees are re-enrolled on this date

re_enrolment_window_start
string<date> | null
required

Earliest permissible re-enrolment date (3 months before the staging anniversary)

re_enrolment_window_end
string<date> | null
required

Latest permissible re-enrolment date (3 months after the staging anniversary)

wage_type_code
string
required

Wage type code used for the pension deduction line item on payslip; must be PENSION category. NET_PAY/RAS use UK-P-001 or UK-P-002; SALARY_SACRIFICE requires UK-P-003

created_at
string<date-time>
required

Timestamp when this configuration version was created

valid_to
string<date> | null

Date on which this version expires (exclusive); null means this is the current active version. Populated automatically when a newer version is created via PATCH

created_by
string | null

User identifier (from JWT sub) who created this version; null if created by the system