Create Employee

curl --request POST \
  --url https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "valid_from": "2023-12-25",
  "address": {
    "address": "10 Downing Street, London, SW1A 2AA"
  }
}
'

import requests

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

payload = {
    "valid_from": "2023-12-25",
    "address": { "address": "10 Downing Street, London, SW1A 2AA" }
}
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({
    valid_from: '2023-12-25',
    address: {address: '10 Downing Street, London, SW1A 2AA'}
  })
};

fetch('https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees', 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",
  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([
    'valid_from' => '2023-12-25',
    'address' => [
        'address' => '10 Downing Street, London, SW1A 2AA'
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"valid_from\": \"2023-12-25\",\n  \"address\": {\n    \"address\": \"10 Downing Street, London, SW1A 2AA\"\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}/employees")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"valid_from\": \"2023-12-25\",\n  \"address\": {\n    \"address\": \"10 Downing Street, London, SW1A 2AA\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"valid_from\": \"2023-12-25\",\n  \"address\": {\n    \"address\": \"10 Downing Street, London, SW1A 2AA\"\n  }\n}"

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

{
  "id": "<string>",
  "external_ref": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z",
  "organization_id": "<string>",
  "status": {},
  "core": {
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "employee_name": "<string>",
    "gender": "M",
    "marital_status": "Single",
    "birth_date": "2023-12-25",
    "personal_email": "jsmith@example.com",
    "work_email": "jsmith@example.com",
    "phone_numbers": [
      {
        "phone_number": "<string>",
        "phone_type": "mobile",
        "is_primary": false
      }
    ]
  },
  "address": {
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "address": "<string>"
  },
  "job": {
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "start_date": "2023-12-25",
    "contracted_weekly_hours": 40,
    "department": "<string>",
    "contracted_weekdays": [
      "Monday"
    ],
    "worker_type": "EMPLOYEE",
    "director_since": "2023-12-25",
    "pay_basis": "SALARIED",
    "apprenticeship": {
      "start_date": "2023-12-25",
      "level": 4,
      "expected_end_date": "2023-12-25"
    },
    "p45_issued": false,
    "irregular_payment_pattern": false,
    "ordinarily_works_in_uk": true,
    "proration_basis": {
      "mode": "CALENDAR_DAY",
      "business_days_per_year": "<string>"
    },
    "end_date": "2023-12-25"
  },
  "tax": {
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "rti_id": "<string>",
    "tax_code": "<string>",
    "student_loan_type": "Plan1",
    "postgraduate_loan": false,
    "p45_gross_pay": "0.00",
    "p45_tax_amount": "0.00"
  },
  "insurance": {
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "national_insurance_number": "<string>",
    "nic_category": "A"
  },
  "compensation": {
    "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>"
      }
    ]
  },
  "bank": {
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "accounts": [
      {
        "account_number": "<string>",
        "sort_code": "<string>",
        "financial_institution_name": "Lloyds Bank",
        "is_primary": false,
        "is_active": true,
        "allocation_percentage": "<string>"
      }
    ]
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

organizations

{organization_id}

employees

Create Employee

curl --request POST \
  --url https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "valid_from": "2023-12-25",
  "address": {
    "address": "10 Downing Street, London, SW1A 2AA"
  }
}
'

import requests

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

payload = {
    "valid_from": "2023-12-25",
    "address": { "address": "10 Downing Street, London, SW1A 2AA" }
}
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({
    valid_from: '2023-12-25',
    address: {address: '10 Downing Street, London, SW1A 2AA'}
  })
};

fetch('https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees', 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",
  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([
    'valid_from' => '2023-12-25',
    'address' => [
        'address' => '10 Downing Street, London, SW1A 2AA'
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"valid_from\": \"2023-12-25\",\n  \"address\": {\n    \"address\": \"10 Downing Street, London, SW1A 2AA\"\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}/employees")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"valid_from\": \"2023-12-25\",\n  \"address\": {\n    \"address\": \"10 Downing Street, London, SW1A 2AA\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"valid_from\": \"2023-12-25\",\n  \"address\": {\n    \"address\": \"10 Downing Street, London, SW1A 2AA\"\n  }\n}"

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

{
  "id": "<string>",
  "external_ref": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z",
  "organization_id": "<string>",
  "status": {},
  "core": {
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "employee_name": "<string>",
    "gender": "M",
    "marital_status": "Single",
    "birth_date": "2023-12-25",
    "personal_email": "jsmith@example.com",
    "work_email": "jsmith@example.com",
    "phone_numbers": [
      {
        "phone_number": "<string>",
        "phone_type": "mobile",
        "is_primary": false
      }
    ]
  },
  "address": {
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "address": "<string>"
  },
  "job": {
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "start_date": "2023-12-25",
    "contracted_weekly_hours": 40,
    "department": "<string>",
    "contracted_weekdays": [
      "Monday"
    ],
    "worker_type": "EMPLOYEE",
    "director_since": "2023-12-25",
    "pay_basis": "SALARIED",
    "apprenticeship": {
      "start_date": "2023-12-25",
      "level": 4,
      "expected_end_date": "2023-12-25"
    },
    "p45_issued": false,
    "irregular_payment_pattern": false,
    "ordinarily_works_in_uk": true,
    "proration_basis": {
      "mode": "CALENDAR_DAY",
      "business_days_per_year": "<string>"
    },
    "end_date": "2023-12-25"
  },
  "tax": {
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "rti_id": "<string>",
    "tax_code": "<string>",
    "student_loan_type": "Plan1",
    "postgraduate_loan": false,
    "p45_gross_pay": "0.00",
    "p45_tax_amount": "0.00"
  },
  "insurance": {
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "national_insurance_number": "<string>",
    "nic_category": "A"
  },
  "compensation": {
    "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>"
      }
    ]
  },
  "bank": {
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "accounts": [
      {
        "account_number": "<string>",
        "sort_code": "<string>",
        "financial_institution_name": "Lloyds Bank",
        "is_primary": false,
        "is_active": true,
        "allocation_percentage": "<string>"
      }
    ]
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Get token from Auth0 and paste it here

Headers

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

Body

application/json

Creating an employee: the hub, valid_from, and the satellites sent. Each satellite starts on [valid_from, 9999-12-31); one not sent starts at its schema defaults.

valid_from

string<date>

required

The date every satellite starts on

external_ref

string

The integrator's own stable key, unique within the organization. Generated when absent.

Required string length: 1 - 255

core

GBEmployeeCore · object | null

Identity of the person, as payroll and filing need it.

Show child attributes

address

GBEmployeeAddress · object | null

The person's residence address, as filed to HMRC.

Show child attributes

job

GBEmployeeJob · object | null

The terms of the employment as a client writes them.

Show child attributes

tax

GBEmployeeTax · object | null

Show child attributes

insurance

GBEmployeeInsurance · object | null

Show child attributes

compensation

GBEmployeeCompensation · object | null

Standing pay elements and the pay group they are paid in (PDR-0007, PDR-0012).

Show child attributes

bank

GBEmployeeBank · object | null

Show child attributes

Response

Successful Response

The employee with every satellite as it reads on one date. A satellite with no slice on an explicit date is absent.

string

required

external_ref

string | null

required

created_at

string<date-time>

required

read-only

created_by

string

required

read-only

Who created the hub: 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.

deleted_at

string<date-time> | null

required

When the hub was closed

organization_id

string

required

status

GBEmployeeStatus · object

required

The read-only status satellite. It carries no fields; it exists so that every employee read has a status object.

core

GBEmployeeCoreSatellite · object | null

Show child attributes

address

GBEmployeeAddressSatellite · object | null

Show child attributes

job

GBEmployeeJobSatellite · object | null

Show child attributes

tax

GBEmployeeTaxSatellite · object | null

Show child attributes

insurance

GBEmployeeInsuranceSatellite · object | null

Show child attributes

compensation

GBEmployeeCompensationSatellite · object | null

Show child attributes

bank

GBEmployeeBankSatellite · object | null

Show child attributes