Skip to main content
GET
/
statements
/
users
/
{tenantUserId}
/
{periodStart}
/
{periodEnd}
Get statement detail for a user + period
curl --request GET \
  --url https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}"

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/statements/users/{tenantUserId}/{periodStart}/{periodEnd}', 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/statements/users/{tenantUserId}/{periodStart}/{periodEnd}",
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/statements/users/{tenantUserId}/{periodStart}/{periodEnd}"

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/statements/users/{tenantUserId}/{periodStart}/{periodEnd}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}")

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": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "TenantUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "periodStart": "2023-11-07T05:31:56Z",
    "periodEnd": "2023-11-07T05:31:56Z",
    "flags": {
      "onHold": true,
      "disputed": true
    },
    "gross": "<string>",
    "net": "<string>",
    "paidAmount": "<string>",
    "priorBalance": "<string>",
    "reportingCurrency": "USD",
    "frozenAt": "2023-11-07T05:31:56Z",
    "lastCalculatedAt": "2023-11-07T05:31:56Z",
    "statusHistory": [
      {
        "status": "<string>",
        "at": "2023-11-07T05:31:56Z",
        "actorUserId": "<string>",
        "reason": "<string>"
      }
    ],
    "breakdown": [
      {}
    ],
    "deductionsBreakdown": [
      {}
    ],
    "paymentHistory": [
      {}
    ],
    "perSplit": [
      {
        "splitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "splitName": "<string>",
        "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "assetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "upc": "<string>",
        "isrc": "<string>",
        "periodRef": "2023-12-25",
        "gross": "<string>",
        "net": "<string>",
        "currency": "USD"
      }
    ],
    "adjustments": [
      {}
    ],
    "statefulStatementsEnabled": true
  }
}
{
"status": "error",
"message": "Unauthorized"
}
{
"status": "error",
"message": "Resource not found"
}

Description

Get statement detail Returns the statement for (tenantUserId, periodStart..periodEnd). Dual-path:
  • If a persisted Statement row exists, it is returned as-is.
  • Otherwise the response is synthesized from aggregated LedgerEntries and marked readFrom='ledger_fallback'.
Artists cannot view drafts via this endpoint. Admins can. New in 4a.0 redesign §08g: the perSplit field on the response carries the per-contract breakdown for the window, sourced from UserAccountingProjection.SplitId IS NOT NULL. Empty [] when the tenant is still on the row-per-fact ledger. Authorization:
  • Required role: user or higher

Code Examples

const response = await fetch('https://api.royalti.io/statements/users/example-id/2026-01-01T00:00:00.000Z/2026-04-01T00:00:00.000Z', {
  method: 'GET',
});

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

response = requests.get(
  'https://api.royalti.io/statements/users/example-id/2026-01-01T00:00:00.000Z/2026-04-01T00:00:00.000Z',
)

data = response.json()
print(data)
curl -X GET https://api.royalti.io/statements/users/example-id/2026-01-01T00:00:00.000Z/2026-04-01T00:00:00.000Z \

Authorizations

Authorization
string
header
required

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

Path Parameters

tenantUserId
string<uuid>
required
periodStart
string<date-time>
required
periodEnd
string<date-time>
required

Response

Statement detail fetched.

Every statements response wraps the payload in { status, message, data }. data carries the per-endpoint payload PLUS the per-tenant feature flag.

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