Skip to main content
PATCH
Transition a statement's status
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

PATCH /publisher/publishers//statements//status Enforces the locked status state machine (see the Publisher Statements tag description). Setting status to the current value is a no-op (200, unchanged). Approving a statement applies recoupment in the same transaction (H-08) — the response envelope carries an additive recoupment key when that ran, or warning when un-approving a statement that already produced ledger rows. Authorization: admin role + publisher addon.

Code Examples

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required
statementId
string<uuid>
required

Body

application/json
status
enum<string>
required

Allowed transitions: draft→pending, pending→approved|draft, approved→paid|pending. paid is terminal.

Available options:
draft,
pending,
approved,
paid

Response

Status updated (or unchanged).

Standard server envelope used by the statement, reconciliation, sub-publishing, and analytics endpoints.

status
enum<string>
Available options:
success,
error
message
string
data
object
recoupment
object | null
warning
string | null