Relatórios
Relatórios financeiros em PDF. Corresponde à tela Relatórios do menu Financeiro, que gera o relatório escolhido com os filtros preenchidos.
Os endereços a seguir são relativos a https://api.pedagogo.app.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /financial/reports | Lista os relatórios disponíveis |
| GET | /financial/reports/{report_id} | Gera um relatório em PDF |
| GET | /financial/reports/release-types | Tipos de lançamento (lista de apoio) |
| GET | /financial/reports/account-types | Tipos de conta (lista de apoio) |
| GET | /financial/reports/accounts | Contas cadastradas (lista de apoio) |
| GET | /financial/reports/cost-centers | Centros de custo (lista de apoio) |
| GET | /financial/reports/categories | Categorias (lista de apoio) |
| GET | /financial/reports/payment-methods | Métodos de pagamento (lista de apoio) |
Relatórios disponíveis
GET /financial/reports
Lista os relatórios, com id e name de cada um.
GET /financial/reports/{report_id}
Gera o relatório e devolve o arquivo para download.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
report_id | Relatório a gerar: 1 para Extrato de Conta Corrente, 2 para Resumo de lançamento do plano de conta e 3 para Extrato do Plano de Conta |
start_date | Data inicial do período (AAAA-MM-DD) |
end_date | Data final do período (AAAA-MM-DD) |
Resposta (200): arquivo PDF para download.
curl -G https://api.pedagogo.app/financial/reports/1 \
-H "Accept: application/pdf" \
-H "Authorization: Bearer <token-de-sessao>" \
--data-urlencode "start_date=2026-01-01" \
--data-urlencode "end_date=2026-01-31" \
-o relatorio.pdf
Listas de apoio
As listas abaixo alimentam os filtros do formulário de Relatórios. Cada uma tem a mesma forma da lista equivalente de outras telas:
| Caminho | Descrição |
|---|---|
/financial/reports/release-types | Tipos de lançamento. Crédito (1) e Débito (2). Veja Movimentação financeira |
/financial/reports/account-types | Tipos de conta. Veja Contas |
/financial/reports/accounts | Contas cadastradas. Veja Contas |
/financial/reports/cost-centers | Centros de custo. Veja Centros de custo |
/financial/reports/categories | Categorias. Veja Categorias |
/financial/reports/payment-methods | Métodos de pagamento. Veja Métodos de pagamento |