Create saved report view

Save one report filter set under a workspace-wide name. Names are unique within that report and the report key cannot change later.

Outcome

Save one report filter set under a workspace-wide name. Names are unique within that report and the report key cannot change later.

Before you start

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

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

Input fields

Field	Required	Meaning	Schema and constraints
`reportKey`	Required	report Key	{"type":"string","enum":["profit_and_loss","balance_sheet","cash_flow","trial_balance","aged_receivables","aged_payables","sales_by_customer","purchases_by_supplier","bank_summary"]}
`name`	Required	name	{"type":"string","minLength":1,"maxLength":80}
`parameters`	Required	parameters	{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","maxLength":200}}

Inspect nested fields and the complete input schema.

Effects

Creates one workspace-scoped saved view for the named report. It stores filter parameters only and changes no accounting data.

Interpret the response

Read $.view.id for the returned report_view identifier. Empty collections and nullable fields do not discover a target.

Call app_topolo_books.report_views.list with the same reportKey and confirm the returned view name and parameters.

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.report_views.create --data @payload.json --json
topolo actions plan app_topolo_books.report_views.create --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.report_views.create --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.report_views.create",
    "input": {
      "reportKey": "profit_and_loss",
      "name": "Live",
      "parameters": {}
    },
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "confirm": true,
    "detail": true
  }
}

Refused response · auth_error

Input · payload.json:

{
  "reportKey": "profit_and_loss",
  "name": "Quarterly management view",
  "parameters": {
    "from": "2026-04-01",
    "to": "2026-06-30",
    "compare": "previous_year"
  }
}

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 201

Input · payload.json:

{
  "reportKey": "profit_and_loss",
  "name": "Live",
  "parameters": {}
}

Captured response · HTTP 201

{
  "view": {
    "id": "rpv_944aaa75996b40989d0b2445254d40b1",
    "reportKey": "profit_and_loss",
    "name": "Live",
    "parameters": {},
    "createdBy": "usr_route",
    "createdAt": "2026-10-05T19:43:10.721Z",
    "updatedAt": "2026-10-05T19:43:10.721Z"
  }
}

HTTP 201. Call app_topolo_books.report_views.list with the same reportKey and confirm the returned view name and parameters.

Verify the result

Call app_topolo_books.report_views.list with the same reportKey and confirm the returned view name and parameters.

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

Delete the returned view id.

List saved report views: List the named filter sets saved for one report in this workspace, including the exact URL parameters each view restores.
Delete saved report view: Permanently remove one saved report filter set from this workspace. The report and its accounting data are unchanged.