Partilhar via


Cronometragem UKG Pro WFM (Pré-visualização)

Ações de autoatendimento do funcionário para controle de ponto.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome QUILOGRAMAS
URL https://www.ukg.com/support
Email support@ukg.com
Metadados do conector
Editora Ria Gupta
Sítio Web https://www.ukg.com/
Política de privacidade https://www.ukg.com/privacy
Categorias Recursos Humanos

O conector de Timekeeping do UKG Pro WFM simplifica as etapas para facilitar o acesso a algumas das APIs de Timekeeping do Pro WFM usadas com mais frequência.

Pré-requisitos

Você precisará do valor de access_token gerado via conector de autenticação PRO WFM.

Como obter credenciais

Configure as propriedades do conector usando as informações de pré-requisito durante o processo de criação da conexão. Após uma chamada bem-sucedida do conector de autenticação WFM PRO, a resposta do conector incluirá o valor de access_token, que pode ser posteriormente utilizado como parâmetros no conector de cronometragem PRO WFM.

Introdução ao conector

  • Selecione Get Last Timestamp a ação para buscar o último carimbo de data/hora gravado.
  • Selecione Add Timestamp a ação para gravar um carimbo de data/hora para uma transação de perfuração.
  • Selecione Get Employee Timecard a ação para buscar um cartão de ponto de funcionário.
  • Selecione View Accruals a ação para buscar o Resumo de Competência.

Problemas conhecidos e limitações

Nenhum

Erros e soluções comuns

Contacte-nos via https://www.ukg.com/support

FAQ

Contacte-nos via https://www.ukg.com/support em caso de erros e dúvidas.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
URL DE VAIDADE PRO WFM securestring O PRO WFM Vanity URL para esta api Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Adicionar carimbo de data/hora

Esta operação registra um carimbo de data/hora para uma transação de perfuração.

Recuperar carimbo de data/hora

Esta operação retorna o último carimbo de data/hora registrado.

Recuperar cartão de ponto

Esta operação retorna um cartão de ponto de funcionário.

Ver acréscimos

Esta operação retorna o Resumo de Competência.

Adicionar carimbo de data/hora

Esta operação registra um carimbo de data/hora para uma transação de perfuração.

Parâmetros

Name Chave Necessário Tipo Description
Token de Acesso
accessToken True string

Token para acessar a API.

transferString
transferString string

Lista de entradas de categoria de mão de obra e centro de custo.

cancelarDeduct
cancelDeduct boolean

Um valor booleano.

Número de Pessoa
qualifier True integer

Um número que identifica exclusivamente uma pessoa. Este não é um ID de funcionário.

Nome da posição
qualifier string

Nome do cargo.

Devoluções

Recuperar carimbo de data/hora

Esta operação retorna o último carimbo de data/hora registrado.

Parâmetros

Name Chave Necessário Tipo Description
Token de Acesso
accessToken True string

Token para acessar a API.

Devoluções

Recuperar cartão de ponto

Esta operação retorna um cartão de ponto de funcionário.

Parâmetros

Name Chave Necessário Tipo Description
select
select string

Determina os objetos retornados na resposta de solicitação de cartão de ponto.

person_number
person_number True string

Um número que identifica exclusivamente uma pessoa

ID do período simbólico
symbolic_period_id string

Um identificador simbólico que representa um período de tempo ou um período de tempo

start_date
start_date string

A data de início no formato ISO_LOCAL_DATE (AAAA-MM-DD). Mutuamente exclusivo com período simbólico, mas é necessário um período simbólico ou um intervalo de datas que consista em uma data de início e uma data de término.

end_date
end_date string

A data final no formato ISO_LOCAL_DATE (AAAA-MM-DD). Mutuamente exclusivo com período simbólico, mas é necessário um período simbólico ou um intervalo de datas que consista em uma data de início e uma data de término.

breakUpAtMidnight
breakUpAtMidnight boolean

Um indicador booleano de se deve ou não interromper um turno de trabalho à meia-noite do dia do calendário, quando o turno passa de um dia de calendário para outro.

include_phantom_punches
include_phantom_punches boolean

Um indicador booleano de incluir ou não socos fantasmas.

include_kind_of_time_segments
include_kind_of_time_segments boolean

Um indicador booleano de incluir ou não segmentos de Tipos de Tempo.

show_totals_with_hidden_paycodes
show_totals_with_hidden_paycodes boolean

Um indicador booleano de se os totais devem ou não ser mostrados quando são para códigos de pagamento que foram configurados para serem ocultos.

activity_name
activity_name string

O nome da atividade desejada para recuperação dos tipos de dados de atividade.

consolidate_schedule_segments
consolidate_schedule_segments boolean

Um indicador booleano de consolidar ou não segmentos programados de um turno de trabalho.

shift_id
shift_id integer

A ID do turno desejado para recuperação dos tipos de dados de atividade.

totals_rollup_by
totals_rollup_by string

Os critérios pelos quais os totais foram acumulados.

context_date
context_date string

A data para a qual ou até à qual os totais são calculados no formato ISO_LOCAL_DATE (AAAA-MM-DD). Deve estar dentro do start_date e end_date indicados ou do período de tempo representado por um ID de período de tempo simbólico fornecido.

totals_include_combined_paycodes
totals_include_combined_paycodes boolean

Um indicador booleano de se os totais incluem ou não códigos de pagamento combinados.

retrieve_full_labor_categories
retrieve_full_labor_categories boolean

Um indicador booleano de se os totais incluem ou não categorias completas de trabalho.

return_true_cost_center_id
return_true_cost_center_id boolean

Um indicador booleano de retornar ou não o ID verdadeiro do centro de custo na resposta.

Token de Acesso
accessToken True string

Token para acessar a API.

Devoluções

Ver acréscimos

Esta operação retorna o Resumo de Competência.

Parâmetros

Name Chave Necessário Tipo Description
Token de Acesso
accessToken True string

