A aba Cobrança expõe a gestão de cobrança dos contratos: listar os contratos, consultar a cobrança (parcelas, boleto e pix), gerar e cancelar boletos, negociar e renegociar parcelas, incluir entrada e notificar o cliente por WhatsApp. Todo contrato é endereçado pelo code público da operação (o mesmo da aba Operações).
Autentique-se antes (Autenticação) e revise os Conceitos da API (envelope __hcf, erros). O acesso à cobrança depende das permissões financeiras do seu tenant.

Fluxo

1

Listar os contratos

ListarContratos traz a lista paginada dos contratos, com filtros por produto, texto, status e período.
2

Ver a cobrança

ObterCobranca traz o detalhe da cobrança de um contrato (valor pendente, parcela em atraso, vencimento, código do boleto e pix copia e cola).
3

Boletos

Pelo code: GerarBoleto, CancelarBoleto ou CancelarEReemitirBoleto para as parcelas alvo.
4

Negociação e avisos

ExecutarNegociacao e CancelarNegociacao para renegociar parcelas, IncluirLancamento para lançar uma entrada e NotificarWhatsApp para avisar o cliente.

Observações

  • O contrato é sempre identificado pelo code público da operação, nunca por id interno.
  • Os campos de enum (produto, status, tipo de cálculo, tipo de negociação) são inteiros, descritos em cada endpoint.