Plantonizei

Painel da empresa › Dashboard

Painel da empresa

GET/api/v1/dashboardPede sessão

Como funciona

Os indicadores principais do painel da empresa no período: plantões, cobertura, horas, valores e afins.

O período padrão é o mês corrente. Mude com period (today, week para os últimos 7 dias, ou period para escolher as datas) ou mande from e to em AAAA-MM-DD. Para ver só uma escala, use scheduleId; para ver uma das empresas cadastradas no seletor do topo, use companyId.

Pede a permissão de ver o painel. Para carregar a tela inteira de uma vez, prefira GET /dashboard/aggregate.

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 · Os indicadores do período.

  • activeAdvancesCentsinteger · Antecipações em aberto, em centavos.
  • advancesInMonthinteger · Antecipações no mês.
  • checkinsInMonthinteger · Pontos batidos no mês.
  • closesInDaysinteger · Dias até o fechamento.
  • exposurePctnumber · Exposição em antecipações, em porcentagem.
  • lateCheckinsinteger · Entradas com atraso.
  • liveNowinteger · Plantões acontecendo agora.
  • marginPctnumber · Margem, em porcentagem.
  • payableCentsinteger · Valor a pagar, em centavos.
  • payableDoctorsinteger · Médicos a pagar.
  • receivableCentsinteger · Valor a receber, em centavos.
  • shiftsInMonthinteger · Plantões no mês.

Corpo de exemplo

{
  "activeAdvancesCents": 150000,
  "advancesInMonth": 1,
  "checkinsInMonth": 1,
  "closesInDays": 1,
  "exposurePct": 1,
  "lateCheckins": 1,
  "liveNow": 1,
  "marginPct": 1,
  "payableCents": 150000,
  "payableDoctors": 1,
  "receivableCents": 150000,
  "shiftsInMonth": 1
}