Token para acessar a API.

Data de início
startDate True string

Data de início do intervalo de datas no formato (AAAA-MM-DD).

Data de fim
endDate True string

Data final do intervalo de datas no formato (AAAA-MM-DD).

Número
qualifier True string

O número de pessoa do funcionário.

Devoluções

Itens
viewAccruals

Definições

getTimeStamps

Name Caminho Tipo Description
id
id integer

O ID da transação de perfuração.

id
employee.id integer

Funcionário Ref Id

qualificador
employee.qualifier string

Qualificador exclusivo Employee Ref

nome
employee.name string

nome

id
timeZone.id integer

Funcionário Ref Id

qualificador
timeZone.qualifier string

Qualificador exclusivo Employee Ref

nome
timeZone.name string

nome

transferString
transferString string

Uma lista ordenada, separada por ponto-e-vírgula, de Entradas de Categoria de Trabalho e Centro de Custo.

punchDtm
punchDtm string

Data e hora de punção no formato ISO_LOCAL_DATE_TIME (aaaa-mm-ddThh:mm:ss.sss).

cancelarDeduct
cancelDeduct boolean

cancelarDeduct

getEmployeeTimeCard

Name Caminho Tipo Description
startDate
startDate string

A data de início mais antiga associada a um cartão de ponto no formato (AAAA-MM-DD).

data de término
endDate string

A última data de término associada a um cartão de ponto no formato (AAAA-MM-DD).

socos
punches array of object

Uma lista dos socos associados a um cartão de ponto

id
punches.id integer

O ID deste conjunto de Comentários e Notas anexadas

id
punches.employee.id integer

Objeto ref id

qualificador
punches.employee.qualifier string

Qualificador exclusivo Object Ref

nome
punches.employee.name string

nome

punchDtm
punches.punchDtm string

O carimbo de data e hora para o punch in ISO_LOCAL_DATE_TIME

arredondadoPunchDtm
punches.roundedPunchDtm string

A data e hora do punch arredondado

id
punches.timeZone.id integer

Objeto ref id

qualificador
punches.timeZone.qualifier string

Qualificador exclusivo Object Ref

nome
punches.timeZone.name string

nome

enteredOnDtm
punches.enteredOnDtm string

O carimbo de data e hora de quando essa transação de perfuração foi inserida por meio da API

hasComentários
punches.hasComments boolean

Um indicador booleano de se um comentário está ou não associado a um segmento de atividade

id
punches.editByType.id integer

Objeto ref id

qualificador
punches.editByType.qualifier string

Qualificador exclusivo Object Ref

nome
punches.editByType.name string

nome

id
punches.dataSource.id integer

Objeto ref id

qualificador
punches.dataSource.qualifier string

Qualificador exclusivo Object Ref

nome de exibição
punches.dataSource.displayName string

nome de exibição

functionalAreaName
punches.dataSource.functionalAreaName string

functionalAreaName

nome
punches.dataSource.name string

nome

exceções
punches.exceptions array of object

Uma lista de objetos de exceção associados a um cartão de ponto

id
punches.exceptions.employee.id integer

Objeto ref id

qualificador
punches.exceptions.employee.qualifier string

Qualificador exclusivo Object Ref

nome
punches.exceptions.employee.name string

nome

DataHoraDeInício
punches.exceptions.startDateTime string

A data e a hora do início da atividade no formato ISO_LOCAL_DATE_TIME (aaaa-MM-dd HH:mm:ss. SSS)

endDateTime
punches.exceptions.endDateTime string

A data e a hora do fim da atividade no formato ISO_LOCAL_DATE_TIME (aaaa-MM-dd HH:mm:ss. SSS)

applyDate
punches.exceptions.applyDate string

A data de aplicação para um intervalo de datas de segmento processado por atividade no formato ISO_LOCAL_DATE (AAAA-MM-DD).

id
punches.exceptions.id integer

id

id
punches.exceptions.endTimeZone.id integer

Objeto ref id

id
punches.exceptions.exceptionType.id integer

A ID de um tipo de exceção de cronometragem

nome
punches.exceptions.exceptionType.name string

O nome de um tipo de exceção Timekeeping

descrição
punches.exceptions.exceptionType.description string

A descrição de um tipo de exceção de cronometragem

nome de exibição
punches.exceptions.exceptionType.displayName string

O nome para exibição de um tipo de exceção de cronometragem

categoria
punches.exceptions.exceptionType.category string

A categoria de um tipo de exceção Timekeeping

id
punches.exceptions.orgJob.id integer

Objeto ref id

overLimitInHours
punches.exceptions.overLimitInHours number

O valor (em horas) que excede o limite definido pela exceção associada à edição do código de pagamento. Esta propriedade é somente leitura

id
punches.exceptions.startTimeZone.id integer

Objeto ref id

violaçãoInHours
punches.exceptions.violationInHours number

O número total de horas violadas, o que causou uma exceção. Esta propriedade é somente leitura

id
punches.exceptions.workRule.id integer

Objeto ref id

qualificador
punches.exceptions.workRule.qualifier string

Qualificador exclusivo Object Ref

nome
punches.exceptions.workRule.name string

nome

comentáriosNotas
punches.exceptions.commentsNotes array of

Uma referência a uma lista de Comentários. Este objeto pode ter vários Comentários com várias Notas para cada Comentário

id
punches.exceptions.punchEvent.id integer

Objeto ref id

isExcusedAbsence
punches.exceptions.isExcusedAbsence boolean

Um indicador booleano de se a exceção envolve ou não uma ausência justificada. Esta propriedade é somente leitura

isUnExcusedAbsence
punches.exceptions.isUnExcusedAbsence boolean

Um indicador booleano de se a exceção envolve ou não uma ausência injustificada. Esta propriedade é somente leitura

id
punches.exceptions.missingTimeStatus.id integer

O ID do status de tempo ausente variando de 1 a 4

