API de importação de dívidas

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

A API de importação de dívidas deve ser utilizada para cadastrar uma ou mais dívidas para clientes no Recuperador CRM.


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

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, 
   dividas: array de divida

}

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 dívidas com códigos 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.
  • Dividas: lista de dívidas a serem importadas. O array deve ser do tipo divida, que será descrito abaixo.


Classe divida

{

   id_credor: int
   codigo: string,
   cpf_cnpj: string, 
   nome_cliente: string, 
   datavencto: DateTime,
   situacao: string, 
   datapagto: DateTime,
   valor: decimal, 
   descricao: string, 
   obs: string, 
   valor_cartorio: decimal, 
   contrato: string, 
   unidade: string, 
   competencia: string

}

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

  • *ID do credor: aceita apenas valores inteiros e é obrigatório. Ele deve ser preenchido com o código do credor que aparece em Cadastros > Credores.
  • *Codigo: aceita no máximo de 100 caracteres e é obrigatório.
  • *CPF/CNPJ: aceita no máximo de 18 caracteres e é obrigatório. Somente números preferencialmente.
  • *Cliente: aceita no máximo 40 caracteres e é obrigatório.
  • *Data vencto.: aceita no máximo 10 caracteres no formato AAAA-MM-DD e é obrigatório.
  • *Situacao: aceita no máximo 1 caractere e é obrigatório. Informe N maiúsculo para parcelas não pagas e P maiúsculo para parcelas pagas.
  • Data pagto.: aceita no máximo 10 caracteres no formato AAAA-MM-DD e é obrigatório apenas para situação P.
  • *Valor: aceita no máximo 8 dígitos e é obrigatório. Use ponto como separador de decimais.
  • *Descricao: aceita no máximo 40 caracteres e é obrigatório.
  • Obs: aceita no máximo 100 caracteres e não é obrigatório.
  • Valor do protesto: aceita no máximo 8 dígitos e não é obrigatório. Use ponto como separador de decimais.
  • Contrato: aceita no máximo 40 dígitos. Pode ou não ser obrigatório dependendo da parametrização do cadastro do credor.
  • Unidade: aceita no máximo 40 dígitos. Pode ou não ser obrigatório dependendo da parametrização do cadastro do credor.
  • Competência: aceita no máximo 40 dígitos. Pode ou não ser obrigatório dependendo da parametrização do cadastro do credor.

Importante: os clientes devem existir previamente no cadastro de clientes com o mesmo CPF ou CNPJ informados na planilha para viabilizar a importação. Porém, se o parâmetro Exigir Dados Completos do Cliente estiver marcado como Não no cadastro do credor e um CPF/CNPJ a ser importado não estiver cadastrado, então o importador tentará criar o cadastro do cliente para viabilizar a importaçã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.