API para consulta de dívidas de um devedor - Histórico de revisão

Suporte em 13h53min de 23 de fevereiro de 2026

2026-02-23T13:53:57Z

Suporte em 21h16min de 21 de junho de 2023

2023-06-21T21:16:41Z

Suporte em 16h16min de 25 de março de 2021

2021-03-25T16:16:17Z

Suporte em 15h14min de 25 de março de 2021

2021-03-25T15:14:04Z

Suporte em 15h09min de 25 de março de 2021

2021-03-25T15:09:39Z

Suporte em 15h07min de 25 de março de 2021

2021-03-25T15:07:37Z

Suporte em 15h06min de 25 de março de 2021

2021-03-25T15:06:27Z

Suporte: 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...'

2021-03-25T14:44:43Z

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...'

Página nova

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://www.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.

== Classe responsavel ==

{
'''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.
* *CPF/CNPJ do devedor: aceita no máximo de 18 caracteres e é obrigatório. Somente números preferencialmente.
* *Nome do devedor: aceita no máximo de 40 caracteres e é obrigatório.
* *Prioridade do responsável: aceita apenas valores inteiros é obrigatório.
* *Título do responsável: aceita no máximo de 40 caracteres e é obrigatório.
* *Nome: aceita no máximo de 40 caracteres e é obrigatório.
* Apelido: aceita no máximo de 40 caracteres e não é obrigatório.
* Data nasc.: aceita no máximo 10 caracteres no formato DD/MM/AAAA e não é obrigatório.
* *E-mail: aceita no máximo de 256 caracteres e é obrigatório.
* E-mail 2: aceita no máximo de 256 caracteres e não é obrigatório.
* E-mail 3: aceita no máximo de 256 caracteres e não é obrigatório.
* E-mail 4: aceita no máximo de 256 caracteres e não é obrigatório.
* *Telefone: aceita no máximo de 20 caracteres e é obrigatório.
* Telefone2: aceita no máximo de 20 caracteres e não é obrigatório.
* *Endereço: aceita no máximo de 256 caracteres e é obrigatório.
* *Número: aceita no máximo de 5 caracteres e é obrigatório.
* Complemento: aceita no máximo de 150 caracteres e não é obrigatório.
* *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:

* 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.

@@ Linha 45: / Linha 45: @@
          '''nome_credor''': string,
          '''cpf_cnpj_credor''': string
+     }
+]
@@ Linha 67: / Linha 74: @@
 * 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 anterior		Edição das 21h16min de 21 de junho de 2023
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 26: / Linha 26: @@
 == Lista de retorno ==
-−
+[
-    '''id_contasareceber''': int,
-    '''id_credor''': int,
+        '''id_contasareceber''': int,
-    '''id_cliente''': int,
+        '''id_credor''': int,
-    '''codigo''': string,
+        '''id_cliente''': int,
-    '''nome_cliente''': string,
+        '''codigo''': string,
-    '''cpf_cnpj''': string,
+        '''nome_cliente''': string,
-    '''datavencto''': datetime,
+        '''cpf_cnpj''': string,
-    '''valor''': decimal,
+        '''datavencto''': datetime,
-    '''valor_atualizado''': decimal,
+        '''valor''': decimal,
-    '''descricao''': string,
+        '''valor_atualizado''': decimal,
-    '''obs''': string,
+        '''descricao''': string,
-    '''valor_cartorio''': decimal,
+        '''obs''': string,
-    '''contrato''': string,
+        '''valor_cartorio''': decimal,
-    '''unidade''': string,
+        '''contrato''': string,
-    '''competencia''': string,
+        '''unidade''': string,
-    '''nome_credor''': string,
+        '''competencia''': string,
-    '''cpf_cnpj_credor''': string
+        '''nome_credor''': string,
+        '''cpf_cnpj_credor''': string
 Seguem informações complementares sobre cada coluna da lista de retorno:

@@ Linha 53: / Linha 53: @@
 * 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 cadastrado para o devedor.
+* CPF/CNPJ: retornará uma string que representa o CPF ou CNPJ do devedor.
-* Data de vencimento: retornará uma string que representa data de vencimento original da dívida. Ela está no formato YYYY-MM-DDT00:00:00.
+* 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.

@@ Linha 51: / Linha 51: @@
 * 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 do credor, se houver.
+* 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 código do CPF ou CNPJ cadastrado para o devedor.
+* CPF/CNPJ: retornará uma string que representa o CPF ou CNPJ cadastrado para o devedor.
 * Data de vencimento: retornará uma string que representa data de vencimento original da dívida. Ela está 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.

@@ Linha 23: / Linha 23: @@
 * CPF/CNPJ do devedor: aceita no máximo de 18 caracteres e é obrigatório. Somente números preferencialmente.
+== Lista de retorno ==
+{
-     '''sucesso''': bool,
+     '''id_contasareceber''': int,
-     '''mensagem''': string
+     '''id_credor''': int,
+}
-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.