Topolo Docs Topolo Platform
Open workspace

Get onboarding status

How far the workspace is from being a working set of books, read from what is in it: settings, chart, invoice details, tax rates, opening balances, bank accounts and their ledger links, contacts, the first invoice and bill, statement lines, reconciled lines and a locked month. Each step says whether it is done, what was counted and the Books screen where it is done. nextStep names the first required step still open.

Outcome

How far the workspace is from being a working set of books, read from what is in it: settings, chart, invoice details, tax rates, opening balances, bank accounts and their ledger links, contacts, the first invoice and bill, statement lines, reconciled lines and a locked month. Each step says whether it is done, what was counted and the Books screen where it is done. nextStep names the first required step still open.

Before you start

  • Verify the intended environment, authenticated identity and specifically approved organization context.
  • The published application permission is settings: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.onboarding.status.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/onboarding

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

Input fields

Use an empty input object. Credential and resource context are separate.

Inspect nested fields and the complete input schema.

Effects

  • Reads the selected Books onboarding result in the credential-scoped organization and applicable canonical workspace. How far the workspace is from being a working set of books, read from what is in it: settings, chart, invoice details, tax rates, opening balances, bank accounts and their ledger links, contacts, the first invoice and bill, statement lines, reconciled lines and a locked month. Each step says whether it is done, what was counted and the Books screen where it is done. nextStep names the first required step still open.

Interpret the response

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

Inspect the actual response fields and retained identifiers for the selected organization/workspace. How far the workspace is from being a working set of books, read from what is in it: settings, chart, invoice details, tax rates, opening balances, bank accounts and their ledger links, contacts, the first invoice and bill, statement lines, reconciled lines and a locked month. Each step says whether it is done, what was counted and the Books screen where it is done. nextStep names the first required step still open. Use the related published read actions when a returned record or ledger outcome needs further inspection; an HTTP 200 does not establish provider delivery or financial agreement.

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.onboarding.status.get --data @payload.json --json
topolo actions plan app_topolo_books.onboarding.status.get --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.onboarding.status.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.onboarding.status.get",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "detail": true
  }
}

Refused response · auth_error

Input · payload.json:

{}

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.

Refused response · forbidden

Input · payload.json:

{}

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.

Successful response · HTTP 200

Input · payload.json:

{}

Captured response · HTTP 200

{
  "workspaceId": "ws_onb_muvnq9rt3",
  "initialised": false,
  "steps": [
    {
      "key": "workspace_settings",
      "stage": "setup",
      "optional": false,
      "path": "/settings/books",
      "done": false,
      "count": null
    },
    {
      "key": "chart_of_accounts",
      "stage": "setup",
      "optional": false,
      "path": "/dashboard/accounts",
      "done": false,
      "count": 0
    },
    {
      "key": "invoice_details",
      "stage": "setup",
      "optional": false,
      "path": "/settings/invoices",
      "done": false,
      "count": null
    },
    {
      "key": "tax_rates",
      "stage": "setup",
      "optional": false,
      "path": "/settings/tax",
      "done": false,
      "count": 0
    },
    {
      "key": "opening_balances",
      "stage": "setup",
      "optional": true,
      "path": "/settings/opening-balances",
      "done": false,
      "count": null
    },
    {
      "key": "bank_account",
      "stage": "transactions",
      "optional": false,
      "path": "/settings/bank",
      "done": false,
      "count": 0
    },
    {
      "key": "bank_linked",
      "stage": "transactions",
      "optional": false,
      "path": "/dashboard/banking",
      "done": false,
      "count": 0
    },
    {
      "key": "contacts",
      "stage": "transactions",
      "optional": false,
      "path": "/dashboard/contacts",
      "done": false,
      "count": 0
    },
    {
      "key": "first_invoice",
      "stage": "transactions",
      "optional": false,
      "path": "/dashboard/invoices/new",
      "done": false,
      "count": 0
    },
    {
      "key": "first_bill",
      "stage": "transactions",
      "optional": true,
      "path": "/dashboard/bills/new",
      "done": false,
      "count": 0
    },
    {
      "key": "bank_lines",
      "stage": "close",
      "optional": false,
      "path": "/dashboard/banking",
      "done": false,
      "count": 0
    },
    {
      "key": "reconciled",
      "stage": "close",
      "optional": false,
      "path": "/dashboard/banking/reconcile",
      "done": false,
      "count": 0
    },
    {
      "key": "month_closed",
      "stage": "close",
      "optional": false,
      "path": "/dashboard/periods",
      "done": false,
      "count": 0
    }
  ],
  "completed": 0,
  "total": 11,
  "nextStep": "workspace_settings"
}

HTTP 200. Inspect the actual response fields and retained identifiers for the selected organization/workspace. How far the workspace is from being a working set of books, read from what is in it: settings, chart, invoice details, tax rates, opening balances, bank accounts and their ledger links, contacts, the first invoice and bill, statement lines, reconciled lines and a locked month. Each step says whether it is done, what was counted and the Books screen where it is done. nextStep names the first required step still open. Use the related published read actions when a returned record or ledger outcome needs further inspection; an HTTP 200 does not establish provider delivery or financial agreement.

Verify the result

  • Inspect the actual response fields and retained identifiers for the selected organization/workspace. How far the workspace is from being a working set of books, read from what is in it: settings, chart, invoice details, tax rates, opening balances, bank accounts and their ledger links, contacts, the first invoice and bill, statement lines, reconciled lines and a locked month. Each step says whether it is done, what was counted and the Books screen where it is done. nextStep names the first required step still open.
  • Use the related published read actions when a returned record or ledger outcome needs further inspection; an HTTP 200 does not establish provider delivery or financial agreement.

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.
  • 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.

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

Repeat a read in the same authorized context; no state is changed.

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.