Get Compensation
curl --request GET \
--url https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation \
--header 'Authorization: Bearer <token>'import requests
url = "https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation")
.header("Authorization", "Bearer <token>")
.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::Get.new(url)
request["Authorization"] = 'Bearer <token>'
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>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Compensation
Get Compensation
ETag is the edition read: send it as If-Match on the next PUT.
GET
/
gb
/
organizations
/
{organization_id}
/
employees
/
{employee_id}
/
compensation
Get Compensation
curl --request GET \
--url https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation \
--header 'Authorization: Bearer <token>'import requests
url = "https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/compensation")
.header("Authorization", "Bearer <token>")
.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::Get.new(url)
request["Authorization"] = 'Bearer <token>'
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>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Get token from Auth0 and paste it here
Query Parameters
Valid-time date to read, past or future. Defaults to today, or to the first upcoming edition when nothing is valid yet.
Response
Successful Response
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.
The pay group the employee is paid in
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?