UKG Pro WFM Timekeeping (Preview)

Employee Self Service Actions for Timekeeping.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name KGS
URL https://www.ukg.com/support
Email support@ukg.com
Connector Metadata
Publisher Ria Gupta
Website https://www.ukg.com/
Privacy policy https://www.ukg.com/privacy
Categories Human Resources

UKG Pro WFM Timekeeping connector simplifies the steps to easy access some of the most frequently used Pro WFM Timekeeping APIs.

Prerequisites

You will need the value of access_token generated via PRO WFM Authentication connector.

How to get credentials

Configure the connector properties using the prerequisite information during the connection creation process. Upon a successful call of WFM PRO Authentication connector, the connector's response will include both the value of access_token, which can be subsequently utilized as parameters in PRO WFM Timekeeping connector.

Get started with your connector

  • Select Get Last Timestamp action to fetch the last recorded timestamp.
  • Select Add Timestamp action to record a timestamp for a punch transaction.
  • Select Get Employee Timecard action to fetch an employee timecard.
  • Select View Accruals action to fetch the Accrual Summary.

Known issues and limitations

None

Common errors and remedies

Contact us via https://www.ukg.com/support

FAQ

Contact us via https://www.ukg.com/support in case of errors and questions.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
PRO WFM Vanity URL securestring The PRO WFM Vanity URL for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add Timestamp

This operation records a timestamp for a punch transaction.

Retrieve Timecard

This operation returns an employee timecard.

Retrieve Timestamp

This operation returns the last recorded timestamp.

View Accruals

This operation returns Accrual Summary.

Add Timestamp

This operation records a timestamp for a punch transaction.

Parameters

Name Key Required Type Description
Access Token
accessToken True string

Token to access API.

transferString
transferString string

List of Labor Category Entries and Cost Center.

cancelDeduct
cancelDeduct boolean

A boolean value.

Person Number
qualifier True integer

A number that uniquely identifies a person. This is not an employee ID.

Position Name
qualifier string

Name of the Position.

Returns

Retrieve Timecard

This operation returns an employee timecard.

Parameters

Name Key Required Type Description
select
select string

Determines the objects returned in the timecard request response.

person_number
person_number True string

A number that uniquely identifies a person

Symbolic Period ID
symbolic_period_id string

A symbolic identifier that represents a timeframe or a span of time

start_date
start_date string

The start date in ISO_LOCAL_DATE format (YYYY-MM-DD). Mutually exclusive with symbolic period, but either a symbolic period or a date range consisting of a start date and end date is required.

end_date
end_date string

The end date in ISO_LOCAL_DATE format (YYYY-MM-DD). Mutually exclusive with symbolic period, but either a symbolic period or a date range consisting of a start date and end date is required.

breakUpAtMidnight
breakUpAtMidnight boolean

A Boolean indicator of whether or not to break up a worked shift at calendar day midnight when the shift crosses from one calendar day to another.

include_phantom_punches
include_phantom_punches boolean

A Boolean indicator of whether or not to include phantom punches.

include_kind_of_time_segments
include_kind_of_time_segments boolean

A Boolean indicator of whether or not to include Kinds Of Time segments.

show_totals_with_hidden_paycodes
show_totals_with_hidden_paycodes boolean

A Boolean indicator of whether or not totals should be shown when they are for for paycodes that have been configured to be hidden.

activity_name
activity_name string

The name of the desired activity for retrieval of the activity data types.

consolidate_schedule_segments
consolidate_schedule_segments boolean

A Boolean indicator of whether or not to consolidate scheduled segments of a worked shift.

shift_id
shift_id integer

The ID of the desired shift for retrieval of the activity data types.

totals_rollup_by
totals_rollup_by string

The criteria by which totals have been rolled up.

context_date
context_date string

The date for which or until which totals are calculated in ISO_LOCAL_DATE format (YYYY-MM-DD). Must be within the given start_date and end_date or the time frame represented by a provided symbolic timeframe ID.

totals_include_combined_paycodes
totals_include_combined_paycodes boolean

A Boolean indicator of whether or not totals include combined paycodes.

retrieve_full_labor_categories
retrieve_full_labor_categories boolean

A Boolean indicator of whether or not totals include full labor categories.

return_true_cost_center_id
return_true_cost_center_id boolean

A Boolean indicator of whether or not to return the true cost center ID in the response.

Access Token
accessToken True string

Token to access API.

Returns

Retrieve Timestamp

This operation returns the last recorded timestamp.

Parameters

Name Key Required Type Description
Access Token
accessToken True string

Token to access API.

Returns

View Accruals

This operation returns Accrual Summary.

Parameters

Name Key Required Type Description
Access Token
accessToken True string

Token to access API.

Start Date
startDate True string

Start date of date range in format(YYYY-MM-DD).

End Date
endDate True string

End date of date range in format(YYYY-MM-DD).

Number
qualifier True string

The person number of the employee.

Returns

Items
viewAccruals

Definitions

getTimeStamps

