Skip to main content

Transactions

The statement itself: every credit and debit that hit a financial account, classified by category and classification center. The aggregates endpoint returns totals instead of the full list.

CommandHTTPDescription
financial-transactions listGET /v1/financial-transactionsList transactions
financial-transactions createPOST /v1/financial-transactionsCreate a transaction
financial-transactions getGET /v1/financial-transactions/{id}Get a transaction by ID
financial-transactions updatePATCH /v1/financial-transactions/{id}Update a transaction
financial-transactions deleteDELETE /v1/financial-transactions/{id}Delete a transaction
financial-transactions aggregates listGET /v1/financial-transactions/aggregatesAggregate transaction totals
financial-transactions ids listGET /v1/financial-transactions/idsList transaction IDs

Examples​

--params carries query and path parameters (id, page, filters); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# List transactions
kobana finance financial-transactions list \
  --fields "id,company_id,financial_account_id,description,bank_description"

# Get a transaction by ID
kobana finance financial-transactions get \
  --params '{"id": "FINANCIAL_TRANSACTION_ID"}'

# Create a transaction
kobana finance financial-transactions create \
  --json '{"company_id": "COMPANY_ID", "financial_account_id": "FINANCIAL_ACCOUNT_ID", "description": "DESCRIPTION", "amount": "1500.00", "occurred_at": "2026-01-31T12:00:00Z"}'

# Update a transaction
kobana finance financial-transactions update \
  --params '{"id": "FINANCIAL_TRANSACTION_ID"}' \
  --json '{"description": "DESCRIPTION", "bank_description": "BANK_DESCRIPTION", "document": "DOCUMENT"}'

# Delete a transaction
kobana finance financial-transactions delete \
  --params '{"id": "FINANCIAL_TRANSACTION_ID"}' \
  --dry-run

Next steps​