Skip to main content

Usage

Syntax​

kobana <product> <resource> <method> [flags]
  • <product> — banking, finance, billing or inbox.
  • <resource> — can be nested: payables, receivables, attachments links.
  • <method> — the action: list, get, create, update, delete, or an action specific to the resource.

The API version never appears in the command — the CLI resolves the URL from the embedded OpenAPI spec.

URL and query parameters go in --params; the request body goes in --json.

The whole surface is discoverable through --help, at every level:

kobana --help                             # products
kobana finance --help                     # Smart Finance resources
kobana finance financial-accounts --help  # a resource's methods

finance resources​

ResourceDescription
financial-accountsFinancial accounts
financial-transactionsTransactions
payablesPayables
receivablesReceivables
cash-flowCash flow
reconciliationsReconciliations
categoriesCategories
classification-centersClassification centers
automatic-rulesAutomatic rules
peoplePeople
companiesCompanies
taxesTaxes
attachmentsAttachments
receiptsReceipts
transfersTransfers
banksBanks

Each resource has a page of its own, with the full command table and examples — see the catalogue.

Examples​

# Open payables
kobana finance payables list \
  --params '{"status": "pending"}' \
  --fields "id,description,amount,due_date"

# Aggregate totals instead of the whole list
kobana finance payables aggregates --params '{"group_by": "category"}'

# Send a bill to the bank for payment
kobana finance payables send-to-bank --dry-run --params '{"id": "PAYABLE_ID"}'

# The month's cash flow
kobana finance cash-flow list \
  --params '{"start_date": "2026-01-01", "end_date": "2026-01-31"}'

# Reconcile a transaction against a bill
kobana finance reconciliations create \
  --json '{"financial_transaction_id": "TRANSACTION_ID", "payable_id": "PAYABLE_ID"}'

# List with automatic pagination (NDJSON)
kobana finance financial-transactions list --page-all --fields "id,amount,date"

# Table output
kobana finance financial-accounts list --output-format table

# Save the response to a file
kobana finance payables get --params '{"id": "PAYABLE_ID"}' --output conta.json

Next steps​