Mudanças entre as edições de "API para consulta de dívidas de um devedor"

(Criou página com 'A API de consulta de dívidas deve ser utilizada para retornar a lista de dívidas em aberto e não negociadas de um devedor cadastrado no Recuperador CRM. É importante desta...')
 
 
(5 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/v1Divida/?id_credor=XXXX&cpf_cnpj=YYYY
+
Endpoint: https://app.recuperador.com.br/api/v1Divida/?id_credor=XXXX&cpf_cnpj=YYYY
  
 
Ação: '''GET'''
 
Ação: '''GET'''
Linha 15: Linha 15:
 
{
 
{
 
     '''id_credor''': int,
 
     '''id_credor''': int,
     '''cpf_cnpj''': string,
+
     '''cpf_cnpj''': string
 
}
 
}
  
Linha 23: Linha 23:
 
* CPF/CNPJ do devedor: aceita no máximo de 18 caracteres e é obrigatório. Somente números preferencialmente.
 
* CPF/CNPJ do devedor: aceita no máximo de 18 caracteres e é obrigatório. Somente números preferencialmente.
  
== Classe responsavel ==
 
  
{
+
== Lista de retorno ==
    '''id_credor''': int
 
    '''cpf_cnpj_devedor''': string,
 
    '''nome_devedor''': string,
 
    '''prioridade''': int,
 
    '''titulo''': string,
 
    '''nome''': string,
 
    '''apelido''': string,
 
    '''datanasc''': DateTime,
 
    '''email''': string,
 
    '''email2''': string,
 
    '''email3''': string,
 
    '''email4''': string,
 
    '''telefone''': string,
 
    '''telefone2''': string,
 
    '''endereco''': string,
 
    '''numero''': string,
 
    '''complemento''': string,
 
    '''bairro''': string,
 
    '''cidade''': string,
 
    '''estado''': string,
 
    '''cep''': string,
 
    '''sexo''': string,
 
    '''rg''': string,
 
    '''tipo_pessoa''': string,
 
    '''cpf_cnpj''': string,
 
    '''whatsapp''': string,
 
    '''telegram''': string,
 
    '''profissao''': string,
 
    '''username_fb''': string,
 
    '''username_insta''': string,
 
    '''telefone3''': string,
 
    '''telefone4''': string,
 
    '''telefone5''': string,
 
    '''telefone6''': string,
 
    '''codigo''': string,
 
    '''obs''': string
 
}
 
  
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_contasareceber''': int,
* *CPF/CNPJ do devedor: aceita no máximo de 18 caracteres e é obrigatório. Somente números preferencialmente.
+
        '''id_credor''': int,
* *Nome do devedor: aceita no máximo de 40 caracteres e é obrigatório.
+
        '''id_cliente''': int,
* *Prioridade do responsável: aceita apenas valores inteiros é obrigatório.
+
        '''codigo''': string,
* *Título do responsável: aceita no máximo de 40 caracteres e é obrigatório.
+
        '''nome_cliente''': string,
* *Nome: aceita no máximo de 40 caracteres e é obrigatório.
+
        '''cpf_cnpj''': string,
* Apelido: aceita no máximo de 40 caracteres e não é obrigatório.
+
        '''datavencto''': datetime,
* Data nasc.: aceita no máximo 10 caracteres no formato DD/MM/AAAA e não é obrigatório.
+
        '''valor''': decimal,
* *E-mail: aceita no máximo de 256 caracteres e é obrigatório.
+
        '''valor_atualizado''': decimal,
* E-mail 2: aceita no máximo de 256 caracteres e não é obrigatório.
+
        '''descricao''': string,
* E-mail 3: aceita no máximo de 256 caracteres e não é obrigatório.
+
        '''obs''': string,
* E-mail 4: aceita no máximo de 256 caracteres e não é obrigatório.
+
        '''valor_cartorio''': decimal,
* *Telefone: aceita no máximo de 20 caracteres e é obrigatório.
+
        '''contrato''': string,
* Telefone2: aceita no máximo de 20 caracteres e não é obrigatório.
+
        '''unidade''': string,
* *Endereço: aceita no máximo de 256 caracteres e é obrigatório.
+
        '''competencia''': string,
* *Número: aceita no máximo de 5 caracteres e é obrigatório.
+
        '''nome_credor''': string,
* Complemento: aceita no máximo de 150 caracteres e não é obrigatório.
+
        '''cpf_cnpj_credor''': string
* *Bairro: aceita no máximo de 60 caracteres e é obrigatório.
+
    }
* *Cidade: aceita no máximo de 60 caracteres e é obrigatório.
+
]
* *Estado: aceita no máximo de 2 caracteres e é obrigatório.
 
* *CEP: aceita no máximo de 9 caracteres e é obrigatório. Somente números preferencialmente.
 
* Sexo: aceita no máximo de 1 caractere e não é obrigatório. Deve ser preenchido com M ou F. Se não houver sexo, informar N maiúsculo.
 
* *Tipo: aceita no máximo de 1 caractere e é obrigatório. Informar F maiúsculo para pessoa física ou J maiúsculo para pessoa jurídica.
 
* *CPF/CNPJ: aceita no máximo de 18 caracteres e é obrigatório. Somente números preferencialmente.
 
* RG: aceita no máximo de 12 caracteres e não é obrigatório.
 
* WhatsApp: aceita no máximo de 20 caracteres e não é obrigatório.
 
* Telegram: aceita no máximo de 20 caracteres e não é obrigatório.
 
* Profissão: aceita no máximo de 100 caracteres e não é obrigatório.
 
* Facebook: aceita no máximo de 256 caracteres e não é obrigatório.
 
* Instagram: aceita no máximo de 256 caracteres e não é obrigatório.
 
* Telefone de recado 1: aceita no máximo de 20 caracteres e não é obrigatório.
 
* Telefone de recado 2: aceita no máximo de 20 caracteres e não é obrigatório.
 
* Telefone de recado 3: aceita no máximo de 20 caracteres e não é obrigatório.
 
* Telefone de recado 4: aceita no máximo de 20 caracteres e não é obrigatório.
 
* Código do cliente: aceita no máximo de 100 caracteres e não é obrigatório.
 
* Observações: aceita no máximo de 400 caracteres e não é obrigatório.
 
 
 
Se o parâmetro '''Exigir dados completos do cliente''' estiver configurado como Não no cadastro do credor, então não será obrigatório informar o e-mail, telefone, data de nascimento e endereço completo do responsável.
 
 
 
 
 
== Classe de retorno ==
 
 
 
{
 
    '''sucesso''': bool,
 
    '''mensagem''': string
 
}
 
  
Seguem informações complementares sobre cada coluna do objeto:
+
Seguem informações complementares sobre cada coluna da lista de retorno:
  
* Sucesso: retornará true em caso de chamada realizada com sucesso e false em caso de erro na chamada.
+
* ID contas a receber: retornará um valor inteiro que representa o identificador da dívida no credor.
* Mensagem: exibirá a mensagem de sucesso ou de erro.
+
* ID credor: retornará um inteiro que representa o código do credor.
 +
* ID cliente: retornará um inteiro que representa o código do cliente (devedor).
 +
* Codigo: retornará uma string que representa o código do dívida presente no sistema de gestão do credor, se houver.
 +
* Nome cliente: retornará uma string que representa o nome do cliente (devedor).
 +
* CPF/CNPJ: retornará uma string que representa o CPF ou CNPJ do devedor.
 +
* Data de vencimento: retornará uma string que representa a data de vencimento original da dívida. Ela estará no formato YYYY-MM-DDT00:00:00.
 +
* Valor: valor original (principal) da dívida. Campo no formato decimal e usa ponto como separador de decimais.
 +
* Valor atualizado: valor da dívida atualizado com juros, multa, correção monetária (se houver) e taxa de cartório (se houver). Campo no formato decimal e usa ponto como separador de decimais.
 +
* Descricao: retornará uma breve descrição sobre a dívida em formato string.
 +
* Obs: retornará observações complementares sobre a dívida em formato string, se houver.
 +
* Valor cartorio: valor da taxa de cartório da dívida, se houver. Campo no formato decimal e usa ponto como separador de decimais.
 +
* Contrato: retornará uma string com o código do contrato da dívida, se houver.
 +
* Unidade: retornará uma string com o número da unidade da dívida, se houver.
 +
* Competencia: retornará uma string com o mês e ano da competência da dívida, se houver.
 +
* Nome credor: retornará uma string com o nome do credor da dívida;
 +
* CPF/CNPJ credor: retornará uma string que representa o CPF ou CNPJ do credor da dívida;

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

A API de consulta de dívidas deve ser utilizada para retornar a lista de dívidas em aberto e não negociadas de um devedor cadastrado no Recuperador CRM. É importante destacar que essa API não tem relação com o portal de negociação, ou seja, ela ignora o fato da dívida ser elegível ou não para o portal. Caso você queira listar apenas as dívidas elegíveis para negociação via portal de negociação, então consulte a API para listagem de dívidas elegíveis.


Endpoint: https://app.recuperador.com.br/api/v1Divida/?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:

  • 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.
  • CPF/CNPJ do devedor: aceita no máximo de 18 caracteres e é obrigatório. Somente números preferencialmente.


Lista de retorno

[

   {
       id_contasareceber: int,
       id_credor: int,
       id_cliente: int,
       codigo: string,
       nome_cliente: string,
       cpf_cnpj: string,
       datavencto: datetime,
       valor: decimal,
       valor_atualizado: decimal,
       descricao: string,
       obs: string,
       valor_cartorio: decimal,
       contrato: string,
       unidade: string,
       competencia: string,
       nome_credor: string,
       cpf_cnpj_credor: string
   }

]

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

  • ID contas a receber: retornará um valor inteiro que representa o identificador da dívida no credor.
  • ID credor: retornará um inteiro que representa o código do credor.
  • ID cliente: retornará um inteiro que representa o código do cliente (devedor).
  • Codigo: retornará uma string que representa o código do dívida presente no sistema de gestão do credor, se houver.
  • Nome cliente: retornará uma string que representa o nome do cliente (devedor).
  • CPF/CNPJ: retornará uma string que representa o CPF ou CNPJ do devedor.
  • Data de vencimento: retornará uma string que representa a data de vencimento original da dívida. Ela estará no formato YYYY-MM-DDT00:00:00.
  • Valor: valor original (principal) da dívida. Campo no formato decimal e usa ponto como separador de decimais.
  • Valor atualizado: valor da dívida atualizado com juros, multa, correção monetária (se houver) e taxa de cartório (se houver). Campo no formato decimal e usa ponto como separador de decimais.
  • Descricao: retornará uma breve descrição sobre a dívida em formato string.
  • Obs: retornará observações complementares sobre a dívida em formato string, se houver.
  • Valor cartorio: valor da taxa de cartório da dívida, se houver. Campo no formato decimal e usa ponto como separador de decimais.
  • Contrato: retornará uma string com o código do contrato da dívida, se houver.
  • Unidade: retornará uma string com o número da unidade da dívida, se houver.
  • Competencia: retornará uma string com o mês e ano da competência da dívida, se houver.
  • Nome credor: retornará uma string com o nome do credor da dívida;
  • CPF/CNPJ credor: retornará uma string que representa o CPF ou CNPJ do credor da dívida;