Mudanças entre as edições de "Webhook acordos"

(Criou página com 'Neste capítulo, falaremos sobre como ativar e utilizar o módulo de webhook de acordos. Este módulo serve para integrar sistemas de terceiros com acordos cadastrados no Recu...')
 
 
(2 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 48: Linha 48:
 
*'''int id''': código do webhook;
 
*'''int id''': código do webhook;
 
*'''int id_credor''': código do credor;
 
*'''int id_credor''': código do credor;
−
*'''int id_acordo''': código do acordo referente à parcela aprovada;
+
*'''int id_acordo''': código do acordo;
−
*'''int id_cliente''': código do cliente ;
+
*'''int id_cliente''': código do devedor;
−
*'''int id_parcela''': código da parcela de acordo aprovada;
+
*'''int id_consultor''': código do consultor do acordo;
 
*'''string nome_cliente''': nome do devedor;
 
*'''string nome_cliente''': nome do devedor;
−
*'''string cpf_cnpj''': CPF ou CNPJ formatado do devedor;
+
*'''string cpf_cnpj''': CPF ou CNPJ do devedor;
 
*'''string nome_credor''': nome do credor;
 
*'''string nome_credor''': nome do credor;
−
*'''DatTime data_vencto''': data de vencimento da parcela de acordo;
+
*'''string nome_consultor''': nome do consultor do acordo;
−
*'''DateTime data_pagto''': data de pagamento da parcela de acordo;
+
*'''string data''': data do acordo;
−
*'''string meio_pagto''': nome do meio de pagamento utilizado. Válido apenas se houver integração com Zoop ou Pagar.me;
+
*'''int atraso''': atraso em dias da dívida mais antiga negociada no acordo;
−
*'''string forma_pagto''': nome da forma de pagamento utilizada. Válido apenas se houver integração com Zoop ou Pagar.me;
+
*'''string datavencto_original''': data de vencimento da dívida mais antiga negociada no acordo;
−
*'''string parcela''': código da parcela do acordo. Exemplo: 01/12 para parcela 1 de 12.
+
*'''decimal valor_original''': valor das dívidas negociadas sem descontos;
−
*'''decimal valor_principal_proporcional''': valor do principal (original) dividido pela quantidade de parcelas acordadas;
+
*'''decimal valor_acordo''': valor final do acordo (com descontos);
−
*'''decimal valor_pago''': valor pago pelo devedor;
+
*'''int parcelas''': quantidade de parcelas geradas pelo acordo, incluindo a entrada quando houver;
−
*'''decimal valor_honorarios_adv''': valor negociado de honorários advocaticios, quando aplicáveis;
+
*'''string periodicidade''': periodicidade definida entre as parcelas do acordo. Exibe os valores M, Q ou S para periodicidade mensal, quinzenal ou semanal respectivamente,
−
*'''decimal valor_honorarios_ass''': valor negociado de honorários da assessoria, quando aplicáveis;
+
*'''string dataprivencto''': data de vencimento da primeira parcela do acordo;
−
*'''decimal valor_liquido''': valor líquido a ser repassado para o credor, desconsiderando comissões;
+
*'''string entrada''': define se foi cobrada ou não entrada no acordo. Aceita os valores S ou N para sim ou não respectivamente;
−
*'''decimal valor_taxa_adm_agrupada''': valor da taxa administrativa (comissões) da assessoria;
+
*'''string data_entrada''': data de vencimento da entrada do acordo;
−
*'''string contratos''': lista de códigos de contrato das dívidas negociadas no acordo desta parcela. Se houver mais de um código de contrato, eles serão separados por vírgula;
+
*'''decimal valor_entrada''': valor da entrada do acordo;
−
*'''string unidades''': lista de códigos de unidade das dívidas negociadas no acordo desta parcela. Se houver mais de um código de unidade, eles serão separados por vírgula;
+
*'''string feito_via_portal_negociacao''': define se o acordo foi feito ou não pelo portal de negociação. Aceita os valores S ou N para sim ou não respectivamente;
−
*'''string competencias''': lista de datas de competência das dívidas negociadas no acordo desta parcela. Se houver mais de uma data de competência, elas serão separados por vírgula;
+
*'''decimal valor_desconto_juros_multa_correcao''': valor total dos descontos em juros, multa e correções do acordo;
−
*'''decimal valor_juros_proporcionais''': valor dos juros cobrados no acordo dividido pela quantidade de parcelas acordadas;
+
*'''decimal valor_desconto_principal''': valor do desconto no valor principal (valor original das dívidas);
−
*'''decimal valor_multa_proporcional''': valor da multa cobrados no acordo dividido pela quantidade de parcelas acordadas;
+
*'''decimal valor_juros_proporcional_acordado''': valor do desconto nos juros do acordo;
−
*'''decimal valor_correcao_monetaria_proporcional''': valor da correção monetária cobrada no acordo dividido pela quantidade de parcelas acordadas;
+
*'''decimal valor_multa_proporcional_acordada''': valor do desconto na multa do acordo;
 +
*'''decimal valor_correcao_proporcional_acordada''': valor do desconto na correção monetária do acordo;
 +
*'''decimal obs''': observações definidas no formulário do acordo;
 +
*'''decimal obs_publicas''': observações públicas, visíveis na tela de fatura do acordo, definidas no formulário do acordo,
 +
*'''decimal cancelado''': define se o acordo foi cancelado ou não. Aceita os valores S ou N para sim ou não respectivamente;
 +
*'''string data_cancelamento''': data do cancelamento do acordo;
 +
*'''string motivo_cancelamento''': motivo do cancelamento do acordo definido no formulário de cancelamento;
 +
*'''string situacao''': define a situação do acordo. Aceita os valores A, I ou Q para Aguardando pagamento, Inativo e Quitado respectivamente;
 +
*'''array lista_dividas''': array com a lista de dívidas negociadas no acordo;
 +
*'''array lista_parcelas''': array com a parcelas geradas pelo acordo;
 +
 
 +
 
 +
== Classe do array lista_dividas ==
 +
 
 +
*'''int id''': código da dívida;
 +
*'''string datavencto''': data de vencimento da dívida;
 +
*'''string datapagto''': data de pagamento da dívida, definida apenas quando o acordo estiver quitado;
 +
*'''decimal valor''': valor original da dívida;
 +
*'''string descricao''': breve descrição da dívida;
 +
*'''string obs''': observações da dívida;
 +
*'''string contrato''': código do contrato da dívida;
 +
*'''string unidade''': unidade da dívida;
 +
*'''string competencia''': competência da dívida;
 +
*'''string codigo''': código da dívida definido no importador;
 +
*'''string situacao''': define a situação da dívida. Aceita os valores N e P para não pago e pago respectivamente;
 +
 
 +
 
 +
== Classe do array lista_parcelas ==
 +
 
 +
*'''int id''': código da parcela;
 +
*'''string datavencto''': data de vencimento da parcela;
 +
*'''string datapagto''': data de pagamento da parcela, definida apenas quando a parcela estiver paga;
 +
*'''decimal valor''': valor da parcela;
 +
*'''string situacao''': define a situação da parcela. Aceita os valores N e P para não pago e pago respectivamente;

Edição atual tal como às 18h20min de 14 de abril de 2022

Neste capítulo, falaremos sobre como ativar e utilizar o módulo de webhook de acordos. Este módulo serve para integrar sistemas de terceiros com acordos cadastrados 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 o acordo cadastrado. Isso permitirá com que o sistema de terceiros faça algumas ações, tais como cadastrar uma negociação, registrar faturas (contas a receber) e entre outras coisas.


Dica: sistema de terceiros é um sistema feito por outra empresa, diferente da empresa responsável pelo Recuperador CRM, que receberá as informações do acordo. 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 acordos no cadastro do credor em questão. Isso pode ser feito logado como administrador (assessoria) por meio do menu Cadastros > Credores > aba Webhooks. Mude o campo HABILITA WEBHOOK DE ACORDOS para Sim, defina o endereço do endpoint do sistema de terceiros e clique em Salvar.


Importante: o endpoint do webhook de acordos 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 acordos

Os webhooks de acordos serão disparados automaticamente sempre que:


  1. Um acordo for cadastrado no formulário de acordos;
  2. Um acordo for cadastrado usando o portal de negociações;
  3. Um acordo for cancelado;
  4. Um acordo for quitado;


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.


Relatório

Em Cadastros > Credores > aba Webhooks > botão Lista de payloads de acordos, é possível consultar os disparos dos webhooks de acordos 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 acordos 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.


ListaPayloadsAcordos.png

Lista de payloads de acordos com destaque para a coluna Enviado e botão Reprocessar


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;
  • int id_cliente: código do devedor;
  • int id_consultor: código do consultor do acordo;
  • string nome_cliente: nome do devedor;
  • string cpf_cnpj: CPF ou CNPJ do devedor;
  • string nome_credor: nome do credor;
  • string nome_consultor: nome do consultor do acordo;
  • string data: data do acordo;
  • int atraso: atraso em dias da dívida mais antiga negociada no acordo;
  • string datavencto_original: data de vencimento da dívida mais antiga negociada no acordo;
  • decimal valor_original: valor das dívidas negociadas sem descontos;
  • decimal valor_acordo: valor final do acordo (com descontos);
  • int parcelas: quantidade de parcelas geradas pelo acordo, incluindo a entrada quando houver;
  • string periodicidade: periodicidade definida entre as parcelas do acordo. Exibe os valores M, Q ou S para periodicidade mensal, quinzenal ou semanal respectivamente,
  • string dataprivencto: data de vencimento da primeira parcela do acordo;
  • string entrada: define se foi cobrada ou não entrada no acordo. Aceita os valores S ou N para sim ou não respectivamente;
  • string data_entrada: data de vencimento da entrada do acordo;
  • decimal valor_entrada: valor da entrada do acordo;
  • string feito_via_portal_negociacao: define se o acordo foi feito ou não pelo portal de negociação. Aceita os valores S ou N para sim ou não respectivamente;
  • decimal valor_desconto_juros_multa_correcao: valor total dos descontos em juros, multa e correções do acordo;
  • decimal valor_desconto_principal: valor do desconto no valor principal (valor original das dívidas);
  • decimal valor_juros_proporcional_acordado: valor do desconto nos juros do acordo;
  • decimal valor_multa_proporcional_acordada: valor do desconto na multa do acordo;
  • decimal valor_correcao_proporcional_acordada: valor do desconto na correção monetária do acordo;
  • decimal obs: observações definidas no formulário do acordo;
  • decimal obs_publicas: observações públicas, visíveis na tela de fatura do acordo, definidas no formulário do acordo,
  • decimal cancelado: define se o acordo foi cancelado ou não. Aceita os valores S ou N para sim ou não respectivamente;
  • string data_cancelamento: data do cancelamento do acordo;
  • string motivo_cancelamento: motivo do cancelamento do acordo definido no formulário de cancelamento;
  • string situacao: define a situação do acordo. Aceita os valores A, I ou Q para Aguardando pagamento, Inativo e Quitado respectivamente;
  • array lista_dividas: array com a lista de dívidas negociadas no acordo;
  • array lista_parcelas: array com a parcelas geradas pelo acordo;


Classe do array lista_dividas

  • int id: código da dívida;
  • string datavencto: data de vencimento da dívida;
  • string datapagto: data de pagamento da dívida, definida apenas quando o acordo estiver quitado;
  • decimal valor: valor original da dívida;
  • string descricao: breve descrição da dívida;
  • string obs: observações da dívida;
  • string contrato: código do contrato da dívida;
  • string unidade: unidade da dívida;
  • string competencia: competência da dívida;
  • string codigo: código da dívida definido no importador;
  • string situacao: define a situação da dívida. Aceita os valores N e P para não pago e pago respectivamente;


Classe do array lista_parcelas

  • int id: código da parcela;
  • string datavencto: data de vencimento da parcela;
  • string datapagto: data de pagamento da parcela, definida apenas quando a parcela estiver paga;
  • decimal valor: valor da parcela;
  • string situacao: define a situação da parcela. Aceita os valores N e P para não pago e pago respectivamente;
Disponível em "http://docs.recuperador.com.br/index.php?title=Webhook_acordos&oldid=860"