Bulk-render writer and/or publisher statement PDFs as one zip

curl --request POST \
  --url https://api.royalti.io/publisher/statements/bulk-render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "periodStart": "2023-12-25",
  "periodEnd": "2023-12-25",
  "statementIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "tenantUserIds": [
    "<string>"
  ]
}
'

import requests

url = "https://api.royalti.io/publisher/statements/bulk-render"

payload = {
    "periodStart": "2023-12-25",
    "periodEnd": "2023-12-25",
    "statementIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "tenantUserIds": ["<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({
    periodStart: '2023-12-25',
    periodEnd: '2023-12-25',
    statementIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    tenantUserIds: ['<string>']
  })
};

fetch('https://api.royalti.io/publisher/statements/bulk-render', 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/statements/bulk-render",
  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([
    'periodStart' => '2023-12-25',
    'periodEnd' => '2023-12-25',
    'statementIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'tenantUserIds' => [
        '<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/statements/bulk-render"

	payload := strings.NewReader("{\n  \"periodStart\": \"2023-12-25\",\n  \"periodEnd\": \"2023-12-25\",\n  \"statementIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tenantUserIds\": [\n    \"<string>\"\n  ]\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/statements/bulk-render")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"periodStart\": \"2023-12-25\",\n  \"periodEnd\": \"2023-12-25\",\n  \"statementIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tenantUserIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publisher/statements/bulk-render")

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  \"periodStart\": \"2023-12-25\",\n  \"periodEnd\": \"2023-12-25\",\n  \"statementIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tenantUserIds\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

"<string>"

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

POST

publisher

statements

bulk-render

Bulk-render writer and/or publisher statement PDFs as one zip

curl --request POST \
  --url https://api.royalti.io/publisher/statements/bulk-render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "periodStart": "2023-12-25",
  "periodEnd": "2023-12-25",
  "statementIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "tenantUserIds": [
    "<string>"
  ]
}
'

import requests

url = "https://api.royalti.io/publisher/statements/bulk-render"

payload = {
    "periodStart": "2023-12-25",
    "periodEnd": "2023-12-25",
    "statementIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "tenantUserIds": ["<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({
    periodStart: '2023-12-25',
    periodEnd: '2023-12-25',
    statementIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    tenantUserIds: ['<string>']
  })
};

fetch('https://api.royalti.io/publisher/statements/bulk-render', 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/statements/bulk-render",
  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([
    'periodStart' => '2023-12-25',
    'periodEnd' => '2023-12-25',
    'statementIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'tenantUserIds' => [
        '<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/statements/bulk-render"

	payload := strings.NewReader("{\n  \"periodStart\": \"2023-12-25\",\n  \"periodEnd\": \"2023-12-25\",\n  \"statementIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tenantUserIds\": [\n    \"<string>\"\n  ]\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/statements/bulk-render")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"periodStart\": \"2023-12-25\",\n  \"periodEnd\": \"2023-12-25\",\n  \"statementIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tenantUserIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publisher/statements/bulk-render")

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  \"periodStart\": \"2023-12-25\",\n  \"periodEnd\": \"2023-12-25\",\n  \"statementIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"tenantUserIds\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

"<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

POST /publisher/statements/bulk-render Scopes and renders statement PDFs for a period window, zipping the results (application/zip) rather than returning JSON. kind selects which PDF families render: writer (per-writer statements), publisher (per-publisher statements), or both. Optional statementIds/tenantUserIds narrow the scope further within the period; omitted, every eligible statement/writer in the tenant for the window is rendered. Capped at 100 PDFs total across the batch — once reached, the remaining eligible entries are skipped (not erred) and a PDF cap (100) reached warning is added. Any per-entry render failure is likewise a warning, not a request failure: the zip only ever contains successful renders. If warnings is non-empty, the response also carries an X-Bulk-Render-Warnings header (count) so a client can detect partial failure without parsing the zip body. A request whose scope produces zero renderable PDFs returns 400 instead of an empty zip. Authorization: admin role + publisher addon.

Code Examples

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

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

import requests

response = requests.post(
  'https://api.royalti.io/publisher/statements/bulk-render',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"ref":"#/components/schemas/BulkRenderStatementsRequest"}
)

data = response.json()
print(data)

curl -X POST https://api.royalti.io/publisher/statements/bulk-render \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ref":"#/components/schemas/BulkRenderStatementsRequest"}'

Authorizations

Authorization

string

header

required

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

Body

application/json

periodStart

string<date>

required

periodEnd

string<date>

required

Must be strictly after periodStart.

kind

enum<string>

required

Available options:

writer,

publisher,

both

statementIds

string<uuid>[]

Optional narrowing within the period window.

tenantUserIds

string[]

Optional narrowing to specific writer TenantUsers within the period window.

Response

Zip of rendered PDFs. Check the X-Bulk-Render-Warnings header for partial per-entry failures.

The response is of type file.

​Description

​Code Examples

Authorizations

Body

Response

Description

Code Examples