Create an organisation's standard rates
curl --request POST \
--url https://api.ctrl-hub.com/v3/standard-rates \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"type": "standard-rates",
"attributes": {
"standard": "<string>",
"sets": [
{
"effective_from": "2025-04-01",
"domestic": {
"base": {
"amount": 9250,
"currency": "GBP"
}
},
"non_domestic": {
"base": {
"amount": 9250,
"currency": "GBP"
}
}
}
]
},
"relationships": {
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
}
}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/standard-rates"
payload = { "data": {
"type": "standard-rates",
"attributes": {
"standard": "<string>",
"sets": [
{
"effective_from": "2025-04-01",
"domestic": { "base": {
"amount": 9250,
"currency": "GBP"
} },
"non_domestic": { "base": {
"amount": 9250,
"currency": "GBP"
} }
}
]
},
"relationships": { "organisation": { "data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
} } }
} }
headers = {
"X-Session-Token": "<api-key>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Session-Token': '<api-key>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'standard-rates',
attributes: {
standard: '<string>',
sets: [
{
effective_from: '2025-04-01',
domestic: {base: {amount: 9250, currency: 'GBP'}},
non_domestic: {base: {amount: 9250, currency: 'GBP'}}
}
]
},
relationships: {
organisation: {data: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', type: 'organisations'}}
}
}
})
};
fetch('https://api.ctrl-hub.com/v3/standard-rates', 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://api.ctrl-hub.com/v3/standard-rates",
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([
'data' => [
'type' => 'standard-rates',
'attributes' => [
'standard' => '<string>',
'sets' => [
[
'effective_from' => '2025-04-01',
'domestic' => [
'base' => [
'amount' => 9250,
'currency' => 'GBP'
]
],
'non_domestic' => [
'base' => [
'amount' => 9250,
'currency' => 'GBP'
]
]
]
]
],
'relationships' => [
'organisation' => [
'data' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'type' => 'organisations'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/vnd.api+json",
"X-Session-Token: <api-key>"
],
]);
$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://api.ctrl-hub.com/v3/standard-rates"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"standard-rates\",\n \"attributes\": {\n \"standard\": \"<string>\",\n \"sets\": [\n {\n \"effective_from\": \"2025-04-01\",\n \"domestic\": {\n \"base\": {\n \"amount\": 9250,\n \"currency\": \"GBP\"\n }\n },\n \"non_domestic\": {\n \"base\": {\n \"amount\": 9250,\n \"currency\": \"GBP\"\n }\n }\n }\n ]\n },\n \"relationships\": {\n \"organisation\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"organisations\"\n }\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Session-Token", "<api-key>")
req.Header.Add("Content-Type", "application/vnd.api+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://api.ctrl-hub.com/v3/standard-rates")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"standard-rates\",\n \"attributes\": {\n \"standard\": \"<string>\",\n \"sets\": [\n {\n \"effective_from\": \"2025-04-01\",\n \"domestic\": {\n \"base\": {\n \"amount\": 9250,\n \"currency\": \"GBP\"\n }\n },\n \"non_domestic\": {\n \"base\": {\n \"amount\": 9250,\n \"currency\": \"GBP\"\n }\n }\n }\n ]\n },\n \"relationships\": {\n \"organisation\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"organisations\"\n }\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/standard-rates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Session-Token"] = '<api-key>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"standard-rates\",\n \"attributes\": {\n \"standard\": \"<string>\",\n \"sets\": [\n {\n \"effective_from\": \"2025-04-01\",\n \"domestic\": {\n \"base\": {\n \"amount\": 9250,\n \"currency\": \"GBP\"\n }\n },\n \"non_domestic\": {\n \"base\": {\n \"amount\": 9250,\n \"currency\": \"GBP\"\n }\n }\n }\n ]\n },\n \"relationships\": {\n \"organisation\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"organisations\"\n }\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "standard-rates",
"attributes": {
"standard": "<string>",
"sets": [
{
"effective_from": "2025-04-01",
"domestic": {
"base": {
"amount": 9250,
"currency": "GBP"
},
"per_period": {
"amount": 9250,
"currency": "GBP"
},
"cap": {
"amount": 9250,
"currency": "GBP"
}
},
"non_domestic": {
"base": {
"amount": 9250,
"currency": "GBP"
},
"per_period": {
"amount": 9250,
"currency": "GBP"
},
"cap": {
"amount": 9250,
"currency": "GBP"
}
},
"late_payment": {
"amount": 9250,
"currency": "GBP"
}
}
]
},
"relationships": {
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
}
},
"meta": {
"created_at": "2026-11-03T12:42:40.000Z",
"updated_at": "2026-11-03T12:42:44.000Z"
}
},
"jsonapi": {
"version": "1.0"
}
}{
"id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
"status": "400",
"title": "A validation error was encountered",
"source": {
"parameter": "include"
},
"meta": {
"resource": "wrong_value"
}
}{
"id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
"status": "401",
"title": "You are not authorised to access this resource",
"detail": "In order to access this resource, you need the 'admin' role.",
"code": "AUTH.001"
}{
"id": "8e2f9a34-b5c6-4d7e-9f8a-2b3c4d5e6f7g",
"status": "409",
"title": "Conflict",
"detail": "The request conflicts with the current state of the resource.",
"code": "CONFLICT.001"
}{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}Standards
Create standard rates
Set an organisation’s own rates for a performance standard, in the organisation the body’s organisation relationship names. They take precedence over the standard’s platform rates on any date one of them is in effect. An organisation has one record per standard, so a second answers 409; change the existing record with a PUT instead. The change is audited. The caller needs permission to manage standard rates across the organisation.
POST
/
v3
/
standard-rates
Create an organisation's standard rates
curl --request POST \
--url https://api.ctrl-hub.com/v3/standard-rates \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"type": "standard-rates",
"attributes": {
"standard": "<string>",
"sets": [
{
"effective_from": "2025-04-01",
"domestic": {
"base": {
"amount": 9250,
"currency": "GBP"
}
},
"non_domestic": {
"base": {
"amount": 9250,
"currency": "GBP"
}
}
}
]
},
"relationships": {
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
}
}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/standard-rates"
payload = { "data": {
"type": "standard-rates",
"attributes": {
"standard": "<string>",
"sets": [
{
"effective_from": "2025-04-01",
"domestic": { "base": {
"amount": 9250,
"currency": "GBP"
} },
"non_domestic": { "base": {
"amount": 9250,
"currency": "GBP"
} }
}
]
},
"relationships": { "organisation": { "data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
} } }
} }
headers = {
"X-Session-Token": "<api-key>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Session-Token': '<api-key>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'standard-rates',
attributes: {
standard: '<string>',
sets: [
{
effective_from: '2025-04-01',
domestic: {base: {amount: 9250, currency: 'GBP'}},
non_domestic: {base: {amount: 9250, currency: 'GBP'}}
}
]
},
relationships: {
organisation: {data: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', type: 'organisations'}}
}
}
})
};
fetch('https://api.ctrl-hub.com/v3/standard-rates', 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://api.ctrl-hub.com/v3/standard-rates",
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([
'data' => [
'type' => 'standard-rates',
'attributes' => [
'standard' => '<string>',
'sets' => [
[
'effective_from' => '2025-04-01',
'domestic' => [
'base' => [
'amount' => 9250,
'currency' => 'GBP'
]
],
'non_domestic' => [
'base' => [
'amount' => 9250,
'currency' => 'GBP'
]
]
]
]
],
'relationships' => [
'organisation' => [
'data' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'type' => 'organisations'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/vnd.api+json",
"X-Session-Token: <api-key>"
],
]);
$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://api.ctrl-hub.com/v3/standard-rates"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"standard-rates\",\n \"attributes\": {\n \"standard\": \"<string>\",\n \"sets\": [\n {\n \"effective_from\": \"2025-04-01\",\n \"domestic\": {\n \"base\": {\n \"amount\": 9250,\n \"currency\": \"GBP\"\n }\n },\n \"non_domestic\": {\n \"base\": {\n \"amount\": 9250,\n \"currency\": \"GBP\"\n }\n }\n }\n ]\n },\n \"relationships\": {\n \"organisation\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"organisations\"\n }\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Session-Token", "<api-key>")
req.Header.Add("Content-Type", "application/vnd.api+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://api.ctrl-hub.com/v3/standard-rates")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"standard-rates\",\n \"attributes\": {\n \"standard\": \"<string>\",\n \"sets\": [\n {\n \"effective_from\": \"2025-04-01\",\n \"domestic\": {\n \"base\": {\n \"amount\": 9250,\n \"currency\": \"GBP\"\n }\n },\n \"non_domestic\": {\n \"base\": {\n \"amount\": 9250,\n \"currency\": \"GBP\"\n }\n }\n }\n ]\n },\n \"relationships\": {\n \"organisation\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"organisations\"\n }\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/standard-rates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Session-Token"] = '<api-key>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"standard-rates\",\n \"attributes\": {\n \"standard\": \"<string>\",\n \"sets\": [\n {\n \"effective_from\": \"2025-04-01\",\n \"domestic\": {\n \"base\": {\n \"amount\": 9250,\n \"currency\": \"GBP\"\n }\n },\n \"non_domestic\": {\n \"base\": {\n \"amount\": 9250,\n \"currency\": \"GBP\"\n }\n }\n }\n ]\n },\n \"relationships\": {\n \"organisation\": {\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"organisations\"\n }\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "standard-rates",
"attributes": {
"standard": "<string>",
"sets": [
{
"effective_from": "2025-04-01",
"domestic": {
"base": {
"amount": 9250,
"currency": "GBP"
},
"per_period": {
"amount": 9250,
"currency": "GBP"
},
"cap": {
"amount": 9250,
"currency": "GBP"
}
},
"non_domestic": {
"base": {
"amount": 9250,
"currency": "GBP"
},
"per_period": {
"amount": 9250,
"currency": "GBP"
},
"cap": {
"amount": 9250,
"currency": "GBP"
}
},
"late_payment": {
"amount": 9250,
"currency": "GBP"
}
}
]
},
"relationships": {
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
}
},
"meta": {
"created_at": "2026-11-03T12:42:40.000Z",
"updated_at": "2026-11-03T12:42:44.000Z"
}
},
"jsonapi": {
"version": "1.0"
}
}{
"id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
"status": "400",
"title": "A validation error was encountered",
"source": {
"parameter": "include"
},
"meta": {
"resource": "wrong_value"
}
}{
"id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
"status": "401",
"title": "You are not authorised to access this resource",
"detail": "In order to access this resource, you need the 'admin' role.",
"code": "AUTH.001"
}{
"id": "8e2f9a34-b5c6-4d7e-9f8a-2b3c4d5e6f7g",
"status": "409",
"title": "Conflict",
"detail": "The request conflicts with the current state of the resource.",
"code": "CONFLICT.001"
}{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}Authorizations
SessionOAuth2Cookie
Session token for authentication.
Body
application/vnd.api+json
An organisation's own rate sets for a standard, in the organisation the organisation relationship names.
Show child attributes
Show child attributes
Response
An organisation's own rates for a standard.
JSON API response object