Plantonizei

Painel da empresa › Financeiro

Folha da competência

GET/api/v1/payrollPede sessão

Como funciona

A folha do período, plantão a plantão: médico, CRM, especialidade, escala, horas e valor previstos, horas e valor realizados pelo ponto, a diferença, entrada e saída, a validação do ponto, os dados bancários e o PIX para o pagamento, as antecipações pendentes e pagas e se a competência já está fechada.

A folha é por competência, que fecha no dia configurado em Configurações → Financeiro: com fechamento no dia 25, a competência de outubro vai de 26/09 a 25/10, e o plantão do dia 26 já entra no mês seguinte. Fechamento, pagamento e antecipações casam pela competência. Sem configuração, a competência é o mês do calendário.

Sem parâmetro, abre a competência de hoje; competency (AAAA-MM) abre outra. period ou from e to (AAAA-MM-DD) pedem um período livre. Pagine com page e pageSize.

contractAmountCents, o valor que a contratante paga pelo plantão, é a margem da empresa: só o administrador recebe esse campo. Para os demais perfis ele não sai na resposta.

Pede a permissão de ver a folha.

Parâmetros

  • competencyQuery · stringCompetência a abrir (`AAAA-MM`). Sem ela, abre a competência de hoje.
  • pageQuery · integerPágina, a partir de 1. Padrão: 1.
  • pageSizeQuery · integerItens por página. Padrão: 50; máximo: 100.
  • 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 · shifts da página, pagination com o total e a competência aberta com o período dela.

  • competencystring · Competência aberta (AAAA-MM).
  • periodFromstring · Primeiro dia da competência (AAAA-MM-DD).
  • periodTostring · Último dia da competência (AAAA-MM-DD).
  • closingDayinteger · Dia de fechamento da competência na empresa; 31 é o último dia do mês.
  • paginationobject · Paginação: página, tamanho e total.
  • pagination.pageinteger · Página.
  • pagination.pageSizeinteger · Itens por página.
  • pagination.totalinteger · Total.
  • shiftsobject[] · Os plantões.
  • shifts[].accountstring · Conta.
  • shifts[].actualAmountCentsinteger · Valor realizado pelo ponto, em centavos. Zero enquanto o plantão não começou (validation = scheduled), sem ponto (missing) ou sem saída (incomplete); o isento de ponto vale o planejado.
  • shifts[].actualHoursnumber · Horas realizadas pelo ponto.
  • shifts[].advancesPaidCentsinteger · Antecipações já pagas ao médico na competência, em centavos.
  • shifts[].paidOnSiteCentsinteger · Pago NA HORA neste plantão, em centavos; sai do líquido da folha.
  • shifts[].paidOnSiteAtstring · Quando o pagamento na hora foi registrado.
  • shifts[].startsAtstring · Início PLANEJADO do plantão.
  • shifts[].endsAtstring · Término PLANEJADO do plantão.
  • shifts[].advancesPendingCentsinteger · Antecipações do médico na competência, em centavos; o líquido já as desconta.
  • shifts[].agencystring · Agência.
  • shifts[].bankstring · Banco.
  • shifts[].bondstring · Tipo de vínculo do médico.
  • shifts[].checkInstring · Entrada (RFC 3339).
  • shifts[].checkOutstring · Saída (RFC 3339).
  • shifts[].competencyClosedboolean · A competência já foi fechada.
  • shifts[].contractAmountCentsinteger · Valor que a contratante paga pelo plantão, em centavos. Só o administrador recebe este campo.
  • shifts[].cpfstring · CPF, só dígitos.
  • shifts[].crmstring · Número do CRM.
  • shifts[].datestring · Data do plantão (AAAA-MM-DD).
  • shifts[].diffAmountCentsinteger · Diferença entre o realizado e o previsto, em centavos.
  • shifts[].diffHoursnumber · Diferença entre o realizado e o previsto, em horas.
  • shifts[].doctorLinkIdstring · Identificador do médico nesta empresa (o vínculo).
  • shifts[].doctorNamestring · Nome do médico.
  • shifts[].paidAtstring · Quando a folha deste médico nesta competência foi paga.
  • shifts[].pixstring · Chave PIX.
  • shifts[].plannedAmountCentsinteger · Valor previsto pela escala, em centavos.
  • shifts[].plannedHoursnumber · Horas previstas pela escala.
  • shifts[].schedulestring · Escala.
  • shifts[].shiftIdstring · Identificador do plantão.
  • shifts[].shiftTypestring · Tipo de plantão da jornada.
  • shifts[].specialtystring · Especialidade.
  • shifts[].validatedAtstring · Quando o ponto foi validado.
  • shifts[].validatedBystring · Quem validou; ausente enquanto ninguém validou.
  • shifts[].validationstring · Apuração do plantão: validated (ponto completo ou isento), validatedWithDivergence (medido diferente do planejado), scheduled (ainda não começou), incomplete (só a entrada) ou missing (começou sem ponto).
  • shifts[].competencystring · Competência do plantão (AAAA-MM), pelo dia de fechamento da empresa.

Corpo de exemplo

{
  "competency": "texto",
  "periodFrom": "texto",
  "periodTo": "texto",
  "closingDay": 1,
  "pagination": {
    "page": 1,
    "pageSize": 1,
    "total": 1
  },
  "shifts": [
    {
      "account": "texto",
      "actualAmountCents": 150000,
      "actualHours": 1,
      "advancesPaidCents": 150000,
      "paidOnSiteCents": 150000,
      "paidOnSiteAt": "2026-10-20T09:30:00-03:00",
      "startsAt": "2026-10-20T09:30:00-03:00",
      "endsAt": "2026-10-20T09:30:00-03:00",
      "advancesPendingCents": 150000,
      "agency": "texto",
      "bank": "texto",
      "bond": "texto",
      "checkIn": "texto",
      "checkOut": "texto",
      "competencyClosed": true,
      "contractAmountCents": 150000,
      "cpf": "texto",
      "crm": "texto",
      "date": "texto",
      "diffAmountCents": 150000,
      "diffHours": 1,
      "doctorLinkId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "doctorName": "texto",
      "paidAt": "texto",
      "pix": "texto",
      "plannedAmountCents": 150000,
      "plannedHours": 1,
      "schedule": "texto",
      "shiftId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "shiftType": "texto",
      "specialty": "texto",
      "validatedAt": "texto",
      "validatedBy": "texto",
      "validation": "texto",
      "competency": "texto"
    }
  ]
}