Pular para o conteúdo principal

Uso

Sintaxe​

kobana <produto> <recurso> <metodo> [flags]
  • <produto> — banking, finance, billing ou inbox.
  • <recurso> — pode ser aninhado: payables, receivables, attachments links.
  • <metodo> — a ação: list, get, create, update, delete, ou uma ação específica do recurso.

A versão da API nunca entra no comando — o CLI resolve a URL a partir da spec OpenAPI embutida.

Parâmetros de URL e de query vão em --params; o corpo da requisição vai em --json.

Toda a superfície é descoberta pelo --help, em qualquer nível:

kobana --help                             # produtos
kobana finance --help                     # recursos do Financeiro Inteligente
kobana finance financial-accounts --help  # métodos de um recurso

Recursos de finance​

RecursoDescrição
financial-accountsContas financeiras
financial-transactionsLançamentos
payablesContas a pagar
receivablesContas a receber
cash-flowFluxo de caixa
reconciliationsConciliações
categoriesCategorias
classification-centersCentros de classificação
automatic-rulesRegras automáticas
peoplePessoas
companiesEmpresas
taxesImpostos
attachmentsAnexos
receiptsComprovantes
transfersTransferências
banksBancos

Cada recurso tem a sua própria página, com a tabela completa de comandos e exemplos — veja o catálogo.

Exemplos​

# Contas a pagar em aberto
kobana finance payables list \
  --params '{"status": "pending"}' \
  --fields "id,description,amount,due_date"

# Totais agregados em vez da lista inteira
kobana finance payables aggregates --params '{"group_by": "category"}'

# Enviar uma conta para pagamento no banco
kobana finance payables send-to-bank --dry-run --params '{"id": "PAYABLE_ID"}'

# Fluxo de caixa do mês
kobana finance cash-flow list \
  --params '{"start_date": "2026-01-01", "end_date": "2026-01-31"}'

# Conciliar um lançamento com um título
kobana finance reconciliations create \
  --json '{"financial_transaction_id": "TRANSACTION_ID", "payable_id": "PAYABLE_ID"}'

# Listar com paginação automática (NDJSON)
kobana finance financial-transactions list --page-all --fields "id,amount,date"

# Saída em tabela
kobana finance financial-accounts list --output-format table

# Salvar a resposta em arquivo
kobana finance payables get --params '{"id": "PAYABLE_ID"}' --output conta.json

Próximos passos​