Métodos das regras de apuração - Gestão do Ponto X

Representa um motivo de acerto, utilizado para justificar ajustes em horários ou datas de trabalho durante o processo de apuração. Essa classe permite identificar o código correspondente ao motivo aplicado.

Métodos disponíveis

• code: retorna o código do motivo de acerto cadastrado no sistema.

Representa uma programação de ponte entre dois dias. Uma ponte ocorre quando há uma troca de horários entre um dia útil e um dia não trabalhado, como um feriado. Essa classe é usada para identificar a origem e o destino dessa programação especial.

Métodos disponíveis

• originDate: retorna a data original da ponte (dia útil que será trocado).
• destinationDate: retorna a data de destino da ponte (dia que será trabalhado em substituição).

Representa uma marcação de ponto realizada pelo colaborador. Essa classe fornece informações completas sobre a data, hora, origem e tipo de uso da marcação registrada no sistema.

Métodos disponíveis

• clockingEventDate: retorna a data em que a marcação foi registrada.
• clockingEventDateTime: retorna a data e hora completas da marcação.
• clockingEventTime: retorna o horário da marcação em minutos desde a meia-noite.
• functionCode: retorna o código da função associada à marcação no relógio coletor.
• originType: indica a origem da marcação (por exemplo, relógio físico, app, web, etc.).
• useType: informa o tipo de uso da marcação, como marcação padrão ou outro tipo previsto pelo sistema.

Representa uma filial da empresa. Essa classe permite acessar informações cadastrais relacionadas à filial, como o código identificador utilizado no sistema.

Métodos disponíveis

• code: retorna o código da filial cadastrado no sistema.

Representa o histórico de filial da empresa, contendo informações sobre os períodos em que determinada filial esteve associada a um colaborador ou vínculo. Essa classe permite consultar as datas de início e fim da relação, além da filial correspondente.

Métodos disponíveis

• startDate: retorna a data inicial do histórico de vínculo com a filial.
• endDate: retorna a data final do histórico, ou null se ainda estiver ativo.
• companyBranch: retorna a filial associada a esse histórico de vínculo.

Representa uma programação de compensação de horas. Essa classe é utilizada para definir e consultar períodos em que o colaborador poderá compensar horas, incluindo datas, horários e tipos de compensação.

Métodos disponíveis

• startDate: retorna a data de início da compensação.
• endDate: retorna a data de término da compensação.
• startDateTimeInterval: retorna a data e hora inicial da programação.
• endDateTimeInterval: retorna a data e hora final da programação.
• intervalStart: informa o horário inicial do intervalo de compensação (em minutos).
• intervalEnd: informa o horário final do intervalo de compensação (em minutos).
• numberOfHours: define a quantidade de horas que devem ser compensadas.
• compensationType: identifica o tipo de compensação (ex.: hora extra, ausência justificada, etc.).
• periodType: define como a compensação será aplicada no expediente (início, fim, qualquer parte).
• situation: retorna a situação associada à compensação.
• workschedule: retorna o horário de trabalho relacionado à programação de compensação.

Representa o contexto de execução do processo de apuração. Essa classe define o ambiente onde a apuração é realizada, reunindo informações como contratos envolvidos, período da apuração, usuário em execução, logs do processo e resultado final.

Métodos e propriedades disponíveis

• startDate: retorna a data inicial do período de apuração.
• endDate: retorna a data final do período de apuração.
• contracts: retorna a lista de contratos que estão sendo processados no contexto.
• currentUser: identifica o usuário que está executando a apuração.
• batchId: retorna o identificador do lote de apuração.
• getBodyResult: retorna o resultado do processamento da apuração no formato JSON (string).
• logInfo: adiciona uma informação no log do processo.
• logWarning: adiciona um aviso no log do processo.
• logError: adiciona uma mensagem de erro no log do processo.
• processChanges: processa e retorna as mudanças personalizadas feitas na apuração, como situações, pendências e metadados.

O contrato representa a unidade de trabalho do colaborador. É por meio dele que o sistema acessa todas as informações relacionadas à apuração de ponto, como o colaborador, seus históricos, banco de horas, programações e feriados.

