GET
/
organizations
/
{organization_id}
/
employees
/
{employee_id}
/
compensation-details
Get Employee Compensation Details
curl --request GET \
  --url https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/compensation-details \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/compensation-details"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/compensation-details', 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/organizations/{organization_id}/employees/{employee_id}/compensation-details",
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://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/compensation-details"

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://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/compensation-details")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://dev.intermezzo.ai/organizations/{organization_id}/employees/{employee_id}/compensation-details")

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
{
  "employee_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "employment_country": "GB",
  "earnings": [
    {
      "wage_type_code": "<string>",
      "amount": "<string>",
      "earning_type": "AMOUNT",
      "earning_frequency": "MONTH",
      "is_lumpsum": false,
      "sacrificed_amount": "<string>"
    }
  ],
  "benefits": [
    {
      "wage_type_code": "<string>",
      "amount": "0.00",
      "make_good_amount": "0.00",
      "foregone_amount": "0.00",
      "cash_alternative_amount": "0.00"
    }
  ],
  "deductions": [
    {
      "name": "<string>",
      "amount": "<string>",
      "wage_type_code": "<string>",
      "sacrificed_amount": "<string>"
    }
  ],
  "reimbursements": [
    {
      "wage_type_code": "<string>",
      "amount": "<string>"
    }
  ],
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25"
}
{
"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
employee_id
required

Response

Successful Response

Response model for GB compensation details.

employee_id
string
required
created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required
id
required
employment_country
string
default:GB
Allowed value: "GB"
earnings
AmountEarnings · object[] | null
benefits
Benefits · object[] | null
deductions
Deductions · object[] | null
reimbursements
Reimbursement · object[] | null
valid_from
string<date>

Effective date

valid_to
string<date> | null

End date (None = current)