Skip to main content
GET
/
frequency
/
daily
Busca as frequências diárias de um colaborador por um determinado período de tempo
curl --request GET \
  --url https://api.example.com/frequency/daily
{
  "dataInicial": "01/01/2022",
  "dataFinal": "31/12/2022",
  "tipoTurno": "turnoFixo",
  "turnoAtivo": true,
  "tipoRegraDePonto": "BANCO_DE_HORAS",
  "horasTrabalhadasTotal": "8:00",
  "saldoTotal": "+7:23",
  "atrasosTotal": "1:20",
  "antecipacoesTotal": "1:15",
  "pendenciasTotal": 7,
  "totalJornadas": 5,
  "totalFaltas": 5,
  "frequenciasDiarias": [
    {
      "data": "2023-07-23T00:00:00.000Z",
      "cargaHoraria": "8:48",
      "horasTrabalhadas": "8:00",
      "saldo": "-0:48",
      "atrasos": "0:20",
      "antecipacoes": "0:15",
      "tempoIntrajornada": "1:12",
      "tempoInterjornada": "12:00",
      "registros": [
        {
          "dataHora": "2024-05-02T14:22:43.230Z",
          "nome": "Nelson da Silva",
          "cpf": "15217510056",
          "tipo": "SIMPLE",
          "endereco": "Avenida Afonso Pena, 237, Belo Horizonte, MG",
          "NSR": "2307",
          "hashCode": "c0fc3c713f09a43384ac08f7d91fca430dcbc6466fff9284ce4571bdc2c8f9f9",
          "criadoEm": "2024-05-02T14:22:43.230Z",
          "tipoOrigem": "01",
          "online": true,
          "tipoRegistroBatida": "ENTRADA",
          "tipoAmbiente": "INDIVIDUAL",
          "fusoHorario": "SAO_PAULO",
          "criadoPorAjuste": false,
          "invalidadoPorAjuste": false,
          "inconsistencias": [
            "ENDERECO_IP_AUSENTE_OU_NAO_CADASTRADO"
          ],
          "colaboradorId": "123-456abc",
          "relogioId": "123-456abc",
          "coletorId": "123-456abc",
          "relatorioId": "123-456abc",
          "coletorDescricao": "Piso 01",
          "indevido": false,
          "statusInconstencias": "PENDENTE"
        }
      ],
      "statusVigenteColaborador": "ATIVO",
      "regraPontoVigente": {
        "id": "123-456abc",
        "tipo": "MISTO",
        "nome": "Regra de ponto 1"
      },
      "turnoVigente": {
        "tipo": "turnoFixo",
        "nome": "Horário comercial",
        "turnoId": "123-456abc",
        "tipoTurnoFlexivel": "DIARIO",
        "excecao": false,
        "excecaoId": "123-456abc"
      },
      "ocorrencias": [
        "TEMPO_INTERJORNADA_MENOR_QUE_O_MINIMO"
      ],
      "pendencias": [
        "FALTA"
      ],
      "saldoIntrajornada": "-0:08",
      "adicionalNoturno": "4:00",
      "bancoHoras": "+0:48",
      "horasExtras": "0:48",
      "horasExtrasSaldoBase": "0:30",
      "horasExtrasIntervaloSaldoBase": "0:30",
      "indenizacaoInterjornada": 30,
      "falta": 1,
      "faltaHoras": "4:00",
      "feriado": "Natal",
      "diaTurnoFixo": {
        "tipoDiaTrabalho": "NORMAL",
        "diaSemana": "SEGUNDA",
        "entrada": "8:00",
        "saida": "18:00",
        "intervaloFlexivel": true,
        "intervalos": [
          {
            "inicio": "8:00",
            "fim": "18:00",
            "minimo": "0:30",
            "maximo": "1:30"
          }
        ]
      },
      "diaRevezamento": {
        "tipoDiaTrabalho": "NORMAL",
        "mesConfig": 1,
        "diaConfig": 1,
        "entrada": "8:00",
        "saida": "18:00",
        "intervaloFlexivel": true,
        "intervalos": [
          {
            "inicio": "8:00",
            "fim": "18:00",
            "minimo": "0:30",
            "maximo": "1:30"
          }
        ]
      },
      "grupoFlexivelConfiguracao": {
        "tempoTrabalho": "8:00",
        "trabalhaSegunda": true,
        "trabalhaTerca": true,
        "trabalhaQuarta": true,
        "trabalhaQuinta": true,
        "trabalhaSexta": true,
        "trabalhaSabado": false,
        "trabalhaDomingo": false,
        "viraNoite": "1:00",
        "intervalos": [
          {
            "inicio": "8:00",
            "fim": "18:00",
            "minimo": "0:30",
            "maximo": "1:30"
          }
        ]
      },
      "ajuste": {
        "ajusteRegistroId": "123-456abc",
        "codigo": 1,
        "jornada": "2024-01-01T00:00:00.000Z",
        "status": "APROVADO",
        "formato": "REGISTRO_PONTO",
        "descricao": "Atestado",
        "createdAt": "2023-07-23T00:00:00.000Z",
        "updatedAt": "2023-07-23T00:00:00.000Z",
        "motivo": {
          "descricao": "Esqueceu de registrar o ponto",
          "tipo": "ABONO",
          "motivoAjusteRegistroId": "123-456abc",
          "descontarJornada": false,
          "descontarPreferencialmenteAdicionalNoturno": false
        },
        "titulo": "Confraternização da firma",
        "jornadas": [
          "2024-01-01T00:00:00.000Z",
          "2024-01-02T00:00:00.000Z"
        ],
        "minPeriodo": "2024-01-01T00:00:00.000Z",
        "maxPeriodo": "2024-05-31T00:00:00.000Z",
        "minMinutos": 480,
        "maxMinutos": 720,
        "considerarRegistroRealizado": false,
        "tempoFaltante": "+04:48",
        "ferias": false,
        "registrosPropostos": [
          {
            "dataHora": "2024-05-02T14:22:43.230Z",
            "registroHash": "c0fc3c713f09a43384ac08f7d91fca430dcbc6466fff9284ce4571bdc2c8f9f9"
          }
        ],
        "anexos": [
          {
            "arquivoId": "123-456abc",
            "nome": "comprovante.pdf",
            "url": "https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg"
          }
        ],
        "nomeGestor": "Nelson da Silva",
        "observacaoGestor": "Não se esqueça novamente de registrar ponto",
        "colaboradores": [
          {
            "colaboradorId": "123-456abc",
            "nome": "João da Silva",
            "numeroDocumento": "152.175.100-56",
            "saldoAntigo": "-04:48",
            "adicionalNoturnoAntigo": "+04:48",
            "foto": "https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg",
            "nomeUnidadeNegocio": "Tron",
            "logoUnidadeNegocio": "https://s3-bucket.s3.amazonaws.com/files/tenant_x/file.jpg"
          }
        ],
        "frequenciaDiariaJornada": "<unknown>"
      }
    }
  ],
  "tipoTurnoFlexivel": "DIARIO",
  "cargaHorariaTotal": "8:48",
  "horasPositivasTotal": "+2:37",
  "horasNegativasTotal": "-2:37",
  "adicionalNoturnoTotal": "23:07",
  "bancoHorasTotal": {
    "total": "+0:48",
    "saldosConfigAvancada": [
      {
        "percentual": 0.5,
        "saldo": "+0:48"
      }
    ]
  },
  "horasExtrasTotal": {
    "total": "+0:48",
    "saldosConfigPadrao": [
      {
        "percentual": 0.5,
        "saldo": "+0:48"
      }
    ],
    "saldosConfigPersonalizada": [
      {
        "percentual": 0.5,
        "saldo": "+0:48"
      }
    ],
    "saldosConfigAvancada": [
      {
        "percentual": 0.5,
        "saldo": "+0:48"
      }
    ]
  },
  "horasExtrasIntervaloTotal": {
    "total": "+0:48",
    "saldosConfigPadrao": [
      {
        "percentual": 0.5,
        "saldo": "+0:48"
      }
    ],
    "saldosConfigPersonalizada": [
      {
        "percentual": 0.5,
        "saldo": "+0:48"
      }
    ],
    "saldosConfigAvancada": [
      {
        "percentual": 0.5,
        "saldo": "+0:48"
      }
    ]
  },
  "totalFaltasHoras": "7:23",
  "pontualidadeTotal": "100%"
}