Durante o processo de apuração, o contrato é utilizado para iterar dia a dia e identificar as situações ocorridas, como atrasos, faltas ou horas extras.

Métodos e propriedades disponíveis

• employee: retorna o colaborador associado ao contrato, com informações pessoais e vínculos ativos.
• histories: fornece os históricos do colaborador durante o período apurado (como cargo, centro de custo, etc.).
• hourBankAccounts: retorna as contas de banco de horas ativas no contrato.
• schedules: acessa as programações do colaborador, como trocas de horário ou escalas.
• timeEvaluation: lista as apurações diárias do contrato, com as situações detectadas por dia.
• getHolidayByDate: permite consultar se existe feriado cadastrado para uma determinada data no contrato.

Representa um centro de custo, utilizado para classificar e organizar financeiramente as atividades de um colaborador ou unidade dentro da empresa. Essa classe permite acessar o código do centro de custo cadastrado.

Métodos disponíveis

• code: retorna o código do centro de custo.

Representa o histórico de centro de custo do colaborador. Essa classe permite verificar qual centro de custo estava associado ao colaborador em determinada data, considerando possíveis alterações ao longo do tempo.

Métodos disponíveis

• startDate: retorna a data de início da vigência do centro de custo.
• endDate: retorna a data de término da vigência, ou null se ainda estiver ativo.
• costCenter: retorna o centro de custo associado ao histórico.

Representa um intervalo de datas, definido por uma data inicial e uma data final. O intervalo é considerado válido quando a data de início é anterior ou igual à data de término. É utilizado em diversos processos de apuração para delimitar períodos de vigência.

Métodos disponíveis

• start: retorna a data de início do intervalo.
• end: retorna a data de término do intervalo.
• toString: representa o intervalo como uma string no formato ISO.

Representa um colaborador, ou seja, uma pessoa que possui vínculo empregatício com um empregador. Essa classe reúne todas as informações relacionadas ao colaborador dentro do contexto de apuração, incluindo dados pessoais, vínculo, admissão, demissão, cargo, escala, filial, centro de custo e mais.

Métodos e propriedades disponíveis

• code: retorna o código do colaborador.
• person: acessa os dados pessoais do colaborador, como nome.
• hireDate: retorna a data de admissão do colaborador.
• dismissalDate: retorna a data de demissão, se houver.
• employmentRelationship: retorna o vínculo de emprego do colaborador.
• employer: retorna a empresa empregadora do colaborador.
• companyBranch: retorna a filial à qual o colaborador está vinculado.
• costCenter: retorna o centro de custo associado ao colaborador, quando existente.
• jobPosition: retorna o cargo do colaborador.
• workshift: retorna a escala de trabalho do colaborador.
• workshiftGroup: retorna a turma da escala de trabalho do colaborador.

Representa uma empresa cadastrada no sistema. Essa classe é utilizada para identificar o empregador ao qual o colaborador está vinculado durante o processo de apuração.

Métodos disponíveis

• code: retorna o código da empresa no sistema.

Representa um vínculo empregatício entre um colaborador e uma empresa. Essa classe contém informações sobre o tipo de contrato de trabalho e o código identificador do vínculo, sendo essencial para definir a relação formal entre empregado e empregador.

Métodos disponíveis

• code: retorna o código do vínculo empregatício.
• contractType: retorna o tipo de contrato associado ao vínculo (por exemplo, CLT, estágio, temporário, etc.).

Representa o histórico de vínculo empregatício de um colaborador. Essa classe é utilizada para consultar o vínculo que esteve ativo em determinado período, incluindo a data de início e, se aplicável, a data de término do vínculo.

Métodos disponíveis

• startDate: retorna a data de início do histórico de vínculo.
• endDate: retorna a data de término do histórico, ou null se o vínculo ainda estiver ativo.
• employmentRelationship: retorna o vínculo empregatício associado ao histórico.

Representa a previsão de horas de trabalho, refeição e lanche do colaborador ao longo do expediente. Essa classe permite acessar os blocos de tempo estimado para cada tipo de intervalo do dia, facilitando o controle e análise de jornadas previstas.

Métodos disponíveis

