Compartilhar via


Manutenção de tempo do WFM do UKG Pro (versão prévia)

Ações de autoatendimento do funcionário para manutenção de tempo.

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

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome KGS
URL https://www.ukg.com/support
Email support@ukg.com
Metadados do conector
Publicador Ria Gupta
Site https://www.ukg.com/
Política de privacidade https://www.ukg.com/privacy
Categorias Recursos Humanos

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

Pré-requisitos

Você precisará do valor de access_token gerado por meio do conector de Autenticação WFM PRO.

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 do WFM PRO, a resposta do conector incluirá o valor de access_token, que pode ser utilizado posteriormente como parâmetros no conector de Manutenção de Tempo do WFM PRO.

Introdução ao conector

  • Selecione Get Last Timestamp a ação para buscar o último carimbo de data/hora registrado.
  • Selecione Add Timestamp a ação para gravar um carimbo de data/hora para uma transação de punch.
  • Selecione Get Employee Timecard a ação para buscar um cartão de horário do funcionário.
  • Selecione View Accruals a ação para buscar o Resumo do Acréscimo.

Problemas e limitações conhecidos

None

Erros e soluções comuns

Entre em contato conosco por meio de https://www.ukg.com/support

perguntas frequentes

Entre em contato conosco em https://www.ukg.com/support caso de erros e perguntas.

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:

Default 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.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
PRO WFM Vanity URL secureString A URL do Pro WFM Vanity para esta api Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à 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 punch.

Exibir acréscimos

Esta operação retorna Resumo de Acumulação.

Recuperar carimbo de data/hora

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

Recuperar Cartão de Horário

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

Adicionar carimbo de data/hora

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de acesso
accessToken True string

Token para acessar a API.

transferString
transferString string

Lista de Entradas de Categoria de Trabalho e Centro de Custo.

cancelDeduct
cancelDeduct boolean

Um valor booleano.

Número da Pessoa
qualifier True integer

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

Nome da posição
qualifier string

Nome da posição.

Retornos

Exibir acréscimos

Esta operação retorna Resumo de Acumulação.

Parâmetros

Nome Chave Obrigató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(YYYY-MM-DD).

Data de Término
endDate True string

Data de término do intervalo de datas em formato(YYYY-MM-DD).

Número
qualifier True string

O número da pessoa do funcionário.

Retornos

Itens
viewAccruals

Recuperar carimbo de data/hora

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

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de acesso
accessToken True string

Token para acessar a API.

Retornos

Recuperar Cartão de Horário

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

Parâmetros

Nome Chave Obrigatório Tipo Description
select
select string

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

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

start_date
start_date string

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

end_date
end_date string

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

breakUpAtMidnight
breakUpAtMidnight boolean

Um indicador booliano de interromper ou não um turno trabalhado na meia-noite do dia do calendário, quando o turno passa de um dia do calendário para outro.

include_phantom_punches
include_phantom_punches boolean

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

include_kind_of_time_segments
include_kind_of_time_segments boolean

Um indicador booliano de incluir ou não segmentos tipos de tempo.

show_totals_with_hidden_paycodes
show_totals_with_hidden_paycodes boolean

Um indicador booliano de se os totais devem ou não ser mostrados quando são destinados a 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 booliano de consolidar ou não segmentos agendados de uma mudança de trabalho.

shift_id
shift_id integer

A ID da mudança desejada 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é quais totais são calculados em formato ISO_LOCAL_DATE (YYYY-MM-DD). Deve estar dentro de determinado start_date e end_date ou no período de tempo representado por uma ID de período simbólico fornecida.

totals_include_combined_paycodes
totals_include_combined_paycodes boolean

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

retrieve_full_labor_categories
retrieve_full_labor_categories boolean

Um indicador booliano de se os totais incluem ou não categorias de trabalho completa.

return_true_cost_center_id
return_true_cost_center_id boolean

Um indicador booliano de retornar ou não a verdadeira ID do centro de custo na resposta.

Token de acesso
accessToken True string

Token para acessar a API.

Retornos

Definições

getTimeStamps

Nome Caminho Tipo Description
id
id integer

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

id
employee.id integer

ID do Ref do Funcionário

qualificador
employee.qualifier string

Qualificador Exclusivo do Ref do Funcionário

