Getting Started

Command Line & API

The bonbox CLI puts your receipts, invoices and customers in the terminal. It talks to the public bonbox REST API with your normal bonbox account — no extra credentials, no direct database access. Handy for scripting, bulk work and anything you would rather automate than click.

Install

The CLI is a Node package (Node 20 or newer) and installs globally as bonbox:

npm i -g bonbox

Coming to npm. Until it is published there, you can build it from the bonbox repository:

pnpm -C packages/cli build
node packages/cli/dist/cli.js --help

Sign in

bonbox login opens your browser and signs you in with Google or Apple — the same account you use in the app. The session is stored on your machine and refreshed automatically, so you only do this once.

bonbox login
bonbox login --provider apple
bonbox whoami

Everyday commands

Create an invoice with line items (<code>description:quantity:unit price[:discount]</code>) and save the PDF:

bonbox invoices create \
  --customer "Velo GmbH" \
  --item "Design work:8:145" \
  --item "Retainer:1:2000:10%" \
  --pdf invoice.pdf

Mark an invoice as paid — the income is booked as a receipt at the same time:

bonbox invoices paid 260830-001

Upload one or more receipts; amount, date and vendor are extracted automatically:

bonbox receipts scan lunch.jpg train-ticket.pdf

List last month's receipts as JSON, ready to pipe into your own scripts:

bonbox receipts ls --month 2026-08 --json

See your customers:

bonbox customers ls

Every command accepts --json for the raw response and --lang for the output language. bonbox --help lists everything.

API

The CLI is a thin layer over the public REST API at https://app.bonbox.io/api/v1. If you want to go further — your own integration, a scheduled job, a script in another language — authenticate with a bearer token and call it directly. The full endpoint list lives in the OpenAPI document:

https://app.bonbox.io/api/v1/openapi.json

Requires bonbox Pro

The CLI and the API are part of bonbox Pro. Without an active subscription the API answers with a 402 and returns no data.

Ready to simplify your bookkeeping?

Download bonbox and get started in minutes.