resource_action pattern, for example transactions_list or rules_create. Each tool 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. - The 43 read tools work with any key. They are the
_list,_get, and_countactions, plus the history, verification, VAT report, and attachment reads. The other 80 tools change data or start a job and requirewriteaccess on that company, otherwise they return403. - No tool deletes transactions, wallets, contacts, or rules. Use the Breezing dashboard for that. A few tools do remove something:
journals_void,journals_discard,invoices_unpublish,xero_unsync,qbo_unsync,xero_find_duplicates, andqbo_find_duplicates. Ask for these by name when you want them. - Agents cannot upload files. Sending invoice files for scanning and adding attachments to a transaction or journal goes through the API upload flow or the dashboard. Once a file is in Breezing, the agent can work with it, for example reviewing a scanned invoice or reading an attachment with
transactions_attachments_list.
Long-Running Operations
Many tools start a background job and return before the work is done:- Transactions:
transactions_create,transactions_updatePriceAuto,transactions_detect_internals,transactions_export_journals, and the filter-basedtransactions_bulkUpdate,transactions_bulkLock,transactions_bulkUnlock, andtransactions_bulkUpdatePriceAuto - Wallets:
wallets_create,wallets_sync,wallets_integrity_check - Calculations:
balances_calculate,ngl_calculate,active_issues_refresh,rules_apply - Reports:
reports_create_token,reports_create_account,reports_create_explorer_balances,reports_regenerate - Invoices:
invoices_rescan - Accounting sync:
xero_sync,qbo_sync,xero_unsync,qbo_unsync,xero_find_duplicates,qbo_find_duplicates
taskId. Pass it to tasks_list as id to follow that task until it reads done, completedWithWarning, or error. A lookup by id returns the task whatever its status, while the plain list leaves finished tasks out. transactions_export_journals ends as ready, with the CSV download link in the task metadata.
While a job is running for the same company or wallet, starting the same job again returns 409 TASK_IN_PROGRESS. The exceptions:
wallets_createalways succeeds, since each call targets a new wallet.wallets_syncreturns409 CONFLICTon a balance tracking wallet while a tracking walk is running, andwallets_integrity_checkreturns409 CONFLICTwhile a check is running for that wallet.- The report tools allow parallel creation. Poll
tasks_listorreports_getuntil the report leavespending/progress, and avoid sending the same parameters again while one is pending.reports_regeneratereturns409only while the target report itself is still generating.
xero_sync and qbo_sync queue the sync and return a taskId at once. Queued is not synced, so the agent has to read the task to know which transactions made it across. Syncs for one company run one after another, and a new sync waits for the one in front of it. Both tools return 409 TASK_IN_PROGRESS only while a find duplicates scan is unfinished. bexio_sync still runs synchronously and returns 409 TASK_IN_PROGRESS while a dashboard batch sync is running for the company.
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, update settings such as the cost-basis method, default accounts, and books lock date, and read the chart of accounts version history.
Chart of Accounts
List the chart of accounts with statement classifications, add accounts, and update one by its code.
Transactions
List, count, get, create, and update transactions by ID or by filter. View edit history, group internal transfers or trades, re-detect internal transfers, consolidate, reprice from market data or a manual price, lock or unlock, export journals as CSV, and read attachments.
Wallets
List, get, create, update, and sync wallets, start an integrity check, read balance verification state and history, and record a manual attestation.
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, including vendor entities with default invoice coding.
Active Issues
List active issues blocking the close, or refresh the snapshot.
Reports
List and generate token, account, and explorer balance reports, regenerate one, and read an account report as detail rows, financial statements, general ledger lines, or aged payables and receivables.
Rules
List, get, create, update, and retroactively apply automation rules.
Tasks
List active background tasks like wallet syncs, report generation, and accounting syncs, or look one up by ID.
Gain/Loss
Trigger a net gain/loss run with average, FIFO, LIFO, or HIFO cost basis.
Invoices
List, review, and approve received invoices, rescan a failed one, find and link the transactions that paid them, and publish them as bills to Xero or QuickBooks with their payments.
Issued Invoices
List, get, create, and update the invoices you send to customers, and link or unlink the incoming payments.
Journals
List, get, create, update, post, void, and discard manual journals.
Tax Rates
List, get, create, and update the tax rates that transactions, invoices, and rules reference by name.
VAT Report
Read the VAT report of a period, with the transactions and documents behind it.
Record History
See who changed a contact, asset, rule, tax rate, invoice, or journal, and what the values were before.
Xero
Refresh Xero accounts, categories, and invoices, create or update an account, list and book invoice payments, submit gain/loss journals, sync or unsync transactions, remove duplicate journals, and attach a file to a journal.
QuickBooks
Refresh QuickBooks accounts, classes, and entities, create or update an account, sync or unsync transactions, and remove duplicate journal entries.
Bexio
Refresh Bexio accounts and sync transactions.
All Tools
Every tool, linked to its API reference page. Read tools work with aread key. Write tools need write access.