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

(Criou página com '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 acord...')
 
 
(2 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 2: Linha 2:
  
  
−
Endpoint: https://www.recuperador.com.br/api/v1PortalNegociacaoParcelas/?id_credor=XXXX&id_cliente=YYYY&id_contasareceber=ZZZZ
+
Endpoint: https://app.recuperador.com.br/api/v1PortalNegociacaoParcelas/?id_credor=XXXX&id_cliente=YYYY&id_contasareceber=ZZZZ
  
 
Ação: '''GET'''
 
Ação: '''GET'''
Linha 19: Linha 19:
 
}
 
}
  
−
Seguem informações complementares sobre cada coluna do objeto:
+
Seguem informações complementares sobre cada parâmetro de entrada:
  
 
* 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 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 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.
 
* 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.
 +
  
 
== Lista de retorno ==
 
== Lista de retorno ==
Linha 36: Linha 37:
 
Seguem informações complementares sobre cada coluna da lista de retorno:
 
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]].
 

Edição atual tal como às 21h04min de 22 de junho de 2023

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.


Endpoint: https://app.recuperador.com.br/api/v1PortalNegociacaoParcelas/?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:


Lista de retorno

[ 

   {
       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.
Disponível em "http://docs.recuperador.com.br/index.php?title=API_de_listagem_de_parcelamentos_do_portal_de_negociação&oldid=1031"