• work: retorna a lista de horas previstas para trabalho.
• meal: retorna a lista de horas previstas para refeições.
• snack: retorna a lista de horas previstas para lanches.
• getWorkHours: retorna as horas de trabalho de um determinado intervalo ou o total do dia.
• getMealHours: retorna as horas de refeição de um determinado intervalo ou o total do dia.
• getSnackHours: retorna as horas de lanche de um determinado intervalo ou o total do dia.

Representa os históricos do colaborador no período calculado para a apuração. Essa classe agrupa as alterações ocorridas em cargos, vínculos, filiais, escalas, centros de custo e afastamentos, permitindo consultar os dados vigentes em uma determinada data.

O período considerado para os históricos é maior do que o período de apuração, incluindo dias adicionais conforme definido na configuração Retornar dias.

Métodos e propriedades disponíveis

• jobPositionHistories: lista os históricos de cargos.
• companyBranchHistories: lista os históricos de filiais da empresa.
• employmentRelationshipHistories: lista os históricos de vínculos empregatícios.
• workshiftHistories: lista os históricos de escalas de trabalho.
• costCenterHistories: lista os históricos de centros de custo.
• leaveHistories: lista os históricos de afastamentos.
• timeEvaluationHistories: lista os históricos de apuração.
• findJobPositionByDate: busca o histórico de cargo em uma data específica.
• findCompanyBranchByDate: busca o histórico de filial em uma data específica.
• findEmploymentRelationshipByDate: busca o histórico de vínculo empregatício em uma data específica.
• findWorkshiftHistoryByDate: busca o histórico de escala em uma data específica.
• findCostCenterHistoryByDate: busca o histórico de centro de custo em uma data específica.
• findLeaveHistoryByTimeEvaluationDate: busca o histórico de afastamento com base na data de apuração.
• findTimeEvaluationHistoryByDate: busca o histórico de apuração em uma data específica.

Representa um feriado dentro do calendário do sistema. Um feriado é um dia reconhecido como não trabalhado, geralmente por motivos legais, religiosos ou comemorativos. Está sempre associado a um grupo de feriados configurado no sistema.

Métodos disponíveis

• date: retorna a data do feriado.
• holidayGroup: retorna o grupo de feriados ao qual o feriado está vinculado.

Representa uma tabela de feriados cadastrada no sistema. Essa tabela agrupa os feriados aplicáveis a determinados colaboradores, empresas ou localidades, e é utilizada durante os cálculos de apuração para considerar os dias não trabalhados.

Métodos disponíveis

• code: retorna o código da tabela de feriados.

Representa um banco de horas do sistema. Um banco de horas é utilizado para acumular e compensar horas trabalhadas além da jornada regular, conforme regras da empresa. Cada banco é identificado por um código único.

Métodos disponíveis

• code: retorna o código do banco de horas.

Representa uma conta de banco de horas de um colaborador. Cada conta registra a associação do colaborador a um banco de horas específico, com data de início e, se aplicável, data de encerramento.

Métodos disponíveis

• creationDate: retorna a data de criação da conta de banco de horas.
• extinctionDate: retorna a data de extinção da conta, se houver.
• hourBank: retorna o banco de horas associado à conta.

Representa um intervalo do espelho de cálculo de apuração. Esse intervalo descreve como as horas de um dia são classificadas (como horas extras, faltas, refeição, entre outros), sendo o núcleo do processo de apuração. Cada intervalo contém informações como horários de início e fim, tipo de intervalo, subtipos e vínculos com justificativas ou situações específicas.

Métodos disponíveis

