Create Job Edition

curl --request PUT \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/job \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_date": "2023-12-25",
  "contracted_weekly_hours": 40,
  "department": "<string>",
  "pay_group_id": "<string>",
  "contracted_weekdays": [],
  "director_since": "2023-12-25",
  "apprenticeship": {
    "start_date": "2023-12-25",
    "expected_end_date": "2023-12-25",
    "level": 4
  },
  "p45_issued": true,
  "irregular_payment_pattern": true,
  "ordinarily_works_in_uk": true,
  "uk_work_exclusion_reason": "NOT_APPLICABLE",
  "proration_basis": {
    "business_days_per_year": "260"
  },
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25"
}
'

import requests

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

payload = {
    "start_date": "2023-12-25",
    "contracted_weekly_hours": 40,
    "department": "<string>",
    "pay_group_id": "<string>",
    "contracted_weekdays": [],
    "director_since": "2023-12-25",
    "apprenticeship": {
        "start_date": "2023-12-25",
        "expected_end_date": "2023-12-25",
        "level": 4
    },
    "p45_issued": True,
    "irregular_payment_pattern": True,
    "ordinarily_works_in_uk": True,
    "uk_work_exclusion_reason": "NOT_APPLICABLE",
    "proration_basis": { "business_days_per_year": "260" },
    "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({
    start_date: '2023-12-25',
    contracted_weekly_hours: 40,
    department: '<string>',
    pay_group_id: '<string>',
    contracted_weekdays: [],
    director_since: '2023-12-25',
    apprenticeship: {start_date: '2023-12-25', expected_end_date: '2023-12-25', level: 4},
    p45_issued: true,
    irregular_payment_pattern: true,
    ordinarily_works_in_uk: true,
    uk_work_exclusion_reason: 'NOT_APPLICABLE',
    proration_basis: {business_days_per_year: '260'},
    valid_from: '2023-12-25',
    valid_to: '2023-12-25'
  })
};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/job', 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}/job",
  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([
    'start_date' => '2023-12-25',
    'contracted_weekly_hours' => 40,
    'department' => '<string>',
    'pay_group_id' => '<string>',
    'contracted_weekdays' => [
        
    ],
    'director_since' => '2023-12-25',
    'apprenticeship' => [
        'start_date' => '2023-12-25',
        'expected_end_date' => '2023-12-25',
        'level' => 4
    ],
    'p45_issued' => true,
    'irregular_payment_pattern' => true,
    'ordinarily_works_in_uk' => true,
    'uk_work_exclusion_reason' => 'NOT_APPLICABLE',
    'proration_basis' => [
        'business_days_per_year' => '260'
    ],
    '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://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/job"

	payload := strings.NewReader("{\n  \"start_date\": \"2023-12-25\",\n  \"contracted_weekly_hours\": 40,\n  \"department\": \"<string>\",\n  \"pay_group_id\": \"<string>\",\n  \"contracted_weekdays\": [],\n  \"director_since\": \"2023-12-25\",\n  \"apprenticeship\": {\n    \"start_date\": \"2023-12-25\",\n    \"expected_end_date\": \"2023-12-25\",\n    \"level\": 4\n  },\n  \"p45_issued\": true,\n  \"irregular_payment_pattern\": true,\n  \"ordinarily_works_in_uk\": true,\n  \"uk_work_exclusion_reason\": \"NOT_APPLICABLE\",\n  \"proration_basis\": {\n    \"business_days_per_year\": \"260\"\n  },\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://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/job")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"start_date\": \"2023-12-25\",\n  \"contracted_weekly_hours\": 40,\n  \"department\": \"<string>\",\n  \"pay_group_id\": \"<string>\",\n  \"contracted_weekdays\": [],\n  \"director_since\": \"2023-12-25\",\n  \"apprenticeship\": {\n    \"start_date\": \"2023-12-25\",\n    \"expected_end_date\": \"2023-12-25\",\n    \"level\": 4\n  },\n  \"p45_issued\": true,\n  \"irregular_payment_pattern\": true,\n  \"ordinarily_works_in_uk\": true,\n  \"uk_work_exclusion_reason\": \"NOT_APPLICABLE\",\n  \"proration_basis\": {\n    \"business_days_per_year\": \"260\"\n  },\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"start_date\": \"2023-12-25\",\n  \"contracted_weekly_hours\": 40,\n  \"department\": \"<string>\",\n  \"pay_group_id\": \"<string>\",\n  \"contracted_weekdays\": [],\n  \"director_since\": \"2023-12-25\",\n  \"apprenticeship\": {\n    \"start_date\": \"2023-12-25\",\n    \"expected_end_date\": \"2023-12-25\",\n    \"level\": 4\n  },\n  \"p45_issued\": true,\n  \"irregular_payment_pattern\": true,\n  \"ordinarily_works_in_uk\": true,\n  \"uk_work_exclusion_reason\": \"NOT_APPLICABLE\",\n  \"proration_basis\": {\n    \"business_days_per_year\": \"260\"\n  },\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>",
  "start_date": "2023-12-25",
  "contracted_weekly_hours": 40,
  "department": "<string>",
  "pay_group_id": "<string>",
  "contracted_weekdays": [
    "MONDAY"
  ],
  "worker_type": "EMPLOYEE",
  "director_since": "2023-12-25",
  "pay_basis": "SALARIED",
  "apprenticeship": {
    "start_date": "2023-12-25",
    "expected_end_date": "2023-12-25",
    "level": 4
  },
  "p45_issued": false,
  "irregular_payment_pattern": false,
  "ordinarily_works_in_uk": true,
  "uk_work_exclusion_reason": "NOT_APPLICABLE",
  "proration_basis": {
    "mode": "CALENDAR_DAY",
    "business_days_per_year": "<string>"
  },
  "end_date": "2023-12-25"
}

PUT

organizations

{organization_id}

employees

{employee_id}

job

Create Job Edition

curl --request PUT \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/job \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_date": "2023-12-25",
  "contracted_weekly_hours": 40,
  "department": "<string>",
  "pay_group_id": "<string>",
  "contracted_weekdays": [],
  "director_since": "2023-12-25",
  "apprenticeship": {
    "start_date": "2023-12-25",
    "expected_end_date": "2023-12-25",
    "level": 4
  },
  "p45_issued": true,
  "irregular_payment_pattern": true,
  "ordinarily_works_in_uk": true,
  "uk_work_exclusion_reason": "NOT_APPLICABLE",
  "proration_basis": {
    "business_days_per_year": "260"
  },
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25"
}
'

