API para listagem de acordos feitos via portal de negociação

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

A API de listagem de acordos feitos via portal de negociação deve ser utilizada para exibir os acordos de um devedor feitos pelo portal de negociação, incluindo acordos feitos pela API para cadastro de acordo de forma semelhante ao portal de negociação.


Endpoint: https://www.recuperador.com.br/api/v1PortalNegociacaoAcordos/?id_credor=XXXX&cpf_cnpj=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,
   cpf_cnpj: string

}

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


Classe de retorno

[

   {
       nome_credor: string,
       nome_assessoria: string,
       dataprivencto: datetime,
       valor_acordo: decimal,
       link_fatura: string
   }

]

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

  • nome_credor: retornará uma string com o nome do credor do acordo.
  • nome_assessoria: retornará uma string com o nome da assessoria responsável pelo acordo.
  • dataprivencto: retornará uma string com a data do vencimento da primeira parcela do acordo. Ela estará no formato YYYY-MM-DDT00:00:00.
  • valor_acordo: retornará um decimal representando o valor total do acordo.
  • link_fatura: retornará uma string com a URL para visualização da fatura para pagamento das parcelas do acordo.