nome
employee.name string

nome

id
timeZone.id integer

ID do Ref do Funcionário

qualificador
timeZone.qualifier string

Qualificador Exclusivo do Ref do Funcionário

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

Soque a data e a hora em ISO_LOCAL_DATE_TIME formato (yyyy-mm-ddThh:mm:ss.sss).

cancelDeduct
cancelDeduct boolean

cancelDeduct

getEmployeeTimeCard

Nome Caminho Tipo Description
startDate
startDate string

A data de início mais antiga associada a um cartão de horário no formato (YYYY-MM-DD).

data de término
endDate string

A data de término mais recente associada a um cartão de horário no formato (YYYY-MM-DD).

Socos
punches array of object

Uma lista dos socos associados a um cartão de horário

id
punches.id integer

A ID deste conjunto de comentários e anotações anexadas

id
punches.employee.id integer

ID do Ref de Objeto

qualificador
punches.employee.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
punches.employee.name string

nome

punchDtm
punches.punchDtm string

O carimbo de data e hora do soco em ISO_LOCAL_DATE_TIME

roundedPunchDtm
punches.roundedPunchDtm string

A data e a hora do soco arredondado

id
punches.timeZone.id integer

ID do Ref de Objeto

qualificador
punches.timeZone.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
punches.timeZone.name string

nome

enteredOnDtm
punches.enteredOnDtm string

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

hasComments
punches.hasComments boolean

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

id
punches.editByType.id integer

ID do Ref de Objeto

qualificador
punches.editByType.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
punches.editByType.name string

nome

id
punches.dataSource.id integer

ID do Ref de Objeto

qualificador
punches.dataSource.qualifier string

Qualificador Exclusivo do Ref de Objeto

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 horário

id
punches.exceptions.employee.id integer

ID do Ref de Objeto

qualificador
punches.exceptions.employee.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
punches.exceptions.employee.name string

nome

startDateTime
punches.exceptions.startDateTime string

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

endDateTime
punches.exceptions.endDateTime string

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

applyDate
punches.exceptions.applyDate string

A data de aplicação de um intervalo de datas do segmento processado pela atividade no formato ISO_LOCAL_DATE (YYYY-MM-DD).

id
punches.exceptions.id integer

id

id
punches.exceptions.endTimeZone.id integer

ID do Ref de Objeto

id
punches.exceptions.exceptionType.id integer

A ID de um tipo de exceção timekeeping

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 erro de exceção de Timekeeping

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

O nome de exibição de um tipo de exceção Timekeeping

categoria
punches.exceptions.exceptionType.category string

A categoria de um tipo de exceção timekeeping

id
punches.exceptions.orgJob.id integer

ID do Ref de Objeto

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

ID do Ref de Objeto

violationInHours
punches.exceptions.violationInHours number

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

id
punches.exceptions.workRule.id integer

ID do Ref de Objeto

qualificador
punches.exceptions.workRule.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
punches.exceptions.workRule.name string

nome

commentsNotes
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 Anotações para cada Comentário

id
punches.exceptions.punchEvent.id integer

ID do Ref de Objeto

isExcusedAbsence
punches.exceptions.isExcusedAbsence boolean

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

isUnExcusedAbsence
punches.exceptions.isUnExcusedAbsence boolean

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

id
punches.exceptions.missingTimeStatus.id integer

A 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 de status de hora ausente localizado

Justificações
punches.exceptions.justifications array of

Uma lista de justificativas de tempo ausentes para essa exceção. Esta propriedade é somente leitura

justifiedTimes
punches.exceptions.justifiedTimes array of

Uma lista de horários justificados para essa exceção. Esta propriedade é somente leitura

transferência
punches.exceptions.transfer boolean

transferência

eventDate
punches.exceptions.eventDate string

eventDate

startException
punches.exceptions.startException boolean

startException

endException
punches.exceptions.endException boolean

endException

revisado
punches.exceptions.reviewed boolean

revisado

commentsNotes
punches.commentsNotes array of

Uma referência a uma lista de Comentários. Esse objeto pode ter vários Comentários com várias Anotações para cada Comentário. Esta propriedade é somente leitura

isPhantom
punches.isPhantom boolean

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

isScheduled
punches.isScheduled boolean

