Exibir código-fonte para API para cadastro de acordo de forma semelhante ao portal de negociação (quitação)

A API de cadastro de acordos de forma semelhante ao portal de negociação (quitação) deve ser utilizada para registrar um acordo no Recuperador CRM seguindo o formato do portal de negociação para quitação de todas as dívidas em aberto com o credor, ou seja, deverá ser informado o parcelamento desejado e o sistema efetuará o acordo como sendo um acordo feito pelo portal de negociação. Isso é bastante útil para utilizar a funcionalidade do portal de negociação do Recuperador CRM em formato white label.


Endpoint: https://www.recuperador.com.br/api/v1PortalNegociacaoAcordoTotal

Ação: '''POST'''

Formato: '''JSON'''

Autenticação: enviar o '''token''' da API no campo '''username''' da autenticação '''Basic Auth'''. Deixe o campo password em branco.


== Objeto de entrada ==

{
    '''id_credor''': int,
    '''id_cliente''': int,
    '''parcelas''': int,
    '''cpf_cnpj_formatado''': string
}

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

* ID credor: deve ser preenchido com o código do credor das dívidas. 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. Utilize a [[API para listagem de dívidas elegíveis para negociação pelo portal de negociação]] para obter o id correto.
* Parcelas: deve ser preenchido com um valor inteiro representando a quantidade e parcelas do acordo. Utilize a [[API de listagem de parcelamentos do portal de negociação (quitação)]] para obter os parcelamentos válidos definidos pelo administrador do sistema. É importante destacar que o administrador define a quantidade de parcelas e o respectivo desconto por parcelamento. Exemplo: para uma parcela, desconto de 70% nos juros, multa e correção. Para 2 parcelas, desconto de 60% etc. Portanto, é necessário informar a quantidade de parcelas de acordo com os parcelamentos configurados previamente.
* CPF/CNPJ formatado: deve ser preenchido com o CPF ou CNPJ do devedor. O documento deverá ser formatado com ponto, hífen e barra. Exemplo: utilize o formato 999.999.999-99 para CPF ou 99.999.999/9999-99 para CNPJ.


== Classe de retorno ==

{
    '''sucesso''': bool,
    '''mensagem''': string
}

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

* Sucesso: retornará true em caso de acordo realizado com sucesso e false em caso de erro na chamada.
* 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.


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 (quitação)]].