Pular para o conteúdo principal

Operacional — /api/v1/company/directory/:companyId/operational

Controller: CompanyOperationalV1Controller
Auth: Bearer + resolução de tenant e pertença da company
Tag: Operacional (dados por empresa)
BD: default — estabelecimentos, transacoes_locais, propostas, configs financeiras, etc.

Rotas

MétodoRota relativaDescrição
GET/estabelecimentosListar ECs vinculados à company
GET/estabelecimentos/:estabelecimentoIdDetalhe de um EC
GET/dashboardIndicadores TPV / transacoes_locais
GET/top-estabelecimentosTop ECs por TPV (APPR) no período
GET/comissoes/resumoResumo financeiro por EC
GET/alugueis/resumoAluguel de máquinas (contratos ATIVO)
GET/propostasListar propostas da company

Exemplo completo:

GET /api/v1/company/directory/{companyId}/operational/dashboard?dataInicio=2026-04-01&dataFim=2026-05-04
QueryEndpointsNotas
dataIniciodashboard, top, comissõesISO / YYYY-MM-DD. Default: ~30 dias antes de dataFim
dataFimdashboard, top, comissõesDefault: agora
limitetop-estabelecimentos1–100, default 10

Inventário: catalogo-completo.md §9.