• clockingEventStart: retorna a data e hora inicial do intervalo.
• clockingEventEnd: retorna a data e hora final do intervalo.
• type: retorna o tipo principal do intervalo (ex: TRABALHO, FALTA, EXTRA).
• subType: retorna o subtipo do intervalo (ex: antes do expediente, durante, após).
• typeIntervalTolerance: retorna o tipo de intervalo relacionado à tolerância.
• subTypeIntervalTolerance: retorna o subtipo de intervalo relacionado à tolerância.
• adjustmentReason: informa o motivo de acerto relacionado ao intervalo, se aplicável.
• isNightly: indica se o intervalo é noturno.
• isOvertimeAuthorized: informa se as horas extras do intervalo estão autorizadas.
• isTolerancePeriod: indica se o intervalo está dentro de alguma tolerância configurada.
• inClockingEventTolerance: indica se o intervalo respeita a tolerância da marcação de ponto.
• justifiedDays: retorna a quantidade de dias justificados associados ao intervalo.
• situation: retorna a situação associada ao intervalo, quando aplicável (ex: afastamentos).
• positionWorkingPart: informa a posição das horas trabalhadas dentro do intervalo.
• getIntervalInMinutes: retorna a duração do intervalo em minutos.

Representa o cargo de um colaborador no sistema. A classe fornece as informações necessárias para identificar o cargo ocupado, incluindo seu código e a estrutura à qual está vinculado.

Métodos disponíveis

• code: retorna o código do cargo.
• structureCode: retorna o código da estrutura organizacional do cargo.

Representa o histórico de cargo de um colaborador. Essa classe permite identificar qual cargo o colaborador ocupava em determinada data, considerando alterações ao longo do tempo.

Métodos disponíveis

• startDate: retorna a data de início da vigência do cargo.
• endDate: retorna a data de término do histórico de cargo, ou null se ainda estiver ativo.
• jobPosition: retorna o cargo associado ao histórico, com informações como código e estrutura.

Representa um histórico de afastamento do colaborador. Essa classe permite consultar afastamentos aplicados em um período, com informações detalhadas como datas, horários e a situação associada.

Métodos disponíveis

• startDate: retorna a data inicial do histórico de afastamento.
• endDate: retorna a data final do afastamento, ou null se não houver.
• startDateTime: retorna a data e hora inicial do afastamento.
• endDateTime: retorna a data e hora final do afastamento, ou null se não houver.
• startTime: retorna o horário inicial do afastamento (em minutos desde a meia-noite).
• endTime: retorna o horário final do afastamento (em minutos desde a meia-noite).
• timeEvaluationStartDate: data inicial da apuração em que o afastamento teve efeito.
• timeEvaluationEndDate: data final da apuração em que o afastamento teve efeito.
• situation: retorna a situação associada ao afastamento.

Representa uma programação de autorização de horas extras. Essa classe é utilizada quando a empresa exige que as horas extras sejam previamente autorizadas, permitindo configurar os períodos em que a realização dessas horas está permitida.

Métodos disponíveis

• startDate: retorna a data de início da programação.
• endDate: retorna a data de término da programação.
• startTime: retorna o horário inicial da programação (em minutos desde a meia-noite).
• endTime: retorna o horário final da programação (em minutos desde a meia-noite).
• startDateTime: retorna a data e hora inicial da programação.
• endDateTime: retorna a data e hora final da programação, ou null se não houver.

Representa uma pessoa no sistema. Essa classe armazena informações pessoais básicas, como o nome, sendo utilizada em diferentes contextos como cadastro de colaboradores.

Métodos disponíveis

• name: retorna o nome da pessoa.

Representa as horas trabalhadas em uma parte do expediente. A divisão do expediente em partes ocorre ao final dos intervalos de refeição, permitindo identificar quanto foi trabalhado em cada segmento do dia.

Métodos disponíveis

• part: retorna o número da parte do expediente (ex: primeira parte, segunda parte, etc.).
• workingHours: retorna a quantidade de horas trabalhadas nessa parte do expediente.

Representa uma programação de sobreaviso. Essa classe é utilizada para informar o período em que o colaborador permanece de prontidão, mesmo fora do local de trabalho, estando disponível para ser acionado pela empresa, conforme as regras definidas.

Métodos disponíveis

• startDate: retorna a data de início da programação de sobreaviso.
• endDate: retorna a data de término da programação de sobreaviso.
• startTime: retorna o horário inicial do sobreaviso (em minutos desde a meia-noite).
• endTime: retorna o horário final do sobreaviso (em minutos desde a meia-noite).
• continuous: indica se o sobreaviso é contínuo (sem interrupções).
• situation: retorna a situação associada ao sobreaviso.