nome de exibição
punches.exceptions.missingTimeStatus.displayName string

O nome de exibição do status de tempo ausente localizado

Justificações
punches.exceptions.justifications array of

Uma lista de justificações de tempo em falta para esta exceção. Esta propriedade é somente leitura

Tempos justificados
punches.exceptions.justifiedTimes array of

Uma lista de tempos justificados para esta exceção. Esta propriedade é somente leitura

transferência
punches.exceptions.transfer boolean

transferência

data-do-evento
punches.exceptions.eventDate string

data-do-evento

startException
punches.exceptions.startException boolean

startException

endException
punches.exceptions.endException boolean

endException

avaliou
punches.exceptions.reviewed boolean

avaliou

comentáriosNotas
punches.commentsNotes array of

Uma referência a uma lista de Comentários. Este objeto pode ter vários Comentários com várias Notas para cada Comentário. Esta propriedade é somente leitura

isPhantom
punches.isPhantom boolean

Um indicador booleano de se o soco é ou não um soco fantasma

isScheduled
punches.isScheduled boolean

Um indicador booleano de se o punch é ou não gerado a partir de um período de trabalho programado

atualizadoOnDtm
punches.updatedOnDtm string

O carimbo de data e hora de quando essa transação de perfuração foi atualizada pela última vez

validateAsTimestamp
punches.validateAsTimestamp boolean

Um indicador booleano de se o punch é ou não inserido como um carimbo de data/hora

atestadoPunchEditar
punches.attestationPunchEdit boolean

Um indicador booleano de se o soco é ou não inserido como uma edição de soco de atestado

markRelatedExceptionsAsReviewed
punches.markRelatedExceptionsAsReviewed boolean

Se existir uma Exceção para um punch, um indicador booleano de se essa Exceção foi resolvida ou não

editável
punches.editable boolean

Um indicador booleano de se uma edição de código de pagamento é editável ou não

cancelarDeduct
punches.cancelDeduct boolean

cancelarDeduct

dePhantomEditado
punches.fromPhantomEdited boolean

dePhantomEditado

exceçãoResolvido
punches.exceptionResolved boolean

exceçãoResolvido

id
punches.typeOverride.id integer

Objeto ref id

qualificador
punches.typeOverride.qualifier string

Qualificador exclusivo Object Ref

typeOverrideId
punches.typeOverride.typeOverrideId integer

A ID da substituição de tipo

descrição
punches.typeOverride.description string

Descrição da substituição de tipo

nome
punches.typeOverride.name string

nome

workedShifts
workedShifts array of object

Uma lista de objetos de turno de trabalho

id
workedShifts.id integer

Objeto ref id

id
workedShifts.employee.id integer

Objeto ref id

DataHoraDeInício
workedShifts.startDateTime string

A data e a hora do início da atividade no formato ISO_LOCAL_DATE_TIME (aaaa-MM-dd HH:mm:ss. SSS)

endDateTime
workedShifts.endDateTime string

A data e hora finais de um intervalo de datas no formato ISO_LOCAL_DATE_TIME (aaaa-mm-ddThh:mm:ss.sss)

id
workedShifts.startTimezone.id integer

Objeto ref id

id
workedShifts.endTimezone.id integer

Objeto ref id

arredondadoStartDateTime
workedShifts.roundedStartDateTime string

Um campo opcional que contém a data e hora de início com base em regras de arredondamento configuradas

roundedEndDateTime
workedShifts.roundedEndDateTime string

Um campo opcional contendo a data e hora de término com base em regras de arredondamento configuradas

id
workedShifts.roundedStartTimezone.id integer

Objeto ref id

id
workedShifts.roundedEndTimezone.id integer

Objeto ref id

transactionDateTime
workedShifts.transactionDateTime string

O carimbo de data e hora de quando essa transação de turno de trabalho foi inserida por meio da API

emProgresso
workedShifts.inProgress boolean

Um indicador booleano que mostra se um segmento processado está ou não em andamento

consolidadoScheduleSegments
workedShifts.consolidatedScheduleSegments boolean

Um indicador booleano de se os segmentos de programação do turno de trabalho foram ou não consolidados

workedSpans
workedShifts.workedSpans array of object

Contém uma lista de objetos workedSpan

id
workedShifts.workedSpans.id integer

id

itemId
workedShifts.workedSpans.itemId integer

A ID do item de tempo

spanId
workedShifts.workedSpans.spanId integer

A ID da extensão trabalhada

DataHoraDeInício
workedShifts.workedSpans.startDateTime string

A data e hora de início de um intervalo de datas no formato ISO_LOCAL_DATE_TIME (aaaa-mm-ddThh:mm:ss.sss)

endDateTime
workedShifts.workedSpans.endDateTime string

A data e hora finais de um intervalo de datas no formato ISO_LOCAL_DATE_TIME (aaaa-mm-ddThh:mm:ss.sss)

arredondadoStartDateTime
workedShifts.workedSpans.roundedStartDateTime string

Um campo opcional que contém a data e hora de início com base em regras de arredondamento configuradas

roundedEndDateTime
workedShifts.workedSpans.roundedEndDateTime string

Um campo opcional contendo a data e hora de término com base em regras de arredondamento configuradas

id
workedShifts.workedSpans.startTimezone.id integer

Objeto ref id

id
workedShifts.workedSpans.endTimezone.id integer

id

id
workedShifts.workedSpans.primaryOrgJob.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.primaryOrgJob.qualifier string

Qualificador exclusivo Object Ref

nome
workedShifts.workedSpans.primaryOrgJob.name string

nome

id
workedShifts.workedSpans.workRule.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.workRule.qualifier string

Qualificador exclusivo Object Ref

nome
workedShifts.workedSpans.workRule.name string

nome

id
workedShifts.workedSpans.primaryWorkRule.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.primaryWorkRule.qualifier string

Qualificador exclusivo Object Ref

nome
workedShifts.workedSpans.primaryWorkRule.name string

