Skip to main content
GET
/
publisher
/
sub-publishing
/
{id}
/
recoupment
List a sub-publishing agreement's recoupment ledger
curl --request GET \
  --url https://api.royalti.io/publisher/sub-publishing/{id}/recoupment \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/publisher/sub-publishing/{id}/recoupment"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/publisher/sub-publishing/{id}/recoupment', 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/sub-publishing/{id}/recoupment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.royalti.io/publisher/sub-publishing/{id}/recoupment"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.royalti.io/publisher/sub-publishing/{id}/recoupment")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publisher/sub-publishing/{id}/recoupment")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "message": "<string>",
  "data": {
    "count": 123,
    "rows": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tenantId": 123,
        "subPublishingAgreementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "eventDate": "2023-11-07T05:31:56Z",
        "amount": 123,
        "balance": 123,
        "currency": "<string>",
        "statementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "notes": "<string>",
        "metadata": {}
      }
    ],
    "runningBalance": 123,
    "currency": "<string>"
  }
}
{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

GET /publisher/sub-publishing//recoupment Returns RecoupmentLedger rows for the agreement, ordered oldest first so the running-balance sequence reads naturally. The top-level runningBalance/currency are taken from the agreement’s full history (not just the current page). Authorization: user role + publisher addon.

Code Examples

const response = await fetch('https://api.royalti.io/publisher/sub-publishing/{id}/recoupment', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

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

response = requests.get(
  'https://api.royalti.io/publisher/sub-publishing/{id}/recoupment',
  headers={
    'Authorization': f'Bearer {token}'
  },
)

data = response.json()
print(data)
curl -X GET https://api.royalti.io/publisher/sub-publishing/{id}/recoupment \
  -H "Authorization: Bearer YOUR_TOKEN" \

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Query Parameters

page
integer
Required range: x >= 1
size
integer

Default 20, max 100.

Response

Ledger fetched.

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

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