Topolo Docs Topolo Platform
Open workspace

Get the bank reconciliation report

At a date (default today): the statement balance (every line the bank sent up to the date, duplicates left out), the bank's own reported balance when a feed supplies one, the balance of the linked ledger account, the unmatched lines with their total, the excluded and matched totals, and the difference (statement minus ledger, unmatched and excluded) that names what is in the ledger but not on the statement. reconciled is true when nothing is unmatched and the difference is zero. Includes the latest sign-off.

Outcome

At a date (default today): the statement balance (every line the bank sent up to the date, duplicates left out), the bank's own reported balance when a feed supplies one, the balance of the linked ledger account, the unmatched lines with their total, the excluded and matched totals, and the difference (statement minus ledger, unmatched and excluded) that names what is in the ledger but not on the statement. reconciled is true when nothing is unmatched and the difference is zero. Includes the latest sign-off.

Before you start

  • Verify the intended environment, authenticated identity and specifically approved organization context.
  • The published application permission is banking: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.bank.accounts.reconciliation.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.
  • bankAccountId: Exact local bank account.id from bank.accounts.list; a provider account identifier is separate.

Request

GET /api/bank/accounts/{bankAccountId}/reconciliation

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

Input fields

FieldRequiredMeaningSchema and constraints
bankAccountIdRequiredExact local bank account.id from bank.accounts.list; a provider account identifier is separate.{"type":"string","minLength":1}
asOfOptionalas Of{"type":"string","pattern":"^\d{4}-\d{2}-\d{2}$"}

Inspect nested fields and the complete input schema.

Effects

  • Reads the selected Books bank result in the credential-scoped organization and applicable canonical workspace. At a date (default today): the statement balance (every line the bank sent up to the date, duplicates left out), the bank's own reported balance when a feed supplies one, the balance of the linked ledger account, the unmatched lines with their total, the excluded and matched totals, and the difference (statement minus ledger, unmatched and excluded) that names what is in the ledger but not on the statement. reconciled is true when nothing is unmatched and the difference is zero. Includes the latest sign-off.

Interpret the response

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

Inspect the actual response fields and retained identifiers for the selected organization/workspace. At a date (default today): the statement balance (every line the bank sent up to the date, duplicates left out), the bank's own reported balance when a feed supplies one, the balance of the linked ledger account, the unmatched lines with their total, the excluded and matched totals, and the difference (statement minus ledger, unmatched and excluded) that names what is in the ledger but not on the statement. reconciled is true when nothing is unmatched and the difference is zero. Includes the latest sign-off. 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.bank.accounts.reconciliation.get --data @payload.json --json
topolo actions plan app_topolo_books.bank.accounts.reconciliation.get --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.bank.accounts.reconciliation.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.bank.accounts.reconciliation.get",
    "input": {
      "bankAccountId": "bk_brc_main_nq3r53",
      "asOf": "2026-06-30"
    },
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "detail": true
  }
}

Successful response · HTTP 200

Input · payload.json:

{
  "bankAccountId": "bk_brc_main_nq3r53",
  "asOf": "2026-06-30"
}

Captured response · HTTP 200

{
  "bankAccount": {
    "id": "bk_brc_main_nq3r53",
    "name": "Current account",
    "nickname": null,
    "currency": "GBP",
    "ledgerAccountId": "acc_c701e2fe79804155a52e70b749d8e16d",
    "ledgerAccountCode": "1000",
    "ledgerAccountName": "Bank account"
  },
  "asOf": "2026-06-30",
  "fromDate": null,
  "openingBalanceMinor": 0,
  "statementBalanceMinor": 0,
  "providerBalanceMinor": 123400,
  "providerBalanceAsOf": "2026-06-30",
  "ledgerBalanceMinor": 0,
  "unmatched": {
    "count": 0,
    "amountMinor": 0,
    "lines": []
  },
  "excluded": {
    "count": 0,
    "amountMinor": 0
  },
  "matched": {
    "count": 0,
    "amountMinor": 0
  },
  "differenceMinor": 0,
  "reconciled": true,
  "lastSignOff": null
}

HTTP 200. Inspect the actual response fields and retained identifiers for the selected organization/workspace. At a date (default today): the statement balance (every line the bank sent up to the date, duplicates left out), the bank's own reported balance when a feed supplies one, the balance of the linked ledger account, the unmatched lines with their total, the excluded and matched totals, and the difference (statement minus ledger, unmatched and excluded) that names what is in the ledger but not on the statement. reconciled is true when nothing is unmatched and the difference is zero. Includes the latest sign-off. 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.

Refused response · forbidden

Input · payload.json:

{
  "bankAccountId": "bk_brc_main_nq3r53"
}

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.

Refused response · auth_error

Input · payload.json:

{
  "bankAccountId": "synthetic_books_unresolved"
}

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

  • Inspect the actual response fields and retained identifiers for the selected organization/workspace. At a date (default today): the statement balance (every line the bank sent up to the date, duplicates left out), the bank's own reported balance when a feed supplies one, the balance of the linked ledger account, the unmatched lines with their total, the excluded and matched totals, and the difference (statement minus ledger, unmatched and excluded) that names what is in the ledger but not on the statement. reconciled is true when nothing is unmatched and the difference is zero. Includes the latest sign-off.
  • 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

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

  • List bank accounts: List the bank accounts reported by connected banks, with cached balances and the ledger account each maps to. linkedOnly returns just the accounts pointed at a ledger account.

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.