Unlock an accounting period

Outcome

Reopen a locked period. The reopen is audited.

Before you start

• Verify the intended environment, authenticated identity and specifically approved organization context.
• The published application permission is periods:write. Discover the exact granted canonical Books workspace and bind it separately from action input.
• Approve the actual mutation, accounting inputs and any provider/recipient effects before CLI --confirm or MCP confirm:true. Fixture identifiers and simulated provider responses authorize no live operation.

Discover the target

topolo whoami --json
topolo actions get app_topolo_books.periods.unlock --detail --json
topolo resources topolo-books --json
topolo workspaces list topolo-books --json

• Set BOOKS_WORKSPACE_ID to the exact granted workspace returned by discovery.

Request

POST /api/periods/{periodKey}/unlock

Inspect and test this action. Save the reviewed input as payload.json; supply credential/resource context separately.

Input fields

Inspect nested fields and the complete input schema.

Effects

• Reopens a locked period so postings are accepted again. The reopen is written to the audit trail.

Interpret the response

Read $.period.period_key for the returned accounting_period identifier. Empty collections and nullable fields do not discover a target.

Call app_topolo_books.periods.list and confirm the status is open.

Inspect the success schema. CLI/MCP add their own transport envelope; CLI --detail requests the full result.

Worked examples

Actual Books route handlers and the exported Worker were exercised against five local SQLite D1 concern databases with all committed migrations, the real posting Durable Object and local R2. Route captures use synthetic verified Auth; Worker captures use synthetic Auth transports. Nexus, Brand, Notify, Pay, Mercury and Xero responses are explicitly simulated at the provider transport boundary. Captures prove local request/response behavior and canonical SDK projection, not live bank access, payment movement, email delivery, provider eligibility, tax compliance, encrypted custody, scheduled execution, deployment or production completion. Fixture identities, credentials, addresses and records authorize no live operation.

Run a reviewed request

Save the input from the selected worked example as payload.json. Validate and inspect the plan before calling the action; refused examples demonstrate errors and are not instructions to execute.

CLI:

topolo actions validate app_topolo_books.periods.unlock --data @payload.json --json
topolo actions plan app_topolo_books.periods.unlock --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.periods.unlock --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --confirm --detail --json

MCP tool and arguments for the first successful example:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_books.periods.unlock",
    "input": {
      "periodKey": "2026-09"
    },
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "confirm": true,
    "detail": true
  }
}

Refused response · auth_error

Input · payload.json:

{
  "periodKey": "2026-01",
  "reason": "Late supplier invoice"
}

Captured response · HTTP 401

{
  "error": "API key validation failed"
}

HTTP 401. SDK error code auth_error. Authenticate in the intended organization again. Verify whoami and the exact Books application/workspace binding before retrying; do not switch identity to work around a refusal.

Successful response · HTTP 200

Input · payload.json:

{
  "periodKey": "2026-09"
}

Captured response · HTTP 200

{
  "period": {
    "id": "per_7f4e2b76e819459db615ce3ace927434",
    "organization_id": "org_route_muvnp2sb19",
    "workspace_id": "ws_route_muvnp2sb19",
    "period_key": "2026-09",
    "start_date": "2026-09-01",
    "end_date": "2026-09-30",
    "fiscal_year": 2026,
    "status": "open",
    "locked_at": null,
    "locked_by": null,
    "lock_reason": null,
    "created_at": "2026-10-05T19:42:12.858Z",
    "updated_at": "2026-10-05T19:42:12.895Z"
  }
}

HTTP 200. Call app_topolo_books.periods.list and confirm the status is open.

Verify the result

• Call app_topolo_books.periods.list and confirm the status is open.

Errors and recovery

• auth_error (HTTP 401): Authenticate in the intended organization again. Verify whoami and the exact Books application/workspace binding before retrying; do not switch identity to work around a refusal.

These are observed local refusals. Shared authentication, schema validation and resource authorization can also refuse before the route. Preserve the actual error, details and request id.

Recovery boundary

Lock the period again once the correction is posted.

Related actions

• List accounting periods: List the monthly accounting periods and their lock status, optionally for one fiscal year.
• Lock an accounting period: Soft-lock (override possible) or hard-lock (nothing posts) a YYYY-MM period. Postings into a locked period are refused with period_locked.

Evidence

Actual Books route handlers and the exported Worker were exercised against five local SQLite D1 concern databases with all committed migrations, the real posting Durable Object and local R2. Route captures use synthetic verified Auth; Worker captures use synthetic Auth transports. Nexus, Brand, Notify, Pay, Mercury and Xero responses are explicitly simulated at the provider transport boundary. Captures prove local request/response behavior and canonical SDK projection, not live bank access, payment movement, email delivery, provider eligibility, tax compliance, encrypted custody, scheduled execution, deployment or production completion. Fixture identities, credentials, addresses and records authorize no live operation.