Name Path Type Description
id
id integer

The ID of the punch transaction.

id
employee.id integer

Employee Ref Id

qualifier
employee.qualifier string

Employee Ref Unique qualifier

name
employee.name string

name

id
timeZone.id integer

Employee Ref Id

qualifier
timeZone.qualifier string

Employee Ref Unique qualifier

name
timeZone.name string

name

transferString
transferString string

An ordered, semi-colon separated list of Labor Category Entries and Cost Center.

punchDtm
punchDtm string

Punch date and time in ISO_LOCAL_DATE_TIME format (yyyy-mm-ddThh:mm:ss.sss).

cancelDeduct
cancelDeduct boolean

cancelDeduct

getEmployeeTimeCard

Name Path Type Description
startDate
startDate string

The earliest start date associated with a timecard in format(YYYY-MM-DD).

endDate
endDate string

The latest end date associated with a timecard in format(YYYY-MM-DD).

punches
punches array of object

A list of the punches associated with a timecard

id
punches.id integer

The ID of this set of Comments and attached Notes

id
punches.employee.id integer

Object Ref Id

qualifier
punches.employee.qualifier string

Object Ref Unique qualifier

name
punches.employee.name string

name

punchDtm
punches.punchDtm string

The date and time stamp for the punch in ISO_LOCAL_DATE_TIME

roundedPunchDtm
punches.roundedPunchDtm string

The rounded punch date and time

id
punches.timeZone.id integer

Object Ref Id

qualifier
punches.timeZone.qualifier string

Object Ref Unique qualifier

name
punches.timeZone.name string

name

enteredOnDtm
punches.enteredOnDtm string

The date and time stamp for when this punch transaction was entered through the API

hasComments
punches.hasComments boolean

A Boolean indicator of whether or not a Comment is associated with an activity segment

id
punches.editByType.id integer

Object Ref Id

qualifier
punches.editByType.qualifier string

Object Ref Unique qualifier

name
punches.editByType.name string

name

id
punches.dataSource.id integer

Object Ref Id

qualifier
punches.dataSource.qualifier string

Object Ref Unique qualifier

displayName
punches.dataSource.displayName string

displayName

functionalAreaName
punches.dataSource.functionalAreaName string

functionalAreaName

name
punches.dataSource.name string

name

exceptions
punches.exceptions array of object

A list of exception objects associated with a timecard

id
punches.exceptions.employee.id integer

Object Ref Id

qualifier
punches.exceptions.employee.qualifier string

Object Ref Unique qualifier

name
punches.exceptions.employee.name string

name

startDateTime
punches.exceptions.startDateTime string

The date and time of the start of the activity in ISO_LOCAL_DATE_TIME format (yyyy-MM-dd HH:mm:ss.SSS)

endDateTime
punches.exceptions.endDateTime string

The date and time of the end of the activity in ISO_LOCAL_DATE_TIME format (yyyy-MM-dd HH:mm:ss.SSS)

applyDate
punches.exceptions.applyDate string

The apply date for an activity processed segment date range in ISO_LOCAL_DATE format (YYYY-MM-DD).

id
punches.exceptions.id integer

id

id
punches.exceptions.endTimeZone.id integer

Object Ref Id

id
punches.exceptions.exceptionType.id integer

The ID of a Timekeeping exception type

name
punches.exceptions.exceptionType.name string

The name of a Timekeeping exception type

description
punches.exceptions.exceptionType.description string

The description of a Timekeeping exception typ

displayName
punches.exceptions.exceptionType.displayName string

The display name of a Timekeeping exception type

category
punches.exceptions.exceptionType.category string

The category of a Timekeeping exception type

id
punches.exceptions.orgJob.id integer

Object Ref Id

overLimitInHours
punches.exceptions.overLimitInHours number

The amount (in hours) that exceeds the limit defined by the exception associated with the pay code edit. This property is read only

id
punches.exceptions.startTimeZone.id integer

Object Ref Id

violationInHours
punches.exceptions.violationInHours number

The total number of hours violated which caused an exception. This property is read only

id
punches.exceptions.workRule.id integer

Object Ref Id

qualifier
punches.exceptions.workRule.qualifier string

Object Ref Unique qualifier

name
punches.exceptions.workRule.name string

name

commentsNotes
punches.exceptions.commentsNotes array of

A reference to a list of Comments. This object can have multiple Comments with multiple Notes for each Comment

id
punches.exceptions.punchEvent.id integer

Object Ref Id

isExcusedAbsence
punches.exceptions.isExcusedAbsence boolean

A Boolean indicator of whether or not the exception involves an excused absence. This property is read only

isUnExcusedAbsence
punches.exceptions.isUnExcusedAbsence boolean

A Boolean indicator of whether or not the exception involves an unexcused absence. This property is read only

id
punches.exceptions.missingTimeStatus.id integer

The ID of the missing time status ranging from 1 to 4

displayName
punches.exceptions.missingTimeStatus.displayName string

