Contas financeiras e extrato

As contas financeiras da conta, os saldos, o extrato e a sua sincronização com o banco.

Famílias nesta página

Família	Tools	read	write	destructive
Contas financeiras	7	4	0	3
Saldos	4	2	1	1
Extrato	3	2	1	0
Sincronizações de extrato	2	2	0	0
Importações de extrato	2	2	0	0
Categorias de extrato	1	1	0	0
Provedores financeiros	1	1	0	0

Contas financeiras

Escopo: banking/financial.accounts

Tool	Tipo	Permissão	Espelha	O que faz
banking_financial_account_list	read	financial.accounts.basic	GET /v2/financial/accounts	Lists the financial accounts of the account: its real bank accounts, with bank, branch, number, last captured balance and service accounts.
banking_financial_account_get	read	financial.accounts.basic	GET /v2/financial/accounts/:uid	Returns one financial account, in the same shape as the API v2, with its last captured balance and the uid of each of its service accounts.
banking_financial_account_create	destructive	financial.accounts.create	POST /v2/financial/accounts	Registers a bank account of the account as a financial account.
banking_financial_account_update	destructive	financial.accounts.update	PATCH /v2/financial/accounts/:uid	Changes a financial account: its bank data, name, holder, tags or custom data.
banking_financial_account_delete	destructive	financial.accounts.destroy	DELETE /v2/financial/accounts/:uid	Deletes a financial account, with its service accounts, balances and statement.
banking_financial_account_command_list	read	financial.accounts.basic	GET /v2/financial/accounts/:account_uid/commands	Lists the commands sent to the bank for one financial account (statement and balance syncs, among others), newest first, with their status.
banking_financial_account_command_get	read	financial.accounts.basic	GET /v2/financial/accounts/:account_uid/commands/:uid	Returns one command sent to the bank for a financial account, with its status and error message.

Saldos

Escopo: banking/financial.balances

Tool	Tipo	Permissão	Espelha	O que faz
banking_financial_balance_list	read	financial.balances.basic	GET /v2/financial/accounts/:account_uid/balances	Lists the balances captured for one financial account (available, blocked and automatically invested amounts, with their capture date), newest first.
banking_financial_balance_get	read	financial.balances.basic	GET /v2/financial/accounts/:account_uid/balances/:uid	Returns one captured balance of a financial account, in the same shape as the API v2.
banking_financial_balance_create	write	financial.balances.create	POST /v2/financial/accounts/:account_uid/balances	Records a balance for a financial account, as informed by the client (it is not read from the bank).
banking_financial_balance_delete	destructive	financial.balances.destroy	DELETE /v2/financial/accounts/:account_uid/balances/:uid	Deletes one captured balance of a financial account.

Extrato

Escopo: banking/financial.statement_transactions

Tool	Tipo	Permissão	Espelha	O que faz
banking_financial_statement_transaction_list	read	financial.statement_transactions.basic	GET /v2/financial/accounts/:account_uid/statement_transactions	Lists the bank statement of one financial account, latest occurrence first.
banking_financial_statement_transaction_summary	read	financial.statement_transactions.basic	GET /v2/financial/accounts/:account_uid/statement_transactions/summary	Totals the bank statement of one financial account per group (month by default; also day, week, kind or category, combinable): count, credits, debits and net, in BRL.
banking_financial_statement_transaction_sync	write	financial.statement_transactions.import	POST /v2/financial/accounts/:account_uid/statement_transactions/sync	Asks the bank for the statement of one financial account over a window (by default, from the first day of the current month until today; at most two years back, never the future).

Sincronizações de extrato

Escopo: banking/financial.statement_transactions

Tool	Tipo	Permissão	Espelha	O que faz
banking_financial_statement_transaction_sync_list	read	financial.statement_transactions.basic	GET /v2/financial/accounts/:account_uid/statement_transactions/syncs	Lists the statement syncs requested for one financial account, newest first, with their aggregate status (pending, processing, done, partial, failed) and how many of their commands are in each status.
banking_financial_statement_transaction_sync_get	read	financial.statement_transactions.basic	GET /v2/financial/accounts/:account_uid/statement_transactions/syncs/:uid	Returns one statement sync of a financial account with its aggregate status and every command it sent to the bank (one per month of the window, each with its own window and error).

Importações de extrato

Escopo: banking/financial.statement_transactions

Tool	Tipo	Permissão	Espelha	O que faz
banking_financial_statement_transaction_import_list	read	financial.statement_transactions.basic	GET /v2/financial/accounts/:account_uid/statement_transactions/imports	Lists the statement files (OFX, RET, JSON) imported into one financial account, newest first, with their status and row counts.
banking_financial_statement_transaction_import_get	read	financial.statement_transactions.basic	GET /v2/financial/accounts/:account_uid/statement_transactions/imports/:uid	Returns one statement import of a financial account: status, row counts and import errors.

Categorias de extrato

Escopo: banking/financial.statement_transactions

Tool	Tipo	Permissão	Espelha	O que faz
banking_financial_statement_category_list	read	financial.statement_transactions.basic	GET /v2/financial/statement_categories	Lists the categories a statement transaction can carry: numeric code, slug, kind (debit, credit, or absent when the category does not declare a side) and description.

Provedores financeiros

Escopo: banking/financial.providers

Tool	Tipo	Permissão	Espelha	O que faz
banking_financial_provider_list	read	financial.accounts.basic	GET /v2/financial/providers	Lists the banks and financial providers Kobana integrates with: kind, slug, name and bank number.

---

Os campos de cada recurso estão na Referência da API. Uma tool que você não pode rodar não aparece em tools/list; se uma daqui não está lá, veja Autenticação.