API de listagem do relatório de proporcionalidade

A API de consulta do relatório de proporcionalidade deve ser utilizada para retornar a lista de parcelas pagas por período. Também, permite alguns filtros, sendo que o principal deles é a data de pagamento, que busca pela data em que o cliente (devedor) pagou a parcela.

Para cada parcela paga, serão exibidas as dívidas negociadas no acordo e o valor pago ou o valor líquido será distribuído proporcionalmente em cada uma das dívidas (rateio).

É importante destacar que essa API pode retornar um grande volume de linhas. Portanto, use os parâmetros para filtrar corretamente os dados a serem retornados.

Endpoint: https://app.recuperador.com.br/api/v1Proporcionalidade/?id_credor={id_credor}&datapagtogte={datapagtogte}&datapagtolte={datapagtolte}&valor_usado_proporcionalidade={valor_usado_proporcionalidade}

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,    
   datapagtogte: date, 
   datapagtolte: date,
   valor_usado_proporcionalidade: 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. Informe zero para não filtrar pelo credor.
• Data de: filtro pela data do pagamento (maior ou igual) e é obrigatório. A data deve ser preenchida no formato aaaa-mm-dd;
• Data até: filtro pela data do pagamento (menor ou igual) e é obrigatório. A data deve ser preenchida no formato aaaa-mm-dd;
• Valor usado na proporcionalidade: aceita no máximo um caractere e é obrigatório. Ele deve ser preenchido com P (maiúsculo) para considerar o valor pago ou L (maiúsculo) para usar o valor líquido (descontando taxas financeiras);

Lista de retorno

[

  {
       nome_cliente: string,
       cpf_cnpj: string,
       nome_credor: string,
       data_vencto: date,
       data_pagto: date,
       data_rec: date,
       meio_pagto: string,
       forma_pagto: string,
       parcela: string,
       parcela_inteiro: int,
       valor_principal_proporcional: decimal,
       valor_pago: decimal,
       valor_honorarios_adv: decimal,
       valor_honorarios_ass: decimal,
       valor_taxa_adm: decimal,
       valor_taxa_camara: decimal,
       valor_taxa_federacao: decimal,
       valor_taxa_financeira: decimal,
       valor_taxa_representante: decimal,
       valor_liquido: decimal,
       taxa_adm_agrupada: decimal,
       contratos: string,
       unidades: string,
       competencias: string,
       obs: string,
       itens: [
           {
               codigo: string,
               data_vencto: date,
               valor: numeric,
               descricao: string
               contrato: string,
               unidade: string,
               competencia: string,
               obs: string,
               valor_proporcional: decimal
           }
       ]
   }

]

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

• 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.
• Nome credor: retornará uma string que representa o nome do credor.
• Data de vencimento: informará a data de vencimento da parcela de acordo paga.
• Data de pagamento: informará a data de pagamento da parcela de acordo paga.
• Data de recebimento: informará a data de prevista para recebimento de acordo com o meio de pagamento.
• Meio de pagamento: informará o nome do meio de pagamento utilizado na aprovação da parcela (ex.: Zoop, Asaas, Pagar.Me etc).
• Forma de pagamento: informará o nome da forma de pagamento utilizada na aprovação da parcela (ex.: Boleto, PIX, Cartão de Crédito).
• Parcela: informará o código da parcela do acordo. Exemplo: 1/5 informando que é a parcela 1 de 5 parcelas.
• Valor do principal proporcional: exibe o valor proporcional originalmente negociado no acordo com relação ao número de parcelas do acordo.
• Valor pago: valor do pagamento aprovado.
• Valor de honorários advocatícios: valor cobrado como honorários de advogado, quando aplicáveis.
• Valor de honorários de assessoria: valor cobrado como honorários de assessoria, quando aplicáveis.
• Valor de taxa administrativa: valor de comissão cobrado como taxa administrativa, quando aplicável.
• Valor de taxa câmara: valor da comissão da câmara, quando aplicável.
• Valor de taxa federação: valor da comissão da federação, quando aplicável.
• Valor de taxa financeira: valor cobrado pelo meio de pagamento pela transação, quando aplicável.
• Valor de taxa representante: valor da comissão do representante, quando aplicável.
• Valor líquido: valor do repasse ao credor, descontando eventuais taxas.
• Contratos: lista de contratos das dívidas negociadas no acordo.
• Unidades: lista de unidades das dívidas negociadas no acordo.
• Competências: lista de competências das dívidas negociadas no acordo.
• Observações: lista de observações das dívidas negociadas no acordo.
• Itens: lista de dívidas presentes no acordo, sendo que a coluna valor_proporcional é justamente o valor que compete à dívida com relação ao valor pago ou valor líquido da parcela de acordo aprovada.