Financial accounts and cash flow

Financial accounts, the computed balance and the balances each source observed, the bank catalogue, and the cash-flow projection.

Families on this page

Family	Tools	read	write	destructive
financial_accounts — Financial accounts and balances	10	4	3	3
banks — Banks	1	1	0	0
cash_flow — Cash flow	1	1	0	0

financial_accounts

Tool	Kind	Permission	Endpoint	What it does
finance_financial_accounts_list	read	accounts.list	GET /v1/financial-accounts	List financial accounts (bank accounts, cash, cards…).
finance_financial_accounts_get	read	accounts.show	GET /v1/financial-accounts/{account_id}	Fetch one financial account with its computed balance (live, from posted transactions).
finance_financial_accounts_create	write	accounts.create	POST /v1/financial-accounts	Create a financial account.
finance_financial_accounts_update	write	accounts.update	PATCH /v1/financial-accounts/{account_id}	Partially update a financial account.
finance_financial_accounts_delete	destructive	accounts.delete	DELETE /v1/financial-accounts/{account_id}	Delete a financial account.
finance_financial_accounts_adjust_balance	destructive	accounts.adjust-balance	POST /v1/financial-accounts/{account_id}/adjust-balance	Correct the account's computed balance to target_balance by inserting an adjustment transaction for the difference.
finance_financial_accounts_balances_list	read	accounts.show	GET /v1/financial-accounts/{account_id}/balances	List the recorded balance observations of an account (bank-reported, manual, calculated), newest capture_date first.
finance_financial_accounts_balances_latest	read	accounts.show	GET /v1/financial-accounts/{account_id}/balances/latest	The most recent balance observation of every source, one row per source.
finance_financial_accounts_balances_create	write	accounts.update	POST /v1/financial-accounts/{account_id}/balances	Record a balance observation for an account (e.g.
finance_financial_accounts_balances_delete	destructive	accounts.update	DELETE /v1/financial-accounts/{account_id}/balances/{balance_id}	Delete a balance observation.

banks

Tool	Kind	Permission	Endpoint	What it does
finance_banks_list	read	— (none)	GET /v1/banks	The Brazilian bank catalog (COMPE/BACEN codes) — use it to find bank_id for an account.

cash_flow

Tool	Kind	Permission	Endpoint	What it does
finance_cash_flow_get	read	cash-flow.show	GET /v1/cash-flow	Cash-flow projection of the workspace between from and to, bucketed by granularity, optionally narrowed to one company or account.

---

The fields of each resource are in the API reference and in finance_schemas_get.

A tool you cannot run is not listed by tools/list at all. If one from this page is missing, see Authentication.