nome

Número da encomenda
workedShifts.workedSpans.orderNumber integer

O número de ordem associado a um segmento de atividade

id
workedShifts.workedSpans.startPunch.id integer

id

id
workedShifts.workedSpans.startPunch.employee.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.startPunch.employee.qualifier string

Qualificador exclusivo Object Ref

nome
workedShifts.workedSpans.startPunch.employee.name string

nome

punchDtm
workedShifts.workedSpans.startPunch.punchDtm string

O carimbo de data e hora para o punch in ISO_LOCAL_DATE_TIME

arredondadoPunchDtm
workedShifts.workedSpans.startPunch.roundedPunchDtm string

A data e hora do punch arredondado

id
workedShifts.workedSpans.startPunch.timeZone.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.startPunch.timeZone.qualifier string

Qualificador exclusivo Object Ref

nome
workedShifts.workedSpans.startPunch.timeZone.name string

nome

enteredOnDtm
workedShifts.workedSpans.startPunch.enteredOnDtm string

O carimbo de data e hora de quando essa transação de perfuração foi inserida por meio da API

hasComentários
workedShifts.workedSpans.startPunch.hasComments boolean

Um indicador booleano de se um comentário está ou não associado a um segmento de atividade

id
workedShifts.workedSpans.startPunch.editByType.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.startPunch.editByType.qualifier string

Qualificador exclusivo Object Ref

nome
workedShifts.workedSpans.startPunch.editByType.name string

nome

id
workedShifts.workedSpans.startPunch.dataSource.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.startPunch.dataSource.qualifier string

Qualificador exclusivo Object Ref

nome de exibição
workedShifts.workedSpans.startPunch.dataSource.displayName string

nome de exibição

functionalAreaName
workedShifts.workedSpans.startPunch.dataSource.functionalAreaName string

functionalAreaName

nome
workedShifts.workedSpans.startPunch.dataSource.name string

nome

exceções
workedShifts.workedSpans.startPunch.exceptions array of object

Uma lista de objetos de exceção associados a um punch

id
workedShifts.workedSpans.startPunch.exceptions.employee.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.startPunch.exceptions.employee.qualifier string

Qualificador exclusivo Object Ref

nome
workedShifts.workedSpans.startPunch.exceptions.employee.name string

nome

DataHoraDeInício
workedShifts.workedSpans.startPunch.exceptions.startDateTime string

A data e a hora do início da atividade no formato ISO_LOCAL_DATE_TIME (aaaa-MM-dd HH:mm:ss. SSS)

endDateTime
workedShifts.workedSpans.startPunch.exceptions.endDateTime string

A data e a hora do fim da atividade no formato ISO_LOCAL_DATE_TIME (aaaa-MM-dd HH:mm:ss. SSS)

applyDate
workedShifts.workedSpans.startPunch.exceptions.applyDate string

A data de aplicação para um intervalo de datas de segmento processado por atividade no formato ISO_LOCAL_DATE (AAAA-MM-DD)

id
workedShifts.workedSpans.startPunch.exceptions.id integer

id

id
workedShifts.workedSpans.startPunch.exceptions.endTimeZone.id integer

Objeto ref id

id
workedShifts.workedSpans.startPunch.exceptions.exceptionType.id integer

A ID de um tipo de exceção de cronometragem

nome
workedShifts.workedSpans.startPunch.exceptions.exceptionType.name string

O nome de um tipo de exceção Timekeeping

descrição
workedShifts.workedSpans.startPunch.exceptions.exceptionType.description string

A descrição de um tipo de exceção Timekeeping

nome de exibição
workedShifts.workedSpans.startPunch.exceptions.exceptionType.displayName string

O nome para exibição de um tipo de exceção de cronometragem

categoria
workedShifts.workedSpans.startPunch.exceptions.exceptionType.category string

categoria

id
workedShifts.workedSpans.startPunch.exceptions.orgJob.id integer

Objeto ref id

overLimitInHours
workedShifts.workedSpans.startPunch.exceptions.overLimitInHours number

O valor (em horas) que excede o limite definido pela exceção associada à edição do código de pagamento. Esta propriedade é somente leitura

id
workedShifts.workedSpans.startPunch.exceptions.startTimeZone.id integer

Objeto ref id

violaçãoInHours
workedShifts.workedSpans.startPunch.exceptions.violationInHours number

O número total de horas violadas, o que causou uma exceção. Esta propriedade é somente leitura

id
workedShifts.workedSpans.startPunch.exceptions.workRule.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.startPunch.exceptions.workRule.qualifier string

Qualificador exclusivo Object Ref

nome
workedShifts.workedSpans.startPunch.exceptions.workRule.name string

nome

comentáriosNotas
workedShifts.workedSpans.startPunch.exceptions.commentsNotes array of

Uma referência a uma lista de Comentários. Este objeto pode ter vários Comentários com várias Notas para cada Comentário. Esta propriedade é somente leitura

id
workedShifts.workedSpans.startPunch.exceptions.punchEvent.id integer

Objeto ref id

isExcusedAbsence
workedShifts.workedSpans.startPunch.exceptions.isExcusedAbsence boolean

Um indicador booleano de se a exceção envolve ou não uma ausência justificada. Esta propriedade é somente leitura

isUnExcusedAbsence
workedShifts.workedSpans.startPunch.exceptions.isUnExcusedAbsence boolean

Um indicador booleano de se a exceção envolve ou não uma ausência injustificada. Esta propriedade é somente leitura

id
workedShifts.workedSpans.startPunch.exceptions.missingTimeStatus.id integer

O ID do status de tempo ausente variando de 1 a 4

nome de exibição
workedShifts.workedSpans.startPunch.exceptions.missingTimeStatus.displayName string

O nome de exibição do status de tempo ausente localizado

Justificações
workedShifts.workedSpans.startPunch.exceptions.justifications array of

Uma lista de justificações de tempo em falta para esta exceção. Esta propriedade é somente leitura

