Create Tax Edition

curl --request PUT \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/tax \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rti_id": "<string>",
  "tax_code": "1257L",
  "postgraduate_loan": true,
  "p45_gross_pay": "0.00",
  "p45_tax_amount": "0.00",
  "starter_details": {
    "basis": "DECLARATION"
  },
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25"
}
'

import requests

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

payload = {
    "rti_id": "<string>",
    "tax_code": "1257L",
    "postgraduate_loan": True,
    "p45_gross_pay": "0.00",
    "p45_tax_amount": "0.00",
    "starter_details": { "basis": "DECLARATION" },
    "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({
    rti_id: '<string>',
    tax_code: '1257L',
    postgraduate_loan: true,
    p45_gross_pay: '0.00',
    p45_tax_amount: '0.00',
    starter_details: {basis: 'DECLARATION'},
    valid_from: '2023-12-25',
    valid_to: '2023-12-25'
  })
};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/tax', 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}/tax",
  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([
    'rti_id' => '<string>',
    'tax_code' => '1257L',
    'postgraduate_loan' => true,
    'p45_gross_pay' => '0.00',
    'p45_tax_amount' => '0.00',
    'starter_details' => [
        'basis' => 'DECLARATION'
    ],
    '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}/tax"

	payload := strings.NewReader("{\n  \"rti_id\": \"<string>\",\n  \"tax_code\": \"1257L\",\n  \"postgraduate_loan\": true,\n  \"p45_gross_pay\": \"0.00\",\n  \"p45_tax_amount\": \"0.00\",\n  \"starter_details\": {\n    \"basis\": \"DECLARATION\"\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}/tax")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rti_id\": \"<string>\",\n  \"tax_code\": \"1257L\",\n  \"postgraduate_loan\": true,\n  \"p45_gross_pay\": \"0.00\",\n  \"p45_tax_amount\": \"0.00\",\n  \"starter_details\": {\n    \"basis\": \"DECLARATION\"\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}/tax")

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  \"rti_id\": \"<string>\",\n  \"tax_code\": \"1257L\",\n  \"postgraduate_loan\": true,\n  \"p45_gross_pay\": \"0.00\",\n  \"p45_tax_amount\": \"0.00\",\n  \"starter_details\": {\n    \"basis\": \"DECLARATION\"\n  },\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\"\n}"

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

{
  "starter_details": {
    "basis": "DECLARATION",
    "declaration": "A"
  },
  "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": "PLAN_1",
  "postgraduate_loan": false,
  "p45_gross_pay": "0.00",
  "p45_tax_amount": "0.00"
}

PUT

organizations

{organization_id}

employees

{employee_id}

tax

Create Tax Edition

curl --request PUT \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/tax \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rti_id": "<string>",
  "tax_code": "1257L",
  "postgraduate_loan": true,
  "p45_gross_pay": "0.00",
  "p45_tax_amount": "0.00",
  "starter_details": {
    "basis": "DECLARATION"
  },
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25"
}
'

import requests

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

payload = {
    "rti_id": "<string>",
    "tax_code": "1257L",
    "postgraduate_loan": True,
    "p45_gross_pay": "0.00",
    "p45_tax_amount": "0.00",
    "starter_details": { "basis": "DECLARATION" },
    "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({
    rti_id: '<string>',
    tax_code: '1257L',
    postgraduate_loan: true,
    p45_gross_pay: '0.00',
    p45_tax_amount: '0.00',
    starter_details: {basis: 'DECLARATION'},
    valid_from: '2023-12-25',
    valid_to: '2023-12-25'
  })
};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/tax', 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}/tax",
  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([
    'rti_id' => '<string>',
    'tax_code' => '1257L',
    'postgraduate_loan' => true,
    'p45_gross_pay' => '0.00',
    'p45_tax_amount' => '0.00',
    'starter_details' => [
        'basis' => 'DECLARATION'
    ],
    '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}/tax"

	payload := strings.NewReader("{\n  \"rti_id\": \"<string>\",\n  \"tax_code\": \"1257L\",\n  \"postgraduate_loan\": true,\n  \"p45_gross_pay\": \"0.00\",\n  \"p45_tax_amount\": \"0.00\",\n  \"starter_details\": {\n    \"basis\": \"DECLARATION\"\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}/tax")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rti_id\": \"<string>\",\n  \"tax_code\": \"1257L\",\n  \"postgraduate_loan\": true,\n  \"p45_gross_pay\": \"0.00\",\n  \"p45_tax_amount\": \"0.00\",\n  \"starter_details\": {\n    \"basis\": \"DECLARATION\"\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}/tax")

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  \"rti_id\": \"<string>\",\n  \"tax_code\": \"1257L\",\n  \"postgraduate_loan\": true,\n  \"p45_gross_pay\": \"0.00\",\n  \"p45_tax_amount\": \"0.00\",\n  \"starter_details\": {\n    \"basis\": \"DECLARATION\"\n  },\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\"\n}"

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

{
  "starter_details": {
    "basis": "DECLARATION",
    "declaration": "A"
  },
  "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": "PLAN_1",
  "postgraduate_loan": false,
  "p45_gross_pay": "0.00",
  "p45_tax_amount": "0.00"
}

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

rti_id

string | null

required

RTI Payroll ID, unique for this employee in HMRC submissions. Null to keep the current one, or generate one on the first write; never generated for EXISTING_EMPLOYMENT.

Required string length: 1 - 35

tax_code

string

required

HMRC tax code (e.g. '1257L', 'K475', 'BR')

Example:

"1257L"

student_loan_type

enum<string> | null

required

Student loan type; null when none

Available options:

PLAN_1,

PLAN_2,

PLAN_4,

PLAN_5

postgraduate_loan

boolean

required

Postgraduate loan?

p45_gross_pay

required

P45 gross pay

Example:

"0.00"

p45_tax_amount

required

P45 tax amount

Example:

"0.00"

starter_details

StarterDetailsDeclaration · object

required

A new employee who completed the starter checklist.

StarterDetailsDeclaration
StarterDetailsSeconded
StarterDetailsExistingEmployment

Show child attributes

valid_from

string<date>

required

valid_to

string<date>

required

Response

Successful Response

starter_details

StarterDetailsDeclaration · object

required

A new employee who completed the starter checklist.

StarterDetailsDeclaration
StarterDetailsSeconded
StarterDetailsExistingEmployment

Show child attributes

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.

rti_id

string | null

RTI Payroll ID

tax_code

string | null

student_loan_type

enum<string> | null

Student loan type

Available options:

PLAN_1,

PLAN_2,

PLAN_4,

PLAN_5

postgraduate_loan

boolean

default:false

Postgraduate loan?

p45_gross_pay

string | null

default:0.00

P45 gross pay

p45_tax_amount

string | null

default:0.00

P45 tax amount

Core

Great Britain

Create Tax Edition

Authorizations

Headers

Path Parameters

Body

Response