The localized missing time status display name

justifications
punches.exceptions.justifications array of

A list of missing time justifications for this exception. This property is read only

justifiedTimes
punches.exceptions.justifiedTimes array of

A list of justified times for this exception. This property is read only

transfer
punches.exceptions.transfer boolean

transfer

eventDate
punches.exceptions.eventDate string

eventDate

startException
punches.exceptions.startException boolean

startException

endException
punches.exceptions.endException boolean

endException

reviewed
punches.exceptions.reviewed boolean

reviewed

commentsNotes
punches.commentsNotes array of

A reference to a list of Comments. This object can have multiple Comments with multiple Notes for each Comment. This property is read only

isPhantom
punches.isPhantom boolean

A Boolean indicator of whether or not the punch is a phantom punch

isScheduled
punches.isScheduled boolean

A Boolean indicator of whether or not the punch is generated from a scheduled worked span

updatedOnDtm
punches.updatedOnDtm string

The date and time stamp for when this punch transaction was last updated

validateAsTimestamp
punches.validateAsTimestamp boolean

A Boolean indicator of whether or not the punch is entered as a timestamp

attestationPunchEdit
punches.attestationPunchEdit boolean

A Boolean indicator of whether or not the punch is entered as an Attestation punch edit

markRelatedExceptionsAsReviewed
punches.markRelatedExceptionsAsReviewed boolean

If an Exception exists for a punch, a Boolean indicator of whether or not that Exception is resolved

editable
punches.editable boolean

A Boolean indicator of whether or not a pay code edit is editable

cancelDeduct
punches.cancelDeduct boolean

cancelDeduct

fromPhantomEdited
punches.fromPhantomEdited boolean

fromPhantomEdited

exceptionResolved
punches.exceptionResolved boolean

exceptionResolved

id
punches.typeOverride.id integer

Object Ref Id

qualifier
punches.typeOverride.qualifier string

Object Ref Unique qualifier

typeOverrideId
punches.typeOverride.typeOverrideId integer

The ID of the type override

description
punches.typeOverride.description string

Description of the type override

name
punches.typeOverride.name string

name

workedShifts
workedShifts array of object

A list of worked shift objects

id
workedShifts.id integer

Object Ref Id

id
workedShifts.employee.id integer

Object Ref Id

startDateTime
workedShifts.startDateTime string

The date and time of the start of the activity in ISO_LOCAL_DATE_TIME format (yyyy-MM-dd HH:mm:ss.SSS)

endDateTime
workedShifts.endDateTime string

The end date and time of a date range in ISO_LOCAL_DATE_TIME format (yyyy-mm-ddThh:mm:ss.sss)

id
workedShifts.startTimezone.id integer

Object Ref Id

id
workedShifts.endTimezone.id integer

Object Ref Id

roundedStartDateTime
workedShifts.roundedStartDateTime string

An optional field containing the start date and time based on configured rounding rules

roundedEndDateTime
workedShifts.roundedEndDateTime string

An optional field containing the end date and time based on configured rounding rules

id
workedShifts.roundedStartTimezone.id integer

Object Ref Id

id
workedShifts.roundedEndTimezone.id integer

Object Ref Id

transactionDateTime
workedShifts.transactionDateTime string

The date and time stamp for when this worked shift transaction was entered through the API

inProgress
workedShifts.inProgress boolean

A Boolean indicator that shows whether or not a Processed Segment is in progress

consolidatedScheduleSegments
workedShifts.consolidatedScheduleSegments boolean

A Boolean indicator of whether or not schedule segments of the worked shift have been consolidated

workedSpans
workedShifts.workedSpans array of object

Contains a list of workedSpan objects

id
workedShifts.workedSpans.id integer

id

itemId
workedShifts.workedSpans.itemId integer

The ID of the time item

spanId
workedShifts.workedSpans.spanId integer

The ID of the worked span

startDateTime
workedShifts.workedSpans.startDateTime string

The start date and time of a date range in ISO_LOCAL_DATE_TIME format (yyyy-mm-ddThh:mm:ss.sss)

endDateTime
workedShifts.workedSpans.endDateTime string

The end date and time of a date range in ISO_LOCAL_DATE_TIME format (yyyy-mm-ddThh:mm:ss.sss)

roundedStartDateTime
workedShifts.workedSpans.roundedStartDateTime string

An optional field containing the start date and time based on configured rounding rules

roundedEndDateTime
workedShifts.workedSpans.roundedEndDateTime string

An optional field containing the end date and time based on configured rounding rules

id
workedShifts.workedSpans.startTimezone.id integer

Object Ref Id

id
workedShifts.workedSpans.endTimezone.id integer

id

id
workedShifts.workedSpans.primaryOrgJob.id integer

Object Ref Id

qualifier
workedShifts.workedSpans.primaryOrgJob.qualifier string

Object Ref Unique qualifier

name
workedShifts.workedSpans.primaryOrgJob.name string

name

id
workedShifts.workedSpans.workRule.id integer

