Skip to main content

Transactions and reconciliation

The realised side: each account's transactions, transfers between accounts, reconciling titles against transactions, and payment receipts.

Families on this page​

FamilyToolsreadwritedestructive
financial_transactions — Transactions7421
transfers — Transfers2101
reconciliations — Reconciliations3102
receipts — Receipts2200

financial_transactions​

ToolKindPermissionEndpointWhat it does
finance_financial_transactions_listreadtransactions.listGET /v1/financial-transactionsList financial transactions (lançamentos — what actually moved in an account), cursor-paginated.
finance_financial_transactions_getreadtransactions.showGET /v1/financial-transactions/{id}Fetch one financial transaction.
finance_financial_transactions_aggregatesreadtransactions.listGET /v1/financial-transactions/aggregatesCredit, 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_idsreadtransactions.listGET /v1/financial-transactions/idsThe id of every live financial transaction, for reconciling a mirror.
finance_financial_transactions_createwritetransactions.createPOST /v1/financial-transactionsRecord a financial transaction (credit or debit) on an account.
finance_financial_transactions_updatewritetransactions.updatePATCH /v1/financial-transactions/{id}Partially update a financial transaction.
finance_financial_transactions_deletedestructivetransactions.deleteDELETE /v1/financial-transactions/{id}Delete a financial transaction.

transfers​

ToolKindPermissionEndpointWhat it does
finance_transfers_createdestructivetransfers.createPOST /v1/transfersTransfer between two accounts: creates the linked debit/credit pair under one transfer_id.
finance_transfers_getreadtransactions.showGET /v1/transfers/{transfer_id}Fetch a transfer: the linked debit and credit transactions.

reconciliations​

ToolKindPermissionEndpointWhat it does
finance_reconciliations_createdestructivereconciliations.createPOST /v1/reconciliationsReconcile payables/receivables against bank transactions (n:m).
finance_reconciliations_getreadreconciliations.showGET /v1/reconciliations/{id}Fetch a reconciliation: the ids of the titles and transactions it groups.
finance_reconciliations_deletedestructivereconciliations.deleteDELETE /v1/reconciliations/{id}Dissolve a manual reconciliation, reverting every title in it to pending.

receipts​

ToolKindPermissionEndpointWhat it does
finance_receipts_listreadreceipts.listGET /v1/receiptsList payment receipts (comprovantes), cursor-paginated.
finance_receipts_getreadreceipts.showGET /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.