Deprecate Wage Type

curl --request POST \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types/{wage_type_id}/deprecate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "valid_from": "2023-12-25"
}
'

import requests

url = "https://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types/{wage_type_id}/deprecate"

payload = { "valid_from": "2023-12-25" }
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'})
};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types/{wage_type_id}/deprecate', 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}/wage-types/{wage_type_id}/deprecate",
  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'
  ]),
  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}/wage-types/{wage_type_id}/deprecate"

	payload := strings.NewReader("{\n  \"valid_from\": \"2023-12-25\"\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://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types/{wage_type_id}/deprecate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"valid_from\": \"2023-12-25\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types/{wage_type_id}/deprecate")

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}"

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>",
  "country_code": "IE",
  "wage_type_code": "<string>",
  "system_usage": "DERIVABLE",
  "core": {
    "name": "<string>",
    "description": "<string>",
    "category": "EARNINGS",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>"
  },
  "treatment": {
    "taxable_status": "YES",
    "tax_timing": "ON_PAYMENT",
    "ni_class": "CLASS_1",
    "p11d_reportable_status": "YES",
    "pension_status": "SCHEME_DEFINED",
    "payrolling_eligible_status": "YES",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "deduction_tax_treatment": "POST_TAX",
    "rti_payment_type": "<string>",
    "ni_employee_applies": true,
    "ni_employer_treatment": "SECONDARY",
    "is_class_1a_applicable": false,
    "is_ae_qualifying": false,
    "uses_ae_bands": false,
    "is_holiday_pay_included": false,
    "is_salary_sacrifice_allowed": false,
    "is_proratable": false,
    "nmw_treatment": "EXCLUDED",
    "opra_rule": "NOT_APPLICABLE",
    "uses_official_interest_rate": false,
    "calculation_variants": [
      "<string>"
    ],
    "thresholds": {},
    "regularity_window_weeks": 123,
    "regularity_threshold_periods": 123,
    "is_gross_up": false,
    "is_notional": false,
    "legislative_source": "<string>",
    "owner": "<string>",
    "reviewer": "<string>",
    "last_reviewed_at": "2023-12-25"
  },
  "lifecycle": {
    "state": "DRAFT",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>"
  },
  "computation": {
    "computation": {
      "amount": "<string>",
      "type": "fixed"
    },
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "depends_on": [
      "<string>"
    ],
    "precision": 2,
    "rounding": "HALF_UP",
    "locked_fields": [
      "<string>"
    ]
  }
}

POST

organizations

{organization_id}

wage-types

{wage_type_id}

deprecate

Deprecate Wage Type

curl --request POST \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types/{wage_type_id}/deprecate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "valid_from": "2023-12-25"
}
'

import requests

url = "https://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types/{wage_type_id}/deprecate"

payload = { "valid_from": "2023-12-25" }
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'})
};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types/{wage_type_id}/deprecate', 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}/wage-types/{wage_type_id}/deprecate",
  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'
  ]),
  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}/wage-types/{wage_type_id}/deprecate"

	payload := strings.NewReader("{\n  \"valid_from\": \"2023-12-25\"\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://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types/{wage_type_id}/deprecate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"valid_from\": \"2023-12-25\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types/{wage_type_id}/deprecate")

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}"

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>",
  "country_code": "IE",
  "wage_type_code": "<string>",
  "system_usage": "DERIVABLE",
  "core": {
    "name": "<string>",
    "description": "<string>",
    "category": "EARNINGS",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>"
  },
  "treatment": {
    "taxable_status": "YES",
    "tax_timing": "ON_PAYMENT",
    "ni_class": "CLASS_1",
    "p11d_reportable_status": "YES",
    "pension_status": "SCHEME_DEFINED",
    "payrolling_eligible_status": "YES",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "deduction_tax_treatment": "POST_TAX",
    "rti_payment_type": "<string>",
    "ni_employee_applies": true,
    "ni_employer_treatment": "SECONDARY",
    "is_class_1a_applicable": false,
    "is_ae_qualifying": false,
    "uses_ae_bands": false,
    "is_holiday_pay_included": false,
    "is_salary_sacrifice_allowed": false,
    "is_proratable": false,
    "nmw_treatment": "EXCLUDED",
    "opra_rule": "NOT_APPLICABLE",
    "uses_official_interest_rate": false,
    "calculation_variants": [
      "<string>"
    ],
    "thresholds": {},
    "regularity_window_weeks": 123,
    "regularity_threshold_periods": 123,
    "is_gross_up": false,
    "is_notional": false,
    "legislative_source": "<string>",
    "owner": "<string>",
    "reviewer": "<string>",
    "last_reviewed_at": "2023-12-25"
  },
  "lifecycle": {
    "state": "DRAFT",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>"
  },
  "computation": {
    "computation": {
      "amount": "<string>",
      "type": "fixed"
    },
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "depends_on": [
      "<string>"
    ],
    "precision": 2,
    "rounding": "HALF_UP",
    "locked_fields": [
      "<string>"
    ]
  }
}

Authorizations

Authorization

string

header

required

Get token from Auth0 and paste it here

Headers

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

wage_type_id

string

required

Body

application/json

A lifecycle change, effective from valid_from onward.

valid_from

string<date>

required

The first day the new status applies

Response

Successful Response

The wage type with every satellite as it reads on one date. A satellite with no slice on an explicit date is null.

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 | null

required

The owning organization; null for the country catalog's own types

country_code

enum<string>

required

Enum for CountryAlpha2 codes

Available options:

IE,

GB,

AE,

US

wage_type_code

string

required

Business key, unique within its owner

system_usage

enum<string> | null

required

On catalog types: how an organization may use it, e.g. as an input, or not submit it at all because the engine calculates it

Available options:

DERIVABLE,

CALCULATED_ONLY,

NON_DERIVABLE,

TERMINATION

core

GBWageTypeCoreSatellite · object | null

Show child attributes

treatment

GBWageTypeTreatmentSatellite · object | null

Show child attributes

lifecycle

WageTypeLifecycleSatellite · object | null

Show child attributes

computation

WageTypeComputationSatellite · object | null

Show child attributes