Object Ref Id

qualifier
workedShifts.workedSpans.workRule.qualifier string

Object Ref Unique qualifier

name
workedShifts.workedSpans.workRule.name string

name

id
workedShifts.workedSpans.primaryWorkRule.id integer

Object Ref Id

qualifier
workedShifts.workedSpans.primaryWorkRule.qualifier string

Object Ref Unique qualifier

name
workedShifts.workedSpans.primaryWorkRule.name string

name

orderNumber
workedShifts.workedSpans.orderNumber integer

The order number associated with an activity segment

id
workedShifts.workedSpans.startPunch.id integer

id

id
workedShifts.workedSpans.startPunch.employee.id integer

Object Ref Id

qualifier
workedShifts.workedSpans.startPunch.employee.qualifier string

Object Ref Unique qualifier

name
workedShifts.workedSpans.startPunch.employee.name string

name

punchDtm
workedShifts.workedSpans.startPunch.punchDtm string

The date and time stamp for the punch in ISO_LOCAL_DATE_TIME

roundedPunchDtm
workedShifts.workedSpans.startPunch.roundedPunchDtm string

The rounded punch date and time

id
workedShifts.workedSpans.startPunch.timeZone.id integer

Object Ref Id

qualifier
workedShifts.workedSpans.startPunch.timeZone.qualifier string

Object Ref Unique qualifier

name
workedShifts.workedSpans.startPunch.timeZone.name string

name

enteredOnDtm
workedShifts.workedSpans.startPunch.enteredOnDtm string

The date and time stamp for when this punch transaction was entered through the API

hasComments
workedShifts.workedSpans.startPunch.hasComments boolean

A Boolean indicator of whether or not a Comment is associated with an activity segment

id
workedShifts.workedSpans.startPunch.editByType.id integer

Object Ref Id

qualifier
workedShifts.workedSpans.startPunch.editByType.qualifier string

Object Ref Unique qualifier

name
workedShifts.workedSpans.startPunch.editByType.name string

name

id
workedShifts.workedSpans.startPunch.dataSource.id integer

Object Ref Id

qualifier
workedShifts.workedSpans.startPunch.dataSource.qualifier string

Object Ref Unique qualifier

displayName
workedShifts.workedSpans.startPunch.dataSource.displayName string

displayName

functionalAreaName
workedShifts.workedSpans.startPunch.dataSource.functionalAreaName string

functionalAreaName

name
workedShifts.workedSpans.startPunch.dataSource.name string

name

exceptions
workedShifts.workedSpans.startPunch.exceptions array of object

A list of exception objects associated with a punch

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

Object Ref Id

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

Object Ref Unique qualifier

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

name

startDateTime
workedShifts.workedSpans.startPunch.exceptions.startDateTime string

The date and time of the start of the activity in ISO_LOCAL_DATE_TIME format (yyyy-MM-dd HH:mm:ss.SSS)

endDateTime
workedShifts.workedSpans.startPunch.exceptions.endDateTime string

The date and time of the end of the activity in ISO_LOCAL_DATE_TIME format (yyyy-MM-dd HH:mm:ss.SSS)

applyDate
workedShifts.workedSpans.startPunch.exceptions.applyDate string

The apply date for an activity processed segment date range in ISO_LOCAL_DATE format (YYYY-MM-DD)

id
workedShifts.workedSpans.startPunch.exceptions.id integer

id

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

Object Ref Id

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

The ID of a Timekeeping exception type

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

The name of a Timekeeping exception type

description
workedShifts.workedSpans.startPunch.exceptions.exceptionType.description string

The description of a Timekeeping exception type

displayName
workedShifts.workedSpans.startPunch.exceptions.exceptionType.displayName string

The display name of a Timekeeping exception type

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

category

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

Object Ref Id

overLimitInHours
workedShifts.workedSpans.startPunch.exceptions.overLimitInHours number

The amount (in hours) that exceeds the limit defined by the exception associated with the pay code edit. This property is read only

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

Object Ref Id

violationInHours
workedShifts.workedSpans.startPunch.exceptions.violationInHours number

The total number of hours violated which caused an exception. This property is read only

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

Object Ref Id

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

Object Ref Unique qualifier

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

name

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

A reference to a list of Comments. This object can have multiple Comments with multiple Notes for each Comment. This property is read only

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

Object Ref Id

isExcusedAbsence
workedShifts.workedSpans.startPunch.exceptions.isExcusedAbsence boolean

A Boolean indicator of whether or not the exception involves an excused absence. This property is read only

isUnExcusedAbsence
workedShifts.workedSpans.startPunch.exceptions.isUnExcusedAbsence boolean

A Boolean indicator of whether or not the exception involves an unexcused absence. This property is read only

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

The ID of the missing time status ranging from 1 to 4

displayName
workedShifts.workedSpans.startPunch.exceptions.missingTimeStatus.displayName string

The localized missing time status display name

justifications
workedShifts.workedSpans.startPunch.exceptions.justifications array of

