Contas a receber
O que você tem a receber, com emissão e cancelamento de cobrança pelo Gateway Bancário a partir do próprio título. Para movimentar o dinheiro, o comando é charge — o registro em si fica aqui.
| Comando | HTTP | Descrição |
|---|---|---|
receivables list | GET /v1/receivables | Listar contas a receber |
receivables create | POST /v1/receivables | Criar conta a receber |
receivables get | GET /v1/receivables/{id} | Obter conta a receber por ID |
receivables update | PATCH /v1/receivables/{id} | Atualizar ou liquidar conta a receber |
receivables delete | DELETE /v1/receivables/{id} | Excluir conta a receber |
receivables aggregates list | GET /v1/receivables/aggregates | Somar totais de contas a receber |
receivables charge create | POST /v1/receivables/{id}/charge | Gerar cobrança de uma conta a receber |
receivables charge cancel create | POST /v1/receivables/{id}/charge/cancel | Cancelar a cobrança de uma conta a receber |
receivables ids list | GET /v1/receivables/ids | Listar IDs de contas a receber |
Exemplos
--params carrega parâmetros de query e de caminho (id, página, filtros); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa.
# Listar contas a receber
kobana finance receivables list \
--fields "id,company_id,description,amount,interest_amount"
# Obter conta a receber por ID
kobana finance receivables get --params '{"id": "RECEIVABLE_ID"}'
# Criar conta a receber
kobana finance receivables create \
--json '{"company_id": "COMPANY_ID", "description": "DESCRIPTION", "amount": "1500.00", "due_date": "2026-01-31T12:00:00Z"}'
# Atualizar ou liquidar conta a receber
kobana finance receivables update \
--params '{"id": "RECEIVABLE_ID"}' \
--json '{"description": "DESCRIPTION", "amount": "1500.00", "due_date": "2026-01-31T12:00:00Z"}'
# Excluir conta a receber
kobana finance receivables delete --params '{"id": "RECEIVABLE_ID"}' --dry-run
Próximos passos
- Fluxo de caixa
- Introspecção de schema — todos os parâmetros que este recurso aceita.