Plantonizei

App do médico › Plantões e vagas

Resumo do período

GET/api/v1/me/summaryPede sessão

Como funciona

O resumo do médico no período, para o topo do app: quantos plantões (shiftCount), quantas horas (totalHours) e quanto tem a receber (receivableCents, em centavos). O período padrão é o mês corrente; mude com period (today, week) ou com from e to (AAAA-MM-DD).

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`).

Respostas

200 · shiftCount, totalHours e receivableCents.

  • receivableCentsinteger · Valor a receber, em centavos.
  • shiftCountinteger · Quantos plantões.
  • totalHoursinteger · Total de horas.

Corpo de exemplo

{
  "receivableCents": 150000,
  "shiftCount": 1,
  "totalHours": 1
}