A list of missing time justifications for this exception. This property is read only

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

A list of justified times for this exception. This property is read only

transfer
workedShifts.workedSpans.startPunch.exceptions.transfer boolean

transfer

eventDate
workedShifts.workedSpans.startPunch.exceptions.eventDate string

eventDate

startException
workedShifts.workedSpans.startPunch.exceptions.startException boolean

startException

endException
workedShifts.workedSpans.startPunch.exceptions.endException boolean

endException

reviewed
workedShifts.workedSpans.startPunch.exceptions.reviewed boolean

reviewed

commentsNotes
workedShifts.workedSpans.startPunch.commentsNotes array of

A reference to a list of Comments. This object can have multiple Comments with multiple Notes for each Comment

isPhantom
workedShifts.workedSpans.startPunch.isPhantom boolean

A Boolean indicator of whether or not the punch is a phantom punch

isScheduled
workedShifts.workedSpans.startPunch.isScheduled boolean

A Boolean indicator of whether or not the punch is generated from a scheduled worked span

updatedOnDtm
workedShifts.workedSpans.startPunch.updatedOnDtm string

The date and time stamp for when this punch transaction was last updated

validateAsTimestamp
workedShifts.workedSpans.startPunch.validateAsTimestamp boolean

A Boolean indicator of whether or not the punch is entered as a timestamp

attestationPunchEdit
workedShifts.workedSpans.startPunch.attestationPunchEdit boolean

A Boolean indicator of whether or not the punch is entered as an Attestation punch edit

markRelatedExceptionsAsReviewed
workedShifts.workedSpans.startPunch.markRelatedExceptionsAsReviewed boolean

If an Exception exists for a punch, a Boolean indicator of whether or not that Exception is resolved

editable
workedShifts.workedSpans.startPunch.editable boolean

A Boolean indicator of whether or not a pay code edit is editable

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

Object Ref Id

qualifier
workedShifts.workedSpans.startPunch.workRule.qualifier string

Object Ref Unique qualifier

name
workedShifts.workedSpans.startPunch.workRule.name string

name

id
workedShifts.workedSpans.startPunch.typeOverride.id integer

Object Ref Id

qualifier
workedShifts.workedSpans.startPunch.typeOverride.qualifier string

Object Ref Unique qualifier

typeOverrideId
workedShifts.workedSpans.startPunch.typeOverride.typeOverrideId integer

The ID of the type override

description
workedShifts.workedSpans.startPunch.typeOverride.description string

dDescription of the type override

name
workedShifts.workedSpans.startPunch.typeOverride.name string

name

id
workedShifts.workedSpans.endPunch.id integer

id

id
workedShifts.workedSpans.endPunch.employee.id integer

Object Ref Id

qualifier
workedShifts.workedSpans.endPunch.employee.qualifier string

Object Ref Unique qualifier

name
workedShifts.workedSpans.endPunch.employee.name string

name

punchDtm
workedShifts.workedSpans.endPunch.punchDtm string

The date and time stamp for the punch in ISO_LOCAL_DATE_TIME

roundedPunchDtm
workedShifts.workedSpans.endPunch.roundedPunchDtm string

The rounded punch date and time

id
workedShifts.workedSpans.endPunch.timeZone.id integer

Object Ref Id

qualifier
workedShifts.workedSpans.endPunch.timeZone.qualifier string

Object Ref Unique qualifier

name
workedShifts.workedSpans.endPunch.timeZone.name string

name

enteredOnDtm
workedShifts.workedSpans.endPunch.enteredOnDtm string

The date and time stamp for when this punch transaction was entered through the API

hasComments
workedShifts.workedSpans.endPunch.hasComments boolean

A Boolean indicator of whether or not a Comment is associated with an activity segment

id
workedShifts.workedSpans.endPunch.editByType.id integer

Object Ref Id

qualifier
workedShifts.workedSpans.endPunch.editByType.qualifier string

Object Ref Unique qualifier

name
workedShifts.workedSpans.endPunch.editByType.name string

name

id
workedShifts.workedSpans.endPunch.dataSource.id integer

Object Ref Id

qualifier
workedShifts.workedSpans.endPunch.dataSource.qualifier string

Object Ref Unique qualifier

displayName
workedShifts.workedSpans.endPunch.dataSource.displayName string

displayName

functionalAreaName
workedShifts.workedSpans.endPunch.dataSource.functionalAreaName string

functionalAreaName

name
workedShifts.workedSpans.endPunch.dataSource.name string

name

exceptions
workedShifts.workedSpans.endPunch.exceptions array of object

A list of exception objects associated with a timecard

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

Object Ref Id

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

Object Ref Unique qualifier

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

name

startDateTime
workedShifts.workedSpans.endPunch.exceptions.startDateTime string

The start date and time of a justification in ISO_LOCAL_DATE_TIME format (yyyy-mm-ddThh:mm:ss.sss)

endDateTime
workedShifts.workedSpans.endPunch.exceptions.endDateTime string

