List Earnings History

curl --request GET \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/earnings-history \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/earnings-history"

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/gb/organizations/{organization_id}/employees/{employee_id}/earnings-history', 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}/employees/{employee_id}/earnings-history",
  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/gb/organizations/{organization_id}/employees/{employee_id}/earnings-history"

	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/gb/organizations/{organization_id}/employees/{employee_id}/earnings-history")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "items": [
    {
      "id": 123,
      "pay_date": "2023-12-25",
      "is_normal_pay_day": true,
      "frequency": "YEAR",
      "period_start": "2023-12-25",
      "period_end": "2023-12-25",
      "gross": "<string>",
      "taxable": "<string>",
      "niable": "<string>",
      "statutory_pay": "<string>",
      "source": "MIGRATED"
    }
  ],
  "pagination": {
    "limit": 123,
    "has_next": false,
    "has_prev": false,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "total": 0
  }
}

GET

organizations

{organization_id}

employees

{employee_id}

earnings-history

List Earnings History

curl --request GET \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/earnings-history \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/earnings-history"

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/gb/organizations/{organization_id}/employees/{employee_id}/earnings-history', 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}/employees/{employee_id}/earnings-history",
  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/gb/organizations/{organization_id}/employees/{employee_id}/earnings-history"

	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/gb/organizations/{organization_id}/employees/{employee_id}/earnings-history")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "items": [
    {
      "id": 123,
      "pay_date": "2023-12-25",
      "is_normal_pay_day": true,
      "frequency": "YEAR",
      "period_start": "2023-12-25",
      "period_end": "2023-12-25",
      "gross": "<string>",
      "taxable": "<string>",
      "niable": "<string>",
      "statutory_pay": "<string>",
      "source": "MIGRATED"
    }
  ],
  "pagination": {
    "limit": 123,
    "has_next": false,
    "has_prev": false,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "total": 0
  }
}

Authorizations

Authorization

string

header

required

Get token from Auth0 and paste it here

Path Parameters

organization_id

string

required

employee_id

string

required

Query Parameters

from_date

string<date>

required

Earliest pay date included

to_date

string<date>

required

Latest pay date included

limit

integer

default:10

Items per page

Required range: 1 <= x <= 100

cursor

string | null

next_cursor of the previous response, for the next page

prev_cursor

string | null

prev_cursor of the previous response, for the page before it. Not together with cursor.

sort

string[]

Fields to order by, - in front for descending (-created_at). Repeat the parameter for more fields. Keep the same sort while following cursors.

Response

Successful Response

items

EarningsHistoryRowSchema · object[]

required

Show child attributes

pagination

PaginationMeta · object

required

Show child attributes

Core

Great Britain

List Earnings History

Authorizations

Path Parameters

Query Parameters

Response