Endpoints da API
Relatórios
Os endpoints de Relatórios cobrem tudo que envolve leitura histórica das transações. Use a listagem ao vivo para dashboards e a geração assíncrona em CSV para BI/auditoria de períodos grandes.
GETListar transaçõesGETDetalhe da transaçãoPOSTGerar relatórioGETListar relatóriosGETStatus do relatórioPOSTBaixar relatórioGETResumo de transaçõesGETListar extratoGETConsultar lançamentoGETListar depósitos pendentesGETConsultar depósito pendente
Quando usar cada um
| Cenário | Endpoint |
|---|---|
| Tela de transações no dashboard | GET /user/transactions |
| Detalhe de uma transação específica | GET /user/transactions/{id} |
| Relatório de período grande (mês, ano) | POST /user/report |
| Listar relatórios solicitados | GET /user/reports |
| Verificar se o relatório terminou | GET /user/report/{id} |
| Baixar o CSV gerado | POST /user/report/{id}/download |
| Totais do período sem somar transação a transação | GET /user/summary |
| Extrato da conta num período | GET /user/bank-statements |
| Detalhe de um lançamento do extrato | GET /user/bank-statements/{id} |
| Depósitos que caíram mas não foram conciliados | GET /user/deposit-pending |
| Investigar um depósito pendente específico | GET /user/deposit-pending/{id} |
Listagem vs relatório assíncrono
| Cenário | Recomendado |
|---|---|
| Dashboard, < 10k registros | GET /user/transactions paginado |
| Conciliação diária | GET /user/transactions paginado |
| Mês ou ano completo | POST /user/report (CSV assíncrono) |
| BI / Data Warehouse | POST /user/report agendado |