The end date and time of a date range in ISO_LOCAL_DATE_TIME format (yyyy-mm-ddThh:mm:ss.sss). This property is read only

applyDate
workedShifts.workedSpans.endPunch.exceptions.applyDate string

The date to which an exception applies in ISO_LOCAL_DATE format (YYYY-MM-DD). This property is read only

id
workedShifts.workedSpans.endPunch.exceptions.id integer

id

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

Object Ref Id

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

The ID of a Timekeeping exception type

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

The name of a Timekeeping exception type

description
workedShifts.workedSpans.endPunch.exceptions.exceptionType.description string

The description of a Timekeeping exception type

displayName
workedShifts.workedSpans.endPunch.exceptions.exceptionType.displayName string

The display name of a Timekeeping exception type

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

The category of a Timekeeping exception type

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

Object Ref Id

overLimitInHours
workedShifts.workedSpans.endPunch.exceptions.overLimitInHours number

The amount (in hours) that exceeds the limit defined by the exception associated with the pay code edit. This property is read only

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

Object Ref Id

violationInHours
workedShifts.workedSpans.endPunch.exceptions.violationInHours number

The total number of hours violated which caused an exception. This property is read only

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

Object Ref Id

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

Object Ref Unique qualifier

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

name

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

A reference to a list of Comments. This object can have multiple Comments with multiple Notes for each Comment. This property is read only

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

Object Ref Id

isExcusedAbsence
workedShifts.workedSpans.endPunch.exceptions.isExcusedAbsence boolean

A Boolean indicator of whether or not the exception involves an excused absence. This property is read only

isUnExcusedAbsence
workedShifts.workedSpans.endPunch.exceptions.isUnExcusedAbsence boolean

A Boolean indicator of whether or not the exception involves an unexcused absence. This property is read only

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

The ID of the missing time status ranging from 1 to 4

displayName
workedShifts.workedSpans.endPunch.exceptions.missingTimeStatus.displayName string

The localized missing time status display name

justifications
workedShifts.workedSpans.endPunch.exceptions.justifications array of

A list of missing time justifications for this exception. This property is read only

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

A list of justified times for this exception. This property is read only

transfer
workedShifts.workedSpans.endPunch.exceptions.transfer boolean

transfer

eventDate
workedShifts.workedSpans.endPunch.exceptions.eventDate string

eventDate

startException
workedShifts.workedSpans.endPunch.exceptions.startException boolean

startException

endException
workedShifts.workedSpans.endPunch.exceptions.endException boolean

endException

reviewed
workedShifts.workedSpans.endPunch.exceptions.reviewed boolean

reviewed

commentsNotes
workedShifts.workedSpans.endPunch.commentsNotes array of

A reference to a list of Comments. This object can have multiple Comments with multiple Notes for each Comment

isPhantom
workedShifts.workedSpans.endPunch.isPhantom boolean

A Boolean indicator of whether or not the punch is a phantom punch

isScheduled
workedShifts.workedSpans.endPunch.isScheduled boolean

A Boolean indicator of whether or not the punch is generated from a scheduled worked span

updatedOnDtm
workedShifts.workedSpans.endPunch.updatedOnDtm string

The date and time stamp for when this punch transaction was last updated

validateAsTimestamp
workedShifts.workedSpans.endPunch.validateAsTimestamp boolean

validateAsTimestamp

attestationPunchEdit
workedShifts.workedSpans.endPunch.attestationPunchEdit boolean

A Boolean indicator of whether or not the punch is entered as an Attestation punch edit

markRelatedExceptionsAsReviewed
workedShifts.workedSpans.endPunch.markRelatedExceptionsAsReviewed boolean

markRelatedExceptionsAsReviewed

editable
workedShifts.workedSpans.endPunch.editable boolean

A Boolean indicator of whether or not a pay code edit is editable

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

Object Ref Id

qualifier
workedShifts.workedSpans.endPunch.workRule.qualifier string

Object Ref Unique qualifier

name
workedShifts.workedSpans.endPunch.workRule.name string

name

id
workedShifts.workedSpans.endPunch.typeOverride.id integer

Object Ref Id

qualifier
workedShifts.workedSpans.endPunch.typeOverride.qualifier string

Object Ref Unique qualifier

typeOverrideId
workedShifts.workedSpans.endPunch.typeOverride.typeOverrideId integer

The ID of the type override

description
workedShifts.workedSpans.endPunch.typeOverride.description string

Description of the type override

name
workedShifts.workedSpans.endPunch.typeOverride.name string

name

approvableByManager
workedShifts.workedSpans.approvableByManager boolean

A Boolean indicator of whether or not the worked span item is approvable by the logged-in manager

scheduledOrgJob
workedShifts.workedSpans.scheduledOrgJob boolean

scheduledOrgJob

scheduledWorkRule
workedShifts.workedSpans.scheduledWorkRule boolean

scheduledWorkRule

userEnteredOrgJob
workedShifts.workedSpans.userEnteredOrgJob boolean

