API de listagem de baixas da empresa de cobrança terceirizada

A API de listagem de baixas da empresa de cobrança tercerizada deve ser utilizada para retornar a lista de baixas feitas pelo credor sob custódia de uma empresa de cobrança terceirizada no Recuperador CRM, simplificando o processo de troca de informações entre credor (parceiro Recuperador CRM) e uma empresa de cobrança terceirizada.

As baixas são importantes para que a empresa de cobrança terceirizada possa marcar tais títulos como pagos, evitando cobranças indevidas.

Endpoint: https://app.recuperador.com.br/api/v1CobrancaTerceirizadaBaixa/?id_cob=XXX&cpf_cnpj_formatado=YYY&dataenviogte=AAAA-MM-DD&dataenviolte=AAAA-MM-DD&codigo=ZZZ&datavenctogte=AAAA-MM-DD&datavenctolte=AAAA-MM-DD&datapagtogte=AAAA-MM-DD&datapagtolte=AAAA-MM-DD&incluir_baixas_feitas_pela_cobranca_terceirizada=Z

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.

Importante: por questões de segurança, este token será diferente do token utilizado em outras APIs. Logo, cada empresa deverá possuir um token exclusivo. Este token deverá ser gerado na tela de detalhes do cadastro da empresa de cobrança terceirizada, que fica em Cadastros > Devedores > Cobrança tercerizada > ícone vis. (visualizar) em frente à empresa desejada > API.

Parâmetros de entrada

{

   id_cob: int,
   cpf_cnpj_formatado: string, 
   dataenviogte: date, 
   dataenviolte: date, 
   codigo: string, 
   datavenctogte: date, 
   datavenctolte: date, 
   datapagtogte: date,
   datapagtolte: date,
   incluir_baixas_feitas_pela_cobranca_terceirizada: string

}

Seguem informações complementares sobre cada parâmetro de entrada:

• ID da empresa de cobrança terceirizada: aceita apenas valores inteiros e é obrigatório. Ele deve ser preenchido com o código da empresa de cobrança terceirizada que aparece em Cadastros > Devedores > Cobrança terceirizada.
• CPF/CNPJ do devedor: aceita no máximo de 18 caracteres e não é obrigatório. O documento deverá ser informado formatado com pontos, hífen e barra.
• Data de envio de: filtro pela data do envio (maior ou igual) e não é obrigatório. A data deve ser preenchida no formato aaaa-mm-dd;
• Data de envio até: filtro pela data do envio (menor ou igual) e não é obrigatório. A data deve ser preenchida no formato aaaa-mm-dd;
• Código da dívida: aceita no máximo de 20 caracteres e não é obrigatório. Serve para filtrar pelo código de uma dívida em específico;
• Data de vencimento de: filtro pela data de vencimento (maior ou igual) e não é obrigatório. A data deve ser preenchida no formato aaaa-mm-dd;
• Data de vencimento até: filtro pela data de vencimento (menor ou igual) e não é obrigatório. A data deve ser preenchida no formato aaaa-mm-dd;
• Data de pagamento de: filtro pela data de pagamento (maior ou igual) e não é obrigatório. A data deve ser preenchida no formato aaaa-mm-dd;
• Data de pagamento até: filtro pela data de vencimento (menor ou igual) e não é obrigatório. A data deve ser preenchida no formato aaaa-mm-dd;
• Incluir baixas feitas pela empresa de cobrança terceirizada: filtro por dívidas baixadas pela própria empresa de cobrança terceirizada. Use S (maiúsculo) para Sim e N (maiúsculo) para Não. Este filtro como S pode ser interessante para conferir se determinados pagamentos aprovados pela empresa de cobrança terceirizada foram recebidos no credor. Já o filtro como N é interessante para processamento de baixas feitas pelo credor e que devem ser feitas na empresa de cobrança terceirizada.

Lista de retorno

[

   {
   credor: string,
   id: int,
   codigo: string,
   devedor: string,
   CPF_CNPJ: string,
   datavencto: date,
   datapagto: date,
   descricao: string,
   obs: string,
   contrato: string,
   unidade: string,
   competencia: string,
   valor: decimal,
   situacao: string
   }

]