API de listagem de valores do portal de negociação (quitação)
A API de listagem de valores do portal de negociação (quitação) deve ser utilizada para exibir o valor atualizado das dívidas, 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 (quitação).
Endpoint: https://app.recuperador.com.br/api/v1PortalNegociacaoValoresTotal/?id_credor=XXXX&id_cliente=YYYY
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
}
Seguem informações complementares sobre cada parâmetro de entrada:
- ID credor: deve ser preenchido código do credor das dívidas para quitação. Utilize a API para listagem de dívidas elegíveis para negociação pelo portal de negociação para obter o id correto.
- ID cliente: deve ser preenchido código do cliente (devedor) das dívidas para quitação. Utilize a API para listagem de dívidas elegíveis para negociação pelo portal de negociação para obter o id correto.
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.