Start building
with Bookey

Specification plus the token list (prefix only).

Accepts No body. Session Bearer only — API tokens cannot mint tokens.

curl -s https://bookeypro.com/api/v1/developer \
  -H "Authorization: Bearer $SESSION"

Issue a token. Secret returned once.

Accepts JSON: name, scopes[] (sales / inventory / receipts), expires_in_days (30 / 90 / 365).

{
  "name": "Kitchen POS",
  "scopes": ["sales.write", "receipts.ingest"],
  "expires_in_days": 90
}

Rotate the secret. Old Bearer dies immediately.

Accepts path id. Optional JSON expires_in_days. Session Bearer only.

Revoke immediately. The secret dies; the row is archived and leaves the Tokens list.

Accepts path id. No body. Session Bearer only.

Store the image, start OCR, land in pending_review. Returns a job. Poll GET /api/v1/jobs/{id}. SHA256 duplicate is not a new receipt. Not JSON. Does not approve or post to QBO.

Accepts multipart field file — JPEG, PNG, or PDF. One file per request.

curl -s https://bookeypro.com/api/v1/receipts/upload \
  -H "Authorization: Bearer $BOOKEY_TOKEN" \
  -F "file=@lunch.jpg;type=image/jpeg"

Poll upload/OCR progress. When done, the receipt is in the expense queue.

Accepts path id from the upload response. No body.

curl -s https://bookeypro.com/api/v1/jobs/{id} \
  -H "Authorization: Bearer $BOOKEY_TOKEN"

Expense queue. Not sales tickets. Filter with state=pending_review.

Accepts query state (all, pending_review, …) and limit (1–100). No body.

curl -s "https://bookeypro.com/api/v1/receipts?state=pending_review&limit=20" \
  -H "Authorization: Bearer $BOOKEY_TOKEN"

One receipt after OCR: vendor, amounts, tax, lines, state.

Accepts path id. No body.

curl -s https://bookeypro.com/api/v1/receipts/{id} \
  -H "Authorization: Bearer $BOOKEY_TOKEN"

Stored JPEG / PNG / PDF files. One file downloads as itself. Two or more are a zip that Bookey deletes after the download.

Accepts optional query from and to (YYYY-MM-DD). Omit both for every stored file.

curl -sO -J "https://bookeypro.com/api/v1/receipts/evidence" \
  -H "Authorization: Bearer $BOOKEY_TOKEN"

Original JPEG / PNG / PDF. Use after list or get.

Accepts path id. Returns the stored file bytes, not JSON.

curl -sO https://bookeypro.com/api/v1/receipts/{id}/image \
  -H "Authorization: Bearer $BOOKEY_TOKEN"

Create one sales ticket. Same external_id + body is idempotent. Never the expense queue.

Accepts JSON object. Decimal strings. amount is pre-tax.

{
  "external_id": "pos-123",
  "occurred_at": "2026-09-08T14:32:00Z",
  "currency": "CAD",
  "amount": "10.00",
  "tax": "1.50",
  "tip": "2.00",
  "tender": "card",
  "store": "Store 1",
  "pos": "2",
  "lines": [
    {"external_id": "line-1", "name": "Latte", "quantity": "2", "unit_price": "5.00", "line_total": "10.00"}
  ]
}

List tickets for a date range.

Accepts query from and to (YYYY-MM-DD). No body.

curl -s "https://bookeypro.com/api/v1/sales?from=2026-09-01&to=2026-09-30" \
  -H "Authorization: Bearer $BOOKEY_TOKEN"

Stock snapshot, locations, and movement.

Accepts No body. Feature flag inventory must be on.

curl -s https://bookeypro.com/api/v1/inventory \
  -H "Authorization: Bearer $BOOKEY_TOKEN"

Create a catalog item.

Accepts JSON: sku, name. Optional item_type, base_uom, reorder_point. Not a stock movement.

{
  "sku": "BEANS-1KG",
  "name": "Coffee beans",
  "base_uom": "KG"
}

Receive stock. Replay of the same key does not double qty.

Accepts JSON. idempotency_key required. sku or item_id, quantity, location_id or location_slug.

{
  "idempotency_key": "recv-2026-09-08-1",
  "sku": "BEANS-1KG",
  "quantity": "12",
  "location_slug": "central_kitchen"
}

Transfer between locations.

Accepts JSON. idempotency_key, from_location_id or from_location_slug, to_*, lines[] with sku or item_id and quantity.

{
  "idempotency_key": "xfer-2026-09-08-1",
  "from_location_slug": "central_kitchen",
  "to_location_slug": "store_1",
  "lines": [{"sku": "BEANS-1KG", "quantity": "2"}]
}

Record waste.

Accepts JSON. idempotency_key, sku or item_id, quantity, location_id or location_slug, reason.

{
  "idempotency_key": "waste-2026-09-08-1",
  "sku": "BEANS-1KG",
  "quantity": "0.25",
  "location_slug": "central_kitchen",
  "reason": "spill"
}

Register a bac_ bank or card account. last4 only — never a full PAN.

Accepts JSON: name, account_kind (bank or card). Optional currency, last4, institution, nickname.

{
  "name": "Visa ops",
  "account_kind": "card",
  "currency": "CAD",
  "last4": "9195"
}

List Bookey feed accounts. Not QBO ledger accounts.

Accepts query active=1, limit, offset. No body.

curl -s https://bookeypro.com/api/v1/banking/accounts \
  -H "Authorization: Bearer $BOOKEY_TOKEN"

Batch upsert btx_ lines. Same external_id + body is exists. Different body is conflict. Soft lookalikes stay and are flagged.

Accepts JSON. account_id plus transactions[]. amount is a signed decimal string.

{
  "account_id": "bac_…",
  "transactions": [{
    "external_id": "visa-1001",
    "booked_on": "2026-09-08",
    "amount": "-42.50",
    "currency": "CAD",
    "payee": "Costco",
    "last4": "9195"
  }]
}

List API-feed rows. Do not send these to GET /api/v1/banking/transactions.

Accepts query from, to, account_id, unmatched=1, duplicate, limit, offset.

curl -s "https://bookeypro.com/api/v1/banking/feed/transactions?from=2026-09-01&to=2026-09-30&unmatched=1" \
  -H "Authorization: Bearer $BOOKEY_TOKEN"

Link a btx_ line to a receipt and stamp Banking cleared (API feed). Not Bank matched.

Accepts JSON: receipt_id. Session or banking.write token.

{
  "receipt_id": "RECEIPT_ID"
}