import requests

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

payload = {
    "start_date": "2023-12-25",
    "contracted_weekly_hours": 40,
    "department": "<string>",
    "pay_group_id": "<string>",
    "contracted_weekdays": [],
    "director_since": "2023-12-25",
    "apprenticeship": {
        "start_date": "2023-12-25",
        "expected_end_date": "2023-12-25",
        "level": 4
    },
    "p45_issued": True,
    "irregular_payment_pattern": True,
    "ordinarily_works_in_uk": True,
    "uk_work_exclusion_reason": "NOT_APPLICABLE",
    "proration_basis": { "business_days_per_year": "260" },
    "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({
    start_date: '2023-12-25',
    contracted_weekly_hours: 40,
    department: '<string>',
    pay_group_id: '<string>',
    contracted_weekdays: [],
    director_since: '2023-12-25',
    apprenticeship: {start_date: '2023-12-25', expected_end_date: '2023-12-25', level: 4},
    p45_issued: true,
    irregular_payment_pattern: true,
    ordinarily_works_in_uk: true,
    uk_work_exclusion_reason: 'NOT_APPLICABLE',
    proration_basis: {business_days_per_year: '260'},
    valid_from: '2023-12-25',
    valid_to: '2023-12-25'
  })
};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/job', 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}/job",
  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([
    'start_date' => '2023-12-25',
    'contracted_weekly_hours' => 40,
    'department' => '<string>',
    'pay_group_id' => '<string>',
    'contracted_weekdays' => [
        
    ],
    'director_since' => '2023-12-25',
    'apprenticeship' => [
        'start_date' => '2023-12-25',
        'expected_end_date' => '2023-12-25',
        'level' => 4
    ],
    'p45_issued' => true,
    'irregular_payment_pattern' => true,
    'ordinarily_works_in_uk' => true,
    'uk_work_exclusion_reason' => 'NOT_APPLICABLE',
    'proration_basis' => [
        'business_days_per_year' => '260'
    ],
    '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://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/job"

	payload := strings.NewReader("{\n  \"start_date\": \"2023-12-25\",\n  \"contracted_weekly_hours\": 40,\n  \"department\": \"<string>\",\n  \"pay_group_id\": \"<string>\",\n  \"contracted_weekdays\": [],\n  \"director_since\": \"2023-12-25\",\n  \"apprenticeship\": {\n    \"start_date\": \"2023-12-25\",\n    \"expected_end_date\": \"2023-12-25\",\n    \"level\": 4\n  },\n  \"p45_issued\": true,\n  \"irregular_payment_pattern\": true,\n  \"ordinarily_works_in_uk\": true,\n  \"uk_work_exclusion_reason\": \"NOT_APPLICABLE\",\n  \"proration_basis\": {\n    \"business_days_per_year\": \"260\"\n  },\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://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/job")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"start_date\": \"2023-12-25\",\n  \"contracted_weekly_hours\": 40,\n  \"department\": \"<string>\",\n  \"pay_group_id\": \"<string>\",\n  \"contracted_weekdays\": [],\n  \"director_since\": \"2023-12-25\",\n  \"apprenticeship\": {\n    \"start_date\": \"2023-12-25\",\n    \"expected_end_date\": \"2023-12-25\",\n    \"level\": 4\n  },\n  \"p45_issued\": true,\n  \"irregular_payment_pattern\": true,\n  \"ordinarily_works_in_uk\": true,\n  \"uk_work_exclusion_reason\": \"NOT_APPLICABLE\",\n  \"proration_basis\": {\n    \"business_days_per_year\": \"260\"\n  },\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"start_date\": \"2023-12-25\",\n  \"contracted_weekly_hours\": 40,\n  \"department\": \"<string>\",\n  \"pay_group_id\": \"<string>\",\n  \"contracted_weekdays\": [],\n  \"director_since\": \"2023-12-25\",\n  \"apprenticeship\": {\n    \"start_date\": \"2023-12-25\",\n    \"expected_end_date\": \"2023-12-25\",\n    \"level\": 4\n  },\n  \"p45_issued\": true,\n  \"irregular_payment_pattern\": true,\n  \"ordinarily_works_in_uk\": true,\n  \"uk_work_exclusion_reason\": \"NOT_APPLICABLE\",\n  \"proration_basis\": {\n    \"business_days_per_year\": \"260\"\n  },\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>",
  "start_date": "2023-12-25",
  "contracted_weekly_hours": 40,
  "department": "<string>",
  "pay_group_id": "<string>",
  "contracted_weekdays": [
    "MONDAY"
  ],
  "worker_type": "EMPLOYEE",
  "director_since": "2023-12-25",
  "pay_basis": "SALARIED",
  "apprenticeship": {
    "start_date": "2023-12-25",
    "expected_end_date": "2023-12-25",
    "level": 4
  },
  "p45_issued": false,
  "irregular_payment_pattern": false,
  "ordinarily_works_in_uk": true,
  "uk_work_exclusion_reason": "NOT_APPLICABLE",
  "proration_basis": {
    "mode": "CALENDAR_DAY",
    "business_days_per_year": "<string>"
  },
  "end_date": "2023-12-25"
}

Authorizations

Authorization

string

header

required

Get token from Auth0 and paste it here

Headers

If-Match

string | null

If-None-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

start_date

string<date>

required

Employment start date

contracted_weekly_hours

integer

required

Contracted weekly hours

Example:

40

department

string | null

required

Department, will be shown on the pension report; null when none

pay_group_id

string

required

The pay group the employee is paid in. Every job write names one: moving to another group is a job write naming it.

contracted_weekdays

enum<string>[]

required

Contracted working days of the week

Required array length: 1 - 7 elements

Days of the week.

Available options:

MONDAY,

TUESDAY,

WEDNESDAY,

THURSDAY,

FRIDAY,

SATURDAY,

SUNDAY

worker_type

enum<string>

required

UK employment status: employee or director

Available options:

EMPLOYEE,

DIRECTOR

director_since

string<date> | null

required

Date appointed as director; null when not a director

pay_basis

enum<string>

required

How pay and hours are determined

Available options:

SALARIED,

HOURLY

apprenticeship

Apprenticeship · object | null

required

Apprenticeship details; null when not an apprentice

Show child attributes

p45_issued

boolean

required

True once a P45 has been issued for this employment (post-cessation). Drives the weekly NIC earnings period for post-P45 payments. Distinct from the inbound-starter p45_gross_pay/p45_tax_amount in tax, which carry a new joiner's prior-employer figures.

irregular_payment_pattern

boolean

required

True for casual staff and anyone else not paid every pay period (seasonal, annual director pay). Reported to HMRC as IrrEmp so the employment is not treated as ceased after a run of periods without payment.

ordinarily_works_in_uk

boolean

required

Whether the worker's ordinary place of work under their contract is in the UK (per TPR Detailed Guidance No. 1). If False, the employer has no statutory auto-enrolment duties for this worker. Employees on temporary overseas secondment who remain on UK payroll and whose ordinary place of work is the UK stay True: this flag reflects the contractual base, not the employee's current physical location.

uk_work_exclusion_reason

enum<string>

required

Why the worker does not ordinarily work in the UK. Required, and other than NOT_APPLICABLE, when ordinarily_works_in_uk is False; must be NOT_APPLICABLE when it is True.

Available options:

NOT_APPLICABLE,

OVERSEAS_CONTRACT,

OUTBOUND_POSTING,

INBOUND_TEMPORARY_POSTING,

MOBILE_WORKER_OVERSEAS_BASE,

OTHER

Example:

"NOT_APPLICABLE"

proration_basis

EmployeeProrationBasis · object | null

required

Null to inherit the pay group's basis; set it only to override that basis for this employee.

Show child attributes

valid_from

string<date>

required

valid_to

string<date>

required

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.

start_date

string<date> | null

Employment start date

contracted_weekly_hours

integer | null

default:40

Contracted weekly hours

department

string | null

Department

pay_group_id

string | null

The pay group the employee is paid in

contracted_weekdays

enum<string>[] | null

Contracted working days of the week

Days of the week.

Available options:

MONDAY,

TUESDAY,

WEDNESDAY,

THURSDAY,

FRIDAY,

SATURDAY,

SUNDAY

worker_type

enum<string>

default:EMPLOYEE

UK employment status

Available options:

EMPLOYEE,

DIRECTOR

director_since

string<date> | null

Date appointed as director

pay_basis

enum<string>

default:SALARIED

How pay and hours are determined

Available options:

SALARIED,

HOURLY

apprenticeship

Apprenticeship · object | null

Apprenticeship details

Show child attributes

p45_issued

boolean

default:false

True once a P45 has been issued

irregular_payment_pattern

boolean

default:false

The employee is not paid every pay period

ordinarily_works_in_uk

boolean

default:true

Whether the worker's ordinary place of work is in the UK

uk_work_exclusion_reason

enum<string>

default:NOT_APPLICABLE

Why the worker does not ordinarily work in the UK

Available options:

NOT_APPLICABLE,

OVERSEAS_CONTRACT,

OUTBOUND_POSTING,

INBOUND_TEMPORARY_POSTING,

MOBILE_WORKER_OVERSEAS_BASE,

OTHER

proration_basis

ProrationBasis · object | null

Employee-level override of the inherited proration basis

Show child attributes

end_date

string<date> | null

Last day of employment

Core

Great Britain

Create Job Edition

Authorizations

Headers

Path Parameters

Body

Response