Um indicador booliano de se o soco é gerado de um intervalo de trabalho agendado

updatedOnDtm
punches.updatedOnDtm string

O carimbo de data e hora para quando esta transação de soco foi atualizada pela última vez

validateAsTimestamp
punches.validateAsTimestamp boolean

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

attestationPunchEdit
punches.attestationPunchEdit boolean

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

markRelatedExceptionsAsReviewed
punches.markRelatedExceptionsAsReviewed boolean

Se houver uma exceção para um soco, um indicador booliano de se essa exceção é resolvida ou não

Editável
punches.editable boolean

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

cancelDeduct
punches.cancelDeduct boolean

cancelDeduct

fromPhantomEdited
punches.fromPhantomEdited boolean

fromPhantomEdited

exceptionResolved
punches.exceptionResolved boolean

exceptionResolved

id
punches.typeOverride.id integer

ID do Ref de Objeto

qualificador
punches.typeOverride.qualifier string

Qualificador Exclusivo do Ref de Objeto

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 trabalhados

id
workedShifts.id integer

ID do Ref de Objeto

id
workedShifts.employee.id integer

ID do Ref de Objeto

startDateTime
workedShifts.startDateTime string

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

endDateTime
workedShifts.endDateTime string

A data e a hora de término de um intervalo de datas no formato ISO_LOCAL_DATE_TIME (yyy-mm-ddThh:mm:ss.sss)

id
workedShifts.startTimezone.id integer

ID do Ref de Objeto

id
workedShifts.endTimezone.id integer

ID do Ref de Objeto

roundedStartDateTime
workedShifts.roundedStartDateTime string

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

roundedEndDateTime
workedShifts.roundedEndDateTime string

Um campo opcional que contém a data e a hora de término com base nas regras de arredondamento configuradas

id
workedShifts.roundedStartTimezone.id integer

ID do Ref de Objeto

id
workedShifts.roundedEndTimezone.id integer

ID do Ref de Objeto

transactionDateTime
workedShifts.transactionDateTime string

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

inProgress
workedShifts.inProgress boolean

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

consolidatedScheduleSegments
workedShifts.consolidatedScheduleSegments boolean

Um indicador booliano de se os segmentos de agendamento do turno trabalhado foram consolidados

workedSpans
workedShifts.workedSpans array of object

Contém uma lista de objetos workSpan

id
workedShifts.workedSpans.id integer

id

ID do item
workedShifts.workedSpans.itemId integer

A ID do item de hora

spanId
workedShifts.workedSpans.spanId integer

A ID do período de trabalho

startDateTime
workedShifts.workedSpans.startDateTime string

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

endDateTime
workedShifts.workedSpans.endDateTime string

A data e a hora de término de um intervalo de datas no formato ISO_LOCAL_DATE_TIME (yyy-mm-ddThh:mm:ss.sss)

roundedStartDateTime
workedShifts.workedSpans.roundedStartDateTime string

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

roundedEndDateTime
workedShifts.workedSpans.roundedEndDateTime string

Um campo opcional que contém a data e a hora de término com base nas regras de arredondamento configuradas

id
workedShifts.workedSpans.startTimezone.id integer

ID do Ref de Objeto

id
workedShifts.workedSpans.endTimezone.id integer

id

id
workedShifts.workedSpans.primaryOrgJob.id integer

ID do Ref de Objeto

qualificador
workedShifts.workedSpans.primaryOrgJob.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
workedShifts.workedSpans.primaryOrgJob.name string

nome

id
workedShifts.workedSpans.workRule.id integer

ID do Ref de Objeto

qualificador
workedShifts.workedSpans.workRule.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
workedShifts.workedSpans.workRule.name string

nome

id
workedShifts.workedSpans.primaryWorkRule.id integer

ID do Ref de Objeto

qualificador
workedShifts.workedSpans.primaryWorkRule.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
workedShifts.workedSpans.primaryWorkRule.name string

nome

orderNumber
workedShifts.workedSpans.orderNumber integer

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

id
workedShifts.workedSpans.startPunch.id integer

id

id
workedShifts.workedSpans.startPunch.employee.id integer

ID do Ref de Objeto

qualificador
workedShifts.workedSpans.startPunch.employee.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
workedShifts.workedSpans.startPunch.employee.name string

