Relatórios Financeiros

Os endpoints de relatórios permitem gerar e exportar as principais demonstrações financeiras e contábeis.

---

Gerar Dados de Relatórios

Este endpoint gera os dados calculados para os principais relatórios (Balancete, DRE, Balanço Patrimonial) com base em um intervalo de datas.

GET/api/reports/generate

Parâmetros de Query

Parâmetro	Tipo	Descrição
startDate	string	Opcional. A data de início para o filtro dos dados, no formato YYYY-MM-DD.
endDate	string	Opcional. A data de fim para o filtro dos dados, no formato YYYY-MM-DD.

Resposta

Retorna um objeto contendo os dados calculados para cada relatório.

{
  "trialBalance": [
    { "accountName": "Caixa", "totalDebits": 10000, "totalCredits": 5000, "finalBalance": 5000 },
    // ... outros saldos
  ],
  "dre": {
    "totalRevenue": 50000,
    "totalExpenses": 30000,
    "netIncome": 20000
  },
  "balanceSheet": {
    "totalAssets": 75000,
    "totalLiabilities": 25000,
    "totalEquity": 50000,
    "isBalanced": true
  }
}

Códigos de Status HTTP

• 200 OK: Dados de relatórios gerados com sucesso.
• 400 Bad Request: Parâmetros de query inválidos.
• 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
• 500 Internal Server Error: Erro interno do servidor ao gerar os dados dos relatórios.

---

Exportar Relatórios

Este endpoint exporta um relatório específico para um arquivo (XLSX, CSV ou PDF).

POST/api/reports/export

Corpo da Requisição

{
  "reportType": "dre",
  "format": "pdf",
  "startDate": "2025-01-01",
  "endDate": "2025-12-31"
}

Atributo	Tipo	Descrição
reportType	string	Obrigatório. O tipo de relatório a ser exportado. Valores possíveis: trialBalance, dre, balanceSheet, ledgerDetails.
format	string	Obrigatório. O formato do arquivo. Valores possíveis: xlsx, csv, pdf.
startDate	string	Opcional. A data de início para o filtro dos dados.
endDate	string	Opcional. A data de fim para o filtro dos dados.
organizationId	string	Opcional. O ID da organização para a qual exportar o relatório.
accountingPeriodId	string	Opcional. O ID do período contábil para o qual exportar o relatório.

Resposta

A resposta será o próprio arquivo para download, com os cabeçalhos Content-Type e Content-Disposition apropriados.

Códigos de Status HTTP

• 200 OK: Relatório exportado com sucesso.
• 400 Bad Request: Dados da requisição inválidos (ex: reportType ou format ausente/inválido).
• 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
• 500 Internal Server Error: Erro interno do servidor ao exportar o relatório.