API de importação de clientes e dívidas

A API de importação de clientes e dívidas deve ser utilizada para cadastrar um ou mais clientes e uma ou mais dívidas em um mesmo endpoint no Recuperador CRM. Assim, esta API é útil para chamar primeiro a API de importação de clientes e depois a API de importação de dívidas em um único endpoint.

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

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

{

   atualizar: string,
   email: string, 
   clientes: array de cliente,
   dividas: array de divida,
   interromper_duplicidade: string

}

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

• Atualizar: deve ser preenchido com S para Sim e N para Não. Quando marcado como S, este campo faz o importador atualizar CPFs ou CNPJs existentes na base de dados com os novos dados.
• E-mail: e-mail que receberá o resultado da importação. Este método é assíncrono, por isso deve-se informar um endereço de e-mail para recebimento do resultado do processamento.
• Clientes: lista de clientes a serem importados. O array deve ser do tipo cliente, que será descrito na documentação da API de importação de clientes.
• Dividas: lista de dívidas a serem importadas. O array deve ser do tipo divida, que será descrito na documentação da API de importação de dívidas.
• Interromper por duplicidade: deve ser preenchido com S para Sim e N para Não. Quando marcado com N, não exibe o erro de duplicidade e pode ser útil em importações incrementais. Válido apenas quando o campo Atualizar for igual a N (Não).

Classe de retorno

{

   sucesso: bool,
   mensagem: string

}

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

• Sucesso: retornará true em caso de chamada realizada com sucesso e false em caso de erro na chamada.
• Mensagem: exibirá a mensagem de sucesso ou de erro.