Query Parameters

​
initialDate
string
required

Data da inicial (dd/MM/yyyy)

Example:

"01/05/2024"

​
finalDate
string
required

Data da final (dd/MM/yyyy)

Example:

"31/05/2024"

​
collaboratorId
string
required

ID do colaborador

Example:

"123-456abc"

​
forceRecalculate
boolean

A operação irá realizar todos os cálculos novamente e atualizar as frequências salvas

Example:

false

Response

Frequências diárias

​
dataInicial
string
required

Data inicial (dd/MM/yyyy) para o cálculo de frequência

Example:

"01/01/2022"

​
dataFinal
string
required

Data final (dd/MM/yyyy) para o cálculo de frequência

Example:

"31/12/2022"

​
tipoTurno
enum<string>
default:turnoFixo
required

Tipo do turno atual

Available options:
turnoFixo,
turnoFlexivel,
turnoRevezamento,
turnoCiclo
​
turnoAtivo
boolean
required

O turno está ativo

Example:

true

​
tipoRegraDePonto
enum<string>
default:BANCO_DE_HORAS
required

Tipo da regra de ponto atual

Available options:
HORAS_EXTRAS,
BANCO_DE_HORAS,
MISTO
​
horasTrabalhadasTotal
string
required

Total de horas trabalhadas

Example:

"8:00"

​
saldoTotal
string
required

Total do saldo comparativo entre os horários de entrada e saída reais e os esperados, positivo ou negativo

Example:

"+7:23"

​
atrasosTotal
string
required

Total do tempo de atraso

Example:

"1:20"

​
antecipacoesTotal
string
required

Total do tempo de antecipação

Example:

"1:15"

​
pendenciasTotal
number
required

Número total de pendências

Example:

7

​
totalJornadas
number
required

Quantidade total de jornadas diárias

Example:

5

​
totalFaltas
number
required

Quantidade total de faltas

Example:

5

​
frequenciasDiarias
object[]
required

Resultado da consulta de frequencias

​
tipoTurnoFlexivel
enum<string>
default:DIARIO

Tipo de turno flexível

Available options:
DIARIO,
SEMANAL,
MENSAL,
LIVRE
​
cargaHorariaTotal
string

Carga horária total esperada

Example:

"8:48"

​
horasPositivasTotal
string

Somatório de horas das jornadas com saldo positivo

Example:

"+2:37"

​
horasNegativasTotal
string

Somatório de horas das jornadas com saldo negativo

Example:

"-2:37"

​
adicionalNoturnoTotal
string

Somatório de adicionais noturnos das jornadas

Example:

"23:07"

​
bancoHorasTotal
object

Banco de horas no período

​
horasExtrasTotal
object

Horas extras no período

​
horasExtrasIntervaloTotal
object

Horas extras em intervalo no período, calculadas separadamente caso configurado como tal

​
totalFaltasHoras
string

Quantidade total de faltas em horas, a ser mostrada caso a regra de ponto estiver configurada para tal

Example:

"7:23"

​
pontualidadeTotal
string

Porcentagem da carga horária cumprida

Example:

"100%"