SN Analytics: Dashboard

Endpoint agregador da WebApiAlcance para o dashboard do Simples Nacional (SN Analytics). É um domínio read-only da fase de integração, sem models nem repository próprios: uma única chamada (GET /sn-dashboard/dados-completos) devolve, em um só payload, todos os dados que o front analytics buscava antes em várias consultas separadas - empresas, receitas, folha, cálculos, consolidados de prefeitura, faturamento anual e registros do Domínio. Cada bloco reutiliza o service do domínio dono, preservando ordenação e serialização JSON idênticas às rotas individuais.

Base path

/api/v1/sn-dashboard

Escopos necessários

• sn_dashboard:read - leitura dos dados agregados do dashboard
• sn_dashboard:write - reservado; nenhum endpoint de escrita é exposto por este domínio

O escopo é derivado da rota: o prefixo /sn-dashboard vira o recurso sn_dashboard (hífen → underscore), e o método HTTP define a ação (read para GET). Como o domínio é um agregador de leitura, na prática apenas sn_dashboard:read é usado.

Endpoints

GET /sn-dashboard/dados-completos

Retorna, em uma única chamada, todos os blocos de dados do dashboard do Simples Nacional. Devolve o conjunto completo, e o agrupamento por empresa continua sendo feito no front (groupBy). Cada chave do data é uma lista, possivelmente vazia ([]).

Parâmetros

Este endpoint não recebe parâmetros de rota ou query - devolve o conjunto completo dos dados agregados. O corpo da resposta segue o Schema do payload agregado.

Request

Sem corpo de requisição.

Response 200 OK

{
  "success": true,
  "message": "Dados completos recuperados com sucesso",
  "data": {
    "empresas": [
      {
        "id": 1,
        "empresa_id": 1,
        "created_at": "2026-07-01T09:30:00",
        "updated_at": "2026-07-01T09:30:00"
      }
    ],
    "receitas": [
      {
        "id": 42,
        "empresa_id": 1,
        "mes": 6,
        "ano": 2026,
        "receita_total": "150000.00",
        "created_at": "2026-07-01T09:30:00",
        "updated_at": "2026-07-01T09:30:00"
      }
    ],
    "folha": [
      {
        "id": 10,
        "empresa_id": 1,
        "mes": 6,
        "ano": 2026,
        "created_at": "2026-07-01T09:30:00",
        "updated_at": "2026-07-01T09:30:00"
      }
    ],
    "calculos": [
      {
        "id": 7,
        "empresa_id": 1,
        "created_at": "2026-07-01T09:30:00",
        "updated_at": "2026-07-01T09:30:00"
      }
    ],
    "prefeitura_consolidados": [
      {
        "empresa_id": 1,
        "created_at": "2026-07-01T09:30:00",
        "updated_at": "2026-07-01T09:30:00"
      }
    ],
    "faturamento_anual": [
      {
        "id": 3,
        "empresa_id": 1,
        "ano": 2026,
        "created_at": "2026-07-01T09:30:00",
        "updated_at": "2026-07-01T09:30:00"
      }
    ],
    "dominio_registros": [
      {
        "id": 5,
        "empresa_id": 1,
        "created_at": "2026-07-01T09:30:00",
        "updated_at": "2026-07-01T09:30:00"
      }
    ]
  }
}

Escopo: sn_dashboard:read

Schemas

Schema do payload agregado

O objeto data reúne sete listas. Cada uma reusa o schema Read do domínio dono, com a mesma serialização das rotas individuais (incluindo o mapeamento empresa_id / created_at / updated_at sobre as colunas de ORM correspondentes). Consulte cada domínio para os campos detalhados de cada item.

Notas

• Toda resposta segue o envelope { success, message, data } (ou { success: false, message, details } em erro).
• Este é um domínio agregador read-only (contrato §8): não possui models nem repository próprios. O service monta o payload injetando os services dos demais domínios SN sobre a mesma sessão de banco, reaproveitando ordenação e serialização de cada um.
• Cada chave de data é sempre uma lista, possivelmente vazia ([]) - o front continua responsável pelo agrupamento por empresa.
• Substitui, em uma única requisição, as várias consultas que o front analytics fazia antes diretamente na base - reduzindo idas e voltas ao servidor.
• Os valores monetários dos blocos (ex.: receitas) trafegam no JSON como string DECIMAL(15,2) para preservar a precisão; consulte cada domínio dono para os campos exatos.