List bank lines

List statement lines, filtered by account, match status or date, searched across description, counterparty, memo and the bank's transaction id, and sorted by posted date, amount, description or match status. Newest first unless you say otherwise; linkedOnly restricts them to accounts linked to a ledger account.

Outcome

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.lines.list --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/lines

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
`bankAccountId`	Optional	Exact local bank account.id from bank.accounts.list; a provider account identifier is separate.	{"type":"string","minLength":1}
`linkedOnly`	Optional	linked Only	{"type":"boolean"}
`reconcilable`	Optional	reconcilable	{"type":"boolean"}
`matchStatus`	Optional	match Status	{"type":"string","enum":["unmatched","matched","excluded"]}
`from`	Optional	from	{"type":"string","pattern":"^\d{4}-\d{2}-\d{2}$"}
`to`	Optional	to	{"type":"string","pattern":"^\d{4}-\d{2}-\d{2}$"}
`search`	Optional	Text filter applied to this action’s collection; this does not discover records outside the credential scope.	{"type":"string","minLength":1,"maxLength":200}
`sortBy`	Optional	One exact supported sort key from the schema.	{"type":"string","enum":["postedOn","amount","description","status","importedAt"]}
`sortOrder`	Optional	Ascending or descending ordering for the same selected sort key.	{"type":"string","enum":["asc","desc"]}
`limit`	Optional	Maximum rows for this page, within the schema bounds; retain pagination metadata.	{"type":"integer","minimum":1,"maximum":500}
`offset`	Optional	Zero-based page offset for the same filters/order; an empty page does not prove no records exist.	{"type":"integer","minimum":0,"maximum":9007199254740991}

Inspect nested fields and the complete input schema.

Effects

Reads statement lines without changing anything. Amounts are signed: money in is positive.

Interpret the response

Read $.lines[].id for the returned bank_line identifier. Empty collections and nullable fields do not discover a target.

No verification needed for a read.

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

Successful response · HTTP 200

Input · payload.json:

{}

Captured response · HTTP 200

{
  "lines": [
    {
      "id": "bln_5177da337bd4491e873a2ccc2fbced1a",
      "organization_id": "org_statement-route_muvnq7lu4",
      "workspace_id": "ws_statement-route_muvnq7lu4",
      "bank_account_id": "bac_aeca8f3096ea4719b1c861b7abe93b34",
      "source": "csv",
      "provider_transaction_id": "stm_3ebe491029d24ba1aa39e40deb4123fd:2",
      "posted_on": "2026-09-02",
      "period_key": "2026-09",
      "amount_minor": 120000,
      "currency": "GBP",
      "description": "Acme Ltd",
      "counterparty": null,
      "memo": null,
      "kind": null,
      "provider_status": "posted",
      "fingerprint": "2026-09-02|120000|acme ltd",
      "match_status": "unmatched",
      "matched_event_id": null,
      "coded_account_id": null,
      "matched_document_id": null,
      "matched_payment_id": null,
      "reconciled_at": null,
      "reconciled_by": null,
      "coded_by_rule_id": null,
      "imported_at": "2026-10-05T19:43:05.739Z",
      "updated_at": "2026-10-05T19:43:05.739Z"
    },
    {
      "id": "bln_26632dc9c22f49df9c18e85520a01d3b",
      "organization_id": "org_statement-route_muvnq7lu4",
      "workspace_id": "ws_statement-route_muvnq7lu4",
      "bank_account_id": "bac_aeca8f3096ea4719b1c861b7abe93b34",
      "source": "csv",
      "provider_transaction_id": "stm_3ebe491029d24ba1aa39e40deb4123fd:3",
      "posted_on": "2026-09-02",
      "period_key": "2026-09",
      "amount_minor": 120000,
      "currency": "GBP",
      "description": "Acme Ltd",
      "counterparty": null,
      "memo": null,
      "kind": null,
      "provider_status": "posted",
      "fingerprint": "2026-09-02|120000|acme ltd",
      "match_status": "unmatched",
      "matched_event_id": null,
      "coded_account_id": null,
      "matched_document_id": null,
      "matched_payment_id": null,
      "reconciled_at": null,
      "reconciled_by": null,
      "coded_by_rule_id": null,
      "imported_at": "2026-10-05T19:43:05.739Z",
      "updated_at": "2026-10-05T19:43:05.739Z"
    },
    {
      "id": "bln_f62175064e4248a69172c9c7a928122b",
      "organization_id": "org_statement-route_muvnq7lu4",
      "workspace_id": "ws_statement-route_muvnq7lu4",
      "bank_account_id": "bac_aeca8f3096ea4719b1c861b7abe93b34",
      "source": "csv",
      "provider_transaction_id": "stm_3ebe491029d24ba1aa39e40deb4123fd:1",
      "posted_on": "2026-09-01",
      "period_key": "2026-09",
      "amount_minor": -4999,
      "currency": "GBP",
      "description": "Cloudflare",
      "counterparty": null,
      "memo": null,
      "kind": null,
      "provider_status": "posted",
      "fingerprint": "2026-09-01|-4999|cloudflare",
      "match_status": "unmatched",
      "matched_event_id": null,
      "coded_account_id": null,
      "matched_document_id": null,
      "matched_payment_id": null,
      "reconciled_at": null,
      "reconciled_by": null,
      "coded_by_rule_id": null,
      "imported_at": "2026-10-05T19:43:05.739Z",
      "updated_at": "2026-10-05T19:43:05.739Z"
    }
  ],
  "total": 3,
  "limit": 100,
  "offset": 0,
  "sortBy": "postedOn",
  "sortOrder": "desc"
}

