Skip to main content
GET
Recoupment status across sub-publishing agreements
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

eventType enum with amount/eventCount. totals.outstandingBalance is the FX-normalized (best-effort) sum of each agreement’s most-recent balance. Unlike the other analytics endpoints, the period range here filters the ledger’s eventDate directly (meta.periodBasis: "ledger-event-date"), not a statement-period overlap — with a range supplied, the outstanding balance is the running balance as of periodEnd (or latest, if no end given). Authorization: user role + publisher addon.

Code Examples

Authorizations

Authorization
string
header
required

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

Query Parameters

periodStart
string<date>

Inclusive ISO date (YYYY-MM-DD). Filters by statement-period overlap unless the endpoint notes otherwise.

periodEnd
string<date>

Inclusive ISO date (YYYY-MM-DD).

Response

Recoupment status 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

Uniform aggregation shape returned by every /analytics/* endpoint (locked contract, G-ANALYTICS).