OpenapiBooks
Returns the org's unmatched bank inflows and their open clarifying questions —…
Returns the org's unmatched bank inflows and their open clarifying questions — the queue a human answers so an unexplained deposit is never guessed into…
GET /v1/books/bank/unreconciled
| Address | https://api.hanzo.ai/v1/books/bank/unreconciled |
| Method | GET |
| Operation | get_books_bank_unreconciled |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns the org's unmatched bank inflows and their open clarifying questions — the queue a human answers so an unexplained deposit is never guessed into revenue.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
sandbox | query | string | — | Sandbox reads the org's SANDBOX ledger when it is exactly "true"; anything else reads the live one. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | unreconciledOut | ok |
200 body — 17 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
questions | body | BankQuestion[] | — | Questions is the open clarifying question per unmatched inflow. |
questions[].connector | body | string | — | Connector names the feed the unplaceable line arrived on. |
questions[].createdAt | body | string | — | CreatedAt is when the question was raised. |
questions[].externalId | body | string | — | ExternalID is the bank's own id for the line in question. |
questions[].prompt | body | string | — | Prompt is the question put to the founder in plain language — what this money was, since the books cannot place it on their own. |
questions[].status | body | string | — | Status is whether the question is still open or has been answered. |
transactions | body | BankTxnRow[] | — | Transactions is every bank row still unmatched against the ledger. |
transactions[].amountCents | body | integer | — | 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. |
transactions[].connector | body | string | — | Connector names the feed this row arrived on — which bank or processor connection it was synced from. |
transactions[].currency | body | string | — | Currency is the ISO code the bank reported the line in. |
transactions[].description | body | string | — | Description is the statement memo as the bank wrote it. |
transactions[].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. |
transactions[].externalId | body | string | — | ExternalID is the bank's OWN id for the line, carried verbatim. |
transactions[].matchedVoucher | body | string | — | MatchedVoucher names the ledger voucher this line was reconciled against — the bill it paid, or the settlement it cleared. |
transactions[].merchant | body | string | — | Merchant is the counterparty the feed identified, where it did. |
transactions[].postedAt | body | string | — | PostedAt is the bank's posting date for the line, not when we synced it. |
transactions[].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… |
Failure carries the platform error shape — see Errors.
Examples
hanzo books bank unreconciledimport { Configuration, BooksApi } from 'hanzoai';
const api = new BooksApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getBooksBankUnreconciled();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_unreconciled()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.BooksAPI.GetBooksBankUnreconciled(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::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_unreconciled(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.BooksApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new BooksApi(client).getBooksBankUnreconciled();curl https://api.hanzo.ai/v1/books/bank/unreconciled \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches books through the books tool, which names its 24 operations with its own verbs — this one among them, under a name only the door 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"
}
}
}'How is this guide?