A Boolean indicator of whether or not a business structure job for this shift segment was entered by the user

transferOrgJob
workedShifts.workedSpans.transferOrgJob boolean

A Boolean indicator of whether or not the business structure job is a transfer

userEnteredWorkRule
workedShifts.workedSpans.userEnteredWorkRule boolean

A Boolean indicator of whether or not a work rule for this shift segment was entered by the user

transferWorkRule
workedShifts.workedSpans.transferWorkRule boolean

transferWorkRule

projected
workedShifts.workedSpans.projected boolean

A Boolean indicator that shows whether or not a Processed Segment is projected

shiftTotalHours
workedShifts.shiftTotalHours number

Total number of hours for a worked shift

scheduledShiftIds
workedShifts.scheduledShiftIds array of integer

A list of scheduled shift IDs assiciated with pay code edits

projected
workedShifts.projected boolean

projected

fromSchedule
workedShifts.fromSchedule boolean

fromSchedule

unscheduledStartDateTime
workedShifts.unscheduledStartDateTime string

A string parameter that represents the start date and time for an unscheduled shift

unscheduledEndDateTime
workedShifts.unscheduledEndDateTime string

A string parameter that represents the end date and time for an unscheduled shift

payCodeEdits
payCodeEdits array of

A list of paycode edit objects

totals
totals array of object

A list of timecard totals associated with a timecard

id
totals.employeeContext.employee.id integer

Object Ref Id

qualifier
totals.employeeContext.employee.qualifier string

Object Ref Unique qualifier

name
totals.employeeContext.employee.name string

name

id
totals.employeeContext.timezone.id integer

Object Ref Id

qualifier
totals.employeeContext.timezone.qualifier string

Object Ref Unique qualifier

name
totals.employeeContext.timezone.name string

name

totalType
totals.totalContext.totalType string

totalType

totalAggregationType
totals.totalContext.totalAggregationType string

totalAggregationType

totalGroupByType
totals.totalContext.totalGroupByType string

totalGroupByType

aggregatedTotals
totals.aggregatedTotals array of object

A list of aggregated totals objects

approvableByManager
totals.aggregatedTotals.approvableByManager boolean

A Boolean indicator of whether or not the aggregated total is approvable by the logged-in manager

id
totals.aggregatedTotals.employee.id integer

Object Ref Id

qualifier
totals.aggregatedTotals.employee.qualifier string

Object Ref Unique qualifier

name
totals.aggregatedTotals.employee.name string

name

id
totals.aggregatedTotals.location.id integer

Object Ref Id

qualifier
totals.aggregatedTotals.location.qualifier string

Object Ref Unique qualifier

name
totals.aggregatedTotals.location.name string

name

id
totals.aggregatedTotals.job.id integer

Object Ref Id

qualifier
totals.aggregatedTotals.job.qualifier string

Object Ref Unique qualifier

name
totals.aggregatedTotals.job.name string

name

id
totals.aggregatedTotals.payCode.id integer

Object Ref Id

qualifier
totals.aggregatedTotals.payCode.qualifier string

Object Ref Unique qualifier

name
totals.aggregatedTotals.payCode.name string

name

amountType
totals.aggregatedTotals.amountType string

Reference to the AmountType object

amount
totals.aggregatedTotals.amount float

The amount of time of a worked shift

wages
totals.aggregatedTotals.wages float

The money amount calculated in totals as wages

amount
totals.aggregatedTotals.wagesCurrency.amount float

Monetary value

currencyCode
totals.aggregatedTotals.wagesCurrency.currencyCode string

Associate currency ISO code

jobTransfer
totals.aggregatedTotals.jobTransfer boolean

A Boolean indicator of whether or not the totals object contains a job transfer

laborCategoryTransfer
totals.aggregatedTotals.laborCategoryTransfer boolean

A Boolean indicator of whether or not the totals object contains a labor category

rate
totals.aggregatedTotals.rate number

The rate of the correlation between wage and amount

viewAccruals

Name Path Type Description
uniqueId
uniqueId string

The unique identifier for an absenceExceptionWithPosition object.

id
employee.id integer

Object Ref Id

qualifier
employee.qualifier string

Object Ref Unique qualifier

name
employee.name string

name

startDateTime
startDateTime string

The start date/time of the summary.

endDateTime
endDateTime string

The end date/time of the summary.

id
accrualCode.id integer

id

name
accrualCode.name string

name

shortName
accrualCode.shortName string

shortName

hoursPerDayInSeconds
accrualCode.hoursPerDayInSeconds integer

hoursPerDayInSeconds

typeId
accrualCode.typeId integer

typeId

allowEdit
accrualCode.allowEdit boolean

allowEdit

typeName
accrualCode.typeName string

typeName

hoursPerDay
accrualCode.hoursPerDay integer

hoursPerDay

effectiveDateRange
effectiveDateRange array of string

The effective date range of the accrual summary data.

dailySummaries
dailySummaries array of object