Tempos justificados
workedShifts.workedSpans.startPunch.exceptions.justifiedTimes array of

Uma lista de tempos justificados para esta exceção. Esta propriedade é somente leitura

transferência
workedShifts.workedSpans.startPunch.exceptions.transfer boolean

transferência

data-do-evento
workedShifts.workedSpans.startPunch.exceptions.eventDate string

data-do-evento

startException
workedShifts.workedSpans.startPunch.exceptions.startException boolean

startException

endException
workedShifts.workedSpans.startPunch.exceptions.endException boolean

endException

avaliou
workedShifts.workedSpans.startPunch.exceptions.reviewed boolean

avaliou

comentáriosNotas
workedShifts.workedSpans.startPunch.commentsNotes array of

Uma referência a uma lista de Comentários. Este objeto pode ter vários Comentários com várias Notas para cada Comentário

isPhantom
workedShifts.workedSpans.startPunch.isPhantom boolean

Um indicador booleano de se o soco é ou não um soco fantasma

isScheduled
workedShifts.workedSpans.startPunch.isScheduled boolean

Um indicador booleano de se o punch é ou não gerado a partir de um período de trabalho programado

atualizadoOnDtm
workedShifts.workedSpans.startPunch.updatedOnDtm string

O carimbo de data e hora de quando essa transação de perfuração foi atualizada pela última vez

validateAsTimestamp
workedShifts.workedSpans.startPunch.validateAsTimestamp boolean

Um indicador booleano de se o punch é ou não inserido como um carimbo de data/hora

atestadoPunchEditar
workedShifts.workedSpans.startPunch.attestationPunchEdit boolean

Um indicador booleano de se o soco é ou não inserido como uma edição de soco de atestado

markRelatedExceptionsAsReviewed
workedShifts.workedSpans.startPunch.markRelatedExceptionsAsReviewed boolean

Se existir uma Exceção para um punch, um indicador booleano de se essa Exceção foi resolvida ou não

editável
workedShifts.workedSpans.startPunch.editable boolean

Um indicador booleano de se uma edição de código de pagamento é editável ou não

cancelarDeduct
workedShifts.workedSpans.startPunch.cancelDeduct boolean

cancelarDeduct

dePhantomEditado
workedShifts.workedSpans.startPunch.fromPhantomEdited boolean

dePhantomEditado

exceçãoResolvido
workedShifts.workedSpans.startPunch.exceptionResolved boolean

exceçãoResolvido

id
workedShifts.workedSpans.startPunch.workRule.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.startPunch.workRule.qualifier string

Qualificador exclusivo Object Ref

nome
workedShifts.workedSpans.startPunch.workRule.name string

nome

id
workedShifts.workedSpans.startPunch.typeOverride.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.startPunch.typeOverride.qualifier string

Qualificador exclusivo Object Ref

typeOverrideId
workedShifts.workedSpans.startPunch.typeOverride.typeOverrideId integer

A ID da substituição de tipo

descrição
workedShifts.workedSpans.startPunch.typeOverride.description string

dDescrição da substituição de tipo

nome
workedShifts.workedSpans.startPunch.typeOverride.name string

nome

id
workedShifts.workedSpans.endPunch.id integer

id

id
workedShifts.workedSpans.endPunch.employee.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.endPunch.employee.qualifier string

Qualificador exclusivo Object Ref

nome
workedShifts.workedSpans.endPunch.employee.name string

nome

punchDtm
workedShifts.workedSpans.endPunch.punchDtm string

O carimbo de data e hora para o punch in ISO_LOCAL_DATE_TIME

arredondadoPunchDtm
workedShifts.workedSpans.endPunch.roundedPunchDtm string

A data e hora do punch arredondado

id
workedShifts.workedSpans.endPunch.timeZone.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.endPunch.timeZone.qualifier string

Qualificador exclusivo Object Ref

nome
workedShifts.workedSpans.endPunch.timeZone.name string

nome

enteredOnDtm
workedShifts.workedSpans.endPunch.enteredOnDtm string

O carimbo de data e hora de quando essa transação de perfuração foi inserida por meio da API

hasComentários
workedShifts.workedSpans.endPunch.hasComments boolean

Um indicador booleano de se um comentário está ou não associado a um segmento de atividade

id
workedShifts.workedSpans.endPunch.editByType.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.endPunch.editByType.qualifier string

Qualificador exclusivo Object Ref

nome
workedShifts.workedSpans.endPunch.editByType.name string

nome

id
workedShifts.workedSpans.endPunch.dataSource.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.endPunch.dataSource.qualifier string

Qualificador exclusivo Object Ref

nome de exibição
workedShifts.workedSpans.endPunch.dataSource.displayName string

nome de exibição

functionalAreaName
workedShifts.workedSpans.endPunch.dataSource.functionalAreaName string

functionalAreaName

nome
workedShifts.workedSpans.endPunch.dataSource.name string

nome

exceções
workedShifts.workedSpans.endPunch.exceptions array of object

Uma lista de objetos de exceção associados a um cartão de ponto

id
workedShifts.workedSpans.endPunch.exceptions.employee.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.endPunch.exceptions.employee.qualifier string

Qualificador exclusivo Object Ref

nome
workedShifts.workedSpans.endPunch.exceptions.employee.name string

nome

DataHoraDeInício
workedShifts.workedSpans.endPunch.exceptions.startDateTime string

A data e hora de início de uma justificação no formato ISO_LOCAL_DATE_TIME (aaaa-mm-ddThh:mm:ss.sss)

endDateTime
workedShifts.workedSpans.endPunch.exceptions.endDateTime string

A data e hora de término de um intervalo de datas no formato ISO_LOCAL_DATE_TIME (aaaa-mm-ddThh:mm:ss.sss). Esta propriedade é somente leitura

applyDate
workedShifts.workedSpans.endPunch.exceptions.applyDate string