nome

punchDtm
workedShifts.workedSpans.startPunch.punchDtm string

O carimbo de data e hora do soco em ISO_LOCAL_DATE_TIME

roundedPunchDtm
workedShifts.workedSpans.startPunch.roundedPunchDtm string

A data e a hora do soco arredondado

id
workedShifts.workedSpans.startPunch.timeZone.id integer

ID do Ref de Objeto

qualificador
workedShifts.workedSpans.startPunch.timeZone.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
workedShifts.workedSpans.startPunch.timeZone.name string

nome

enteredOnDtm
workedShifts.workedSpans.startPunch.enteredOnDtm string

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

hasComments
workedShifts.workedSpans.startPunch.hasComments boolean

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

id
workedShifts.workedSpans.startPunch.editByType.id integer

ID do Ref de Objeto

qualificador
workedShifts.workedSpans.startPunch.editByType.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
workedShifts.workedSpans.startPunch.editByType.name string

nome

id
workedShifts.workedSpans.startPunch.dataSource.id integer

ID do Ref de Objeto

qualificador
workedShifts.workedSpans.startPunch.dataSource.qualifier string

Qualificador Exclusivo do Ref de Objeto

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 soco

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

ID do Ref de Objeto

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

Qualificador Exclusivo do Ref de Objeto

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

nome

startDateTime
workedShifts.workedSpans.startPunch.exceptions.startDateTime string

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

endDateTime
workedShifts.workedSpans.startPunch.exceptions.endDateTime string

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

applyDate
workedShifts.workedSpans.startPunch.exceptions.applyDate string

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

id
workedShifts.workedSpans.startPunch.exceptions.id integer

id

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

ID do Ref de Objeto

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

A ID de um tipo de exceção timekeeping

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 de exibição de um tipo de exceção Timekeeping

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

categoria

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

ID do Ref de Objeto

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

ID do Ref de Objeto

violationInHours
workedShifts.workedSpans.startPunch.exceptions.violationInHours number

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

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

ID do Ref de Objeto

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

Qualificador Exclusivo do Ref de Objeto

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

nome

commentsNotes
workedShifts.workedSpans.startPunch.exceptions.commentsNotes array of

Uma referência a uma lista de Comentários. Esse objeto pode ter vários Comentários com várias Anotações para cada Comentário. Esta propriedade é somente leitura

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

ID do Ref de Objeto

isExcusedAbsence
workedShifts.workedSpans.startPunch.exceptions.isExcusedAbsence boolean

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

isUnExcusedAbsence
workedShifts.workedSpans.startPunch.exceptions.isUnExcusedAbsence boolean

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

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

A 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 de status de hora ausente localizado

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

Uma lista de justificativas de tempo ausentes para essa exceção. Esta propriedade é somente leitura

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

Uma lista de horários justificados para essa exceção. Esta propriedade é somente leitura

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

transferência

eventDate
workedShifts.workedSpans.startPunch.exceptions.eventDate string

eventDate

startException
workedShifts.workedSpans.startPunch.exceptions.startException boolean

startException

endException
workedShifts.workedSpans.startPunch.exceptions.endException boolean

endException

revisado
workedShifts.workedSpans.startPunch.exceptions.reviewed boolean

revisado

commentsNotes
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 Anotações para cada Comentário

isPhantom
workedShifts.workedSpans.startPunch.isPhantom boolean

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

isScheduled
workedShifts.workedSpans.startPunch.isScheduled boolean

Um indicador booliano de se o soco é gerado de um intervalo de trabalho agendado

updatedOnDtm
workedShifts.workedSpans.startPunch.updatedOnDtm string

O carimbo de data e hora para quando esta transação de soco foi atualizada pela última vez

validateAsTimestamp
workedShifts.workedSpans.startPunch.validateAsTimestamp boolean

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

attestationPunchEdit
workedShifts.workedSpans.startPunch.attestationPunchEdit boolean

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

markRelatedExceptionsAsReviewed
workedShifts.workedSpans.startPunch.markRelatedExceptionsAsReviewed boolean

Se houver uma exceção para um soco, um indicador booliano de se essa exceção é resolvida ou não

Editável
workedShifts.workedSpans.startPunch.editable boolean

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

