📡 Lista Completa de Endpoints - ecosif-reports¶

📋 Visão Geral¶

Este documento lista todos os endpoints REST disponíveis no serviço ecosif-reports, especializado em geração de relatórios contábeis.

Base URL: http://localhost:8084
Autenticação: JWT Bearer Token (obtido via ecosif-auth)

🏷️ Tags¶

Os endpoints estão organizados nas seguintes categorias:

Relatórios - Geração de relatórios contábeis
Saldos - Consultas de saldos
Lançamentos Contábeis - Consultas de lançamentos
Preferências - Gerenciamento de preferências

📊 Relatórios¶

Listagem de Lançamentos¶

Método: POST
URL: /reports/lancamentos
Descrição: Gera relatório de listagem de lançamentos contábeis com filtros personalizados.
Autenticação: Obrigatória
Request Body: RequestPostingListingDTO
Response: RetornoGenerico (PDF/CSV/TXT em base64)
Formatos: PDF, CSV, TXT

Balancete Geral COSIF¶

Método: POST
URL: /reports/cosifGeneralBalance
Descrição: Gera balancete geral no padrão COSIF (Plano Contábil das Instituições do Sistema Financeiro Nacional).
Autenticação: Obrigatória
Request Body: BalanceteGeralRequestDTO
Response: RetornoGenerico (PDF/CSV/TXT em base64)

Balancete Mensal¶

Método: POST
URL: /reports/monthlyTrialBalance
Descrição: Gera balancete de verificação mensal com saldos e movimentações do período.
Autenticação: Obrigatória
Request Body: RequestMonthlyTrialBalanceDTO
Response: RetornoGenerico (PDF/CSV/TXT em base64)
Formatos: PDF, CSV, TXT

Balancete Mensal CVM¶

Método: POST
URL: /reports/monthlyTrialCVMBalance
Descrição: Gera balancete mensal no padrão CVM (Comissão de Valores Mobiliários).
Autenticação: Obrigatória
Request Body: RequestMonthlyTrialBalanceDTO
Response: RetornoGenerico (PDF/CSV/TXT em base64)

Balancete Diário¶

Método: POST
URL: /reports/dailyTrialBalance
Descrição: Gera balancete de verificação diário com posição dos saldos em uma data específica.
Autenticação: Obrigatória
Request Body: BalanceteDiarioRequestDTO
Response: RetornoGenerico (PDF/CSV/TXT em base64)
Formatos: PDF, CSV, TXT

Balanço Patrimonial¶

Método: POST
URL: /reports/patrimonialBalance
Descrição: Gera relatório de balanço patrimonial com ativos, passivos e patrimônio líquido.
Autenticação: Obrigatória
Request Body: BalancetePatrimonialRequestDTO
Response: RetornoGenerico (PDF/CSV/TXT em base64)

Balanço Patrimonial CVM¶

Método: POST
URL: /reports/patrimonialCVMBalance
Descrição: Gera balanço patrimonial no padrão CVM (Comissão de Valores Mobiliários).
Autenticação: Obrigatória
Request Body: BalancetePatrimonialRequestDTO
Response: RetornoGenerico (PDF/CSV/TXT em base64)

Relatório de Razão¶

Método: POST
URL: /reports/relatorioRazao
Descrição: Gera relatório de razão contábil com histórico detalhado de movimentações por conta.
Autenticação: Obrigatória
Request Body: RazaoRequestDTO
Response: RetornoGenerico (PDF/CSV/TXT em base64)

Diário Geral¶

Método: POST
URL: /reports/relatorioDiarioGeral
Descrição: Gera relatório de diário geral com todos os lançamentos contábeis do período.
Autenticação: Obrigatória
Request Body: DiarioGeralRequestDTO
Response: RetornoGenerico (PDF/CSV/TXT em base64)

Termos de Abertura/Encerramento¶

Método: POST
URL: /reports/reportTermos
Descrição: Gera termos de abertura e encerramento de livros contábeis.
Autenticação: Obrigatória
Request Body: TermoRequestDTO
Response: RetornoGenerico (PDF em base64)

Relatório Combinado¶

Método: POST
URL: /reports/combineReport
Descrição: Gera um relatório combinado com múltiplos tipos de dados (balancete, lançamentos, etc.) em um único arquivo.
Autenticação: Obrigatória
Request Body: ReportGenerateDTO
Response: RetornoRelatoriosDTO (PDF/CSV/TXT em base64)
Formatos: PDF, CSV, TXT

Listar Planos de Contas¶

Método: POST
URL: /reports/planos
Descrição: Retorna lista de planos de contas disponíveis para uma empresa/filial específica.
Autenticação: Obrigatória
Request Body: RazaoRequestDTO
Response: List<String> - Lista de códigos de planos

💰 Saldos¶

Buscar Saldos Mensais do Plano de Contas¶

Método: GET
URL: /api/v1/saldos/plano-saldo
Descrição: Retorna os saldos mensais de todas as contas do plano para uma empresa/filial em um mês específico.
Autenticação: Obrigatória
Parâmetros:
empresa (String, obrigatório) - Código da empresa
filial (String, obrigatório) - Código da filial
ano (Integer, obrigatório) - Ano de referência
mes (String, obrigatório) - Mês (1-12). Aceita 1, 01 ou 10 (query string, não integer)
pagina (int, opcional) - Número da página (padrão: 0)
tamanho (int, opcional) - Tamanho da página (padrão: 10)
ordenarPor (String, opcional) - Coluna SQL (padrão: empresa; não use conta)
direcao (String, opcional) - Direção da ordenação: ASC/DESC (padrão: "ASC")
Response: RetornoGenerico com PlanoSaldoResponse paginado

