Create Wage Type
curl --request POST \
--url https://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"valid_from": "2023-12-25",
"wage_type_code": "<string>",
"core": {
"name": "<string>",
"description": "<string>"
},
"treatment": {
"deduction_tax_treatment": "POST_TAX",
"rti_payment_type": "<string>",
"ni_employee_applies": true,
"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"
},
"computation": {
"computation": {
"amount": 123,
"type": "fixed"
},
"depends_on": [
"<string>"
],
"precision": 2,
"rounding": "HALF_UP"
}
}
'import requests
url = "https://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types"
payload = {
"valid_from": "2023-12-25",
"wage_type_code": "<string>",
"core": {
"name": "<string>",
"description": "<string>"
},
"treatment": {
"deduction_tax_treatment": "POST_TAX",
"rti_payment_type": "<string>",
"ni_employee_applies": True,
"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"
},
"computation": {
"computation": {
"amount": 123,
"type": "fixed"
},
"depends_on": ["<string>"],
"precision": 2,
"rounding": "HALF_UP"
}
}
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',
wage_type_code: '<string>',
core: {name: '<string>', description: '<string>'},
treatment: {
deduction_tax_treatment: 'POST_TAX',
rti_payment_type: '<string>',
ni_employee_applies: true,
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'
},
computation: {
computation: {amount: 123, type: 'fixed'},
depends_on: ['<string>'],
precision: 2,
rounding: 'HALF_UP'
}
})
};
fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types', 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",
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',
'wage_type_code' => '<string>',
'core' => [
'name' => '<string>',
'description' => '<string>'
],
'treatment' => [
'deduction_tax_treatment' => 'POST_TAX',
'rti_payment_type' => '<string>',
'ni_employee_applies' => true,
'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'
],
'computation' => [
'computation' => [
'amount' => 123,
'type' => 'fixed'
],
'depends_on' => [
'<string>'
],
'precision' => 2,
'rounding' => 'HALF_UP'
]
]),
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"
payload := strings.NewReader("{\n \"valid_from\": \"2023-12-25\",\n \"wage_type_code\": \"<string>\",\n \"core\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"treatment\": {\n \"deduction_tax_treatment\": \"POST_TAX\",\n \"rti_payment_type\": \"<string>\",\n \"ni_employee_applies\": true,\n \"is_class_1a_applicable\": false,\n \"is_ae_qualifying\": false,\n \"uses_ae_bands\": false,\n \"is_holiday_pay_included\": false,\n \"is_salary_sacrifice_allowed\": false,\n \"is_proratable\": false,\n \"nmw_treatment\": \"EXCLUDED\",\n \"opra_rule\": \"NOT_APPLICABLE\",\n \"uses_official_interest_rate\": false,\n \"calculation_variants\": [\n \"<string>\"\n ],\n \"thresholds\": {},\n \"regularity_window_weeks\": 123,\n \"regularity_threshold_periods\": 123,\n \"is_gross_up\": false,\n \"is_notional\": false,\n \"legislative_source\": \"<string>\",\n \"owner\": \"<string>\",\n \"reviewer\": \"<string>\",\n \"last_reviewed_at\": \"2023-12-25\"\n },\n \"computation\": {\n \"computation\": {\n \"amount\": 123,\n \"type\": \"fixed\"\n },\n \"depends_on\": [\n \"<string>\"\n ],\n \"precision\": 2,\n \"rounding\": \"HALF_UP\"\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://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"valid_from\": \"2023-12-25\",\n \"wage_type_code\": \"<string>\",\n \"core\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"treatment\": {\n \"deduction_tax_treatment\": \"POST_TAX\",\n \"rti_payment_type\": \"<string>\",\n \"ni_employee_applies\": true,\n \"is_class_1a_applicable\": false,\n \"is_ae_qualifying\": false,\n \"uses_ae_bands\": false,\n \"is_holiday_pay_included\": false,\n \"is_salary_sacrifice_allowed\": false,\n \"is_proratable\": false,\n \"nmw_treatment\": \"EXCLUDED\",\n \"opra_rule\": \"NOT_APPLICABLE\",\n \"uses_official_interest_rate\": false,\n \"calculation_variants\": [\n \"<string>\"\n ],\n \"thresholds\": {},\n \"regularity_window_weeks\": 123,\n \"regularity_threshold_periods\": 123,\n \"is_gross_up\": false,\n \"is_notional\": false,\n \"legislative_source\": \"<string>\",\n \"owner\": \"<string>\",\n \"reviewer\": \"<string>\",\n \"last_reviewed_at\": \"2023-12-25\"\n },\n \"computation\": {\n \"computation\": {\n \"amount\": 123,\n \"type\": \"fixed\"\n },\n \"depends_on\": [\n \"<string>\"\n ],\n \"precision\": 2,\n \"rounding\": \"HALF_UP\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types")
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 \"wage_type_code\": \"<string>\",\n \"core\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"treatment\": {\n \"deduction_tax_treatment\": \"POST_TAX\",\n \"rti_payment_type\": \"<string>\",\n \"ni_employee_applies\": true,\n \"is_class_1a_applicable\": false,\n \"is_ae_qualifying\": false,\n \"uses_ae_bands\": false,\n \"is_holiday_pay_included\": false,\n \"is_salary_sacrifice_allowed\": false,\n \"is_proratable\": false,\n \"nmw_treatment\": \"EXCLUDED\",\n \"opra_rule\": \"NOT_APPLICABLE\",\n \"uses_official_interest_rate\": false,\n \"calculation_variants\": [\n \"<string>\"\n ],\n \"thresholds\": {},\n \"regularity_window_weeks\": 123,\n \"regularity_threshold_periods\": 123,\n \"is_gross_up\": false,\n \"is_notional\": false,\n \"legislative_source\": \"<string>\",\n \"owner\": \"<string>\",\n \"reviewer\": \"<string>\",\n \"last_reviewed_at\": \"2023-12-25\"\n },\n \"computation\": {\n \"computation\": {\n \"amount\": 123,\n \"type\": \"fixed\"\n },\n \"depends_on\": [\n \"<string>\"\n ],\n \"precision\": 2,\n \"rounding\": \"HALF_UP\"\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>",
"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>"
]
}
}Wage Types
Create Wage Type
POST
/
gb
/
organizations
/
{organization_id}
/
wage-types
Create Wage Type
curl --request POST \
--url https://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"valid_from": "2023-12-25",
"wage_type_code": "<string>",
"core": {
"name": "<string>",
"description": "<string>"
},
"treatment": {
"deduction_tax_treatment": "POST_TAX",
"rti_payment_type": "<string>",
"ni_employee_applies": true,
"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"
},
"computation": {
"computation": {
"amount": 123,
"type": "fixed"
},
"depends_on": [
"<string>"
],
"precision": 2,
"rounding": "HALF_UP"
}
}
'import requests
url = "https://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types"
payload = {
"valid_from": "2023-12-25",
"wage_type_code": "<string>",
"core": {
"name": "<string>",
"description": "<string>"
},
"treatment": {
"deduction_tax_treatment": "POST_TAX",
"rti_payment_type": "<string>",
"ni_employee_applies": True,
"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"
},
"computation": {
"computation": {
"amount": 123,
"type": "fixed"
},
"depends_on": ["<string>"],
"precision": 2,
"rounding": "HALF_UP"
}
}
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',
wage_type_code: '<string>',
core: {name: '<string>', description: '<string>'},
treatment: {
deduction_tax_treatment: 'POST_TAX',
rti_payment_type: '<string>',
ni_employee_applies: true,
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'
},
computation: {
computation: {amount: 123, type: 'fixed'},
depends_on: ['<string>'],
precision: 2,
rounding: 'HALF_UP'
}
})
};
fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types', 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",
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',
'wage_type_code' => '<string>',
'core' => [
'name' => '<string>',
'description' => '<string>'
],
'treatment' => [
'deduction_tax_treatment' => 'POST_TAX',
'rti_payment_type' => '<string>',
'ni_employee_applies' => true,
'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'
],
'computation' => [
'computation' => [
'amount' => 123,
'type' => 'fixed'
],
'depends_on' => [
'<string>'
],
'precision' => 2,
'rounding' => 'HALF_UP'
]
]),
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"
payload := strings.NewReader("{\n \"valid_from\": \"2023-12-25\",\n \"wage_type_code\": \"<string>\",\n \"core\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"treatment\": {\n \"deduction_tax_treatment\": \"POST_TAX\",\n \"rti_payment_type\": \"<string>\",\n \"ni_employee_applies\": true,\n \"is_class_1a_applicable\": false,\n \"is_ae_qualifying\": false,\n \"uses_ae_bands\": false,\n \"is_holiday_pay_included\": false,\n \"is_salary_sacrifice_allowed\": false,\n \"is_proratable\": false,\n \"nmw_treatment\": \"EXCLUDED\",\n \"opra_rule\": \"NOT_APPLICABLE\",\n \"uses_official_interest_rate\": false,\n \"calculation_variants\": [\n \"<string>\"\n ],\n \"thresholds\": {},\n \"regularity_window_weeks\": 123,\n \"regularity_threshold_periods\": 123,\n \"is_gross_up\": false,\n \"is_notional\": false,\n \"legislative_source\": \"<string>\",\n \"owner\": \"<string>\",\n \"reviewer\": \"<string>\",\n \"last_reviewed_at\": \"2023-12-25\"\n },\n \"computation\": {\n \"computation\": {\n \"amount\": 123,\n \"type\": \"fixed\"\n },\n \"depends_on\": [\n \"<string>\"\n ],\n \"precision\": 2,\n \"rounding\": \"HALF_UP\"\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://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"valid_from\": \"2023-12-25\",\n \"wage_type_code\": \"<string>\",\n \"core\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"treatment\": {\n \"deduction_tax_treatment\": \"POST_TAX\",\n \"rti_payment_type\": \"<string>\",\n \"ni_employee_applies\": true,\n \"is_class_1a_applicable\": false,\n \"is_ae_qualifying\": false,\n \"uses_ae_bands\": false,\n \"is_holiday_pay_included\": false,\n \"is_salary_sacrifice_allowed\": false,\n \"is_proratable\": false,\n \"nmw_treatment\": \"EXCLUDED\",\n \"opra_rule\": \"NOT_APPLICABLE\",\n \"uses_official_interest_rate\": false,\n \"calculation_variants\": [\n \"<string>\"\n ],\n \"thresholds\": {},\n \"regularity_window_weeks\": 123,\n \"regularity_threshold_periods\": 123,\n \"is_gross_up\": false,\n \"is_notional\": false,\n \"legislative_source\": \"<string>\",\n \"owner\": \"<string>\",\n \"reviewer\": \"<string>\",\n \"last_reviewed_at\": \"2023-12-25\"\n },\n \"computation\": {\n \"computation\": {\n \"amount\": 123,\n \"type\": \"fixed\"\n },\n \"depends_on\": [\n \"<string>\"\n ],\n \"precision\": 2,\n \"rounding\": \"HALF_UP\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.intermezzo.ai/gb/organizations/{organization_id}/wage-types")
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 \"wage_type_code\": \"<string>\",\n \"core\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"treatment\": {\n \"deduction_tax_treatment\": \"POST_TAX\",\n \"rti_payment_type\": \"<string>\",\n \"ni_employee_applies\": true,\n \"is_class_1a_applicable\": false,\n \"is_ae_qualifying\": false,\n \"uses_ae_bands\": false,\n \"is_holiday_pay_included\": false,\n \"is_salary_sacrifice_allowed\": false,\n \"is_proratable\": false,\n \"nmw_treatment\": \"EXCLUDED\",\n \"opra_rule\": \"NOT_APPLICABLE\",\n \"uses_official_interest_rate\": false,\n \"calculation_variants\": [\n \"<string>\"\n ],\n \"thresholds\": {},\n \"regularity_window_weeks\": 123,\n \"regularity_threshold_periods\": 123,\n \"is_gross_up\": false,\n \"is_notional\": false,\n \"legislative_source\": \"<string>\",\n \"owner\": \"<string>\",\n \"reviewer\": \"<string>\",\n \"last_reviewed_at\": \"2023-12-25\"\n },\n \"computation\": {\n \"computation\": {\n \"amount\": 123,\n \"type\": \"fixed\"\n },\n \"depends_on\": [\n \"<string>\"\n ],\n \"precision\": 2,\n \"rounding\": \"HALF_UP\"\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>",
"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
Get token from Auth0 and paste it here
Headers
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 - 255Path Parameters
Body
application/json
Creating an organization's wage type with its own core and treatment, and
optionally a computation. Each satellite starts on [valid_from, 9999-12-31);
the type starts as DRAFT and resolves in payrolls once approved.
The first day every satellite's data is valid at
Business key, unique within the organization; not in the UK- namespace
What the wage type is called and which block of the payslip it belongs to.
Show child attributes
Show child attributes
The statutory treatment of amounts paid under the code.
Show child attributes
Show child attributes
The integrator's own stable key, unique within the organization
Required string length:
1 - 255How the amount paid under the code is computed: a wagekit spec, the codes it reads, and how its result is rounded.
Show child attributes
Show child attributes
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.
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.
When the hub was closed
The owning organization; null for the country catalog's own types
Enum for CountryAlpha2 codes
Available options:
IE, GB, AE, US Business key, unique within its owner
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 Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes