API para consulta de dívidas de um devedor

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.

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 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.
• 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;