Skip to main content
GET
/
statements
/
users
/
{tenantUserId}
/
{periodStart}
/
{periodEnd}
/
pdf
Download statement as PDF
curl --request GET \
  --url https://api.royalti.io/statements/users/{tenantUserId}/{periodStart}/{periodEnd}/pdf \
  --header 'Authorization: Bearer <token>'
import requests

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

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}/pdf', 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}/pdf",
  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}/pdf"

	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}/pdf")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

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

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
"<string>"
{
  "status": "error",
  "message": "Unauthorized"
}
{
  "status": "error",
  "message": "Resource not found"
}

Description

Download statement PDF Sibling of GET /statements/users/{tenantUserId}/{periodStart}/{periodEnd} (same URL plus /pdf) — streams the rendered statement (same branding + currency conversion as the emailed PDF) as a PDF attachment instead of a JSON envelope. Registered ahead of the JSON detail route on the router so /pdf is never swallowed by the period path params. Same self-or-admin guard and draft-visibility rule as the JSON detail endpoint: members cannot download an editable draft Statement row (readFrom='table', status='draft'); ledger-fallback rows are allowed since they represent immutable ledger facts. 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/pdf', {
  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/pdf',
)

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/pdf \

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

PDF stream. Cache-Control: no-store (financial document).

The response is of type file.