Transactions and reconciliation
The realised side: each account's transactions, transfers between accounts, reconciling titles against transactions, and payment receipts.
Families on this page
| Family | Tools | read | write | destructive |
|---|---|---|---|---|
financial_transactions — Transactions | 7 | 4 | 2 | 1 |
transfers — Transfers | 2 | 1 | 0 | 1 |
reconciliations — Reconciliations | 3 | 1 | 0 | 2 |
receipts — Receipts | 2 | 2 | 0 | 0 |
financial_transactions
| Tool | Kind | Permission | Endpoint | What it does |
|---|---|---|---|---|
finance_financial_transactions_list | read | transactions.list | GET /v1/financial-transactions | List financial transactions (lançamentos — what actually moved in an account), cursor-paginated. |
finance_financial_transactions_get | read | transactions.show | GET /v1/financial-transactions/{id} | Fetch one financial transaction. |
finance_financial_transactions_aggregates | read | transactions.list | GET /v1/financial-transactions/aggregates | Credit, debit and net totals of realised transactions (forecasts excluded) for a period (month+year or start_date+end_date) and optionally one company. |
finance_financial_transactions_ids | read | transactions.list | GET /v1/financial-transactions/ids | The id of every live financial transaction, for reconciling a mirror. |
finance_financial_transactions_create | write | transactions.create | POST /v1/financial-transactions | Record a financial transaction (credit or debit) on an account. |
finance_financial_transactions_update | write | transactions.update | PATCH /v1/financial-transactions/{id} | Partially update a financial transaction. |
finance_financial_transactions_delete | destructive | transactions.delete | DELETE /v1/financial-transactions/{id} | Delete a financial transaction. |
transfers
| Tool | Kind | Permission | Endpoint | What it does |
|---|---|---|---|---|
finance_transfers_create | destructive | transfers.create | POST /v1/transfers | Transfer between two accounts: creates the linked debit/credit pair under one transfer_id. |
finance_transfers_get | read | transactions.show | GET /v1/transfers/{transfer_id} | Fetch a transfer: the linked debit and credit transactions. |
reconciliations
| Tool | Kind | Permission | Endpoint | What it does |
|---|---|---|---|---|
finance_reconciliations_create | destructive | reconciliations.create | POST /v1/reconciliations | Reconcile payables/receivables against bank transactions (n:m). |
finance_reconciliations_get | read | reconciliations.show | GET /v1/reconciliations/{id} | Fetch a reconciliation: the ids of the titles and transactions it groups. |
finance_reconciliations_delete | destructive | reconciliations.delete | DELETE /v1/reconciliations/{id} | Dissolve a manual reconciliation, reverting every title in it to pending. |
receipts
| Tool | Kind | Permission | Endpoint | What it does |
|---|---|---|---|---|
finance_receipts_list | read | receipts.list | GET /v1/receipts | List payment receipts (comprovantes), cursor-paginated. |
finance_receipts_get | read | receipts.show | GET /v1/receipts/{id} | Fetch one payment receipt. |
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.