resource_action pattern, for example transactions_list or rules_create. Each card below links to the matching API reference page, where you can see the full parameters and response shape.
Access and Scope
- Every tool except
companies_listrequiresorgIdandcompanyId. Callcompanies_listfirst to find the org and company IDs your key can reach, along with the access level on each. - Read tools (the
_list,_get, and_countactions) work with any key. Every other tool mutates data and requireswriteaccess on that company, otherwise it returns403. - There are no delete tools. The API is mutate-only; use the Breezing dashboard for destructive actions.
Long-Running Operations
Some tools start a background job and write a row to the tasks list:wallets_create, wallets_sync, transactions_create, transactions_updatePriceAuto, balances_calculate, ngl_calculate, active_issues_refresh, and rules_apply. While one is in flight for the same company or wallet, a duplicate call returns 409 TASK_IN_PROGRESS. The exception is wallets_create: creating another wallet is always allowed, since each call targets a new wallet.
The accounting sync tools (xero_sync, qbo_sync, and bexio_sync) run synchronously and respond once the journals are accepted or rejected, but they also return 409 TASK_IN_PROGRESS while a dashboard-initiated batch sync is running for the company.
The report tools (reports_create_token, reports_create_account, reports_create_explorer_balances, reports_regenerate) also run in the background and return the report and task IDs immediately, but parallel report creation is allowed, so they are not blocked by the 409 guard. Poll tasks_list or reports_get until the report leaves pending/progress, and avoid re-submitting the same parameters while one is pending. reports_regenerate returns 409 only while the target report itself is still generating.
Call
tasks_list first to check for in-progress work, and again before reading derived data such as balances or reports. Overlapping runs can corrupt computed state.Tools by Resource
Companies
List the companies your API key can access. Always call this first to find org and company IDs.
Company
Get the accounting configuration and chart of accounts, or update accounting settings.
Transactions
List, count, get, create, update, batch update up to 500, view edit history, group internal transfers or trades, consolidate, reprice, and lock or unlock to close a period.
Wallets
List, get, create chain wallets, and trigger incremental or custom period syncs.
Assets
List token assets and update GL account mappings or spam flags.
Balances
Get aggregated token balances or recompute daily snapshots.
Contacts
List, get, create, and update counterparty contacts for transaction context.
Active Issues
List active issues blocking the close, or refresh the snapshot.
Reports
List reports, get a single report, pull computed detail rows, generate token or account reports, run explorer balance reconciliations, and regenerate.
Rules
List, get, create, update, and retroactively apply automation rules.
Tasks
List active background tasks like wallet syncs, report generation, and rule application.
Gain/Loss
Trigger a net gain/loss run with average, FIFO, LIFO, or HIFO cost basis.
Xero
Refresh Xero accounts, categories, and invoices, create a new account, list and book invoice payments, submit gain/loss journals, and sync transactions.
QuickBooks
Refresh QuickBooks accounts, classes, and entities, create a new account, and sync transactions.
Bexio
Refresh Bexio accounts and sync transactions.