Pular para o conteúdo principal

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.

ComandoHTTPDescrição
receivables listGET /v1/receivablesListar contas a receber
receivables createPOST /v1/receivablesCriar conta a receber
receivables getGET /v1/receivables/{id}Obter conta a receber por ID
receivables updatePATCH /v1/receivables/{id}Atualizar ou liquidar conta a receber
receivables deleteDELETE /v1/receivables/{id}Excluir conta a receber
receivables aggregates listGET /v1/receivables/aggregatesSomar totais de contas a receber
receivables charge createPOST /v1/receivables/{id}/chargeGerar cobrança de uma conta a receber
receivables charge cancel createPOST /v1/receivables/{id}/charge/cancelCancelar a cobrança de uma conta a receber
receivables ids listGET /v1/receivables/idsListar 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​