Plantonizei

Painel da empresa › Dashboard

Seções do painel

GET/api/v1/dashboard/sectionsPede sessão

Como funciona

Os blocos detalhados do painel (as listas e quebras que ficam abaixo dos indicadores), no mesmo período e no mesmo recorte de GET /dashboard.

Aceita os mesmos filtros: period, from, to, scheduleId e companyId. Pede a permissão de ver o painel.

Parâmetros

  • periodQuery · stringAtalho de período: `today` (hoje), `week` (últimos 7 dias) ou `period` (datas de `from` e `to`). Sem ele, vale o mês corrente.
  • fromQuery · stringInício do período (`AAAA-MM-DD`).
  • toQuery · stringFim do período (`AAAA-MM-DD`).
  • scheduleIdQuery · stringMostra só uma escala.
  • companyIdQuery · stringMostra só uma empresa cadastrada (o seletor do topo do painel).

Respostas

200 · As seções do painel no período.

  • advancesobject[] · Os pedidos de antecipação.
  • advances[].doctorNamestring · Nome do médico.
  • advances[].feePctnumber · Taxa, em porcentagem.
  • advances[].idstring · Identificador do registro.
  • advances[].netAmountCentsinteger · Valor líquido, em centavos.
  • advances[].shiftsDoneinteger · Plantões realizados.
  • advances[].statusstring · Situação.
  • advances[].whenstring · Quando.
  • cashflowobject[] · Fluxo de caixa.
  • cashflow[].monthstring · Mês.
  • cashflow[].payableCentsinteger · Valor a pagar, em centavos.
  • cashflow[].projectedboolean · O mês ainda não fechou: o número é projeção.
  • cashflow[].receivableCentsinteger · Valor a receber, em centavos.
  • checkinByDoctorobject[] · Ponto por médico.
  • checkinByDoctor[].labelstring · Nome exibido.
  • checkinByDoctor[].lateinteger · Plantões com atraso.
  • checkinByDoctor[].missinginteger · Plantões sem ponto.
  • checkinByDoctor[].onTimeinteger · Plantões no horário.
  • checkinByScheduleobject[] · Ponto por escala.
  • checkinBySchedule[].labelstring · Nome exibido.
  • checkinBySchedule[].lateinteger · Plantões com atraso.
  • checkinBySchedule[].missinginteger · Plantões sem ponto.
  • checkinBySchedule[].onTimeinteger · Plantões no horário.
  • pendenciesobject[] · Pendências.
  • pendencies[].countinteger · Quantidade.
  • pendencies[].detailstring · Detalhe do evento.
  • pendencies[].hrefstring · Caminho da tela onde a pessoa resolve o assunto.
  • pendencies[].idstring · Identificador do registro.
  • pendencies[].labelstring · Nome exibido.
  • pendencies[].severitystring · Gravidade.
  • shiftsobject[] · Os plantões.
  • shifts[].currentinteger · É o atual.
  • shifts[].dayinteger · Dia.
  • shifts[].previousinteger · Valor do período anterior.

Corpo de exemplo

{
  "advances": [
    {
      "doctorName": "texto",
      "feePct": 1,
      "id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "netAmountCents": 150000,
      "shiftsDone": 1,
      "status": "texto",
      "when": "2026-10-20T09:30:00-03:00"
    }
  ],
  "cashflow": [
    {
      "month": "texto",
      "payableCents": 150000,
      "projected": true,
      "receivableCents": 150000
    }
  ],
  "checkinByDoctor": [
    {
      "label": "texto",
      "late": 1,
      "missing": 1,
      "onTime": 1
    }
  ],
  "checkinBySchedule": [
    {
      "label": "texto",
      "late": 1,
      "missing": 1,
      "onTime": 1
    }
  ],
  "pendencies": [
    {
      "count": 1,
      "detail": "texto",
      "href": "texto",
      "id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "label": "texto",
      "severity": "texto"
    }
  ],
  "shifts": [
    {
      "current": 1,
      "day": 1,
      "previous": 1
    }
  ]
}