Create Absence Scheme
curl --request POST \
--url https://preview.intermezzo.ai/gb/organizations/{organization_id}/absence-schemes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"valid_from": "2023-12-25",
"terms": {
"top_up_wage_type_code": "<string>",
"content_schema_version": 1,
"baseline": "CONTRACTUAL_WEEKLY",
"bands": [
{
"from_week": 26,
"to_week": 26,
"pay_level": {
"percent": 50,
"kind": "percent_of_baseline",
"statutory_floor": false
}
}
],
"service_bands": [
{
"min_service_months": 1,
"bands": [
{
"from_week": 26,
"to_week": 26,
"pay_level": {
"percent": 50,
"kind": "percent_of_baseline",
"statutory_floor": false
}
}
]
}
]
}
}
'import requests
url = "https://preview.intermezzo.ai/gb/organizations/{organization_id}/absence-schemes"
payload = {
"name": "<string>",
"valid_from": "2023-12-25",
"terms": {
"top_up_wage_type_code": "<string>",
"content_schema_version": 1,
"baseline": "CONTRACTUAL_WEEKLY",
"bands": [
{
"from_week": 26,
"to_week": 26,
"pay_level": {
"percent": 50,
"kind": "percent_of_baseline",
"statutory_floor": False
}
}
],
"service_bands": [
{
"min_service_months": 1,
"bands": [
{
"from_week": 26,
"to_week": 26,
"pay_level": {
"percent": 50,
"kind": "percent_of_baseline",
"statutory_floor": False
}
}
]
}
]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
valid_from: '2023-12-25',
terms: {
top_up_wage_type_code: '<string>',
content_schema_version: 1,
baseline: 'CONTRACTUAL_WEEKLY',
bands: [
{
from_week: 26,
to_week: 26,
pay_level: {percent: 50, kind: 'percent_of_baseline', statutory_floor: false}
}
],
service_bands: [
{
min_service_months: 1,
bands: [
{
from_week: 26,
to_week: 26,
pay_level: {percent: 50, kind: 'percent_of_baseline', statutory_floor: false}
}
]
}
]
}
})
};
fetch('https://preview.intermezzo.ai/gb/organizations/{organization_id}/absence-schemes', 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://preview.intermezzo.ai/gb/organizations/{organization_id}/absence-schemes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'valid_from' => '2023-12-25',
'terms' => [
'top_up_wage_type_code' => '<string>',
'content_schema_version' => 1,
'baseline' => 'CONTRACTUAL_WEEKLY',
'bands' => [
[
'from_week' => 26,
'to_week' => 26,
'pay_level' => [
'percent' => 50,
'kind' => 'percent_of_baseline',
'statutory_floor' => false
]
]
],
'service_bands' => [
[
'min_service_months' => 1,
'bands' => [
[
'from_week' => 26,
'to_week' => 26,
'pay_level' => [
'percent' => 50,
'kind' => 'percent_of_baseline',
'statutory_floor' => false
]
]
]
]
]
]
]),
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://preview.intermezzo.ai/gb/organizations/{organization_id}/absence-schemes"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"valid_from\": \"2023-12-25\",\n \"terms\": {\n \"top_up_wage_type_code\": \"<string>\",\n \"content_schema_version\": 1,\n \"baseline\": \"CONTRACTUAL_WEEKLY\",\n \"bands\": [\n {\n \"from_week\": 26,\n \"to_week\": 26,\n \"pay_level\": {\n \"percent\": 50,\n \"kind\": \"percent_of_baseline\",\n \"statutory_floor\": false\n }\n }\n ],\n \"service_bands\": [\n {\n \"min_service_months\": 1,\n \"bands\": [\n {\n \"from_week\": 26,\n \"to_week\": 26,\n \"pay_level\": {\n \"percent\": 50,\n \"kind\": \"percent_of_baseline\",\n \"statutory_floor\": false\n }\n }\n ]\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://preview.intermezzo.ai/gb/organizations/{organization_id}/absence-schemes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"valid_from\": \"2023-12-25\",\n \"terms\": {\n \"top_up_wage_type_code\": \"<string>\",\n \"content_schema_version\": 1,\n \"baseline\": \"CONTRACTUAL_WEEKLY\",\n \"bands\": [\n {\n \"from_week\": 26,\n \"to_week\": 26,\n \"pay_level\": {\n \"percent\": 50,\n \"kind\": \"percent_of_baseline\",\n \"statutory_floor\": false\n }\n }\n ],\n \"service_bands\": [\n {\n \"min_service_months\": 1,\n \"bands\": [\n {\n \"from_week\": 26,\n \"to_week\": 26,\n \"pay_level\": {\n \"percent\": 50,\n \"kind\": \"percent_of_baseline\",\n \"statutory_floor\": false\n }\n }\n ]\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://preview.intermezzo.ai/gb/organizations/{organization_id}/absence-schemes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"valid_from\": \"2023-12-25\",\n \"terms\": {\n \"top_up_wage_type_code\": \"<string>\",\n \"content_schema_version\": 1,\n \"baseline\": \"CONTRACTUAL_WEEKLY\",\n \"bands\": [\n {\n \"from_week\": 26,\n \"to_week\": 26,\n \"pay_level\": {\n \"percent\": 50,\n \"kind\": \"percent_of_baseline\",\n \"statutory_floor\": false\n }\n }\n ],\n \"service_bands\": [\n {\n \"min_service_months\": 1,\n \"bands\": [\n {\n \"from_week\": 26,\n \"to_week\": 26,\n \"pay_level\": {\n \"percent\": 50,\n \"kind\": \"percent_of_baseline\",\n \"statutory_floor\": false\n }\n }\n ]\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"scheme_id": "<string>",
"edition_id": 123,
"name": "<string>",
"valid_from": "2023-12-25",
"terms": {
"regime": "SMP",
"offset_mode": "INCLUSIVE",
"top_up_wage_type_code": "<string>",
"content_schema_version": 1,
"baseline": "CONTRACTUAL_WEEKLY",
"bands": [
{
"from_week": 26,
"to_week": 26,
"pay_level": {
"percent": "<string>",
"kind": "percent_of_baseline",
"statutory_floor": false
}
}
],
"service_bands": [
{
"min_service_months": 1,
"bands": [
{
"from_week": 26,
"to_week": 26,
"pay_level": {
"percent": "<string>",
"kind": "percent_of_baseline",
"statutory_floor": false
}
}
]
}
]
},
"created_at": "2023-11-07T05:31:56Z",
"effective_offset_mode": "INCLUSIVE",
"valid_to": "2023-12-25"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Absence Schemes
Create Absence Scheme
Create an occupational absence scheme with its first terms edition.
POST
/
gb
/
organizations
/
{organization_id}
/
absence-schemes
Create Absence Scheme
curl --request POST \
--url https://preview.intermezzo.ai/gb/organizations/{organization_id}/absence-schemes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"valid_from": "2023-12-25",
"terms": {
"top_up_wage_type_code": "<string>",
"content_schema_version": 1,
"baseline": "CONTRACTUAL_WEEKLY",
"bands": [
{
"from_week": 26,
"to_week": 26,
"pay_level": {
"percent": 50,
"kind": "percent_of_baseline",
"statutory_floor": false
}
}
],
"service_bands": [
{
"min_service_months": 1,
"bands": [
{
"from_week": 26,
"to_week": 26,
"pay_level": {
"percent": 50,
"kind": "percent_of_baseline",
"statutory_floor": false
}
}
]
}
]
}
}
'import requests
url = "https://preview.intermezzo.ai/gb/organizations/{organization_id}/absence-schemes"
payload = {
"name": "<string>",
"valid_from": "2023-12-25",
"terms": {
"top_up_wage_type_code": "<string>",
"content_schema_version": 1,
"baseline": "CONTRACTUAL_WEEKLY",
"bands": [
{
"from_week": 26,
"to_week": 26,
"pay_level": {
"percent": 50,
"kind": "percent_of_baseline",
"statutory_floor": False
}
}
],
"service_bands": [
{
"min_service_months": 1,
"bands": [
{
"from_week": 26,
"to_week": 26,
"pay_level": {
"percent": 50,
"kind": "percent_of_baseline",
"statutory_floor": False
}
}
]
}
]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
valid_from: '2023-12-25',
terms: {
top_up_wage_type_code: '<string>',
content_schema_version: 1,
baseline: 'CONTRACTUAL_WEEKLY',
bands: [
{
from_week: 26,
to_week: 26,
pay_level: {percent: 50, kind: 'percent_of_baseline', statutory_floor: false}
}
],
service_bands: [
{
min_service_months: 1,
bands: [
{
from_week: 26,
to_week: 26,
pay_level: {percent: 50, kind: 'percent_of_baseline', statutory_floor: false}
}
]
}
]
}
})
};
fetch('https://preview.intermezzo.ai/gb/organizations/{organization_id}/absence-schemes', 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://preview.intermezzo.ai/gb/organizations/{organization_id}/absence-schemes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'valid_from' => '2023-12-25',
'terms' => [
'top_up_wage_type_code' => '<string>',
'content_schema_version' => 1,
'baseline' => 'CONTRACTUAL_WEEKLY',
'bands' => [
[
'from_week' => 26,
'to_week' => 26,
'pay_level' => [
'percent' => 50,
'kind' => 'percent_of_baseline',
'statutory_floor' => false
]
]
],
'service_bands' => [
[
'min_service_months' => 1,
'bands' => [
[
'from_week' => 26,
'to_week' => 26,
'pay_level' => [
'percent' => 50,
'kind' => 'percent_of_baseline',
'statutory_floor' => false
]
]
]
]
]
]
]),
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://preview.intermezzo.ai/gb/organizations/{organization_id}/absence-schemes"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"valid_from\": \"2023-12-25\",\n \"terms\": {\n \"top_up_wage_type_code\": \"<string>\",\n \"content_schema_version\": 1,\n \"baseline\": \"CONTRACTUAL_WEEKLY\",\n \"bands\": [\n {\n \"from_week\": 26,\n \"to_week\": 26,\n \"pay_level\": {\n \"percent\": 50,\n \"kind\": \"percent_of_baseline\",\n \"statutory_floor\": false\n }\n }\n ],\n \"service_bands\": [\n {\n \"min_service_months\": 1,\n \"bands\": [\n {\n \"from_week\": 26,\n \"to_week\": 26,\n \"pay_level\": {\n \"percent\": 50,\n \"kind\": \"percent_of_baseline\",\n \"statutory_floor\": false\n }\n }\n ]\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://preview.intermezzo.ai/gb/organizations/{organization_id}/absence-schemes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"valid_from\": \"2023-12-25\",\n \"terms\": {\n \"top_up_wage_type_code\": \"<string>\",\n \"content_schema_version\": 1,\n \"baseline\": \"CONTRACTUAL_WEEKLY\",\n \"bands\": [\n {\n \"from_week\": 26,\n \"to_week\": 26,\n \"pay_level\": {\n \"percent\": 50,\n \"kind\": \"percent_of_baseline\",\n \"statutory_floor\": false\n }\n }\n ],\n \"service_bands\": [\n {\n \"min_service_months\": 1,\n \"bands\": [\n {\n \"from_week\": 26,\n \"to_week\": 26,\n \"pay_level\": {\n \"percent\": 50,\n \"kind\": \"percent_of_baseline\",\n \"statutory_floor\": false\n }\n }\n ]\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://preview.intermezzo.ai/gb/organizations/{organization_id}/absence-schemes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"valid_from\": \"2023-12-25\",\n \"terms\": {\n \"top_up_wage_type_code\": \"<string>\",\n \"content_schema_version\": 1,\n \"baseline\": \"CONTRACTUAL_WEEKLY\",\n \"bands\": [\n {\n \"from_week\": 26,\n \"to_week\": 26,\n \"pay_level\": {\n \"percent\": 50,\n \"kind\": \"percent_of_baseline\",\n \"statutory_floor\": false\n }\n }\n ],\n \"service_bands\": [\n {\n \"min_service_months\": 1,\n \"bands\": [\n {\n \"from_week\": 26,\n \"to_week\": 26,\n \"pay_level\": {\n \"percent\": 50,\n \"kind\": \"percent_of_baseline\",\n \"statutory_floor\": false\n }\n }\n ]\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"scheme_id": "<string>",
"edition_id": 123,
"name": "<string>",
"valid_from": "2023-12-25",
"terms": {
"regime": "SMP",
"offset_mode": "INCLUSIVE",
"top_up_wage_type_code": "<string>",
"content_schema_version": 1,
"baseline": "CONTRACTUAL_WEEKLY",
"bands": [
{
"from_week": 26,
"to_week": 26,
"pay_level": {
"percent": "<string>",
"kind": "percent_of_baseline",
"statutory_floor": false
}
}
],
"service_bands": [
{
"min_service_months": 1,
"bands": [
{
"from_week": 26,
"to_week": 26,
"pay_level": {
"percent": "<string>",
"kind": "percent_of_baseline",
"statutory_floor": false
}
}
]
}
]
},
"created_at": "2023-11-07T05:31:56Z",
"effective_offset_mode": "INCLUSIVE",
"valid_to": "2023-12-25"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Get token from Auth0 and paste it here
Path Parameters
Body
application/json
Create a scheme, or append a new edition of its terms effective from
valid_from.
Required string length:
1 - 255Date these terms apply from
The occupational scheme terms: which statutory regime the scheme tops up, how the top-up composes with statutory pay, what it is measured against, and the week bands that set the occupational pay level.
Show child attributes
Show child attributes
Response
Successful Response
One edition of a scheme's terms. valid_to is null while the edition
is open-ended.
The occupational scheme terms: which statutory regime the scheme tops up, how the top-up composes with statutory pay, what it is measured against, and the week bands that set the occupational pay level.
Show child attributes
Show child attributes
How the occupational top-up actually composes with the statutory line for these terms
Available options:
INCLUSIVE, ADDITIVE, SUBSTITUTIVE Was this page helpful?