Recoupment status across sub-publishing agreements
dimension: "eventType" over RecoupmentLedger — one row per
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 capability enabled.
Code Examples
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Query Parameters
Inclusive ISO date (YYYY-MM-DD). Filters by statement-period overlap unless the endpoint notes otherwise.
Inclusive ISO date (YYYY-MM-DD).
Comma-joined list of source PROs. OR within the param, AND against the other filters. An unknown value is a 400.
Comma-joined list of PR/MR/SR, or UNSPECIFIED for the null bucket the endpoints publish. An unknown value is a 400.
Comma-joined list of territories as reported on the line, or UNSPECIFIED for the null bucket. Open set - not validated.
Comma-joined Publisher ids, applied through the parent statement. The BigQuery projection has no publisher entity, so that reading is skipped for the request and meta.filters.bigquery is "skipped".
Comma-joined list of unmatched/matched/disputed/ignored. disputed and ignored have no counterpart in the BigQuery projection, so that reading contributes nothing for them. An unknown value is a 400.
Response
Recoupment status fetched.