Buscar Saldos Diários do Plano de Contas¶

Método: GET
URL: /api/v1/saldos/plano-saldo-dia
Descrição: Retorna os saldos diários de todas as contas do plano para uma empresa/filial em uma data específica.
Autenticação: Obrigatória
Parâmetros:
empresa (String, obrigatório) - Código da empresa
filial (String, obrigatório) - Código da filial
ano (Integer, obrigatório) - Ano de referência
mes (String, obrigatório) - Mês (1-12). Aceita 1, 01 ou 10 (query string, não integer)
dia (String, obrigatório) - Dia (1-31). Aceita 1 ou 01 (query string, não integer)
pagina (int, opcional) - Número da página (padrão: 0)
tamanho (int, opcional) - Tamanho da página (padrão: 10)
ordenarPor (String, opcional) - Coluna SQL (padrão: empresa; não use conta)
direcao (String, opcional) - Direção da ordenação: ASC/DESC (padrão: "ASC")
Response: RetornoGenerico com PlanoSaldoDiaResponse paginado

Buscar Todos os Saldos do Plano¶

Método: GET
URL: /api/v1/saldos/plsaldos
Descrição: Retorna todos os saldos disponíveis do plano de contas para uma empresa/filial.
Autenticação: Obrigatória
Parâmetros:
empresa (String, obrigatório) - Código da empresa
filial (String, obrigatório) - Código da filial
pagina (int, opcional) - Número da página (padrão: 0)
tamanho (int, opcional) - Tamanho da página (padrão: 10)
ordenarPor (String, opcional) - Coluna SQL (padrão: empresa; não use conta)
direcao (String, opcional) - Direção da ordenação: ASC/DESC (padrão: "ASC")
Response: RetornoGenerico com PlSaldosResponse paginado

📝 Lançamentos Contábeis¶

DEPRECATED — Use GET /ecosif-querys/api/v1/sparts/lancamentos-contabeis.
Documentação: ecosif-querys/docs/integradores/sparts.md

Buscar Lançamentos Contábeis (DEPRECATED)¶

Método: GET
URL: /api/v1/lancamentos-contabeis
Descrição: Retorna uma lista paginada de lançamentos contábeis filtrados por período, empresa e filial. Permite ordenação por diferentes campos e direção (ASC/DESC).
Autenticação: Obrigatória
Parâmetros:
dataInicio (String, obrigatório) - Data inicial (formato: YYYY-MM-DD)
dataFim (String, obrigatório) - Data final (formato: YYYY-MM-DD)
empresa (String, opcional) - Código da empresa
filial (String, opcional) - Código da filial
pagina (int, opcional) - Número da página (padrão: 0)
tamanho (int, opcional) - Tamanho da página (padrão: 10)
ordenarPor (String, opcional) - Campo para ordenação (padrão: "dataContabil")
- Valores: "dataContabil", "documento", "valor", "conta"
direcao (String, opcional) - Direção da ordenação: ASC/DESC (padrão: "ASC")
Response: RetornoGenerico com LancamentoContabilResponse paginado

⚙️ Preferências¶

Buscar Preferências do Usuário¶

Método: GET
URL: /preferencias
Descrição: Retorna as preferências salvas de um usuário para um relatório específico.
Autenticação: Obrigatória
Parâmetros:
idUsuario (String, obrigatório) - ID do usuário
nomeRelatorio (String, obrigatório) - Nome do relatório
Response: String - JSON com preferências

Salvar Preferências do Usuário¶

Método: POST
URL: /preferencias
Descrição: Salva ou atualiza as preferências de um usuário para um relatório específico.
Autenticação: Obrigatória
Request Body: PreferenciasRequestDTO
Response: String - Confirmação

🔐 Autenticação¶

Todos os endpoints requerem autenticação JWT.

Header necessário:

Authorization: Bearer <token>

Obter token: 1. Fazer login em ecosif-auth: POST /api/auth/signin 2. Copiar accessToken da resposta 3. Usar no header Authorization

📊 Códigos de Status HTTP¶

Código	Descrição
`200`	OK - Requisição bem-sucedida
`400`	Bad Request - Dados inválidos
`401`	Unauthorized - Token ausente/inválido
`404`	Not Found - Recurso não encontrado
`500`	Internal Server Error - Erro interno

📝 Formatos de Relatórios¶

Todos os relatórios podem ser gerados nos seguintes formatos:

PDF - Formato padrão para impressão
CSV - Para importação em planilhas
TXT - Formato texto simples

O formato é especificado no campo visualizationEnum do DTO de requisição.

📝 Notas Importantes¶

Resposta Base64: Relatórios são retornados em base64 no campo apropriado do RetornoGenerico
Paginação: Endpoints de consulta suportam paginação
Ordenação: Endpoints de consulta suportam ordenação customizada
Templates: Templates JasperReports são compilados automaticamente na primeira execução

Última Atualização: 2025-12-01