OpenapiBooks
Returns the org's vendor book: each canonical vendor, the alias spellings a…
Returns the org's vendor book: each canonical vendor, the alias spellings a receipt may print it under, and the expense account new bills from it default…
GET /v1/books/vendors
| Address | https://api.hanzo.ai/v1/books/vendors |
| Method | GET |
| Operation | get_books_vendors |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns the org's vendor book: each canonical vendor, the alias spellings a receipt may print it under, and the expense account new bills from it default to. A vendor here is what makes a scanned bill self-classify instead of asking again.
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 | vendorsOut | ok |
200 body — 4 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
vendors | body | VendorRow[] | — | Vendors is every vendor the org has recorded, canonical name ascending. |
vendors[].aliases | body | string[] | — | Aliases are the other spellings a receipt may print the vendor under; a scan matching any of them resolves to this vendor. |
vendors[].canonical | body | string | — | Canonical is the vendor's one true name, and the key an upsert writes by. |
vendors[].defaultCategory | body | string | — | DefaultCategory is the COA expense account new bills from this vendor book to. |
Failure carries the platform error shape — see Errors.
Examples
hanzo books vendors getimport { Configuration, BooksApi } from 'hanzoai';
const api = new BooksApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getBooksVendors();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_vendors()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.BooksAPI.GetBooksVendors(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_vendors(&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).getBooksVendors();curl https://api.hanzo.ai/v1/books/vendors \
-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?