Skip to main content
GET
Cross-publisher statements list

Description

Cross-publisher PublisherStatement list Lists PublisherStatement rows across ALL publishers for the active tenant (Phase 2 backfill). Distinct from the per-user Statement roster documented throughout the rest of this file — this reads the publisher-royalty-statement resource whose per-publisher CRUD and reconciliation surface lives at /publisher/publishers/{id}/statements/... (see publishers.yaml). Registered as /statements/publisher (not nested under /publisher/...) because it belongs to the statementRoutes router, mounted at /statements. Requires an active publisher add-on for the tenant (checkAddon('publisher')) in addition to the admin role. Authorization:
  • Required role: admin or higher

Code Examples

Authorizations

Authorization
string
header
required

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

Query Parameters

publisherId
string<uuid>
status
enum<string>

Single status or comma-separated list.

Available options:
draft,
pending,
approved,
paid
currency
string
Example:

"USD"

periodStart
string<date>

Inclusive lower bound on periodStart.

periodEnd
string<date>

Inclusive upper bound on periodEnd.

page
integer
size
integer

Default 20, max 100.

Response

Statements fetched, ordered by periodStart DESC. Omit page/size for the unpaginated { count, PublisherStatements } shape.

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