API de listagem de valores do portal de negociação

De Recuperador CRM | Documentação
Ir para: navegação, pesquisa

A API de listagem de valores do portal de negociação deve ser utilizada para exibir o valor atualizado da dívida, eventuais taxas e exibir o valor com desconto para pagamento à vista. Tais valores são necessários para exibição no formulário de acordo e viabilizar a chamada da API para cadastro de acordo de forma semelhante ao portal de negociação.


Endpoint: https://www.recuperador.com.br/api/v1PortalNegociacaoValores/?id_credor=XXXX&id_cliente=YYYY&id_contasareceber=ZZZZ

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,
   id_cliente: int,
   id_contasareceber: int

}

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


Classe de retorno

{

   valor_fixo_por_parcela_extra: decimal,
   cobrar_valor_fixo_por_acordo: string,
   valor_fixo_por_acordo_extra: decimal,
   valor_corrigido: decimal,
   valor_com_maior_desconto: decimal,
   countAcordosAguardandoPgto: int

}

Seguem informações complementares sobre cada coluna da classe de retorno:

  • valor_fixo_por_parcela_extra: retornará um decimal representando o valor da taxa fixa por parcela extra, se configurado nas taxas administrativas do credor.
  • cobrar_valor_fixo_por_acordo: exibirá S para informar que será feita a cobrança de um valor fixo pelo acordo ou N para informar que não será cobrado um valor fixo pelo acordo.
  • valor_fixo_por_acordo_extra: retornará um decimal representando o valor da taxa fixa por acordo extra, se configurado nas taxas administrativas do credor.
  • valor_corrigido: retornará um decimal representando o valor da dívida atualizado com juros, multa, correção monetária (se houver) e taxa de cartório (se houver).
  • valor_com_maior_desconto: retornará um decimal representando o valor da dívida atualizado com juros, multa, correção monetária (se houver) e taxa de cartório (se houver) menos o desconto aplicado ao menor parcelamento. Exemplo: valor com desconto para pagamento à vista, caso o menor parcelamento seja em uma parcela.
  • countAcordosAguardandoPgto: retornará um inteiro representando a quantidade de acordos que o devedor possui aguardando pagamento e que foram gerados pelo portal de negociação.