Queue a document for later scanning

Takes a document as RAW BYTES and queues it in the caller org's inbox as `unsorted`, answering the queued item.

POST /v1/books/inbox

Books → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/books/inbox`
Method	`POST`
Operation	`post_books_inbox`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Takes a document as RAW BYTES and queues it in the caller org's inbox as unsorted, answering the queued item. It is the drop box: get the paperwork in now, read it later.

It EXTRACTS NOTHING and calls no model — that is what separates it from the scan. Nothing is proposed and nothing is posted; the item simply waits to be scanned, and a booked document leaves the queue.

IDEMPOTENT BY CONTENT: the item's id is the file hash, so re-uploading the same bytes answers the existing item rather than adding a duplicate row — and it is the same id a scan of those bytes uses, which is how the two routes address one document. Scoped to the caller's own org from the validated principal and refused without one; sandbox=true targets the sandbox ledger, and filename is recorded for display. An empty or oversized upload is a 400.

Request

1 field, body application/octet-stream.

Field	In	Type	Required	Description
`(body)`	body	string (binary)	yes

Response

Status	Body	Meaning
`2XX`	InboxItem	Success

2XX body — 18 fields.

Field	In	Type	Always	Description
`category`	body	string	—	Category is the expense account the scanner proposed, as a chart number — a PROPOSAL, not a posting: nothing is booked until it is accepted.
`confidence`	body	string	—	Confidence is how sure the scanner is of that reading, and is the signal for whether a person needs to check it before it is booked.
`createdAt`	body	string	—	CreatedAt is when the document was uploaded.
`extracted`	body	Extracted	—
`extracted.category`	body	string	—	Category is the expense bucket the SCANNER guessed, as a slug — a hint only.
`extracted.currency`	body	string	—	Currency is the ISO code the document is denominated in.
`extracted.issuedAt`	body	string	—	IssuedAt is the document's OWN date as YYYY-MM-DD — when the bill was issued, which is not when it was uploaded or when it will post.
`extracted.lineItems`	body	LineItem[]	—	LineItems are the individual lines read off the document, where it had any.
`extracted.lineItems[].amountCents`	body	integer	—	AmountCents is that line's amount in whole cents.
`extracted.lineItems[].description`	body	string	—	Description is the line as it appears on the document.
`extracted.merchant`	body	string	—	Merchant is the supplier as printed on the document.
`extracted.note`	body	string	—	Note is anything else worth carrying from the document that has no field of its own.
`extracted.taxCents`	body	integer	—	TaxCents is how much of that total is tax, in cents.
`extracted.totalCents`	body	integer	—	TotalCents is the document total in whole cents, tax INCLUDED.
`filename`	body	string	—	Filename is the name the document was uploaded under, for a person to recognise it by.
`id`	body	string	—	ID is the CONTENT HASH of the uploaded bytes, which is what makes the queue idempotent: re-uploading the same document returns this item rather than adding a…
`status`	body	string	—	Status is where the document is in the queue — unsorted until the scanner has read it, and thereafter whether it is waiting on a person or has been booked.
`vendor`	body	string	—	Vendor is the supplier the scanner identified, surfaced beside the item so a queue renders without opening each document.

Failure carries the platform error shape — see Errors.

Examples

hanzo books inbox create

import { Configuration, BooksApi } from 'hanzoai';

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

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_inbox()

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

resp, _, err := client.BooksAPI.PostBooksInbox(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_inbox(&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).postBooksInbox();

curl -X POST https://api.hanzo.ai/v1/books/inbox \
  -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"
         }
       }
     }'

Books API · All Hanzo APIs · Interactive reference

Queue a document for later scanning

Request

Response

Examples

On this page