A reference to a list of AccrualDailySummaryData objects.

balanceDate
dailySummaries.balanceDate string

The date and time associated with the accrual daily summary data.

reportingPeriod
dailySummaries.reportingPeriod string

The reporting period of the accrual daily summary data.

balanceDate
dailySummaries.currentBalance.balanceDate string

The date and time associated with the accrual balance data.

vestedHoursAmount
dailySummaries.currentBalance.vestedHoursAmount float

The vested duration (in hours) of the accrual balance data.

probationHoursAmount
dailySummaries.currentBalance.probationHoursAmount integer

The probation duration (in hours) of the accrual balance data.

vestedDaysAmount
dailySummaries.currentBalance.vestedDaysAmount integer

The vested duration (in days) of the accrual balance data.

probationDaysAmount
dailySummaries.currentBalance.probationDaysAmount integer

The number of probation days.

plannedTakingHours
dailySummaries.plannedTakingHours integer

The planned taking (in hours) of the accrual daily summary data.

pendingGrantHours
dailySummaries.pendingGrantHours float

The pending grant (in hours) of the accrual daily summary data.

takingToDateHours
dailySummaries.takingToDateHours integer

The taking to date (in days) of the accrual daily summary data.

earnedToDateHours
dailySummaries.earnedToDateHours integer

The earned to date (in days) of the accrual daily summary data.

availableBalanceHours
dailySummaries.availableBalanceHours float

The available balance (in hours) of the accrual daily summary data.

plannedTakingDays
dailySummaries.plannedTakingDays integer

The planned taking (in days) of the accrual daily summary data.

pendingGrantDays
dailySummaries.pendingGrantDays integer

The pending grant (in days) of the accrual daily summary data.

takingToDateDays
dailySummaries.takingToDateDays integer

The taking to date (in days) of the accrual daily summary data.

earnedToDateDays
dailySummaries.earnedToDateDays integer

The earned to date (in days) of the accrual daily summary data.

availableBalanceDays
dailySummaries.availableBalanceDays integer

The available balance (in days) of the accrual daily summary data.

reportingPeriodSummaries
reportingPeriodSummaries array of object

A reference to a list of AccrualReportingPeriodSummaryData objects.

reportingPeriodSpan
reportingPeriodSummaries.reportingPeriodSpan string

The reporting period span of the accrual reporting period summary data.

balanceDate
reportingPeriodSummaries.priorEndingBalance.balanceDate string

The date and time associated with the accrual balance data.

vestedHoursAmount
reportingPeriodSummaries.priorEndingBalance.vestedHoursAmount float

The vested duration (in hours) of the accrual balance data.

probationHoursAmount
reportingPeriodSummaries.priorEndingBalance.probationHoursAmount integer

The probation duration (in hours) of the accrual balance data.

vestedDaysAmount
reportingPeriodSummaries.priorEndingBalance.vestedDaysAmount integer

The number of probation days.

probationDaysAmount
reportingPeriodSummaries.priorEndingBalance.probationDaysAmount integer

The number of probation days.

balanceDate
reportingPeriodSummaries.openingBalance.balanceDate string

The date and time associated with the accrual balance data.

vestedHoursAmount
reportingPeriodSummaries.openingBalance.vestedHoursAmount float

The vested duration (in hours) of the accrual balance data.

probationHoursAmount
reportingPeriodSummaries.openingBalance.probationHoursAmount integer

The probation duration (in hours) of the accrual balance data.

vestedDaysAmount
reportingPeriodSummaries.openingBalance.vestedDaysAmount integer

The vested duration (in days) of the accrual balance data.

probationDaysAmount
reportingPeriodSummaries.openingBalance.probationDaysAmount integer

The number of probation days.

balanceDate
reportingPeriodSummaries.endingBalance.balanceDate string

The date and time associated with the accrual balance data.

vestedHoursAmount
reportingPeriodSummaries.endingBalance.vestedHoursAmount float

The vested duration (in hours) of the accrual balance data.

probationHoursAmount
reportingPeriodSummaries.endingBalance.probationHoursAmount integer

The probation duration (in hours) of the accrual balance data.

vestedDaysAmount
reportingPeriodSummaries.endingBalance.vestedDaysAmount integer

The vested duration (in days) of the accrual balance data.

probationDaysAmount
reportingPeriodSummaries.endingBalance.probationDaysAmount integer

The number of probation days.

balanceDate
startingBalanceForPeriod.balanceDate string

The date and time associated with the accrual balance data.

vestedHoursAmount
startingBalanceForPeriod.vestedHoursAmount float

The vested duration (in hours) of the accrual balance data.

probationHoursAmount
startingBalanceForPeriod.probationHoursAmount integer

The probation duration (in hours) of the accrual balance data.

vestedDaysAmount
startingBalanceForPeriod.vestedDaysAmount integer

The vested duration (in days) of the accrual balance data.

probationDaysAmount
startingBalanceForPeriod.probationDaysAmount integer

The number of probation days.