Skip to main content
PATCH
/
publisher
/
publishers
/
{id}
/
statements
/
{statementId}
/
status
Transition a statement's status
curl --request PATCH \
  --url https://api.royalti.io/publisher/publishers/{id}/statements/{statementId}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
import requests

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

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.royalti.io/publisher/publishers/{id}/statements/{statementId}/status', 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}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  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}/status"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.royalti.io/publisher/publishers/{id}/statements/{statementId}/status")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
{
  "message": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "publisherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenantId": 123,
    "periodStart": "2023-12-25",
    "periodEnd": "2023-12-25",
    "totalAmount": 1,
    "metadata": {
      "territories": [
        "<string>"
      ],
      "rightTypes": [],
      "exchangeRates": {},
      "adjustments": [
        {
          "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"
        }
      ]
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "recoupment": {},
  "warning": "<string>"
}
{
  "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

PATCH /publisher/publishers//statements//status Enforces the locked status state machine (see the Publisher Statements tag description). Setting status to the current value is a no-op (200, unchanged). Approving a statement applies recoupment in the same transaction (H-08) — the response envelope carries an additive recoupment key when that ran, or warning when un-approving a statement that already produced ledger rows. Authorization: admin role + publisher addon.

​
Code Examples

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

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

import requests

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

data = response.json()
print(data)

curl -X PATCH https://api.royalti.io/publisher/publishers/{id}/statements/{statementId}/status \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ref":"#/components/schemas/UpdateStatementStatusRequest"}'

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
​
status
enum<string>
required

Allowed transitions: draft→pending, pending→approved|draft, approved→paid|pending. paid is terminal.

Available options:
draft,
pending,
approved,
paid

Response

Status updated (or unchanged).

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

​
status
enum<string>
Available options:
success,
error
​
message
string
​
data
object
​
recoupment
object | null
​
warning
string | null