Webhook de boletos manuais

Neste capítulo, falaremos sobre como ativar e utilizar o módulo de webhook de boleto manual. Este módulo serve para integrar sistemas de terceiros com boletos manuais no Recuperador CRM.

Em resumo, o objetivo desse módulo é disparar automaticamente uma mensagem em formato POST para um sistema de terceiros com dados sobre a intenção de um devedor de abrir um boleto, quando o credor estiver configurado para utilizar boletos manuais.

Isso permitirá com que o sistema de terceiros faça algumas ações, tais como gerar um boleto, registrar o boleto no banco, chamar o endpoint de atualização de boleto manual do Recuperador CRM etc.

Configuração inicial

O primeiro passo é habilitar o webhook de boleto manual no cadastro do credor em questão. Isso pode ser feito logado como administrador por meio do menu Cadastros > Credores > aba Webhooks. Mude o campo Habilita webhook de boleto manual para Sim, defina o endereço do endpoint do sistema de terceiros e clique em Salvar.

Importante: o endpoint do webhook de boleto manual deve ser obtido com o suporte do seu sistema de terceiros. Ele deve começar com http ou https.

Locais de disparo do webhook de boleto manual

Os webhooks de boleto manual será disparado automaticamente sempre que:

1. O usuário clicar no botão Boleto na tela de fatura de uma parcela de acordo de credores configurados para utilizar o meio de pagamento Boleto Manual;

O sistema fará até 5 tentativas de envio de webhook de boleto manual para o sistema de terceiros.

Relatório

Em Cadastros > Credores > aba Webhooks > botão Lista de payloads de boleto manual, é possível consultar os disparos dos webhooks de boleto manual por período e o status do envio por meio da coluna Enviado.

Além disso, é possível usar o botão Reprocessar para forçar o envio dos webhooks de boleto manual de um determinado período que eventualmente não foram enviados. Isso pode ser especialmente útil em caso de queda temporária do sistema de terceiros.

Classe do evento do payload

O webhook disparará uma ação de POST para o endpoint informado no formato JSON com os seguintes campos:

• int id: código do webhook;
• int id_credor: código do credor;
• int id_acordo: código do acordo referente à parcela afetada;
• int id_cliente: código do cliente ;
• int id_contasareceber: código da parcela de acordo afetada;
• string nome_cliente: nome do devedor;
• string cpf_cnpj: CPF ou CNPJ formatado do devedor;
• string nome_credor: nome do credor;
• DatTime data_vencto: data de vencimento da parcela de acordo;
• decimal valor: valor da parcela afetada;
• decimal valor_corrigido: valor atualizado da parcela afetada;
• string cobrar_juros_multa: valor do parâmetro definido no credor para cobrar ou não juros e multa em caso de atrasos. Retorna S para Sim e N para Não;
• decimal pct_juros_dia_parcela: valor do percentual de juros ao dia em caso de atrasos;
• decimal pct_multa_parcela: valor do percentual de multa em caso de atrasos;
• DatTime datacad: data da solicitação do boleto manual;