Representa as programações do colaborador em um período ampliado de cálculo. Essa classe agrupa diferentes tipos de eventos que influenciam a apuração de ponto, como:

• autorização de horas extras,
• compensações de jornada,
• sobreavisos (prontidão),
• pontes de feriados,
• trocas de escala e horário de trabalho.

O período considerado inclui o intervalo de apuração configurado mais um número de dias anteriores e posteriores, conforme a definição de apuração. Esse período ampliado é fundamental para determinar corretamente as influências nas marcações dos dias efetivos de apuração.

Métodos disponíveis

• bridges: retorna as programações de ponte.
• compensations: retorna as compensações de horas.
• overtimeAuthorizations: retorna as autorizações de horas extras.
• readinesses: retorna os sobreavisos/prontidão.
• workscheduleChanges: retorna as trocas de horário de trabalho.
• workshiftChanges: retorna as trocas de escala.

Métodos de busca por data

• findBridgeByDate(date): retorna a ponte do dia informado.
• findCompensationByDate(date): retorna a compensação da data.
• findOvertimeAuthorizationByDate(date): retorna a autorização de hora extra.
• findReadinessByDate(date): retorna os sobreavisos da data.
• findWorkscheduleChangeByDate(date): retorna a troca de horário do dia.
• findWorkshiftChangeByDate(date): retorna a troca de escala do período informado.

Utilização

A classe Schedules está presente no objeto de apuração (TimeEvaluation) e concentra todas as programações que interferem no período calculado. Para analisar apenas as programações do dia, utilize as estruturas disponíveis dentro do próprio objeto da apuração.

Representa um conjunto de horas separadas em diurnas e noturnas. Essa estrutura é útil para apurações que distinguem o tipo de hora trabalhada, principalmente em contextos legais e de remuneração diferenciada.

Métodos disponíveis

• dailyHours: retorna a quantidade de horas diurnas.
• nightlyHours: retorna a quantidade de horas noturnas.
• total: retorna a soma das horas diurnas e noturnas.
• sumDailyHours: adiciona horas à quantidade diurna.
• sumNightlyHours: adiciona horas à quantidade noturna.
• sumSeparatedHours: adiciona outra instância de SeparatedHours às horas atuais.
• toString: retorna a representação em texto das horas separadas.

Representa uma situação de um colaborador. Pode indicar se o colaborador está trabalhando, afastado, de férias, entre outras situações previstas nas regras de apuração.

Métodos disponíveis

• code: retorna o código da situação.
• type: retorna o tipo da situação (exemplo: trabalhando, férias, auxílio doença).
• exception: indica se a situação é considerada uma exceção.
• daytime: indica se a situação é diurna.
• complementarySituation: retorna a situação complementar associada.
• isLoaded: indica se a situação foi carregada com todos os atributos ou apenas com o código.

Representa um sindicato de colaboradores. O sindicato é responsável por definir regras específicas sobre jornada, intervalos e adicionais, conforme os acordos coletivos da categoria.

Métodos disponíveis

• code: retorna o código do sindicato.
• nightStartHour: retorna a hora inicial do período noturno, em minutos.
• nightEndHour: retorna a hora final do período noturno, em minutos.
• minimumInterval4to6Hours: retorna o intervalo mínimo para jornadas entre 4 e 6 horas, em minutos.
• minimumInterval6Hours: retorna o intervalo mínimo para jornadas acima de 6 horas, em minutos.
• minimumWorkDuration6Hours: retorna o tempo mínimo de trabalho exigido para jornadas acima de 6 horas, em minutos.

Representa o processo de apuração de ponto, utilizado para registrar e manipular as informações de horário, escala e situações de apuração do colaborador, incluindo a gestão de faltas, horas extras, intervalos e mais.

Métodos disponíveis

Gerenciamento de Situações

• setSituationHour(situationCode, numberOfHours): Atualiza a quantidade de horas de uma situação existente ou cria uma nova situação com a quantidade de horas especificada.
• getSituationHour(situationCode): Retorna a quantidade de horas de uma situação específica.
• resetSituationHour(situationCode): Zera a quantidade de horas de uma situação.
• sumSituationHour(situationCode, numberOfHours): Soma uma quantidade de horas a uma situação específica.
• getSituationHourByCodes(…situationCodes): Retorna a quantidade de horas de uma lista de situações.

