List transactions — GET /v1/books/bank/transactions

Returns the org's normalized bank transactions, newest first — every row the import and connector paths have ingested, with its amount in exact cents, its direction, and whether it has been matched to a voucher yet.

GET /v1/books/bank/transactions

Books → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/books/bank/transactions`
Method	`GET`
Operation	`get_books_bank_transactions`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Request

2 fields.

Field	In	Type	Required	Description
`sandbox`	query	string	—	Sandbox reads the org's SANDBOX ledger when it is exactly "true".
`limit`	query	integer	—	Limit caps how many rows come back; 500 when absent or not positive.

Response

Status	Body	Meaning
`200`	books.BankTxnRow[]	ok
`default`	problem-details	refused

200 body — 10 fields.

Field	In	Type	Always	Description
`[].amountCents`	body	integer (int64)	—	AmountCents is the size of the movement in whole cents, always POSITIVE — direction carries the sign, so a caller must read both to know which way money went.
`[].connector`	body	string	—	Connector names the feed this row arrived on — which bank or processor connection it was synced from.
`[].currency`	body	string	—	Currency is the ISO code the bank reported the line in.
`[].description`	body	string	—	Description is the statement memo as the bank wrote it.
`[].direction`	body	string	—	Direction is which way the money moved: an inflow into the account or an outflow from it, from the org's point of view.
`[].externalId`	body	string	—	ExternalID is the bank's OWN id for the line, carried verbatim.
`[].matchedVoucher`	body	string	—	MatchedVoucher names the ledger voucher this line was reconciled against — the bill it paid, or the settlement it cleared.
`[].merchant`	body	string	—	Merchant is the counterparty the feed identified, where it did.
`[].postedAt`	body	string	—	PostedAt is the bank's posting date for the line, not when we synced it.
`[].status`	body	string	—	Status is where the line got to: posted (an outflow booked straight to an expense), settled (an outflow that paid down a scanned bill), reconciled (an inflow that cleared a pending settlement), transfer (a move between the org's own accounts, recorded but with no effect on the books), or unmatched (an inflow nobody could place, which is waiting on a human answer).

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo books bank transactions

.ts

.py

.go

.rs

.java

import { Configuration, BooksApi } from 'hanzoai';

const api = new BooksApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getBooksBankTransactions();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import BooksApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = BooksApi(client).get_books_bank_transactions()

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.BooksAPI.GetBooksBankTransactions(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, books_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = books_api::get_books_bank_transactions(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.BooksApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new BooksApi(client).getBooksBankTransactions();

curl https://api.hanzo.ai/v1/books/bank/transactions \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches books through the books tool, which names its 20 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_book_accounts"
         }
       }
     }'

Books API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList accounts NextList unreconciled