Skip to main content
POST
Close a finalized statement period

Description

Close period Transitions every finalized Statement in the tenant’s window (parentStatementId IS NULL) to closed, stamping closedReason (paid_full / unrecouped / zero_balance) from the closing balance. Distinct from POST /statements/periods/notify, which publishes an already-closed period to members — the intended flow is close, review, then notify. Authorization:
  • Required role: admin or higher

Code Examples

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
grain
enum<string>

Defaults to the tenant's statementPeriodGrain when omitted.

Available options:
month,
quarter,
semester,
year

Response

Period closed.

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