cancelDeduct
workedShifts.workedSpans.startPunch.cancelDeduct boolean

cancelDeduct

fromPhantomEdited
workedShifts.workedSpans.startPunch.fromPhantomEdited boolean

fromPhantomEdited

exceptionResolved
workedShifts.workedSpans.startPunch.exceptionResolved boolean

exceptionResolved

id
workedShifts.workedSpans.startPunch.workRule.id integer

ID do Ref de Objeto

qualificador
workedShifts.workedSpans.startPunch.workRule.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
workedShifts.workedSpans.startPunch.workRule.name string

nome

id
workedShifts.workedSpans.startPunch.typeOverride.id integer

ID do Ref de Objeto

qualificador
workedShifts.workedSpans.startPunch.typeOverride.qualifier string

Qualificador Exclusivo do Ref de Objeto

typeOverrideId
workedShifts.workedSpans.startPunch.typeOverride.typeOverrideId integer

A ID da substituição de tipo

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

dDescription 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

ID do Ref de Objeto

qualificador
workedShifts.workedSpans.endPunch.employee.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
workedShifts.workedSpans.endPunch.employee.name string

nome

punchDtm
workedShifts.workedSpans.endPunch.punchDtm string

O carimbo de data e hora do soco em ISO_LOCAL_DATE_TIME

roundedPunchDtm
workedShifts.workedSpans.endPunch.roundedPunchDtm string

A data e a hora do soco arredondado

id
workedShifts.workedSpans.endPunch.timeZone.id integer

ID do Ref de Objeto

qualificador
workedShifts.workedSpans.endPunch.timeZone.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
workedShifts.workedSpans.endPunch.timeZone.name string

nome

enteredOnDtm
workedShifts.workedSpans.endPunch.enteredOnDtm string

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

hasComments
workedShifts.workedSpans.endPunch.hasComments boolean

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

id
workedShifts.workedSpans.endPunch.editByType.id integer

ID do Ref de Objeto

qualificador
workedShifts.workedSpans.endPunch.editByType.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
workedShifts.workedSpans.endPunch.editByType.name string

nome

id
workedShifts.workedSpans.endPunch.dataSource.id integer

ID do Ref de Objeto

qualificador
workedShifts.workedSpans.endPunch.dataSource.qualifier string

Qualificador Exclusivo do Ref de Objeto

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 horário

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

ID do Ref de Objeto

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

Qualificador Exclusivo do Ref de Objeto

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

nome

startDateTime
workedShifts.workedSpans.endPunch.exceptions.startDateTime string

A data e a hora de início de uma justificativa no formato ISO_LOCAL_DATE_TIME (yyyy-mm-ddThh:mm:ss.sss)

endDateTime
workedShifts.workedSpans.endPunch.exceptions.endDateTime string

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

applyDate
workedShifts.workedSpans.endPunch.exceptions.applyDate string

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

id
workedShifts.workedSpans.endPunch.exceptions.id integer

id

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

ID do Ref de Objeto

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

A ID de um tipo de exceção timekeeping

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 de exibição de um tipo de exceção Timekeeping

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

ID do Ref de Objeto

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

ID do Ref de Objeto

violationInHours
workedShifts.workedSpans.endPunch.exceptions.violationInHours number

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

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

ID do Ref de Objeto

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

Qualificador Exclusivo do Ref de Objeto

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

nome

commentsNotes
workedShifts.workedSpans.endPunch.exceptions.commentsNotes array of

Uma referência a uma lista de Comentários. Esse objeto pode ter vários Comentários com várias Anotações para cada Comentário. Esta propriedade é somente leitura

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

ID do Ref de Objeto

isExcusedAbsence
workedShifts.workedSpans.endPunch.exceptions.isExcusedAbsence boolean

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

isUnExcusedAbsence
workedShifts.workedSpans.endPunch.exceptions.isUnExcusedAbsence boolean

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

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

A 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 de status de hora ausente localizado

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

Uma lista de justificativas de tempo ausentes para essa exceção. Esta propriedade é somente leitura

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

Uma lista de horários justificados para essa exceção. Esta propriedade é somente leitura

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

transferência

eventDate
workedShifts.workedSpans.endPunch.exceptions.eventDate string

eventDate