HTTP 200. No verification needed for a read.

Successful response · HTTP 200

Input · payload.json:

{
  "matchStatus": "unmatched",
  "limit": 1
}

Captured response · HTTP 200

{
  "lines": [
    {
      "id": "bln_d4afb56e341f420d8ed21051b2ab04a5",
      "organization_id": "org_route_muvnpuo912",
      "workspace_id": "ws_route_muvnpuo912",
      "bank_account_id": "bac_4ed374718d8148ff8d468733a72267b0",
      "source": "mercury",
      "provider_transaction_id": "tx-2",
      "posted_on": "2026-10-03",
      "period_key": "2026-10",
      "amount_minor": 120000,
      "currency": "USD",
      "description": "Acme Ltd",
      "counterparty": "Acme Ltd",
      "memo": null,
      "kind": "incomingDomesticWire",
      "provider_status": "sent",
      "fingerprint": "2026-10-03|120000|acme ltd",
      "match_status": "unmatched",
      "matched_event_id": null,
      "coded_account_id": null,
      "matched_document_id": null,
      "matched_payment_id": null,
      "reconciled_at": null,
      "reconciled_by": null,
      "coded_by_rule_id": null,
      "imported_at": "2026-10-05T19:42:48.979Z",
      "updated_at": "2026-10-05T19:42:48.979Z"
    }
  ],
  "total": 2,
  "limit": 1,
  "offset": 0,
  "sortBy": "postedOn",
  "sortOrder": "desc"
}

HTTP 200. No verification needed for a read.

Successful response · HTTP 200

Input · payload.json:

{
  "bankAccountId": "bac_4ed374718d8148ff8d468733a72267b0",
  "from": "2026-10-03"
}

Captured response · HTTP 200

{
  "lines": [
    {
      "id": "bln_d4afb56e341f420d8ed21051b2ab04a5",
      "organization_id": "org_route_muvnpuo912",
      "workspace_id": "ws_route_muvnpuo912",
      "bank_account_id": "bac_4ed374718d8148ff8d468733a72267b0",
      "source": "mercury",
      "provider_transaction_id": "tx-2",
      "posted_on": "2026-10-03",
      "period_key": "2026-10",
      "amount_minor": 120000,
      "currency": "USD",
      "description": "Acme Ltd",
      "counterparty": "Acme Ltd",
      "memo": null,
      "kind": "incomingDomesticWire",
      "provider_status": "sent",
      "fingerprint": "2026-10-03|120000|acme ltd",
      "match_status": "unmatched",
      "matched_event_id": null,
      "coded_account_id": null,
      "matched_document_id": null,
      "matched_payment_id": null,
      "reconciled_at": null,
      "reconciled_by": null,
      "coded_by_rule_id": null,
      "imported_at": "2026-10-05T19:42:48.979Z",
      "updated_at": "2026-10-05T19:42:48.979Z"
    }
  ],
  "total": 1,
  "limit": 100,
  "offset": 0,
  "sortBy": "postedOn",
  "sortOrder": "desc"
}

HTTP 200. No verification needed for a read.

Successful response · HTTP 200

Input · payload.json:

{
  "reconcilable": true
}

Captured response · HTTP 200

{
  "lines": [],
  "total": 0,
  "limit": 100,
  "offset": 0,
  "sortBy": "postedOn",
  "sortOrder": "desc"
}

HTTP 200. No verification needed for a read.

Refused response · auth_error

Input · payload.json:

{
  "matchStatus": "unmatched",
  "linkedOnly": true,
  "limit": 100
}

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 · books_request_failed

Input · payload.json:

{}

Captured response · HTTP 500

{
  "error": "books_request_failed",
  "message": "Something went wrong on our side and nothing was written. Try again, and send us this cause if it keeps happening.",
  "details": {
    "cause": "Error: Books concern database BOOKS_BANKING_DB is not bound"
  }
}

HTTP 500. SDK error code books_request_failed. Inspect the structured cause and request id. Read the relevant resource state before retrying; do not assume all operations share a cross-database transaction.

Verify the result

No verification needed for a read.

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.
books_request_failed (HTTP 500): Inspect the structured cause and request id. Read the relevant resource state before retrying; do not assume all operations share a cross-database transaction.

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.

List bank lines

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

Run a reviewed request

Successful response · HTTP 200

Successful response · HTTP 200

Successful response · HTTP 200

Successful response · HTTP 200

Refused response · auth_error

Refused response · books_request_failed

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence