Topolo Docs Topolo Platform
Open workspace

Get the continuous-close dashboard

Summarise the current close and up to twelve recent accounting periods: readiness, outstanding signals, checklist progress, and the three highest-priority actions for this week. This is the same live close overview shown on the Books Periods page.

Outcome

Summarise the current close and up to twelve recent accounting periods: readiness, outstanding signals, checklist progress, and the three highest-priority actions for this week. This is the same live close overview shown on the Books Periods page.

Before you start

  • Verify the intended environment, authenticated identity and specifically approved organization context.
  • The published application permission is periods:read. Discover the exact granted canonical Books workspace and bind it separately from action input.

Discover the target

topolo whoami --json
topolo actions get app_topolo_books.periods.close_dashboard.get --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

GET /api/periods/close-dashboard

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

Input fields

FieldRequiredMeaningSchema and constraints
asOfOptionalas Of{"type":"string","pattern":"^\d{4}-\d{2}-\d{2}$"}
monthsOptionalmonths{"type":"integer","minimum":3,"maximum":12}

Inspect nested fields and the complete input schema.

Effects

  • Reads close-health signals and checklist progress for the current month and recent recorded periods without changing accounting data.

Interpret the response

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

No verification is needed for a read. The first period is the asOf month and each period can be read in full with app_topolo_books.periods.close_health.get.

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.close_dashboard.get --data @payload.json --json
topolo actions plan app_topolo_books.periods.close_dashboard.get --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.periods.close_dashboard.get --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --detail --json

MCP tool and arguments for the first successful example:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_books.periods.close_dashboard.get",
    "input": {
      "asOf": "2026-03-15",
      "months": 3
    },
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "detail": true
  }
}

Successful response · HTTP 200

Input · payload.json:

{
  "asOf": "2026-03-15",
  "months": 3
}

Captured response · HTTP 200

{
  "generatedAt": "2026-10-05T19:42:50.351Z",
  "asOf": "2026-03-15",
  "periods": [
    {
      "period": {
        "periodKey": "2026-03",
        "startDate": "2026-03-01",
        "endDate": "2026-03-31",
        "fiscalYear": 2026,
        "status": "not_started"
      },
      "readiness": "attention",
      "signals": [
        {
          "key": "ledger_verified",
          "severity": "ok",
          "count": 0,
          "amountMinor": null,
          "currency": null,
          "path": "/dashboard/trial-balance"
        },
        {
          "key": "unmatched_bank_lines",
          "severity": "ok",
          "count": 0,
          "amountMinor": 0,
          "currency": "USD",
          "path": "/dashboard/banking/reconcile?from=2026-03-01&to=2026-03-31"
        },
        {
          "key": "draft_journals",
          "severity": "ok",
          "count": 0,
          "amountMinor": null,
          "currency": null,
          "path": "/dashboard/journals"
        },
        {
          "key": "reversals_due",
          "severity": "ok",
          "count": 0,
          "amountMinor": null,
          "currency": null,
          "path": "/dashboard/journals"
        },
        {
          "key": "recurring_due",
          "severity": "ok",
          "count": 0,
          "amountMinor": null,
          "currency": null,
          "path": "/dashboard/journals/recurring"
        },
        {
          "key": "draft_invoices",
          "severity": "ok",
          "count": 0,
          "amountMinor": 0,
          "currency": "USD",
          "path": "/dashboard/invoices"
        },
        {
          "key": "draft_bills",
          "severity": "ok",
          "count": 0,
          "amountMinor": 0,
          "currency": "USD",
          "path": "/dashboard/bills"
        },
        {
          "key": "unsent_invoices",
          "severity": "ok",
          "count": 0,
          "amountMinor": 0,
          "currency": "USD",
          "path": "/dashboard/invoices"
        },
        {
          "key": "overdue_receivables",
          "severity": "ok",
          "count": 0,
          "amountMinor": 0,
          "currency": "USD",
          "path": "/dashboard/reports/aged-receivables?asOf=2026-03-31"
        },
        {
          "key": "period_locked",
          "severity": "info",
          "count": 1,
          "amountMinor": null,
          "currency": null,
          "path": "/dashboard/periods"
        }
      ],
      "checklist": [
        {
          "key": "bank_reconciled",
          "doneAt": null,
          "doneBy": null,
          "note": null
        },
        {
          "key": "receipts_attached",
          "doneAt": null,
          "doneBy": null,
          "note": null
        },
        {
          "key": "accruals_posted",
          "doneAt": null,
          "doneBy": null,
          "note": null
        },
        {
          "key": "invoices_issued",
          "doneAt": null,
          "doneBy": null,
          "note": null
        },
        {
          "key": "tax_reviewed",
          "doneAt": "2026-10-05T19:42:50.344Z",
          "doneBy": "usr_test",
          "note": null
        },
        {
          "key": "statements_reviewed",
          "doneAt": null,
          "doneBy": null,
          "note": null
        }
      ],
      "yearEnd": {
        "fiscalYear": 2026,
        "endsThisPeriod": false,
        "closed": false
      }
    }
  ],
  "totals": {
    "ready": 0,
    "attention": 1,
    "blocked": 0,
    "openSignals": 1,
    "checklistCompleted": 1,
    "checklistTotal": 6
  },
  "weeklySummary": {
    "periodKey": "2026-03",
    "readiness": "attention",
    "blockerSignals": 0,
    "warningSignals": 0,
    "informationSignals": 1,
    "checklistCompleted": 1,
    "checklistTotal": 6,
    "nextActions": [
      {
        "key": "period_locked",
        "severity": "info",
        "count": 1,
        "amountMinor": null,
        "currency": null,
        "path": "/dashboard/periods"
      }
    ]
  }
}

HTTP 200. No verification is needed for a read. The first period is the asOf month and each period can be read in full with app_topolo_books.periods.close_health.get.

Refused response · auth_error

Input · payload.json:

{
  "asOf": "2026-09-08",
  "months": 6
}

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

  • No verification is needed for a read. The first period is the asOf month and each period can be read in full with app_topolo_books.periods.close_health.get.

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

This action is read-only.

  • 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.
  • Sign off a month-end checklist item: 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.
  • 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.