Update tenant-wide reporting defaults
curl --request PUT \
--url https://api.royalti.io/reports/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"terminology": {},
"sourceAliasText": "<string>",
"defaultSectionToggles": {}
}
'import requests
url = "https://api.royalti.io/reports/settings"
payload = {
"terminology": {},
"sourceAliasText": "<string>",
"defaultSectionToggles": {}
}
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({terminology: {}, sourceAliasText: '<string>', defaultSectionToggles: {}})
};
fetch('https://api.royalti.io/reports/settings', 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.royalti.io/reports/settings",
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([
'terminology' => [
],
'sourceAliasText' => '<string>',
'defaultSectionToggles' => [
]
]),
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://api.royalti.io/reports/settings"
payload := strings.NewReader("{\n \"terminology\": {},\n \"sourceAliasText\": \"<string>\",\n \"defaultSectionToggles\": {}\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://api.royalti.io/reports/settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"terminology\": {},\n \"sourceAliasText\": \"<string>\",\n \"defaultSectionToggles\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.royalti.io/reports/settings")
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 \"terminology\": {},\n \"sourceAliasText\": \"<string>\",\n \"defaultSectionToggles\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "<string>",
"data": {
"terminology": {},
"sourceDisclosure": "named",
"sourceAliasText": "<string>",
"defaultSectionToggles": {}
}
}{
"status": "error",
"message": "Unauthorized"
}Reports
Update tenant-wide reporting defaults
Update reporting settings
PUT
/
reports
/
settings
Update tenant-wide reporting defaults
curl --request PUT \
--url https://api.royalti.io/reports/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"terminology": {},
"sourceAliasText": "<string>",
"defaultSectionToggles": {}
}
'import requests
url = "https://api.royalti.io/reports/settings"
payload = {
"terminology": {},
"sourceAliasText": "<string>",
"defaultSectionToggles": {}
}
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({terminology: {}, sourceAliasText: '<string>', defaultSectionToggles: {}})
};
fetch('https://api.royalti.io/reports/settings', 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.royalti.io/reports/settings",
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([
'terminology' => [
],
'sourceAliasText' => '<string>',
'defaultSectionToggles' => [
]
]),
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://api.royalti.io/reports/settings"
payload := strings.NewReader("{\n \"terminology\": {},\n \"sourceAliasText\": \"<string>\",\n \"defaultSectionToggles\": {}\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://api.royalti.io/reports/settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"terminology\": {},\n \"sourceAliasText\": \"<string>\",\n \"defaultSectionToggles\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.royalti.io/reports/settings")
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 \"terminology\": {},\n \"sourceAliasText\": \"<string>\",\n \"defaultSectionToggles\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "<string>",
"data": {
"terminology": {},
"sourceDisclosure": "named",
"sourceAliasText": "<string>",
"defaultSectionToggles": {}
}
}{
"status": "error",
"message": "Unauthorized"
}Description
Update reporting settings Merge-writes a PATCH intoaccountingSettings.reporting — never
clobbers sibling accountingSettings keys (attributionEngineV1,
useStrictSplitAccounting, splitSpecificityOrder, …) or reporting
keys the patch didn’t touch. Returns the resulting merged defaults.
Authorization:
- Required role:
adminor higher
Code Examples
const response = await fetch('https://api.royalti.io/reports/settings', {
method: 'PUT',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
"terminology": {},
"sourceDisclosure": "sample-sourceDisclosure",
"sourceAliasText": "sample-sourceAliasText",
"defaultSectionToggles": {}
})
});
const data = await response.json();
console.log(data);
import requests
response = requests.put(
'https://api.royalti.io/reports/settings',
json={"terminology":{},"sourceDisclosure":"sample-sourceDisclosure","sourceAliasText":"sample-sourceAliasText","defaultSectionToggles":{}}
)
data = response.json()
print(data)
curl -X PUT https://api.royalti.io/reports/settings \
-H "Content-Type: application/json" \
-d '{"terminology":{},"sourceDisclosure":"sample-sourceDisclosure","sourceAliasText":"sample-sourceAliasText","defaultSectionToggles":{}}'
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Body
application/json
Response
Reporting settings updated.
Every /reports JSON response wraps its payload in { status, message, data }.
Available options:
success, error Tenants.accountingSettings.reporting — tenant-wide defaults applied
to every report until a report's own narrative overrides them. Note
the section-toggle key is defaultSectionToggles here vs
sectionToggles on a report.
Show child attributes
Show child attributes
⌘I