Aparência
Módulo Financeiro
Prefixo base: /consolidation
Todas as rotas requerem autenticação JWT + conta ativa.
Headers obrigatórios:
Authorization: Bearer {token}
Content-Type: application/json
account: {account_id}Removido em 03/10/2026: esta página descrevia
GET /consolidation/dashboardeGET /consolidation/dashboard/summary. Essas rotas nunca foram registradas em nenhuma branch. Os controllers e services delas (Consolidation\DashboardController,DashboardSummaryController,Reports\DashboardService,DashboardSummaryService) eram código morto e foram apagados. Os números do dashboard do portal vêm de/consolidation/statistic/*,/consolidation/financial-movementse/billing/charges/reports.
GET /consolidation/balance
Retorna o saldo atual da conta.
Response 200:
json
{
"balance": 4523.75,
"available": 4323.75
}| Campo | Descrição |
|---|---|
balance | Saldo do extrato (soma das transações concluídas) |
available | Saldo disponível para novas saídas: balance menos TEDs e boletos ainda em processamento |
Extrato e transações: /consolidation/financial-movements
Extrato, lista de transações, resumo de entradas e saídas e PDF de uma transação ficam num só recurso, sempre limitado à conta autenticada.
As seções que existiam aqui (
/consolidation/transactions,/consolidation/transactions/{id},/download,balance-summarye/consolidation/extract) descreviam rotas que não existiam com esse prefixo. Eram as de/quickpay/transactions*e/quickpay/extract, removidas em 03/10/2026 (respondem404). Use as rotas abaixo.
| Rota removida | Use |
|---|---|
GET /quickpay/transactions | GET /consolidation/financial-movements |
GET /quickpay/transactions/balance-summary | GET /consolidation/financial-movements?include[]=summary |
GET /quickpay/extract | GET /consolidation/financial-movements?include[]=daily_evolution |
GET /quickpay/transactions/{id} | GET /consolidation/financial-movements/{id} |
GET /quickpay/transactions/{id}/download | GET /consolidation/financial-movements/{id}/download-pdf |
GET /consolidation/financial-movements
| Query | Regras |
|---|---|
search | Texto, até 100 caracteres |
type_id ou type_ids[] | Tipos de transação (/consolidation/transaction-types) |
status ou status_ids[] | Status numérico |
date_start, date_end | Período (date_end ≥ date_start) |
order_by | created_at, datetime, id ou value |
order_dir | asc ou desc |
per_page | 1 a 200 (padrão 15) |
page | Página |
include[] | summary (totais, entradas, saídas e por tipo) e/ou daily_evolution (saldo dia a dia no período). Sem include, o summary vem por padrão |
Resposta: data (transações), meta/links de paginação e os blocos pedidos em include.
GET /consolidation/financial-movements/{id}
Detalhe de uma transação da conta, no envelope { code, success, message, data }. Outra conta ou inexistente: 404 Movimentação não encontrada.
GET /consolidation/financial-movements/{id}/download-pdf
PDF do comprovante (application/pdf). ?download=false abre inline.
GET /consolidation/transaction-types
Lista os tipos de transação disponíveis.
Response 200:
json
[
{ "id": 1, "slug": "pix-in", "name": "Pix Entrada" },
{ "id": 2, "slug": "pix-out", "name": "Pix Saída" },
{ "id": 3, "slug": "boleto-in", "name": "Boleto Recebido" }
]Removido em 03/10/2026: esta página descrevia
GET /consolidation/charge-overview,GET /consolidation/charge-splits,GET /consolidation/rateioseGET /consolidation/rateios/export-excel. Essas rotas não existem naproduction, e os controllers delas (Consolidation\ChargeStatisticsController,Consolidation\RateioController, mais oExports\RateioExport) eram código morto e foram apagados.