Mudanças entre as edições de "API de listagem de parcelamentos do portal de negociação"

Edição das 16h18min de 25 de março de 2021

A API de listagem de parcelamentos do portal de negociação deve ser utilizada para exibir os parcelamentos válidos para viabilizar a chamada da API para cadastro de acordo de forma semelhante ao portal de negociação.

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.

{

   id_credor: int,
   id_cliente: int,
   id_contasareceber: int

}

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

ID credor: deve ser preenchido código do credor da dívida. 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) da dívida. Utilize a API para listagem de dívidas elegíveis para negociação pelo portal de negociação para obter o id correto.
ID contas a receber: deve ser preenchido código da dívida. Utilize a API para listagem de dívidas elegíveis para negociação pelo portal de negociação para obter o id correto.

[

   {
       parcelas: int,
       descricao: string
   }

]

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

Parcelas: retornará um inteiro representando a quantidade de parcelas definida no parcelamento em questão. Exemplo: 1, 2, 3 etc.
Descricao: exibirá a descrição (resumo) do parcelamento em questão. Exemplo: 1x de R$ 516,59.

@@ Linha 36: / Linha 36: @@
 Seguem informações complementares sobre cada coluna da lista de retorno:
-* Sucesso: retornará true em caso de acordo realizado com sucesso e false em caso de erro na chamada.
+* Parcelas: retornará um inteiro representando a quantidade de parcelas definida no parcelamento em questão. Exemplo: 1, 2, 3 etc.
-* Mensagem: exibirá a mensagem de sucesso ou de erro. Em caso de sucesso, será exibido o link da fatura, que é o link que o devedor deverá acessar para conferir as parcelas geradas, bem como para gerar os boletos ou para permitir o pagamento via cartão de crédito, dependendo da configuração do cadastro do credor.
+* Descricao: exibirá a descrição (resumo) do parcelamento em questão. Exemplo: 1x de R$ 516,59.
-Conforme dito anteriormente, esta API serve para registrar o acordo no Recuperador CRM. Porém, antes disso, é necessário exibir o valor atualizado da dívida, eventuais taxas e exibir o valor com desconto para pagamento à vista. Tais valores podem ser obtidos na [[API de listagem de valores do portal de negociação]].