API de eventos do webhook de acordos

A API de eventos do webhook de acordos deve ser utilizada para listar os eventos de webhook de acordos enviados nos últimos dias e também permite marcar um evento como lido pelo sistema de destino. Isso é especialmente útil em caso de implementação de middleware de integração com sistemas ERPs.

Para saber mais sobre a configuração do webhook, por favor, consulte a documentação Webhook acordos.

Lista dos eventos do webhook de acordos

Endpoint: https://www.recuperador.com.br/api/v1PayloadWebhookAcordo

Ação: GET

Formato: JSON

Autenticação: enviar o token da API no campo username da autenticação Basic Auth. Deixe o campo password em branco.

Parâmetros de entrada

{

   id_credor: int,
   qtde_dias_leitura: int

}

Seguem informações complementares sobre cada parâmetro de entrada:

• ID do credor: aceita apenas valores inteiros e é obrigatório. Ele deve ser preenchido com o código do credor que aparece em Cadastros > Credores.
• Quantidade de dias de leitura: informa o período em dias de abrangência da consulta para leitura dos eventos de webhook de acordos não lidos, ou seja, que não receberam a ação de post desta API que será explicada a seguir.

Lista de retorno

[ {

• int id: código do evento do webhook de acordos;
• int id_assessoria: código do administrador;
• 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 situacao: define a situação da parcela. Aceita os valores N e P para não pago e pago respectivamente;
• string datapagto: data de pagamento da parcela, definida apenas quando a parcela estiver paga;
• decimal valor: valor da parcela;
• string link_faturacr_gerado_pelo_recuperadorcrm: link de pagamento gerado pelo Recuperador CRM;

Leitura dos eventos do webhook de acordos

Endpoint: https://www.recuperador.com.br/api/v1PayloadWebhookAcordo

Ação: POST

Formato: JSON

Autenticação: enviar o token da API no campo username da autenticação Basic Auth. Deixe o campo password em branco.

Objeto de entrada

{

   id: inteiro,
   id_assessoria: inteiro, 
   id_credor: inteiro,
   id_acordo: inteiro,
   id_cliente: inteiro

}

Seguem informações complementares sobre cada coluna do objeto:

• ID: código do evento do webhook de acordos, presente no payload do Webhook de acordos na lista de parcelas (método GET acima).
• ID Assessoria: código do administrador no Recuperador CRM. Ele está presente no payload do Webhook de acordos.
• ID Credor: código do credor no Recuperador CRM. Ele está presente no payload do Webhook de acordos.
• ID Acordo: código do acordo no Recuperador CRM. Ele está presente no payload do Webhook de acordos.
• ID Cliente: código do devedor no Recuperador CRM. Ele está presente no payload do Webhook de acordos.

Classe de retorno

{

   sucesso: bool,
   mensagem: string, 
   link_fatura_gerada_pelo_recuperadorcrm: string

}

Seguem informações complementares sobre cada coluna do objeto:

• Sucesso: retornará true em caso de chamada realizada com sucesso e false em caso de erro na chamada.
• Mensagem: exibirá a mensagem de sucesso ou de erro.
• Link da fatura gerada pelo Recuperador CRM: endereço da fatura para pagamento do acordo gerado pelo Recuperador CRM.