Outcome
Get the Books TopoloOne widget v3: live journal, invoice, receipt, receivable and payable figures plus confirmation-gated journal-draft and saved-bank-rule controls.
Before you start
- Verify the intended environment, authenticated identity and specifically approved organization context.
- The published application permission is workspace: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.widget.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/widget
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 widget result in the credential-scoped organization and applicable canonical workspace. Get the Books TopoloOne widget v3: live journal, invoice, receipt, receivable and payable figures plus confirmation-gated journal-draft and saved-bank-rule controls.
Interpret the response
Read $.widgets[].id for the returned widget identifier. Empty collections and nullable fields do not discover a target.
Inspect the actual response fields and retained identifiers for the selected organization/workspace. Get the Books TopoloOne widget v3: live journal, invoice, receipt, receivable and payable figures plus confirmation-gated journal-draft and saved-bank-rule controls. 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.widget.get --data @payload.json --json
topolo actions plan app_topolo_books.widget.get --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.widget.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.widget.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.
Successful response · HTTP 200
Input · payload.json:
{}
Captured response · HTTP 200
{
"success": true,
"contractVersion": "3.0.0",
"appId": "app_topolo_books",
"serviceName": "Books",
"generatedAt": "2026-10-05T19:42:19.250Z",
"widgets": [
{
"id": "books.workspace-summary",
"version": "3.0.0",
"serviceIcon": "📚",
"type": "stats",
"presentation": {
"title": "Books workspace summary",
"description": "Live invoice, receipt and outstanding-balance totals for this Books workspace.",
"contexts": [
"workspace"
],
"supportedSizes": [
"compact",
"medium",
"wide"
],
"defaultSize": "medium"
},
"resource": {
"resourceType": "workspace",
"resourceId": "ws_e2e_muvnp7qn2",
"requiredPermissions": [
"workspace:read"
]
},
"state": {
"status": "empty",
"observedAt": "2026-10-05T19:42:19.250Z",
"lastSuccessfulAt": "2026-10-05T19:42:19.250Z",
"code": "no_accounting_activity",
"message": "No invoices, receipts or journals have been recorded yet."
},
"refresh": {
"intervalSeconds": 60,
"timeoutSeconds": 10,
"maxAgeSeconds": 60,
"staleWhileRevalidateSeconds": 120
},
"configuration": {
"allowMultipleInstances": true,
"fields": [
{
"key": "metricKeys",
"label": "Metrics",
"type": "multi-select",
"required": true,
"options": [
{
"value": "invoices",
"label": "Invoices"
},
{
"value": "receipts",
"label": "Receipts"
},
{
"value": "receivable",
"label": "Receivable"
},
{
"value": "payable",
"label": "Payable"
}
]
}
],
"defaults": {
"metricKeys": [
"invoices",
"receipts",
"receivable",
"payable"
]
}
},
"drilldowns": [
{
"id": "workspace",
"label": "Open Books workspace",
"href": "/dashboard"
},
{
"id": "getting-started",
"label": "View Books getting started",
"href": "/dashboard/getting-started"
}
],
"controls": [
{
"id": "create-journal-draft",
"label": "Create journal draft",
"actionId": "app_topolo_books.journals.drafts.create",
"resourceType": "workspace",
"resourceId": "ws_e2e_muvnp7qn2",
"input": {},
"requiresConfirmation": true,
"destructive": false,
"effects": [
"Creates one empty, editable journal draft. It does not post anything to the ledger."
],
"verification": [
"Read journal drafts and confirm the returned draft is present and still unposted."
],
"recovery": {
"mode": "compensating_action",
"actionId": "app_topolo_books.journals.drafts.delete",
"instructions": "Delete the returned unposted draft if it is not needed."
}
},
{
"id": "apply-bank-rules",
"label": "Apply saved bank rules",
"actionId": "app_topolo_books.bank.rules.apply",
"resourceType": "workspace",
"resourceId": "ws_e2e_muvnp7qn2",
"input": {
"dryRun": false
},
"requiresConfirmation": true,
"destructive": false,
"effects": [
"Applies active saved rules to eligible unmatched bank lines and posts their coding journals."
],
"verification": [
"Read bank lines and confirm the expected eligible lines are matched and identify their posted journals."
],
"recovery": {
"mode": "compensating_action",
"actionId": "app_topolo_books.bank.lines.unmatch",
"instructions": "Unmatch an incorrectly coded line after reviewing its posted journal."
}
}
],
"localization": {
"locale": "en",
"titleKey": "books.api.widget.title",
"descriptionKey": "books.api.widget.summary"
},
"accessibility": {
"label": "Books workspace metrics",
"description": "Live invoice, receipt and outstanding-balance totals for this Books workspace."
},
"contribution": {
"summary": "Accounting activity and outstanding balances for the selected Books workspace.",
"identity": {
"iconSource": "catalog"
},
"workspaceSelector": {
"mode": "required",
"resourceType": "workspace",
"label": "Books workspace",
"supportsMultiple": false
},
"metricDefinitions": [
{
"key": "invoices",
"label": "Invoices",
"description": "Number of invoices in the workspace.",
"unit": "count",
"semantic": "gauge",
"aggregation": "last"
},
{
"key": "receipts",
"label": "Receipts",
"description": "Number of receipts in the workspace.",
"unit": "count",
"semantic": "gauge",
"aggregation": "last"
},
{
"key": "receivable",
"label": "Receivable",
"description": "Current receivable balance.",
"unit": "currency",
"semantic": "currency",
"aggregation": "last"
},
{
"key": "payable",
"label": "Payable",
"description": "Current payable balance.",
"unit": "currency",
"semantic": "currency",
"aggregation": "last"
}
],
"seriesDefinitions": [],
"dimensions": [],
"lifecycleStages": [],
"events": [],
"datasets": [
{
"id": "books.workspace-summary",
"label": "Books workspace summary",
"description": "Current accounting totals for one workspace.",
"grain": "workspace",
"metricKeys": [
"invoices",
"receipts",
"receivable",
"payable"
],
"seriesKeys": [],
"dimensionKeys": [],
"eventKeys": [],
"actionIds": [
"create-journal-draft",
"apply-bank-rules"
]
}
],
"compatibleVisualizations": [
"number",
"bar",
"table"
],
"defaultVisualization": "number"
},
"metrics": [
{
"key": "invoices",
"label": "Invoices",
"value": 0,
"unit": "count",
"semantic": "gauge",
"aggregation": "last",
"period": {
"start": "2026-10-05T19:42:19.250Z",
"end": "2026-10-05T19:42:19.250Z",
"timezone": "UTC"
},
"dimensions": []
},
{
"key": "receipts",
"label": "Receipts",
"value": 0,
"unit": "count",
"semantic": "gauge",
"aggregation": "last",
"period": {
"start": "2026-10-05T19:42:19.250Z",
"end": "2026-10-05T19:42:19.250Z",
"timezone": "UTC"
},
"dimensions": []
},
{
"key": "receivable",
"label": "Receivable",
"value": 0,
"unit": "GBP",
"semantic": "currency",
"aggregation": "last",
"period": {
"start": "2026-10-05T19:42:19.250Z",
"end": "2026-10-05T19:42:19.250Z",
"timezone": "UTC"
},
"dimensions": []
},
{
"key": "payable",
"label": "Payable",
"value": 0,
"unit": "GBP",
"semantic": "currency",
"aggregation": "last",
"period": {
"start": "2026-10-05T19:42:19.250Z",
"end": "2026-10-05T19:42:19.250Z",
"timezone": "UTC"
},
"dimensions": []
}
],
"appId": "app_topolo_books",
"serviceName": "Books",
"lastUpdated": "2026-10-05T19:42:19.250Z"
}
]
}
HTTP 200. Inspect the actual response fields and retained identifiers for the selected organization/workspace. Get the Books TopoloOne widget v3: live journal, invoice, receipt, receivable and payable figures plus confirmation-gated journal-draft and saved-bank-rule controls. 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.
Successful response · HTTP 200
Input · payload.json:
{}
Captured response · HTTP 200
{
"success": true,
"contractVersion": "3.0.0",
"appId": "app_topolo_books",
"serviceName": "Books",
"generatedAt": "2026-10-05T19:42:19.252Z",
"widgets": [
{
"id": "books.workspace-summary",
"version": "3.0.0",
"serviceIcon": "📚",
"type": "stats",
"presentation": {
"title": "Books workspace summary",
"description": "Live invoice, receipt and outstanding-balance totals for this Books workspace.",
"contexts": [
"workspace"
],
"supportedSizes": [
"compact",
"medium",
"wide"
],
"defaultSize": "medium"
},
"resource": {
"resourceType": "workspace",
"requiredPermissions": [
"workspace:read"
]
},
"state": {
"status": "empty",
"observedAt": "2026-10-05T19:42:19.252Z",
"code": "workspace_unavailable",
"message": "No Books workspace is available."
},
"refresh": {
"intervalSeconds": 60,
"timeoutSeconds": 10,
"maxAgeSeconds": 60,
"staleWhileRevalidateSeconds": 120
},
"configuration": {
"allowMultipleInstances": true,
"fields": [
{
"key": "metricKeys",
"label": "Metrics",
"type": "multi-select",
"required": true,
"options": [
{
"value": "invoices",
"label": "Invoices"
},
{
"value": "receipts",
"label": "Receipts"
},
{
"value": "receivable",
"label": "Receivable"
},
{
"value": "payable",
"label": "Payable"
}
]
}
],
"defaults": {
"metricKeys": [
"invoices",
"receipts",
"receivable",
"payable"
]
}
},
"drilldowns": [
{
"id": "workspace",
"label": "Open Books workspace",
"href": "/dashboard"
},
{
"id": "getting-started",
"label": "View Books getting started",
"href": "/dashboard/getting-started"
}
],
"controls": [],
"localization": {
"locale": "en",
"titleKey": "books.api.widget.title",
"descriptionKey": "books.api.widget.summary"
},
"accessibility": {
"label": "Books workspace metrics",
"description": "Live invoice, receipt and outstanding-balance totals for this Books workspace."
},
"contribution": {
"summary": "Accounting activity and outstanding balances for the selected Books workspace.",
"identity": {
"iconSource": "catalog"
},
"workspaceSelector": {
"mode": "required",
"resourceType": "workspace",
"label": "Books workspace",
"supportsMultiple": false
},
"metricDefinitions": [
{
"key": "invoices",
"label": "Invoices",
"description": "Number of invoices in the workspace.",
"unit": "count",
"semantic": "gauge",
"aggregation": "last"
},
{
"key": "receipts",
"label": "Receipts",
"description": "Number of receipts in the workspace.",
"unit": "count",
"semantic": "gauge",
"aggregation": "last"
},
{
"key": "receivable",
"label": "Receivable",
"description": "Current receivable balance.",
"unit": "currency",
"semantic": "currency",
"aggregation": "last"
},
{
"key": "payable",
"label": "Payable",
"description": "Current payable balance.",
"unit": "currency",
"semantic": "currency",
"aggregation": "last"
}
],
"seriesDefinitions": [],
"dimensions": [],
"lifecycleStages": [],
"events": [],
"datasets": [
{
"id": "books.workspace-summary",
"label": "Books workspace summary",
"description": "Current accounting totals for one workspace.",
"grain": "workspace",
"metricKeys": [
"invoices",
"receipts",
"receivable",
"payable"
],
"seriesKeys": [],
"dimensionKeys": [],
"eventKeys": [],
"actionIds": []
}
],
"compatibleVisualizations": [
"number",
"bar",
"table"
],
"defaultVisualization": "number"
},
"metrics": [
{
"key": "invoices",
"label": "Invoices",
"value": 0,
"unit": "count",
"semantic": "gauge",
"aggregation": "last",
"period": {
"start": "2026-10-05T19:42:19.252Z",
"end": "2026-10-05T19:42:19.252Z",
"timezone": "UTC"
},
"dimensions": []
},
{
"key": "receipts",
"label": "Receipts",
"value": 0,
"unit": "count",
"semantic": "gauge",
"aggregation": "last",
"period": {
"start": "2026-10-05T19:42:19.252Z",
"end": "2026-10-05T19:42:19.252Z",
"timezone": "UTC"
},
"dimensions": []
},
{
"key": "receivable",
"label": "Receivable",
"value": 0,
"unit": "GBP",
"semantic": "currency",
"aggregation": "last",
"period": {
"start": "2026-10-05T19:42:19.252Z",
"end": "2026-10-05T19:42:19.252Z",
"timezone": "UTC"
},
"dimensions": []
},
{
"key": "payable",
"label": "Payable",
"value": 0,
"unit": "GBP",
"semantic": "currency",
"aggregation": "last",
"period": {
"start": "2026-10-05T19:42:19.252Z",
"end": "2026-10-05T19:42:19.252Z",
"timezone": "UTC"
},
"dimensions": []
}
],
"appId": "app_topolo_books",
"serviceName": "Books",
"lastUpdated": "2026-10-05T19:42:19.252Z"
}
]
}
HTTP 200. Inspect the actual response fields and retained identifiers for the selected organization/workspace. Get the Books TopoloOne widget v3: live journal, invoice, receipt, receivable and payable figures plus confirmation-gated journal-draft and saved-bank-rule controls. 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.
Successful response · HTTP 200
Input · payload.json:
{}
Captured response · HTTP 200
{
"success": true,
"contractVersion": "3.0.0",
"appId": "app_topolo_books",
"serviceName": "Books",
"generatedAt": "2026-10-05T19:42:19.280Z",
"widgets": [
{
"id": "books.workspace-summary",
"version": "3.0.0",
"serviceIcon": "📚",
"type": "stats",
"presentation": {
"title": "Books workspace summary",
"description": "Live invoice, receipt and outstanding-balance totals for this Books workspace.",
"contexts": [
"workspace"
],
"supportedSizes": [
"compact",
"medium",
"wide"
],
"defaultSize": "medium"
},
"resource": {
"resourceType": "workspace",
"resourceId": "ws_e2e_muvnp7qn2",
"requiredPermissions": [
"workspace:read"
]
},
"state": {
"status": "ready",
"observedAt": "2026-10-05T19:42:19.280Z",
"lastSuccessfulAt": "2026-10-05T19:42:19.280Z"
},
"refresh": {
"intervalSeconds": 60,
"timeoutSeconds": 10,
"maxAgeSeconds": 60,
"staleWhileRevalidateSeconds": 120
},
"configuration": {
"allowMultipleInstances": true,
"fields": [
{
"key": "metricKeys",
"label": "Metrics",
"type": "multi-select",
"required": true,
"options": [
{
"value": "invoices",
"label": "Invoices"
},
{
"value": "receipts",
"label": "Receipts"
},
{
"value": "receivable",
"label": "Receivable"
},
{
"value": "payable",
"label": "Payable"
}
]
}
],
"defaults": {
"metricKeys": [
"invoices",
"receipts",
"receivable",
"payable"
]
}
},
"drilldowns": [
{
"id": "workspace",
"label": "Open Books workspace",
"href": "/dashboard"
},
{
"id": "getting-started",
"label": "View Books getting started",
"href": "/dashboard/getting-started"
}
],
"controls": [
{
"id": "create-journal-draft",
"label": "Create journal draft",
"actionId": "app_topolo_books.journals.drafts.create",
"resourceType": "workspace",
"resourceId": "ws_e2e_muvnp7qn2",
"input": {},
"requiresConfirmation": true,
"destructive": false,
"effects": [
"Creates one empty, editable journal draft. It does not post anything to the ledger."
],
"verification": [
"Read journal drafts and confirm the returned draft is present and still unposted."
],
"recovery": {
"mode": "compensating_action",
"actionId": "app_topolo_books.journals.drafts.delete",
"instructions": "Delete the returned unposted draft if it is not needed."
}
},
{
"id": "apply-bank-rules",
"label": "Apply saved bank rules",
"actionId": "app_topolo_books.bank.rules.apply",
"resourceType": "workspace",
"resourceId": "ws_e2e_muvnp7qn2",
"input": {
"dryRun": false
},
"requiresConfirmation": true,
"destructive": false,
"effects": [
"Applies active saved rules to eligible unmatched bank lines and posts their coding journals."
],
"verification": [
"Read bank lines and confirm the expected eligible lines are matched and identify their posted journals."
],
"recovery": {
"mode": "compensating_action",
"actionId": "app_topolo_books.bank.lines.unmatch",
"instructions": "Unmatch an incorrectly coded line after reviewing its posted journal."
}
}
],
"localization": {
"locale": "en",
"titleKey": "books.api.widget.title",
"descriptionKey": "books.api.widget.summary"
},
"accessibility": {
"label": "Books workspace metrics",
"description": "Live invoice, receipt and outstanding-balance totals for this Books workspace."
},
"contribution": {
"summary": "Accounting activity and outstanding balances for the selected Books workspace.",
"identity": {
"iconSource": "catalog"
},
"workspaceSelector": {
"mode": "required",
"resourceType": "workspace",
"label": "Books workspace",
"supportsMultiple": false
},
"metricDefinitions": [
{
"key": "invoices",
"label": "Invoices",
"description": "Number of invoices in the workspace.",
"unit": "count",
"semantic": "gauge",
"aggregation": "last"
},
{
"key": "receipts",
"label": "Receipts",
"description": "Number of receipts in the workspace.",
"unit": "count",
"semantic": "gauge",
"aggregation": "last"
},
{
"key": "receivable",
"label": "Receivable",
"description": "Current receivable balance.",
"unit": "currency",
"semantic": "currency",
"aggregation": "last"
},
{
"key": "payable",
"label": "Payable",
"description": "Current payable balance.",
"unit": "currency",
"semantic": "currency",
"aggregation": "last"
}
],
"seriesDefinitions": [],
"dimensions": [],
"lifecycleStages": [],
"events": [],
"datasets": [
{
"id": "books.workspace-summary",
"label": "Books workspace summary",
"description": "Current accounting totals for one workspace.",
"grain": "workspace",
"metricKeys": [
"invoices",
"receipts",
"receivable",
"payable"
],
"seriesKeys": [],
"dimensionKeys": [],
"eventKeys": [],
"actionIds": [
"create-journal-draft",
"apply-bank-rules"
]
}
],
"compatibleVisualizations": [
"number",
"bar",
"table"
],
"defaultVisualization": "number"
},
"metrics": [
{
"key": "invoices",
"label": "Invoices",
"value": 0,
"unit": "count",
"semantic": "gauge",
"aggregation": "last",
"period": {
"start": "2026-10-05T19:42:19.280Z",
"end": "2026-10-05T19:42:19.280Z",
"timezone": "UTC"
},
"dimensions": []
},
{
"key": "receipts",
"label": "Receipts",
"value": 0,
"unit": "count",
"semantic": "gauge",
"aggregation": "last",
"period": {
"start": "2026-10-05T19:42:19.280Z",
"end": "2026-10-05T19:42:19.280Z",
"timezone": "UTC"
},
"dimensions": []
},
{
"key": "receivable",
"label": "Receivable",
"value": 0,
"unit": "USD",
"semantic": "currency",
"aggregation": "last",
"period": {
"start": "2026-10-05T19:42:19.280Z",
"end": "2026-10-05T19:42:19.280Z",
"timezone": "UTC"
},
"dimensions": []
},
{
"key": "payable",
"label": "Payable",
"value": 0,
"unit": "USD",
"semantic": "currency",
"aggregation": "last",
"period": {
"start": "2026-10-05T19:42:19.280Z",
"end": "2026-10-05T19:42:19.280Z",
"timezone": "UTC"
},
"dimensions": []
}
],
"appId": "app_topolo_books",
"serviceName": "Books",
"lastUpdated": "2026-10-05T19:42:19.280Z"
}
]
}
HTTP 200. Inspect the actual response fields and retained identifiers for the selected organization/workspace. Get the Books TopoloOne widget v3: live journal, invoice, receipt, receivable and payable figures plus confirmation-gated journal-draft and saved-bank-rule controls. 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. Get the Books TopoloOne widget v3: live journal, invoice, receipt, receivable and payable figures plus confirmation-gated journal-draft and saved-bank-rule controls.
- 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.
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.
Related actions
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.