Recuperador CRM | Documentação - Mudanças recentes [pt-br]

Webhook de boletos manuais

2026-10-15T14:31:50Z

Webhook de boletos manuais

2026-10-15T14:09:52Z

Criou página com '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 Re...'

Página nova

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:

# 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;

Webhook de parcelas aprovadas

2026-10-15T14:07:33Z

Webhook acordos

2026-10-15T14:01:52Z

Webhook de limpeza de transação

2026-10-15T13:55:09Z

Webhook de limpeza de transação

2026-10-15T13:51:01Z

Criou página com 'Neste capítulo, falaremos sobre como ativar e utilizar o módulo de webhook de limpeza de transação. Este módulo serve para integrar sistemas de terceiros com boletos manu...'

Página nova

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

Limpeza de transação é um procedimento usado para cancelar uma transação de meio de pagamento. Serve para cancelar o registro de um boleto, cancelar um QR Code PIX etc. Ela normalmente é feita a pedido do devedor que perdeu o prazo de pagamento de um boleto ou PIX. A limpeza também acontece para viabilizar o cancelamento de um acordo que possua uma parcela com boleto ou transação PIX gerada e não paga.

Em resumo, o objetivo desse módulo é disparar automaticamente uma mensagem em formato POST para um sistema de terceiros com dados sobre a limpeza de transação efetuada. Isso permitirá com que o sistema de terceiros faça algumam ações, tais como remover o registro do boleto, cancelar uma transação PIX etc.

Dica: sistema de terceiros é um sistema feito por outra empresa, diferente da empresa responsável pelo Recuperador CRM, que receberá as informações da parcela afetada pela limpeza de transação. Esse sistema de terceiros pode ser um sistema de gestão, pode ser um sistema próprio etc.

== Configuração inicial ==

O primeiro passo é habilitar o webhook de limpeza de transação 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 limpeza de transação''' para '''Sim''', defina o endereço do endpoint do sistema de terceiros e clique em '''Salvar'''.

Importante: o endpoint do webhook de limpeza de transação 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 limpeza de transação ==

Os webhooks de limpeza de transação serão disparados automaticamente sempre que:

# Uma parcela de acordo for afetada pela limpeza de transação manual;
# Uma parcela de acordo for afetada pela limpeza de transação para cancelamento automático de acordos;
# Uma parcela de acordo for afetada pela limpeza de transação por meio do endpoint de limpeza de transação (integração);

Além disso, o sistema fará uma retentativa diária de disparo de webhooks não processados nos últimos 7 dias na parte da manhã. O sistema faz até 5 tentativas de envio de webhook de uma limpeza de transação para o sistema de terceiros.

== Relatório ==

Em '''Cadastros > Credores > aba Webhooks > botão Lista de payloads de limpeza de transação''', é possível consultar os disparos dos webhooks de limpeza de transação 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 limpeza de transação 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;
*'''int id_limpezatransacao''': 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;
*'''string meio_pagto''': nome do meio de pagamento utilizado na transação afetada pela limpeza de transação;
*'''decimal valor''': valor da parcela afetada;
*'''DateTime data_limpeza''': data da limpeza de transação da parcela de acordo;

Página principal

2026-10-15T13:27:17Z

← Edição anterior		Edição das 14h07min de 15 de outubro de 2026
Linha 27:		Linha 27:


−	~~Além disso, o sistema fará uma retentativa diária de disparo de webhooks não processados nos últimos 7 dias na parte da manhã.~~ O sistema faz até 5 tentativas de envio de webhook de uma parcela aprovada para o sistema de terceiros.	+	O sistema faz até 5 tentativas de envio de webhook de uma parcela aprovada para o sistema de terceiros.

← Edição anterior		Edição das 14h01min de 15 de outubro de 2026
Linha 27:		Linha 27:


−	~~Além disso, o sistema fará uma retentativa diária de disparo de webhooks não processados nos últimos 7 dias na parte da manhã.~~ O sistema faz até 5 tentativas de envio de webhook de um acordo para o sistema de terceiros.	+	O sistema faz até 5 tentativas de envio de webhook de um acordo para o sistema de terceiros.

← Edição anterior		Edição das 13h55min de 15 de outubro de 2026
Linha 29:		Linha 29:


−	~~Além disso, o~~ sistema fará ~~uma retentativa diária de disparo de webhooks não processados nos últimos 7 dias na parte da manhã. O sistema faz~~ até 5 tentativas de envio de webhook de uma limpeza de transação para o sistema de terceiros.	+	O sistema fará até 5 tentativas de envio de webhook de uma limpeza de transação para o sistema de terceiros.

@@ Linha 54: / Linha 54: @@
 # [[Webhook de parcelas aprovadas]]
 # [[Webhook acordos]]
 # [[Domínio personalizado]]
 # [[Limite de acesso dos consultores]]

@@ Linha 47: / Linha 47: @@
 *'''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;
+*'''DateTime data_vencto''': data de vencimento da parcela de acordo;
 *'''decimal valor''': valor da parcela afetada;
 *'''decimal valor_corrigido''': valor atualizado da parcela afetada;
@@ Linha 53: / Linha 53: @@
 *'''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;
+*'''DateTime datacad''': data da solicitação do boleto manual;