startException
workedShifts.workedSpans.endPunch.exceptions.startException boolean

startException

endException
workedShifts.workedSpans.endPunch.exceptions.endException boolean

endException

revisado
workedShifts.workedSpans.endPunch.exceptions.reviewed boolean

revisado

commentsNotes
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 Anotações para cada Comentário

isPhantom
workedShifts.workedSpans.endPunch.isPhantom boolean

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

isScheduled
workedShifts.workedSpans.endPunch.isScheduled boolean

Um indicador booliano de se o soco é gerado de um intervalo de trabalho agendado

updatedOnDtm
workedShifts.workedSpans.endPunch.updatedOnDtm string

O carimbo de data e hora para quando esta transação de soco foi atualizada pela última vez

validateAsTimestamp
workedShifts.workedSpans.endPunch.validateAsTimestamp boolean

validateAsTimestamp

attestationPunchEdit
workedShifts.workedSpans.endPunch.attestationPunchEdit boolean

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

markRelatedExceptionsAsReviewed
workedShifts.workedSpans.endPunch.markRelatedExceptionsAsReviewed boolean

markRelatedExceptionsAsReviewed

Editável
workedShifts.workedSpans.endPunch.editable boolean

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

cancelDeduct
workedShifts.workedSpans.endPunch.cancelDeduct boolean

cancelDeduct

fromPhantomEdited
workedShifts.workedSpans.endPunch.fromPhantomEdited boolean

fromPhantomEdited

exceptionResolved
workedShifts.workedSpans.endPunch.exceptionResolved boolean

exceptionResolved

id
workedShifts.workedSpans.endPunch.workRule.id integer

ID do Ref de Objeto

qualificador
workedShifts.workedSpans.endPunch.workRule.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
workedShifts.workedSpans.endPunch.workRule.name string

nome

id
workedShifts.workedSpans.endPunch.typeOverride.id integer

ID do Ref de Objeto

qualificador
workedShifts.workedSpans.endPunch.typeOverride.qualifier string

Qualificador Exclusivo do Ref de Objeto

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

approvableByManager
workedShifts.workedSpans.approvableByManager boolean

Um indicador booliano de se o item de intervalo trabalhado é ou não approvável pelo gerenciador de logs

scheduledOrgJob
workedShifts.workedSpans.scheduledOrgJob boolean

scheduledOrgJob

scheduledWorkRule
workedShifts.workedSpans.scheduledWorkRule boolean

scheduledWorkRule

userEnteredOrgJob
workedShifts.workedSpans.userEnteredOrgJob boolean

Um indicador booliano de se um trabalho de estrutura de negócios para esse segmento de turno foi inserido pelo usuário

transferOrgJob
workedShifts.workedSpans.transferOrgJob boolean

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

userEnteredWorkRule
workedShifts.workedSpans.userEnteredWorkRule boolean

Um indicador booliano de se uma regra de trabalho para esse segmento de turno foi inserida pelo usuário

transferWorkRule
workedShifts.workedSpans.transferWorkRule boolean

transferWorkRule

Projetada
workedShifts.workedSpans.projected boolean

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

shiftTotalHours
workedShifts.shiftTotalHours number

Número total de horas para um turno trabalhado

scheduledShiftIds
workedShifts.scheduledShiftIds array of integer

Uma lista de IDs de turno agendadas assiciadas com edições de código pago

Projetada
workedShifts.projected boolean

Projetada

fromSchedule
workedShifts.fromSchedule boolean

fromSchedule

unscheduledStartDateTime
workedShifts.unscheduledStartDateTime string

Um parâmetro de cadeia de caracteres que representa a data e a hora de início de uma mudança não agendada

unscheduledEndDateTime
workedShifts.unscheduledEndDateTime string

Um parâmetro de cadeia de caracteres que representa a data e a hora de término de uma mudança não agendada

payCodeEdits
payCodeEdits array of

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

Totais
totals array of object

Uma lista de totais de cartão de tempo associados a um cartão de horário

id
totals.employeeContext.employee.id integer

ID do Ref de Objeto

qualificador
totals.employeeContext.employee.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
totals.employeeContext.employee.name string

nome

id
totals.employeeContext.timezone.id integer

ID do Ref de Objeto

