Sign off a month-end checklist item

Outcome

Tick or untick one item of a period's month-end checklist (bank_reconciled, receipts_attached, accruals_posted, invoices_issued, tax_reviewed, statements_reviewed) with an optional note. Recorded with who did it and when, and written to the audit trail.

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.checklist.set --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

PUT /api/periods/{periodKey}/checklist

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

• Records or clears one sign-off on the period's checklist, with the actor and time, and writes the change to the audit trail. Nothing posts to the ledger.

Interpret the response

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

Call app_topolo_books.periods.close_health.get for the period and confirm the item shows doneAt.

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.checklist.set --data @payload.json --json
topolo actions plan app_topolo_books.periods.checklist.set --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.periods.checklist.set --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.checklist.set",
    "input": {
      "periodKey": "2026-03",
      "itemKey": "tax_reviewed",
      "done": true
    },
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "confirm": true,
    "detail": true
  }
}

Successful response · HTTP 200

Input · payload.json:

{
  "periodKey": "2026-03",
  "itemKey": "tax_reviewed",
  "done": true
}

Captured response · HTTP 200

{
  "periodKey": "2026-03",
  "item": {
    "key": "tax_reviewed",
    "doneAt": "2026-10-05T19:42:50.344Z",
    "doneBy": "usr_test",
    "note": null
  }
}

HTTP 200. Call app_topolo_books.periods.close_health.get for the period and confirm the item shows doneAt.

Refused response · forbidden

Input · payload.json:

{
  "periodKey": "2026-03",
  "itemKey": "tax_reviewed",
  "done": true
}

Captured response · HTTP 403

{
  "error": "forbidden"
}

HTTP 403. SDK error code forbidden. The credential lacks permission or the resource is outside its scope. Compare the published action permission and discovered workspace binding; obtain the appropriate authorization before another call.

Refused response · auth_error

Input · payload.json:

{
  "periodKey": "2026-06",
  "itemKey": "bank_reconciled",
  "done": true,
  "note": "Mercury reconciled to statement"
}

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.

Verify the result

• Call app_topolo_books.periods.close_health.get for the period and confirm the item shows doneAt.

Errors and recovery

• forbidden (HTTP 403): The credential lacks permission or the resource is outside its scope. Compare the published action permission and discovered workspace binding; obtain the appropriate authorization before another call.
• 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

Send the same item with done reversed.

Related actions

• Get month-end close health: What still stands between a month and a clean close: ledger chain verified, unmatched bank lines, draft journals, reversals and recurring journals due, draft invoices and bills, unsent invoices, overdue receivables, the period lock and (in the last month of the year) whether the year end is closed. Each signal carries a count, the money it holds and the screen that clears it, plus the period's sign-off checklist and an overall readiness of ready, attention or blocked.
• 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.
• List accounting periods: List the monthly accounting periods and their lock status, optionally for one fiscal year.

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.