A data a que uma exceção se aplica no formato ISO_LOCAL_DATE (AAAA-MM-DD). Esta propriedade é somente leitura

id
workedShifts.workedSpans.endPunch.exceptions.id integer

id

id
workedShifts.workedSpans.endPunch.exceptions.endTimeZone.id integer

Objeto ref id

id
workedShifts.workedSpans.endPunch.exceptions.exceptionType.id integer

A ID de um tipo de exceção de cronometragem

nome
workedShifts.workedSpans.endPunch.exceptions.exceptionType.name string

O nome de um tipo de exceção Timekeeping

descrição
workedShifts.workedSpans.endPunch.exceptions.exceptionType.description string

A descrição de um tipo de exceção Timekeeping

nome de exibição
workedShifts.workedSpans.endPunch.exceptions.exceptionType.displayName string

O nome para exibição de um tipo de exceção de cronometragem

categoria
workedShifts.workedSpans.endPunch.exceptions.exceptionType.category string

A categoria de um tipo de exceção Timekeeping

id
workedShifts.workedSpans.endPunch.exceptions.orgJob.id integer

Objeto ref id

overLimitInHours
workedShifts.workedSpans.endPunch.exceptions.overLimitInHours number

O valor (em horas) que excede o limite definido pela exceção associada à edição do código de pagamento. Esta propriedade é somente leitura

id
workedShifts.workedSpans.endPunch.exceptions.startTimeZone.id integer

Objeto ref id

violaçãoInHours
workedShifts.workedSpans.endPunch.exceptions.violationInHours number

O número total de horas violadas, o que causou uma exceção. Esta propriedade é somente leitura

id
workedShifts.workedSpans.endPunch.exceptions.workRule.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.endPunch.exceptions.workRule.qualifier string

Qualificador exclusivo Object Ref

nome
workedShifts.workedSpans.endPunch.exceptions.workRule.name string

nome

comentáriosNotas
workedShifts.workedSpans.endPunch.exceptions.commentsNotes array of

Uma referência a uma lista de Comentários. Este objeto pode ter vários Comentários com várias Notas para cada Comentário. Esta propriedade é somente leitura

id
workedShifts.workedSpans.endPunch.exceptions.punchEvent.id integer

Objeto ref id

isExcusedAbsence
workedShifts.workedSpans.endPunch.exceptions.isExcusedAbsence boolean

Um indicador booleano de se a exceção envolve ou não uma ausência justificada. Esta propriedade é somente leitura

isUnExcusedAbsence
workedShifts.workedSpans.endPunch.exceptions.isUnExcusedAbsence boolean

Um indicador booleano de se a exceção envolve ou não uma ausência injustificada. Esta propriedade é somente leitura

id
workedShifts.workedSpans.endPunch.exceptions.missingTimeStatus.id integer

O ID do status de tempo ausente variando de 1 a 4

nome de exibição
workedShifts.workedSpans.endPunch.exceptions.missingTimeStatus.displayName string

O nome de exibição do status de tempo ausente localizado

Justificações
workedShifts.workedSpans.endPunch.exceptions.justifications array of

Uma lista de justificações de tempo em falta para esta exceção. Esta propriedade é somente leitura

Tempos justificados
workedShifts.workedSpans.endPunch.exceptions.justifiedTimes array of

Uma lista de tempos justificados para esta exceção. Esta propriedade é somente leitura

transferência
workedShifts.workedSpans.endPunch.exceptions.transfer boolean

transferência

data-do-evento
workedShifts.workedSpans.endPunch.exceptions.eventDate string

data-do-evento

startException
workedShifts.workedSpans.endPunch.exceptions.startException boolean

startException

endException
workedShifts.workedSpans.endPunch.exceptions.endException boolean

endException

avaliou
workedShifts.workedSpans.endPunch.exceptions.reviewed boolean

avaliou

comentáriosNotas
workedShifts.workedSpans.endPunch.commentsNotes array of

Uma referência a uma lista de Comentários. Este objeto pode ter vários Comentários com várias Notas para cada Comentário

isPhantom
workedShifts.workedSpans.endPunch.isPhantom boolean

Um indicador booleano de se o soco é ou não um soco fantasma

isScheduled
workedShifts.workedSpans.endPunch.isScheduled boolean

Um indicador booleano de se o punch é ou não gerado a partir de um período de trabalho programado

atualizadoOnDtm
workedShifts.workedSpans.endPunch.updatedOnDtm string

O carimbo de data e hora de quando essa transação de perfuração foi atualizada pela última vez

validateAsTimestamp
workedShifts.workedSpans.endPunch.validateAsTimestamp boolean

validateAsTimestamp

atestadoPunchEditar
workedShifts.workedSpans.endPunch.attestationPunchEdit boolean

Um indicador booleano de se o soco é ou não inserido como uma edição de soco de atestado

markRelatedExceptionsAsReviewed
workedShifts.workedSpans.endPunch.markRelatedExceptionsAsReviewed boolean

markRelatedExceptionsAsReviewed

editável
workedShifts.workedSpans.endPunch.editable boolean

Um indicador booleano de se uma edição de código de pagamento é editável ou não

cancelarDeduct
workedShifts.workedSpans.endPunch.cancelDeduct boolean

cancelarDeduct

dePhantomEditado
workedShifts.workedSpans.endPunch.fromPhantomEdited boolean

dePhantomEditado

exceçãoResolvido
workedShifts.workedSpans.endPunch.exceptionResolved boolean

exceçãoResolvido

id
workedShifts.workedSpans.endPunch.workRule.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.endPunch.workRule.qualifier string

Qualificador exclusivo Object Ref

nome
workedShifts.workedSpans.endPunch.workRule.name string

nome

id
workedShifts.workedSpans.endPunch.typeOverride.id integer

Objeto ref id

qualificador
workedShifts.workedSpans.endPunch.typeOverride.qualifier string

Qualificador exclusivo Object Ref

