API de listagem do relatório financeiro
A API de consulta do relatório financeiro deve ser utilizada para retornar a lista de parcelas aprovadas no Recuperador CRM. É 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.
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, id_cliente: int, id_consultor: int, baixa_manual: string, datapagtogte: date, datapagtolte: date
}
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.
- ID do cliente: aceita apenas valores inteiros e é obrigatório. Ele deve ser preenchido com o código do devedor que aparece em Cadastros > Devedores. Informe zero para não filtrar pelo devedor.
- ID do consultor: aceita apenas valores inteiros e não é obrigatório. Ele deve ser preenchido com o código do consultor que aparece em Cadastros > Consultores. Informe zero para não filtrar pelo consultor.
- Baixa manual: aceita no máximo um caractere e não é obrigatório. Ele deve ser preenchido com S (maiúsculo) para filtrar apenas baixas manuais ou N (maiúsculo) para não exibir baixas manuais. Deixe em branco para desconsiderar o filtro pela baixa manual;
- 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;
Lista de retorno
[
{
id_credor: int,
id_acordo: int,
id_cliente: int,
id_contasareceber: int,
id_consultor: int?,
nome_cliente: string,
cpf_cnpj: string,
nome_credor: string,
nome_consultor: string,
data_referencia: date,
valor_referencia: numeric,
data_vencto: date,
data_pagto: date,
meio_pagto: string,
forma_pagto: string,
parcela: string,
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,
contratos: string,
unidades: string,
competencias: string,
valor_juros_proporcionais: decimal,
valor_multa_proporcional: decimal,
valor_correcao_monetaria_proporcional: decimal,
id_grupoconsultor: int?,
nome_grupoconsultor: decimal
}
]
Seguem informações complementares sobre cada coluna da lista de retorno:
- ID credor: retornará um inteiro que representa o código do credor.
- ID acordo: retornará um inteiro que representa o código do acordo da parcela.
- ID cliente: retornará um inteiro que representa o código do cliente (devedor).
- ID do contas a receber retornará um valor inteiro que representa o identificador da parcela de acordo aprovada.
- ID consultor: retornará um inteiro que representa o código do consultor (cobrador).
- 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.
- Nome consultor: retornará uma string que representa o nome do consultor (cobrador).
- Data de referência: informará a data de vencimento da dívida mais antiga negociada no acordo.
- Valor de referência: informará o valor da dívida mais antiga negociada no acordo.
- 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.
- 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,
- Valor dos juros proporcionais: exibe o valor proporcional de juros originalmente negociado no acordo com relação ao número de parcelas do acordo.
- Valor da multa proporcional: exibe o valor proporcional de multa originalmente negociado no acordo com relação ao número de parcelas do acordo.
- Valor da correção monetária proporcional: exibe o valor proporcional de correção monetária originalmente negociado no acordo com relação ao número de parcelas do acordo.
- ID do grupo de consultor: retornará um inteiro que representa o código do grupo de consultores do consultor do acordo (cobrador).
- Nome do grupo de consultor: retornará o nome do grupo de consultores do consultor do acordo (cobrador).