Gerenciamento de Intervalos e Horas

• getSeparateHours(intervalType, tolerance): Retorna a quantidade de horas separadas por tipo de intervalo (faltas, atrasos, extras), considerando ou não a tolerância.
• getOvertimeByRangeTime(startClocking, endClocking): Retorna a quantidade de horas extras em minutos dentro de um intervalo de tempo.
• getSeparateHoursWithExpedientPart(intervalType, part, tolerance): Retorna as horas separadas por tipo de intervalo e parte do expediente.

Históricos e Dados do Colaborador

• clockingEvents: Retorna a lista de marcações de ponto para o dia apurado.
• companyBranchHistory: Retorna o histórico de filial para o dia apurado.
• jobPositionHistory: Retorna o histórico de cargo do colaborador no dia apurado.
• leaveHistories: Retorna o histórico de afastamento do colaborador no dia apurado.

Operações de Pendências e Erros

• generatePendingAdjustment: Indica se deve gerar pendência no dia apurado.
• invalidate(message): Invalida uma apuração e a desconsidera no cálculo.
• missingClockingEvent: Indica se faltam marcações de ponto obrigatórias para o dia apurado.

Representa o histórico de apuração do colaborador. Esse histórico permite consultar a apuração em uma data específica, incluindo o tipo de apuração e as definições de situação associadas ao período.

Métodos disponíveis

• startDate: retorna a data inicial do histórico de apuração.
• endDate: retorna a data final da apuração ou null se não estiver definida.
• type: retorna o tipo de apuração do colaborador.
• situationDefinition: retorna a lista de definições de situação associadas ao período de apuração.
• findSituationDefinitionByDate(date): busca a definição de situação correspondente a uma data específica.

Representa uma situação de apuração de horas de um dia. É utilizada para registrar a quantidade de horas apuradas em uma situação específica, como horas extras, faltas ou atrasos.

Métodos disponíveis

• numberOfHours: obtém ou define a quantidade de horas apuradas, em minutos.
• situation: retorna a situação associada à apuração de horas.
• situationCode: retorna o código da situação, mesmo que ela não esteja carregada no contexto.
• addNumberOfHours(numberOfHours): adiciona uma quantidade de horas à situação apurada, em minutos.

Representa o histórico de definição das situações de apuração, permitindo consultar códigos, datas e situações relacionadas a faltas, atrasos, adicionais noturnos, horas extras e outras ocorrências no contexto da apuração de ponto.

Métodos e propriedades principais:

• code: Retorna o código da definição.
• startDate: Retorna a data inicial da definição.
• endDate: Retorna a data final da definição ou null.
• workSituation: Situação de trabalho associada à definição.
• absenceSituation: Situação de falta.
• tardinessSituation: Situação de atraso.
• unauthorizedOvertime: Situação de horas extras não autorizadas.
• nightShiftWorkPremium: Situação de adicional noturno trabalhado.
• nightShiftOvertimePremiumSituation: Situação de adicional noturno sobre extras.
• overtimeBefore, overtimeAfter, overtimeDuringRest, etc.: Diversas situações de horas extras (antes, depois, durante feriado, folga, descanso, etc.).
• normalOvertimeSeparationLimit: Limite de separação para horas extras normais.
• percentageNextDay: Informa se o percentual do dia seguinte está ativo.
• separateOvertimeAfterConvertingNightShiftHours: Indica se deve separar extras após conversão das noturnas.

Representa o usuário corrente no contexto da execução, permitindo acesso ao nome de identificação do usuário autenticado.

Métodos disponíveis

• userName: retorna o nome do usuário corrente.

Representa um horário de trabalho, contendo informações como código, tipo, carga horária, marcações e configurações específicas da aba ponto.

Métodos disponíveis

• code: retorna o código do horário.
• type: retorna o tipo do horário.
• definitionType: retorna o tipo de definição do horário.
• workload: retorna a carga horária do horário.
• clockingRegisters: retorna a lista de marcações do horário.
• clockingRegistersCount: retorna a quantidade de marcações do horário.
• clockingEvent: retorna as definições da aba ponto do horário.