typeOverrideId
workedShifts.workedSpans.endPunch.typeOverride.typeOverrideId integer

A ID da substituição de tipo

descrição
workedShifts.workedSpans.endPunch.typeOverride.description string

Descrição da substituição de tipo

nome
workedShifts.workedSpans.endPunch.typeOverride.name string

nome

aprovadoByManager
workedShifts.workedSpans.approvableByManager boolean

Um indicador booleano de se o item de span trabalhado é ou não aprovável pelo gerente conectado

agendadoOrgJob
workedShifts.workedSpans.scheduledOrgJob boolean

agendadoOrgJob

scheduledWorkRule
workedShifts.workedSpans.scheduledWorkRule boolean

scheduledWorkRule

userEnteredOrgJob
workedShifts.workedSpans.userEnteredOrgJob boolean

Um indicador booleano de se um trabalho de estrutura de negócios para este segmento de turno foi ou não inserido pelo usuário

transferOrgJob
workedShifts.workedSpans.transferOrgJob boolean

Um indicador booleano de se o trabalho da estrutura de negócios é ou não uma transferência

userEnteredWorkRule
workedShifts.workedSpans.userEnteredWorkRule boolean

Um indicador booleano de se uma regra de trabalho para este segmento de turno foi ou não inserida pelo usuário

transferWorkRule
workedShifts.workedSpans.transferWorkRule boolean

transferWorkRule

projetado
workedShifts.workedSpans.projected boolean

Um indicador booleano que mostra se um segmento processado é projetado ou não

shiftTotalHoras
workedShifts.shiftTotalHours number

Número total de horas por turno de trabalho

scheduledShiftIds
workedShifts.scheduledShiftIds array of integer

Uma lista de IDs de turno agendado com edições de código de pagamento

projetado
workedShifts.projected boolean

projetado

fromSchedule
workedShifts.fromSchedule boolean

fromSchedule

unscheduledStartDateTime
workedShifts.unscheduledStartDateTime string

Um parâmetro de cadeia de caracteres que representa a data e hora de início de um turno não agendado

unscheduledEndDateTime
workedShifts.unscheduledEndDateTime string

Um parâmetro de cadeia de caracteres que representa a data e hora de término de um turno não agendado

payCodeEdits
payCodeEdits array of

Uma lista de objetos de edição de código de pagamento

Totais
totals array of object

Uma lista de totais de cartões de ponto associados a um cartão de ponto

id
totals.employeeContext.employee.id integer

Objeto ref id

qualificador
totals.employeeContext.employee.qualifier string

Qualificador exclusivo Object Ref

nome
totals.employeeContext.employee.name string

nome

id
totals.employeeContext.timezone.id integer

Objeto ref id

qualificador
totals.employeeContext.timezone.qualifier string

Qualificador exclusivo Object Ref

nome
totals.employeeContext.timezone.name string

nome

totalType
totals.totalContext.totalType string

totalType

totalAggregationType
totals.totalContext.totalAggregationType string

totalAggregationType

totalGroupByType
totals.totalContext.totalGroupByType string

totalGroupByType

agregadosTotais
totals.aggregatedTotals array of object

Uma lista de objetos totais agregados

aprovadoByManager
totals.aggregatedTotals.approvableByManager boolean

Um indicador booleano de se o total agregado é ou não aprovável pelo gerente conectado

id
totals.aggregatedTotals.employee.id integer

Objeto ref id

qualificador
totals.aggregatedTotals.employee.qualifier string

Qualificador exclusivo Object Ref

nome
totals.aggregatedTotals.employee.name string

nome

id
totals.aggregatedTotals.location.id integer

Objeto ref id

qualificador
totals.aggregatedTotals.location.qualifier string

Qualificador exclusivo Object Ref

nome
totals.aggregatedTotals.location.name string

nome

id
totals.aggregatedTotals.job.id integer

Objeto ref id

qualificador
totals.aggregatedTotals.job.qualifier string

Qualificador exclusivo Object Ref

nome
totals.aggregatedTotals.job.name string

nome

id
totals.aggregatedTotals.payCode.id integer

Objeto ref id

qualificador
totals.aggregatedTotals.payCode.qualifier string

Qualificador exclusivo Object Ref

nome
totals.aggregatedTotals.payCode.name string

nome

montanteTipo
totals.aggregatedTotals.amountType string

Referência ao objeto AmountType

Montante
totals.aggregatedTotals.amount float

A quantidade de tempo de um turno de trabalho

salários
totals.aggregatedTotals.wages float

O montante monetário calculado em totais como salários

Montante
totals.aggregatedTotals.wagesCurrency.amount float

Valor monetário

código da moeda
totals.aggregatedTotals.wagesCurrency.currencyCode string

Código ISO da moeda associada

transferência de emprego
totals.aggregatedTotals.jobTransfer boolean

Um indicador booleano de se o objeto totals contém ou não uma transferência de trabalho

laborCategoryTransfer
totals.aggregatedTotals.laborCategoryTransfer boolean

Um indicador booleano de se o objeto totais contém ou não uma categoria de trabalho

taxa
totals.aggregatedTotals.rate number

A taxa de correlação entre salário e montante

viewAcréscimos

Name Caminho Tipo Description
uniqueId
uniqueId string

O identificador exclusivo de um objeto AusenceExceptionWithPosition.

id
employee.id integer

Objeto ref id

qualificador
employee.qualifier string

Qualificador exclusivo Object Ref

nome
employee.name string

nome

DataHoraDeInício
startDateTime string

A data/hora de início do resumo.

endDateTime
endDateTime string

A data/hora final do resumo.

id
accrualCode.id integer

id

nome
accrualCode.name string

nome

shortNome
accrualCode.shortName string

shortNome

horasPerDayInSeconds
accrualCode.hoursPerDayInSeconds integer

horasPerDayInSeconds

typeId
accrualCode.typeId integer

typeId

permitirEditar
accrualCode.allowEdit boolean

