Skip to main content
POST
/
publisher
/
publishers
/
{id}
/
statements
/
{statementId}
/
adjustments
Add a manual adjustment to a statement (H-05)
curl --request POST \
  --url https://api.royalti.io/publisher/publishers/{id}/statements/{statementId}/adjustments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source": "<string>",
  "amount": 123,
  "territory": "<string>",
  "currency": "<string>",
  "notes": "<string>"
}
'
import requests

url = "https://api.royalti.io/publisher/publishers/{id}/statements/{statementId}/adjustments"

payload = {
"source": "<string>",
"amount": 123,
"territory": "<string>",
"currency": "<string>",
"notes": "<string>"
}
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({
source: '<string>',
amount: 123,
territory: '<string>',
currency: '<string>',
notes: '<string>'
})
};

fetch('https://api.royalti.io/publisher/publishers/{id}/statements/{statementId}/adjustments', 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/publisher/publishers/{id}/statements/{statementId}/adjustments",
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([
'source' => '<string>',
'amount' => 123,
'territory' => '<string>',
'currency' => '<string>',
'notes' => '<string>'
]),
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/publisher/publishers/{id}/statements/{statementId}/adjustments"

payload := strings.NewReader("{\n \"source\": \"<string>\",\n \"amount\": 123,\n \"territory\": \"<string>\",\n \"currency\": \"<string>\",\n \"notes\": \"<string>\"\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://api.royalti.io/publisher/publishers/{id}/statements/{statementId}/adjustments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"source\": \"<string>\",\n \"amount\": 123,\n \"territory\": \"<string>\",\n \"currency\": \"<string>\",\n \"notes\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publisher/publishers/{id}/statements/{statementId}/adjustments")

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 \"source\": \"<string>\",\n \"amount\": 123,\n \"territory\": \"<string>\",\n \"currency\": \"<string>\",\n \"notes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "message": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "manual",
    "source": "<string>",
    "territory": "<string>",
    "amount": 123,
    "currency": "<string>",
    "notes": "<string>",
    "description": "<string>",
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}
{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}
{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

POST /publisher/publishers//statements//adjustments Rejected once the statement is approved or paid (locked). Runs in a transaction with a row lock on the statement to avoid racing a concurrent status change. Triggers a best-effort variance re-detection after the write (failures are logged, not surfaced). Authorization: admin role + publisher addon.

Code Examples

const response = await fetch('https://api.royalti.io/publisher/publishers/{id}/statements/{statementId}/adjustments', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "ref": "#/components/schemas/CreateAdjustmentRequest"
  })
});

const data = await response.json();
console.log(data);
import requests

response = requests.post(
  'https://api.royalti.io/publisher/publishers/{id}/statements/{statementId}/adjustments',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"ref":"#/components/schemas/CreateAdjustmentRequest"}
)

data = response.json()
print(data)
curl -X POST https://api.royalti.io/publisher/publishers/{id}/statements/{statementId}/adjustments \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ref":"#/components/schemas/CreateAdjustmentRequest"}'

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

id
string<uuid>
required
statementId
string<uuid>
required

Body

application/json
source
string
required
amount
number
required

Finite, non-zero.

territory
string | null
rightType
enum<string> | null
Available options:
PR,
MR,
SR
currency
string

3-letter ISO code. Defaults to the statement's currency.

notes
string | null
Maximum string length: 2000

Response

Adjustment added.

Standard server envelope used by the statement, reconciliation, sub-publishing, and analytics endpoints.

status
enum<string>
Available options:
success,
error
message
string
data
object