Archive account

Outcome

Archive an account so nothing new posts to it. Accounts are never deleted; system accounts cannot be archived.

Before you start

• Verify the intended environment, authenticated identity and specifically approved organization context.
• The published application permission is accounts: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.accounts.archive --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.
• accountId: Exact account.id from accounts.list/get; a chart code is not an id.

Request

POST /api/accounts/{accountId}/archive

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

• Stops anything new posting to the account. Posted history is untouched and the account is never deleted.

Interpret the response

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

Call app_topolo_books.accounts.get and confirm status is archived.

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

Refused response · auth_error

Input · payload.json:

{
  "accountId": "acc_7f3c1b"
}

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:

{
  "accountId": "acc_4cd85cc192b949838584abaad578817b"
}

Captured response · HTTP 200

{
  "account": {
    "id": "acc_4cd85cc192b949838584abaad578817b",
    "organization_id": "org_documentation-chart_muvnpnbe1",
    "workspace_id": "ws_documentation-chart_muvnpnbe1",
    "code": "5501",
    "name": "Fixture expense",
    "type": "expense",
    "subtype": null,
    "parent_id": null,
    "currency": null,
    "system_key": null,
    "description": null,
    "status": "archived",
    "created_at": "2026-10-05T19:42:39.436Z",
    "updated_at": "2026-10-05T19:42:39.438Z",
    "source": "manual",
    "source_account_id": null
  }
}

HTTP 200. Call app_topolo_books.accounts.get and confirm status is archived.

Successful response · HTTP 200

Input · payload.json:

{
  "accountId": "acc_e18b055c56324f60a17be4eb268253fa"
}

Captured response · HTTP 200

{
  "account": {
    "id": "acc_e18b055c56324f60a17be4eb268253fa",
    "organization_id": "org_route_muvnp2sb19",
    "workspace_id": "ws_route_muvnp2sb19",
    "code": "6250",
    "name": "Hosting and cloud",
    "type": "expense",
    "subtype": null,
    "parent_id": null,
    "currency": null,
    "system_key": null,
    "description": null,
    "status": "archived",
    "created_at": "2026-10-05T19:42:12.851Z",
    "updated_at": "2026-10-05T19:42:12.855Z",
    "source": "manual",
    "source_account_id": null
  }
}

HTTP 200. Call app_topolo_books.accounts.get and confirm status is archived.

Verify the result

• Call app_topolo_books.accounts.get and confirm status is archived.

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

Restore the account, provided no live account has taken its code.

Related actions

• List accounts: List the chart of accounts. Filter by type or archived state, search across code, name and description, and sort by code, name, type, subtype or status.
• Restore an account: Bring an archived account back into use, provided no live account holds its code.

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.