permitirEditar

typeName
accrualCode.typeName string

typeName

horasPerDay
accrualCode.hoursPerDay integer

horasPerDay

effectiveDateRange
effectiveDateRange array of string

O intervalo de datas efetivas dos dados resumidos da especialização dos exercícios.

diáriosResumos
dailySummaries array of object

Uma referência a uma lista de objetos AccrualDailySummaryData.

saldoData
dailySummaries.balanceDate string

A data e a hora associadas aos dados resumidos diários de especialização dos exercícios.

período de relatório
dailySummaries.reportingPeriod string

O período de referência dos dados resumidos diários de especialização dos exercícios.

saldoData
dailySummaries.currentBalance.balanceDate string

A data e a hora associadas aos dados do saldo de competência.

vestedHoursAmount
dailySummaries.currentBalance.vestedHoursAmount float

A duração adquirida (em horas) dos dados do saldo de competência.

probationHoursAmount
dailySummaries.currentBalance.probationHoursAmount integer

A duração do período experimental (em horas) dos dados do saldo de competência.

vestedDaysAmount
dailySummaries.currentBalance.vestedDaysAmount integer

A duração adquirida (em dias) dos dados do saldo de competência.

probationDaysAmount
dailySummaries.currentBalance.probationDaysAmount integer

O número de dias experimentais.

planeadoTakingHours
dailySummaries.plannedTakingHours integer

A tomada planeada (em horas) dos dados sumários diários de competência.

pendingGrantHours
dailySummaries.pendingGrantHours float

A concessão pendente (em horas) dos dados sumários diários de competência.

takingToDateHours
dailySummaries.takingToDateHours integer

A tomada até à data (em dias) dos dados sumários diários de especialização dos exercícios.

ganhoToDateHours
dailySummaries.earnedToDateHours integer

O ganho até à data (em dias) dos dados sumários diários de competência.

disponívelBalanceHours
dailySummaries.availableBalanceHours float

O saldo disponível (em horas) dos dados sumários diários de especialização dos exercícios.

planeadoTakingDays
dailySummaries.plannedTakingDays integer

A tomada planeada (em dias) dos dados sumários diários de competência.

pendentesGrantDays
dailySummaries.pendingGrantDays integer

A concessão pendente (em dias) dos dados sumários diários de competência.

takingToDateDays
dailySummaries.takingToDateDays integer

A tomada até à data (em dias) dos dados sumários diários de especialização dos exercícios.

ganhouToDateDays
dailySummaries.earnedToDateDays integer

O ganho até à data (em dias) dos dados sumários diários de competência.

disponívelBalanceDays
dailySummaries.availableBalanceDays integer

O saldo disponível (em dias) dos dados resumidos diários de especialização dos exercícios.

relatóriosPeríodoResumos
reportingPeriodSummaries array of object

Uma referência a uma lista de objetos AccrualReportingPeriodSummaryData.

relatóriosPeriodSpan
reportingPeriodSummaries.reportingPeriodSpan string

O período de relato dos dados resumidos do período de relato de exercício.

saldoData
reportingPeriodSummaries.priorEndingBalance.balanceDate string

A data e a hora associadas aos dados do saldo de competência.

vestedHoursAmount
reportingPeriodSummaries.priorEndingBalance.vestedHoursAmount float

A duração adquirida (em horas) dos dados do saldo de competência.

probationHoursAmount
reportingPeriodSummaries.priorEndingBalance.probationHoursAmount integer

A duração do período experimental (em horas) dos dados do saldo de competência.

vestedDaysAmount
reportingPeriodSummaries.priorEndingBalance.vestedDaysAmount integer

O número de dias experimentais.

probationDaysAmount
reportingPeriodSummaries.priorEndingBalance.probationDaysAmount integer

O número de dias experimentais.

saldoData
reportingPeriodSummaries.openingBalance.balanceDate string

A data e a hora associadas aos dados do saldo de competência.

vestedHoursAmount
reportingPeriodSummaries.openingBalance.vestedHoursAmount float

A duração adquirida (em horas) dos dados do saldo de competência.

probationHoursAmount
reportingPeriodSummaries.openingBalance.probationHoursAmount integer

A duração do período experimental (em horas) dos dados do saldo de competência.

vestedDaysAmount
reportingPeriodSummaries.openingBalance.vestedDaysAmount integer

A duração adquirida (em dias) dos dados do saldo de competência.

probationDaysAmount
reportingPeriodSummaries.openingBalance.probationDaysAmount integer

O número de dias experimentais.

saldoData
reportingPeriodSummaries.endingBalance.balanceDate string

A data e a hora associadas aos dados do saldo de competência.

vestedHoursAmount
reportingPeriodSummaries.endingBalance.vestedHoursAmount float

A duração adquirida (em horas) dos dados do saldo de competência.

probationHoursAmount
reportingPeriodSummaries.endingBalance.probationHoursAmount integer

A duração do período experimental (em horas) dos dados do saldo de competência.

vestedDaysAmount
reportingPeriodSummaries.endingBalance.vestedDaysAmount integer

A duração adquirida (em dias) dos dados do saldo de competência.

probationDaysAmount
reportingPeriodSummaries.endingBalance.probationDaysAmount integer

O número de dias experimentais.

saldoData
startingBalanceForPeriod.balanceDate string

A data e a hora associadas aos dados do saldo de competência.

vestedHoursAmount
startingBalanceForPeriod.vestedHoursAmount float

A duração adquirida (em horas) dos dados do saldo de competência.

probationHoursAmount
startingBalanceForPeriod.probationHoursAmount integer

A duração do período experimental (em horas) dos dados do saldo de competência.

vestedDaysAmount
startingBalanceForPeriod.vestedDaysAmount integer

A duração adquirida (em dias) dos dados do saldo de competência.

probationDaysAmount
startingBalanceForPeriod.probationDaysAmount integer

O número de dias experimentais.