qualificador
totals.employeeContext.timezone.qualifier string

Qualificador Exclusivo do Ref de Objeto

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

aggregatedTotals
totals.aggregatedTotals array of object

Uma lista de objetos totais agregados

approvableByManager
totals.aggregatedTotals.approvableByManager boolean

Um indicador booliano de se o total agregado é ou não approvável pelo gerenciador conectado

id
totals.aggregatedTotals.employee.id integer

ID do Ref de Objeto

qualificador
totals.aggregatedTotals.employee.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
totals.aggregatedTotals.employee.name string

nome

id
totals.aggregatedTotals.location.id integer

ID do Ref de Objeto

qualificador
totals.aggregatedTotals.location.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
totals.aggregatedTotals.location.name string

nome

id
totals.aggregatedTotals.job.id integer

ID do Ref de Objeto

qualificador
totals.aggregatedTotals.job.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
totals.aggregatedTotals.job.name string

nome

id
totals.aggregatedTotals.payCode.id integer

ID do Ref de Objeto

qualificador
totals.aggregatedTotals.payCode.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
totals.aggregatedTotals.payCode.name string

nome

amountType
totals.aggregatedTotals.amountType string

Referência ao objeto AmountType

quantidade
totals.aggregatedTotals.amount float

A quantidade de tempo de um turno trabalhado

salário
totals.aggregatedTotals.wages float

O valor do dinheiro calculado em totais como salários

quantidade
totals.aggregatedTotals.wagesCurrency.amount float

Valor monetário

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

Associar código ISO de moeda

jobTransfer
totals.aggregatedTotals.jobTransfer boolean

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

laborCategoryTransfer
totals.aggregatedTotals.laborCategoryTransfer boolean

Um indicador booliano de se o objeto total contém ou não uma categoria de trabalho

taxa
totals.aggregatedTotals.rate number

A taxa da correlação entre salário e valor

viewAccruals

Nome Caminho Tipo Description
uniqueId
uniqueId string

O identificador exclusivo de um objeto absenceExceptionWithPosition.

id
employee.id integer

ID do Ref de Objeto

qualificador
employee.qualifier string

Qualificador Exclusivo do Ref de Objeto

nome
employee.name string

nome

startDateTime
startDateTime string

A data/hora de início do resumo.

endDateTime
endDateTime string

A data/hora de término do resumo.

id
accrualCode.id integer

id

nome
accrualCode.name string

nome

shortName
accrualCode.shortName string

shortName

hoursPerDayInSeconds
accrualCode.hoursPerDayInSeconds integer

hoursPerDayInSeconds

ID do tipo
accrualCode.typeId integer

ID do tipo

allowEdit
accrualCode.allowEdit boolean

allowEdit

typeName
accrualCode.typeName string

typeName

horaspor dia
accrualCode.hoursPerDay integer

horaspor dia

effectiveDateRange
effectiveDateRange array of string

O intervalo de datas efetivo dos dados de resumo de acréscimo.

dailySummaries
dailySummaries array of object

Uma referência a uma lista de objetos AccrualDailySummaryData.

balanceDate
dailySummaries.balanceDate string

A data e a hora associadas aos dados de resumo diário acumulados.

reportingPeriod
dailySummaries.reportingPeriod string

O período de relatório dos dados de resumo diário acumulados.

balanceDate
dailySummaries.currentBalance.balanceDate string

A data e a hora associadas aos dados de saldo acumulado.

vestedHoursAmount
dailySummaries.currentBalance.vestedHoursAmount float

A duração investida (em horas) dos dados de saldo acumulado.

probationHoursAmount
dailySummaries.currentBalance.probationHoursAmount integer

A duração da condicional (em horas) dos dados de saldo acumulado.

vestedDaysAmount
dailySummaries.currentBalance.vestedDaysAmount integer

A duração (em dias) dos dados de saldo acumulado.

probationDaysAmount
dailySummaries.currentBalance.probationDaysAmount integer

O número de dias de condicional.

plannedTakingHours
dailySummaries.plannedTakingHours integer

A tomada planejada (em horas) dos dados de resumo diário acumulados.

pendingGrantHours
dailySummaries.pendingGrantHours float

A concessão pendente (em horas) dos dados de resumo diário acumulados.

