Hanzo
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

Addresshttps://api.hanzo.ai/v1/books/vendors
MethodGET
Operationget_books_vendors
AuthAuthorization: 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.

FieldInTypeRequiredDescription
sandboxquerystringSandbox reads the org's SANDBOX ledger when it is exactly "true"; anything else reads the live one.

Response

StatusBodyMeaning
200vendorsOutok

200 body — 4 fields.

FieldInTypeAlwaysDescription
vendorsbodyVendorRow[]Vendors is every vendor the org has recorded, canonical name ascending.
vendors[].aliasesbodystring[]Aliases are the other spellings a receipt may print the vendor under; a scan matching any of them resolves to this vendor.
vendors[].canonicalbodystringCanonical is the vendor's one true name, and the key an upsert writes by.
vendors[].defaultCategorybodystringDefaultCategory is the COA expense account new bills from this vendor book to.

Failure carries the platform error shape — see Errors.

Examples

hanzo books vendors get

Books API · All Hanzo APIs · Interactive reference

How is this guide?

On this page