GetbeelDocs

CLI

Send invoices, upload bank statements and check deadlines from the terminal.

The getbeel command uses the TypeScript SDK. Node.js 20.19+.

npm install -g @getbeel/cli   # or: npx @getbeel/cli whoami
getbeel login                 # paste a key from Settings → API keys & MCP
getbeel whoami

login checks the key and saves it in ~/.config/getbeel/config.json (readable only by you). GETBEEL_API_KEY or --api-key take precedence (and then go to the default host, not a base URL saved with another key); getbeel logout forgets it. Start with a test key (gb_test_…): sends go to the sandbox.

Commands

CommandWhat it does
invoices list [--status s] [--limit n] [--cursor c] [--all]Issued invoices
invoices get <id>One invoice
invoices create --file invoice.jsonCreate a draft from a CreateInvoiceRequest JSON file
invoices validate --file fattura.xmlCheck a FatturaPA XML
invoices send <id>Send a draft to SDI (to the sandbox with a test key)
received list [--status s] [--source s] [--all]Received invoices
bank statements upload <file> [--currency EUR]Upload a statement (PDF, CSV, TXT, CBI, CAMT.053, MT940)
bank statements list [--all]Statements and their status
bank connections listConnected banks
bank connections sync <id>Sync a bank now
taxes calendar [--from date] [--to date]Tax deadlines
taxes registers --period 2026-Q3Sales and purchase VAT registers of a month or quarter
taxes settlement --period 2026-10VAT settlement of the period (to check)
taxes report --type profit-and-loss --period 2026Management report: P&L, cash flow, receivables aging
filings prepare --type bollo|withholdings --period 2026-Q3 [--amount 200.00]Prepare an F24
filings prepare --type vat_payment|lipe --period 2026-10Save the VAT settlement and prepare its F24, or a quarter's LIPE file
filings list [--all]Prepared filings

Options

  • --json: print the API's JSON (for scripts and jq); errors go to stderr as JSON.
  • --company <id>: act on a client company.
  • --idempotency-key <key>: for create, send, upload and prepare (otherwise a random one).
  • --base-url <url>: another API host (https; http only for localhost).

Exit codes: 0 ok, 1 API error (printed with code and request id), 2 wrong command or options.

getbeel invoices create --file invoice.json --json | jq -r .id | xargs getbeel invoices send

On this page