API de eventos do webhook de parcelas aprovadas

A API de eventos do webhook de parcelas aprovadas deve ser utilizada para listar os eventos de webhook de parcelas aprovadas 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 de parcelas aprovadas.

Lista dos eventos do webhook de parcelas aprovadas

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

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 parcelas aprovadas 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 webhook;
• int id_assessoria: código do administrador;
• int id_credor: código do credor;
• int id_acordo: código do acordo referente à parcela aprovada;
• int id_cliente: código do cliente;
• int id_contasareceber: código da parcela de acordo aprovada;
• int id_consultor: código do consultor responsável pelo acordo;
• string nome_cliente: nome do devedor;
• string cpf_cnpj: CPF ou CNPJ formatado do devedor;
• string nome_credor: nome do credor;
• string nome_consultor: nome do consultor responsável pelo acordo;
• DateTime data_referencia: data da dívida mais antiga negociada no acordo;
• DatTime data_vencto: data de vencimento da parcela de acordo;
• DateTime data_pagto: data de pagamento da parcela de acordo;
• DateTime data_rec: data prevista para recebimento de acordo com o meio de pagamento;
• string meio_pagto: nome do meio de pagamento utilizado. Válido apenas se houver integração com Zoop ou Pagar.me;
• string forma_pagto: nome da forma de pagamento utilizada. Válido apenas se houver integração com Zoop ou Pagar.me;
• string parcela: código da parcela do acordo. Exemplo: 01/12 para parcela 1 de 12.
• int parcela_inteiro: número da parcela do acordo. Exemplo: 1 para parcela 1 de 12.
• decimal valor_principal_proporcional: valor do principal (original) dividido pela quantidade de parcelas acordadas;
• decimal valor_pago: valor pago pelo devedor;
• decimal valor_honorarios_adv: valor negociado de honorários advocaticios, quando aplicáveis;
• decimal valor_honorarios_ass: valor negociado de honorários da assessoria, quando aplicáveis;
• decimal valor_taxa_adm: valor da taxa administrativa (comissões) da assessoria quando aplicáveis;
• decimal valor_taxa_camara: valor da taxa (comissões) da câmara quando aplicáveis;
• decimal valor_taxa_federacao: valor da taxa (comissões) da federação quando aplicáveis;
• decimal valor_taxa_financeira: valor da taxa da instituição financeira quando aplicável;
• decimal valor_taxa_representante: valor da taxa (comissões) do representante quando aplicáveis;
• decimal valor_liquido: valor líquido a ser repassado para o credor, desconsiderando comissões;
• decimal valor_taxa_adm_agrupada: valor das taxas (comissões) agrupadas quando aplicáveis;
• int qtde_parcelas_recuperadas: total de parcelas pagas no 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;
• 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 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_juros_proporcionais: valor dos juros cobrados no acordo dividido pela quantidade de parcelas acordadas;
• decimal valor_multa_proporcional: valor da multa cobrados no acordo dividido pela quantidade de parcelas acordadas;
• decimal valor_correcao_monetaria_proporcional: valor da correção monetária cobrada no acordo dividido pela quantidade de parcelas acordadas;
• int id_grupoconsultor: código do grupo do consultor responsável pelo acordo;
• string nome_grupoconsultor: nome do grupo do consultor responsável pelo acordo;

} ]

Leitura dos eventos do webhook de parcela aprovada

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

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 parcelas aprovadas, presente no payload do Webhook de parcelas aprovadas 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 parcelas aprovadas.
• ID Credor: código do credor no Recuperador CRM. Ele está presente no payload do Webhook de parcelas aprovadas.
• ID Acordo: código do acordo no Recuperador CRM. Ele está presente no payload do Webhook de parcelas aprovadas.
• ID Cliente: código do devedor no Recuperador CRM. Ele está presente no payload do Webhook de parcelas aprovadas.

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 da parcela de acordo gerado pelo Recuperador CRM.