takingToDateHours
dailySummaries.takingToDateHours integer

A data de início (em dias) dos dados de resumo diário acumulados.

earnedToDateHours
dailySummaries.earnedToDateHours integer

O ganho até a data (em dias) dos dados de resumo diário acumulados.

availableBalanceHours
dailySummaries.availableBalanceHours float

O saldo disponível (em horas) dos dados de resumo diário acumulados.

plannedTakingDays
dailySummaries.plannedTakingDays integer

A tomada planejada (em dias) dos dados de resumo diário acumulados.

PendingGrantDays
dailySummaries.pendingGrantDays integer

A concessão pendente (em dias) dos dados de resumo diário acumulados.

takingToDateDays
dailySummaries.takingToDateDays integer

A data de início (em dias) dos dados de resumo diário acumulados.

earnedToDateDays
dailySummaries.earnedToDateDays integer

O ganho até a data (em dias) dos dados de resumo diário acumulados.

availableBalanceDays
dailySummaries.availableBalanceDays integer

O saldo disponível (em dias) dos dados de resumo diário acumulados.

reportingPeriodSummaries
reportingPeriodSummaries array of object

Uma referência a uma lista de objetos AccrualReportingPeriodSummaryData.

reportingPeriodSpan
reportingPeriodSummaries.reportingPeriodSpan string

O período de relatório dos dados de resumo do período de relatório acumulado.

balanceDate
reportingPeriodSummaries.priorEndingBalance.balanceDate string

A data e a hora associadas aos dados de saldo acumulado.

vestedHoursAmount
reportingPeriodSummaries.priorEndingBalance.vestedHoursAmount float

A duração investida (em horas) dos dados de saldo acumulado.

probationHoursAmount
reportingPeriodSummaries.priorEndingBalance.probationHoursAmount integer

A duração da condicional (em horas) dos dados de saldo acumulado.

vestedDaysAmount
reportingPeriodSummaries.priorEndingBalance.vestedDaysAmount integer

O número de dias de condicional.

probationDaysAmount
reportingPeriodSummaries.priorEndingBalance.probationDaysAmount integer

O número de dias de condicional.

balanceDate
reportingPeriodSummaries.openingBalance.balanceDate string

A data e a hora associadas aos dados de saldo acumulado.

vestedHoursAmount
reportingPeriodSummaries.openingBalance.vestedHoursAmount float

A duração investida (em horas) dos dados de saldo acumulado.

probationHoursAmount
reportingPeriodSummaries.openingBalance.probationHoursAmount integer

A duração da condicional (em horas) dos dados de saldo acumulado.

vestedDaysAmount
reportingPeriodSummaries.openingBalance.vestedDaysAmount integer

A duração (em dias) dos dados de saldo acumulado.

probationDaysAmount
reportingPeriodSummaries.openingBalance.probationDaysAmount integer

O número de dias de condicional.

balanceDate
reportingPeriodSummaries.endingBalance.balanceDate string

A data e a hora associadas aos dados de saldo acumulado.

vestedHoursAmount
reportingPeriodSummaries.endingBalance.vestedHoursAmount float

A duração investida (em horas) dos dados de saldo acumulado.

probationHoursAmount
reportingPeriodSummaries.endingBalance.probationHoursAmount integer

A duração da condicional (em horas) dos dados de saldo acumulado.

vestedDaysAmount
reportingPeriodSummaries.endingBalance.vestedDaysAmount integer

A duração (em dias) dos dados de saldo acumulado.

probationDaysAmount
reportingPeriodSummaries.endingBalance.probationDaysAmount integer

O número de dias de condicional.

balanceDate
startingBalanceForPeriod.balanceDate string

A data e a hora associadas aos dados de saldo acumulado.

vestedHoursAmount
startingBalanceForPeriod.vestedHoursAmount float

A duração investida (em horas) dos dados de saldo acumulado.

probationHoursAmount
startingBalanceForPeriod.probationHoursAmount integer

A duração da condicional (em horas) dos dados de saldo acumulado.

vestedDaysAmount
startingBalanceForPeriod.vestedDaysAmount integer

A duração (em dias) dos dados de saldo acumulado.

probationDaysAmount
startingBalanceForPeriod.probationDaysAmount integer

O número de dias de condicional.