Painel da empresa › Ponto
Listar pontos
GET/api/v1/checkinsPede sessãoComo funciona
Os registros de ponto da empresa no período, paginados: médico, plantão, entrada, saída, local, resultado da biometria, situação (validado, aguardando validação, recusado) e o motivo quando há divergência.
O período padrão é o mês corrente; mude com period ou com from e to (AAAA-MM-DD). Pagine com page e pageSize.
Pede a permissão de ver o Check-in.
Parâmetros
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 · records da página e pagination com o total.
paginationobject · Paginação: página, tamanho e total.pagination.pageinteger · Página.pagination.pageSizeinteger · Itens por página.pagination.totalinteger · Total.recordsobject[] · Os registros de ponto.records[].addressstring · Endereço.records[].biometrystring · Resultado da biometria.records[].checkinstring · Entrada.records[].checkoutstring · Saída.records[].coordinatorstring · Coordenador responsável pela jornada.records[].crmstring · Número do CRM.records[].crmStatusstring · Situação do CRM no conselho, por extenso.records[].datestring · Data.records[].distanceMetersinteger · Distância, em metros, entre a batida e o local da escala.records[].doctorNamestring · Nome do médico.records[].exceptionReasonstring · Motivo da exceção.records[].exemptboolean · O médico é isento de ponto; sem registro, não é pendência.records[].geofenceRadiusMetersinteger · Raio, em metros, dentro do qual o ponto vale.records[].idstring · Identificador do registro.records[].lateMinutesinteger · Minutos de atraso na entrada.records[].paidAmountCentsinteger · Valor pago, em centavos.records[].paidAtstring · Quando foi pago.records[].paidBystring · Quem registrou o pagamento.records[].paymentTermstring · Prazo de pagamento: à vista ou a prazo.records[].punchLatnumber · Latitude de onde o médico bateu o ponto.records[].punchLngnumber · Longitude de onde o médico bateu o ponto.records[].scaleNamestring · Nome da escala.records[].scheduleLatnumber · Latitude do local da escala.records[].scheduleLngnumber · Longitude do local da escala.records[].sectorstring · Setor.records[].shiftstring · Turno.records[].shiftIdstring · Identificador do plantão.records[].shiftOriginstring · Origem do plantão:manual(avulso, pago na hora) ourule(da escala fixa, pago pela folha).records[].shiftTypestring · Tipo de plantão.records[].sourcestring · Origem.records[].specialtystring · Especialidade.records[].validatedAtstring · Quando foi validado.records[].decisionstring: approved | rejected · A última decisão da coordenação sobre a batida; ausente sem decisão.records[].rejectReasonstring · O motivo da recusa, quando a última decisão foi recusar.records[].checkinInformedboolean · A entrada foi informada depois (lançada à mão), não batida no local. Recusado o ponto, só o horário informado deixa de valer.records[].checkoutInformedboolean · A saída foi informada depois (lançada à mão), não batida no local.records[].justificationstring · A justificativa do lançamento manual (do médico ou do escalista).records[].evidenceKeystring · A chave do comprovante do lançamento manual; abre porGET /api/v1/schedule/evidencias?key=.records[].postedBystring · Quem lançou o horário à mão.records[].radiusobject · As saídas do raio do plantão, o mesmo corpo deGET /api/v1/schedule/shifts/{id}/radius-exits, para o detalhe abrir sem outra chamada.records[].radius.trackedbooleanrecords[].radius.finishedbooleanrecords[].radius.startsAtstringrecords[].radius.endsAtstringrecords[].radius.exitsobject[]records[].radius.exits[].leftAtstringrecords[].radius.exits[].returnedAtstringrecords[].radius.exits[].maxDistanceMetersintegerrecords[].releasedBystring · Quem da coordenação liberou esta batida fora da regra, quando houve pedido de liberação.records[].validatedBystring · Quem validou; ausente enquanto ninguém validou.records[].valueCentsinteger · Valor, em centavos.records[].windowstring · Janela do plantão (início e fim), em texto.
Corpo de exemplo
{
"pagination": {
"page": 1,
"pageSize": 1,
"total": 1
},
"records": [
{
"address": "texto",
"biometry": "texto",
"checkin": "texto",
"checkout": "texto",
"coordinator": "texto",
"crm": "texto",
"crmStatus": "texto",
"date": "texto",
"distanceMeters": 1,
"doctorName": "texto",
"exceptionReason": "texto",
"exempt": true,
"geofenceRadiusMeters": 1,
"id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"lateMinutes": 1,
"paidAmountCents": 150000,
"paidAt": "texto",
"paidBy": "texto",
"paymentTerm": "texto",
"punchLat": 1,
"punchLng": 1,
"scaleName": "texto",
"scheduleLat": 1,
"scheduleLng": 1,
"sector": "texto",
"shift": "texto",
"shiftId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"shiftOrigin": "texto",
"shiftType": "texto",
"source": "texto",
"specialty": "texto",
"validatedAt": "texto",
"decision": "approved",
"rejectReason": "texto",
"checkinInformed": true,
"checkoutInformed": true,
"justification": "texto",
"evidenceKey": "texto",
"postedBy": "texto",
"radius": {
"tracked": null,
"finished": null,
"startsAt": null,
"endsAt": null,
"exits": []
},
"releasedBy": "texto",
"validatedBy": "texto",
"valueCents": 150000,
"window": "texto"
}
]
}