Mudanças entre as edições de "API de importação de dívidas"
 
(8 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/WsImportacaoDivida
+
Endpoint: https://app.recuperador.com.br/api/v1ImportacaoDivida
  
 
Ação: '''POST'''
 
Ação: '''POST'''
Linha 16: Linha 16:
 
     '''atualizar''': string,
 
     '''atualizar''': string,
 
     '''email''': string,  
 
     '''email''': string,  
−
     '''dividas''': array de divida
+
     '''dividas''': array de divida,
 +
    '''interromper_duplicidade''': string
 
}
 
}
 +
  
 
Seguem informações complementares sobre cada coluna do objeto:
 
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.
 
* 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.
 
* 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.
 
* Dividas: lista de dívidas a serem importadas. O array deve ser do tipo divida, que será descrito abaixo.
−
 
+
* 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 divida ==
 
== Classe divida ==
Linha 42: Linha 45:
 
     '''contrato''': string,  
 
     '''contrato''': string,  
 
     '''unidade''': string,  
 
     '''unidade''': string,  
−
     '''competencia''': string
+
     '''competencia''': string,
 +
    '''valor_desconto_pontualidade''': decimal,
 +
    '''cobrar_juros_multa_correcao_nivel_divida''': string,
 +
    '''tipo_juros''': string,
 +
    '''pct_juros_dia''': decimal,
 +
    '''pct_juros_mes''': decimal,
 +
    '''pct_multa''': decimal,
 +
    '''id_tabela_correcao_monetaria ''': inteiro
 
}
 
}
 +
  
 
Seguem informações complementares sobre cada coluna do objeto:
 
Seguem informações complementares sobre cada coluna do objeto:
  
−
* *ID do credor: aceita apenas valores inteiros e é obrigatório somente na importação de múltiplos credores. Ele deve ser preenchido com o código do credor que aparece em Cadastros > Credores.
+
 
 +
* *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.
 
* *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.
 
* *CPF/CNPJ: aceita no máximo de 18 caracteres e é obrigatório. Somente números preferencialmente.
Linha 61: Linha 73:
 
* Unidade: 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.
 
* Competência: aceita no máximo 40 dígitos. Pode ou não ser obrigatório dependendo da parametrização do cadastro do credor.
 +
* Desconto por pontualidade: aceita no máximo 8 dígitos e não é obrigatório. Use vírgula como separador de decimais.
 +
* Cobrar juros multa e correção no nível da dívida: aceita no máximo 1 dígito. Deve ser preenchido com S para sim ou N para não. Pode ou não ser obrigatório dependendo da parametrização do administrador.
 +
* Tipo de juros: aceita no máximo 1 dígito. Deve ser preenchido com S para sim ou N para não. Pode ou não ser obrigatório dependendo da parametrização do administrador.
 +
* Porcentagem de juros simples ao dia: aceita no máximo 5 dígitos, sendo até 3 casas decimais e não é obrigatório. Use vírgula como separador de decimais.
 +
* Porcentagem de juros compostos ao mês: aceita no máximo 5 dígitos, sendo até 3 casas decimais e não é obrigatório. Use vírgula como separador de decimais.
 +
* Porcentagem de multa: aceita no máximo 5 dígitos, sendo até 3 casas decimais e não é obrigatório. Use vírgula como separador de decimais.
 +
* Código da tabela de correção monetária: aceita valores inteiros e não é obrigatório. Consulte o help da tela de importação para obter os valores atualizados de cada tabela.
 +
  
 
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.
 
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 (postback) ==
+
== Classe de retorno ==
  
 
{
 
{
Linha 71: Linha 91:
 
     '''mensagem''': string
 
     '''mensagem''': string
 
}
 
}
 +
  
 
Seguem informações complementares sobre cada coluna do objeto:
 
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.
 
* 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.
 
* Mensagem: exibirá a mensagem de sucesso ou de erro.

Edição atual tal como às 20h54min de 21 de junho de 2023

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://app.recuperador.com.br/api/v1ImportacaoDivida

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,
   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 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.
  • 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 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,
   valor_desconto_pontualidade: decimal,
   cobrar_juros_multa_correcao_nivel_divida: string, 
   tipo_juros: string, 
   pct_juros_dia: decimal, 
   pct_juros_mes: decimal,
   pct_multa: decimal,
   id_tabela_correcao_monetaria : inteiro

}


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.
  • Desconto por pontualidade: aceita no máximo 8 dígitos e não é obrigatório. Use vírgula como separador de decimais.
  • Cobrar juros multa e correção no nível da dívida: aceita no máximo 1 dígito. Deve ser preenchido com S para sim ou N para não. Pode ou não ser obrigatório dependendo da parametrização do administrador.
  • Tipo de juros: aceita no máximo 1 dígito. Deve ser preenchido com S para sim ou N para não. Pode ou não ser obrigatório dependendo da parametrização do administrador.
  • Porcentagem de juros simples ao dia: aceita no máximo 5 dígitos, sendo até 3 casas decimais e não é obrigatório. Use vírgula como separador de decimais.
  • Porcentagem de juros compostos ao mês: aceita no máximo 5 dígitos, sendo até 3 casas decimais e não é obrigatório. Use vírgula como separador de decimais.
  • Porcentagem de multa: aceita no máximo 5 dígitos, sendo até 3 casas decimais e não é obrigatório. Use vírgula como separador de decimais.
  • Código da tabela de correção monetária: aceita valores inteiros e não é obrigatório. Consulte o help da tela de importação para obter os valores atualizados de cada tabela.


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.
Disponível em "http://docs.recuperador.com.br/index.php?title=API_de_importação_de_dívidas&oldid=1024"