Creates or updates one vendor in the org's vendor book, keyed by its canonical…
Creates or updates one vendor in the org's vendor book, keyed by its canonical name — writing a canonical name that already exists REPLACES that row's…
POST /v1/books/vendors
| Address | https://api.hanzo.ai/v1/books/vendors |
| Method | POST |
| Operation | post_books_vendors |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Creates or updates one vendor in the org's vendor book, keyed by its canonical name — writing a canonical name that already exists REPLACES that row's aliases and default category. A category given as a slug ("software") is normalized to its real COA expense account, and anything unrecognized becomes 5900 Uncategorized rather than a guessed real account. It answers the row exactly as stored, so the caller sees the normalization. Recording a vendor is what makes future bills from it self-classify instead of asking again.
Request
3 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
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. |
canonical | body | string | — | Canonical is the vendor's one true name, and the key an upsert writes by. |
defaultCategory | body | string | — | DefaultCategory is the COA expense account new bills from this vendor book to. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | VendorRow | ok |
200 body — 3 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
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. |
canonical | body | string | — | Canonical is the vendor's one true name, and the key an upsert writes by. |
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 createimport { Configuration, BooksApi } from 'hanzoai';
const api = new BooksApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postBooksVendors({ aliases: ["<aliases>"], canonical: "<canonical>" });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).post_books_vendors(aliases=["<aliases>"], canonical="<canonical>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.BooksAPI.PostBooksVendors(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::post_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).postBooksVendors();curl -X POST https://api.hanzo.ai/v1/books/vendors \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"aliases": [
"<aliases>"
],
"canonical": "<canonical>"
}'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?