Representa uma programação de mudança de horário de trabalho, permitindo registrar alterações pontuais no horário de um colaborador, como trocas de turno ou ajustes específicos em determinada data.

Métodos disponíveis

• date: retorna a data da mudança de horário.
• workschedule: retorna o horário de trabalho associado à mudança.

Representa um evento da guia ponto no cadastro do horário, reunindo as tolerâncias de ausência e de horas extras aplicáveis durante o expediente e nos intervalos.

Métodos disponíveis

• absenceDailyTotalTolerance: retorna a tolerância total diária de ausências em minutos.
• mealAbsenceTolerance: retorna a tolerância de ausência para refeições em minutos.
• mealOvertimeTolerance: retorna a tolerância de horas extras para refeições.
• overtimeDailyTotalTolerance: retorna a tolerância total diária de horas extras em minutos.
• workStartEndAbsenceTolerance: retorna a tolerância de ausência no início e fim do expediente.
• workStartEndOvertimeTolerance: retorna a tolerância de horas extras no início e fim do expediente.

Representa um registro de marcação do horário de trabalho, contendo dados como horário da marcação, tolerâncias, mobilidade, tipo de uso e de evento.

Métodos disponíveis

• clockingEvent: retorna a marcação em minutos.
• clockingEventScheduleType: retorna o tipo de evento de marcação.
• intervalType: retorna o tipo de intervalo ou null se não existir.
• mobilityAfter: retorna a mobilidade após o horário de marcação.
• mobilityBefore: retorna a mobilidade antes do horário de marcação.
• sequence: retorna a sequência do registro de marcação.
• toleranceAfter: retorna a tolerância após o horário de marcação.
• toleranceBefore: retorna a tolerância antes do horário de marcação.
• usingType: retorna o tipo de uso.

Representa uma escala de trabalho, com informações como código, tipo, minutos semanais/mensais, DSR, turnos e configurações de turmas e detalhes da escala.

Métodos disponíveis

• autoSearchType: retorna o tipo de busca automática.
• code: retorna o código da escala.
• dsrMinutes: retorna o descanso semanal remunerado (DSR) em minutos.
• extensionNightHours: retorna se a escala possui prorrogação noturna.
• monthMinutes: retorna os minutos mensais da escala.
• rotationWorkShift: retorna se a escala é rotativa.
• timeShiftType: retorna o tipo de turno da escala.
• type: retorna o tipo da escala.
• weekMinutes: retorna a quantidade de minutos semanais da escala.
• workshiftDetails: retorna a lista de configurações da escala.
• workshiftGroups: retorna a lista de turmas da escala associada.

Representa uma programação de troca de escala, permitindo definir períodos em que o colaborador atuará com uma escala diferente da padrão.

Métodos disponíveis

• startDate: retorna a data inicial da troca de escala.
• endDate: retorna a data final da troca de escala.
• workshift: retorna a escala associada à troca.
• workshiftGroups: retorna a turma da escala associada.

Representa um detalhe da escala, também chamado de configuração da escala, responsável por definir o grupo de feriados e o tipo de feriado aplicados a partir de uma data específica.

Métodos disponíveis

• holidayGroup: retorna o grupo de feriados (tabela de feriados) da configuração.
• holidayType: retorna o tipo de feriado associado.
• startDate: retorna a data inicial da configuração da escala.

Representa uma turma de escala, utilizada para agrupar colaboradores que compartilham a mesma configuração de escala de trabalho a partir de uma data base.

Métodos disponíveis

• baseDate: retorna a data base da turma da escala.
• code: retorna o código da turma da escala.

Representa o histórico de escala, permitindo identificar qual escala estava vigente para o colaborador em determinada data, incluindo a turma e período de validade.

Métodos disponíveis

• startDate: retorna a data inicial do histórico de escala.
• endDate: retorna a data final do histórico de escala ou null se não estiver definida.
• workshift: retorna a escala associada ao histórico.
• workshiftGroups: retorna a turma da escala associada ao histórico..