Create Compensation Edition

curl --request PUT \
  --url https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25"
}
'

import requests

url = "https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation"

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

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

print(response.text)

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

fetch('https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation', 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}/employees/{employee_id}/compensation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'valid_from' => '2023-12-25',
    'valid_to' => '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://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation"

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

	req, _ := http.NewRequest("PUT", 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.put("https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation")

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

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

response = http.request(request)
puts response.read_body

{
  "edition": 123,
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "pay_group_id": "<string>",
  "earnings": [
    {
      "wage_type_code": "<string>",
      "amount": "<string>",
      "external_ref": "<string>",
      "earning_type": "AMOUNT",
      "earning_frequency": "MONTH",
      "is_lumpsum": false,
      "sacrificed_amount": "<string>"
    }
  ],
  "benefits": [
    {
      "wage_type_code": "<string>",
      "external_ref": "<string>",
      "amount": "0.00",
      "make_good_amount": "0.00",
      "foregone_amount": "0.00",
      "cash_alternative_amount": "0.00"
    }
  ],
  "deductions": [
    {
      "wage_type_code": "<string>",
      "amount": "<string>",
      "external_ref": "<string>",
      "sacrificed_amount": "<string>"
    }
  ],
  "reimbursements": [
    {
      "wage_type_code": "<string>",
      "amount": "<string>",
      "external_ref": "<string>"
    }
  ]
}

PUT

organizations

{organization_id}

employees

{employee_id}

compensation

Create Compensation Edition

curl --request PUT \
  --url https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25"
}
'

import requests

url = "https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation"

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

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

print(response.text)

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

fetch('https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation', 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}/employees/{employee_id}/compensation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'valid_from' => '2023-12-25',
    'valid_to' => '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://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation"

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

	req, _ := http.NewRequest("PUT", 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.put("https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation")

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

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

response = http.request(request)
puts response.read_body

{
  "edition": 123,
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "pay_group_id": "<string>",
  "earnings": [
    {
      "wage_type_code": "<string>",
      "amount": "<string>",
      "external_ref": "<string>",
      "earning_type": "AMOUNT",
      "earning_frequency": "MONTH",
      "is_lumpsum": false,
      "sacrificed_amount": "<string>"
    }
  ],
  "benefits": [
    {
      "wage_type_code": "<string>",
      "external_ref": "<string>",
      "amount": "0.00",
      "make_good_amount": "0.00",
      "foregone_amount": "0.00",
      "cash_alternative_amount": "0.00"
    }
  ],
  "deductions": [
    {
      "wage_type_code": "<string>",
      "amount": "<string>",
      "external_ref": "<string>",
      "sacrificed_amount": "<string>"
    }
  ],
  "reimbursements": [
    {
      "wage_type_code": "<string>",
      "amount": "<string>",
      "external_ref": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Get token from Auth0 and paste it here

Headers

If-Match

string | null

X-Acting-User

string | null

The person acting through the access credential, recorded as created_by of what the request writes. Audit only: access is checked on the credential.

Required string length: 1 - 255

Path Parameters

organization_id

string

required

employee_id

string

required

Body

application/json

valid_from

string<date>

required

valid_to

string<date>

required

pay_group_id

string | null

The pay group the employee is paid in

earnings

AmountEarnings · object[] | null

Show child attributes

benefits

Benefits · object[] | null

Show child attributes

deductions

Deductions · object[] | null

Show child attributes

reimbursements

Reimbursement · object[] | null

Show child attributes

Response

Successful Response

edition

integer

required

read-only

valid_from

string<date>

required

valid_to

string<date>

required

created_at

string<date-time>

required

read-only

created_by

string

required

read-only

Who wrote the edition: the acting user (X-Acting-User, else the access credential), system for our own writes, or <authority>:<notice> for a write on an authority's behalf, e.g. hmrc:P6.

pay_group_id

string | null

The pay group the employee is paid in

earnings

AmountEarnings · object[] | null

Show child attributes

benefits

Benefits · object[] | null

Show child attributes

deductions

Deductions · object[] | null

Show child attributes

reimbursements

Reimbursement · object[] | null

Show child attributes

Core

Great Britain

Create Compensation Edition

Authorizations

Headers

Path Parameters

Body

Response