Timekeeping paycodes
In this tutorial, we add, update, and remove paycode edits.
Paycode Edits
Paycode edits leverage the Timecard resource using the payCodeEdits array.
The following examples feature adding, updating, and removing paycode edits.
Add Paycode Edits
The manager calls the Update Timecard as Manager operation using the POST HTTP method to add a paycode edit.
- POST a request to the following URL:
https://<<hostName>>/api/v1/timekeeping/timecard - Include the standard Headers.
- Include an appropriate JSON call body. Refer to the examples below.
When constructing the JSON body of your request, keep the following points in mind:
- Use the payCodeEdits/added array
- In the array, provide the employee ID, paycode name, durationInHours, amountType, and applyDate
- The operation requires an employee ID with start and end dates and times or a symbolic period
- Set the property
onlyValidateto false, or the paycode edit is not saved
Example request
{
"where": {
"employee": {
"id": 309
},
"dateRange": {
"startDate": "2017-11-06T00:00",
"EndDate": "2017-11-12T00:00"
}
},
"do":
{
"payCodeEdits": {
"added": [
{
"employee": {
"id": 309
},
"paycode": {
"name": "Call Back"
},
"durationInHours": 3,
"amountType": "HOUR",
"applyDate": "2017-11-08"
}
]
},
"onlyValidate": false
}
}
Example response
{
"lastUpdates": [
{
"employeeId": 309,
"updateDateTime": "2018-02-08T02:52:24",
"updateByPersonFullName": "Ivan, Sean",
"isEditedInSignedOff": false
}
],
"projects": [],
"overtimeApprovals": [
{
"existingApprovalsOrDenials": [],
"unapprovedSegments": [],
"unapprovedAmount": 0,
"deniedAmount": 0
}
],
"punches": [
{
"id": 6001,
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"punchDtm": "2017-11-08T10:02:00",
"timeZone": {
"id": 134110,
"qualifier": "(GMT -05:00) Eastern Time (USA; Canada)",
"name": "(GMT -05:00) Eastern Time (USA; Canada)"
},
"enteredOnDtm": "2018-02-08T02:52:24",
"editByType": {
"id": -2
},
"dataSource": {
"id": 3275,
"qualifier": "Ivan, Sean",
"name": "Ivan, Sean"
},
"exceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"applyDate": "2017-11-08",
"id": 26456,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 17,
"name": "UNSCHEDULED",
"description": "UNSCHEDULED_DSC",
"displayName": "Unscheduled",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": true,
"endException": false
}
],
"commentsNotes": [],
"isPhantom": false,
"isScheduled": false,
"updatedOnDtm": "2018-02-08T02:52:24",
"exceptionResolved": false,
"editable": true
}
],
"workedShifts": [
{
"id": 30401,
"employee": {
"id": 309
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"startTimezone": {
"id": 134110
},
"endTimezone": {
"id": 134110
},
"roundedStartDateTime": "2017-11-08T10:02:00",
"roundedEndDateTime": "2017-11-08T10:02:00",
"roundedStartTimezone": {
"id": 134110
},
"roundedEndTimezone": {
"id": 134110
},
"unscheduledStartDateTime": "2017-11-08T10:02:00",
"unscheduledEndDateTime": "2017-11-08T18:02:00",
"unscheduledWorkRule": {
"id": 17
},
"inProgress": false,
"workedSpans": [
{
"id": 30401,
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"startTimezone": {
"id": 134110
},
"endTimezone": {
"id": 134110
},
"primaryOrgJob": {
"id": 440
},
"workRule": {
"id": 17
},
"primaryWorkRule": {
"id": 440
},
"orderNumber": 1,
"startPunch": {
"id": 6001,
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"punchDtm": "2017-11-08T10:02:00",
"timeZone": {
"id": 134110,
"qualifier": "(GMT -05:00) Eastern Time (USA; Canada)",
"name": "(GMT -05:00) Eastern Time (USA; Canada)"
},
"enteredOnDtm": "2018-02-08T02:52:24",
"editByType": {
"id": -2
},
"dataSource": {
"id": 3275,
"qualifier": "Ivan, Sean",
"name": "Ivan, Sean"
},
"exceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"applyDate": "2017-11-08",
"id": 26456,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 17,
"name": "UNSCHEDULED",
"description": "UNSCHEDULED_DSC",
"displayName": "Unscheduled",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": true,
"endException": false
}
],
"commentsNotes": [],
"isPhantom": false,
"isScheduled": false,
"updatedOnDtm": "2018-02-08T02:52:24",
"exceptionResolved": false,
"editable": true
},
"endPunch": {
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"typeOverride": {
"id": 4,
"qualifier": "Out Punch",
"typeOverrideId": 4,
"description": "Out Punch",
"name": "Out Punch"
},
"exceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T18:02:00",
"applyDate": "2017-11-08",
"id": 26522,
"exceptionType": {
"id": 16,
"name": "MISSED_OUT_PUNCH",
"description": "MISSED_OUT_PUNCH_DSC",
"displayName": "Missed Out Punch",
"category": "OUT_PUNCH_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": false,
"endException": true
}
],
"commentsNotes": [],
"isPhantom": true,
"isScheduled": false,
"exceptionResolved": false,
"editable": true
},
"scheduledOrgJob": false,
"scheduledWorkRule": false,
"userEnteredOrgJob": false,
"transferOrgJob": false,
"userEnteredWorkRule": false,
"transferWorkRule": false,
"projected": false
}
],
"shiftTotalHours": 0,
"scheduledShiftIds": [],
"projected": false,
"fromSchedule": false
}
],
"hoursWorked": [],
"payCodeEdits": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"paycode": {
"id": 784,
"qualifier": "Call Back",
"name": "Call Back"
},
"id": 2351,
"endDateTime": "2017-11-08T03:00:01",
"durationInHours": 3,
"amountType": "HOUR",
"scheduleAmountType": "AMOUNT_NOT_FROM_SCHEDULE",
"systemGenerated": false,
"editable": true,
"exceptions": [],
"commentsAvailable": false,
"commentsNotes": [],
"itemId": 30451,
"applyDate": "2017-11-08",
"editByType": {
"id": -2
}
}
],
"historicalCorrections": [],
"workHolidayCredits": [],
"exceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"applyDate": "2017-11-08",
"id": 26456,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 17,
"name": "UNSCHEDULED",
"description": "UNSCHEDULED_DSC",
"displayName": "Unscheduled",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workedShift": {
"id": -12
},
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": true,
"endException": false
},
...
],
"extendedExceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"applyDate": "2017-11-08",
"id": 26456,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 17,
"name": "UNSCHEDULED",
"description": "UNSCHEDULED_DSC",
"displayName": "Unscheduled",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workedShift": {
"id": -12
},
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"actualDateTime": "2017-11-08T10:02:00",
"comments": "",
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": true,
"endException": false
},
...
],
"dailyTotals": [
{
"id": 30401,
"durationInHours": 0,
"wages": 0,
"durationInDays": 0,
"timeItemId": 30401,
"amountType": "HOUR",
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"applyDate": "2017-11-08",
"fromShift": true,
"totalType": "HOURSANDCOST"
},
...
],
"totals": [
{
"employeeContext": {
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"timezone": {
"id": 13411,
"qualifier": "(GMT -05:00) Eastern Time (USA; Canada)",
"name": "(GMT -05:00) Eastern Time (USA; Canada)"
}
},
"totalContext": {
"totalType": "Actual totals",
"totalAggregationType": "All",
"totalGroupByType": "All"
},
"aggregatedTotals": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"location": {
"id": 440,
"qualifier": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse",
"name": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse"
},
"job": {
"id": 440,
"qualifier": "RN",
"name": "RN"
},
"payCode": {
"id": 784,
"qualifier": "Call Back",
"name": "Call Back"
},
"amount": 3,
"wages": 0,
"jobTransfer": false,
"laborCategoryTransfer": false,
"timeItemType": {}
}
]
}
],
"dailyTotalSummary": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"applyDate": "2017-11-08",
"cumulativeTotal": 10800,
"dailyTotalAmount": {
"HOUR": 10800
},
"hoursAndCostSummaries": {
"HOUR": [
{
"id": 30401,
"durationInHours": 0,
"wages": 0,
"durationInDays": 0,
"timeItemId": 30401,
"amountType": "HOUR",
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"applyDate": "2017-11-08",
"fromShift": true,
"totalType": "HOURSANDCOST"
},
{
"id": 30451,
"durationInHours": 3,
"wages": 99,
"durationInDays": 0,
"amountType": "HOUR",
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"applyDate": "2017-11-08",
"fromShift": false,
"totalType": "HOURSANDCOST"
}
]
}
},
...
],
"itemTotals": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"itemId": 30401,
"startApplyDate": "2017-11-08",
"endApplyDate": "2017-11-08",
"itemHours": 0
},
]
}
Update Paycode Edits
The manager calls the Update Timecard as Manager operation using the POST HTTP method to update a paycode edit.
- POST a request to the following URL:
https://<<hostName>>/api/v1/timekeeping/timecard - Include the standard Headers.
- Include an appropriate JSON call body. Refer to the examples below.
When constructing the JSON body of your request, keep the following points in mind:
- Use the payCodeEdits/updated array
- In the array, provide the employee ID, paycode name, durationInHours, amountType, and applyDate
- The operation requires an employee ID with start and end dates and times or a symbolic period
- Set the property
onlyValidateto false, or the paycode edit is not saved
Example request
{
"where": {
"employee": {
"id": 309
},
"dateRange": {
"startDate": "2017-11-06T00:00",
"EndDate": "2017-11-12T00:00"
}
},
"do":
{
"payCodeEdits": {
"updated": [
{
"employee": {
"id": 309
},
"paycode": {
"name": "Call Back"
},
"durationInHours": 2,
"amountType": "HOUR",
"applyDate": "2017-11-08"
}
]
},
"onlyValidate": false
}
}
Example response
{
"lastUpdates": [
{
"employeeId": 309,
"updateDateTime": "2018-02-08T02:52:24",
"updateByPersonFullName": "Ivan, Sean",
"isEditedInSignedOff": false
}
],
"projects": [],
"overtimeApprovals": [
{
"existingApprovalsOrDenials": [],
"unapprovedSegments": [],
"unapprovedAmount": 0,
"deniedAmount": 0
}
],
"punches": [
{
"id": 6001,
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"punchDtm": "2017-11-08T10:02:00",
"timeZone": {
"id": 134110,
"qualifier": "(GMT -05:00) Eastern Time (USA; Canada)",
"name": "(GMT -05:00) Eastern Time (USA; Canada)"
},
"enteredOnDtm": "2018-02-08T02:52:24",
"editByType": {
"id": -2
},
"dataSource": {
"id": 3275,
"qualifier": "Ivan, Sean",
"name": "Ivan, Sean"
},
"exceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"applyDate": "2017-11-08",
"id": 26456,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 17,
"name": "UNSCHEDULED",
"description": "UNSCHEDULED_DSC",
"displayName": "Unscheduled",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": true,
"endException": false
}
],
"commentsNotes": [],
"isPhantom": false,
"isScheduled": false,
"updatedOnDtm": "2018-02-08T02:52:24",
"exceptionResolved": false,
"editable": true
}
],
"workedShifts": [
{
"id": 30401,
"employee": {
"id": 309
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"startTimezone": {
"id": 134110
},
"endTimezone": {
"id": 134110
},
"roundedStartDateTime": "2017-11-08T10:02:00",
"roundedEndDateTime": "2017-11-08T10:02:00",
"roundedStartTimezone": {
"id": 134110
},
"roundedEndTimezone": {
"id": 134110
},
"unscheduledStartDateTime": "2017-11-08T10:02:00",
"unscheduledEndDateTime": "2017-11-08T18:02:00",
"unscheduledWorkRule": {
"id": 17
},
"inProgress": false,
"workedSpans": [
{
"id": 30401,
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"startTimezone": {
"id": 134110
},
"endTimezone": {
"id": 134110
},
"primaryOrgJob": {
"id": 440
},
"workRule": {
"id": 17
},
"primaryWorkRule": {
"id": 440
},
"orderNumber": 1,
"startPunch": {
"id": 6001,
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"punchDtm": "2017-11-08T10:02:00",
"timeZone": {
"id": 134110,
"qualifier": "(GMT -05:00) Eastern Time (USA; Canada)",
"name": "(GMT -05:00) Eastern Time (USA; Canada)"
},
"enteredOnDtm": "2018-02-08T02:52:24",
"editByType": {
"id": -2
},
"dataSource": {
"id": 3275,
"qualifier": "Ivan, Sean",
"name": "Ivan, Sean"
},
"exceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"applyDate": "2017-11-08",
"id": 26456,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 17,
"name": "UNSCHEDULED",
"description": "UNSCHEDULED_DSC",
"displayName": "Unscheduled",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": true,
"endException": false
}
],
"commentsNotes": [],
"isPhantom": false,
"isScheduled": false,
"updatedOnDtm": "2018-02-08T02:52:24",
"exceptionResolved": false,
"editable": true
},
"endPunch": {
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"typeOverride": {
"id": 4,
"qualifier": "Out Punch",
"typeOverrideId": 4,
"description": "Out Punch",
"name": "Out Punch"
},
"exceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T18:02:00",
"applyDate": "2017-11-08",
"id": 26522,
"exceptionType": {
"id": 16,
"name": "MISSED_OUT_PUNCH",
"description": "MISSED_OUT_PUNCH_DSC",
"displayName": "Missed Out Punch",
"category": "OUT_PUNCH_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": false,
"endException": true
}
],
"commentsNotes": [],
"isPhantom": true,
"isScheduled": false,
"exceptionResolved": false,
"editable": true
},
"scheduledOrgJob": false,
"scheduledWorkRule": false,
"userEnteredOrgJob": false,
"transferOrgJob": false,
"userEnteredWorkRule": false,
"transferWorkRule": false,
"projected": false
}
],
"shiftTotalHours": 0,
"scheduledShiftIds": [],
"projected": false,
"fromSchedule": false
}
],
"hoursWorked": [],
"payCodeEdits": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"paycode": {
"id": 784,
"qualifier": "Call Back",
"name": "Call Back"
},
"id": 2351,
"endDateTime": "2017-11-08T03:00:01",
"durationInHours": 2,
"amountType": "HOUR",
"scheduleAmountType": "AMOUNT_NOT_FROM_SCHEDULE",
"systemGenerated": false,
"editable": true,
"exceptions": [],
"commentsAvailable": false,
"commentsNotes": [],
"itemId": 30451,
"applyDate": "2017-11-08",
"editByType": {
"id": -2
}
}
],
"historicalCorrections": [],
"workHolidayCredits": [],
"exceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"applyDate": "2017-11-08",
"id": 26456,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 17,
"name": "UNSCHEDULED",
"description": "UNSCHEDULED_DSC",
"displayName": "Unscheduled",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workedShift": {
"id": -12
},
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": true,
"endException": false
},
...
],
"extendedExceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"applyDate": "2017-11-08",
"id": 26456,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 17,
"name": "UNSCHEDULED",
"description": "UNSCHEDULED_DSC",
"displayName": "Unscheduled",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workedShift": {
"id": -12
},
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"actualDateTime": "2017-11-08T10:02:00",
"comments": "",
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": true,
"endException": false
},
...
],
"dailyTotals": [
{
"id": 30401,
"durationInHours": 0,
"wages": 0,
"durationInDays": 0,
"timeItemId": 30401,
"amountType": "HOUR",
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"applyDate": "2017-11-08",
"fromShift": true,
"totalType": "HOURSANDCOST"
},
...
],
"totals": [
{
"employeeContext": {
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"timezone": {
"id": 13411,
"qualifier": "(GMT -05:00) Eastern Time (USA; Canada)",
"name": "(GMT -05:00) Eastern Time (USA; Canada)"
}
},
"totalContext": {
"totalType": "Actual totals",
"totalAggregationType": "All",
"totalGroupByType": "All"
},
"aggregatedTotals": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"location": {
"id": 440,
"qualifier": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse",
"name": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse"
},
"job": {
"id": 440,
"qualifier": "RN",
"name": "RN"
},
"payCode": {
"id": 784,
"qualifier": "Call Back",
"name": "Call Back"
},
"amount": 3,
"wages": 0,
"jobTransfer": false,
"laborCategoryTransfer": false,
"timeItemType": {}
}
]
}
],
"dailyTotalSummary": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"applyDate": "2017-11-08",
"cumulativeTotal": 10800,
"dailyTotalAmount": {
"HOUR": 10800
},
"hoursAndCostSummaries": {
"HOUR": [
{
"id": 30401,
"durationInHours": 0,
"wages": 0,
"durationInDays": 0,
"timeItemId": 30401,
"amountType": "HOUR",
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"applyDate": "2017-11-08",
"fromShift": true,
"totalType": "HOURSANDCOST"
},
{
"id": 30451,
"durationInHours": 3,
"wages": 99,
"durationInDays": 0,
"amountType": "HOUR",
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"applyDate": "2017-11-08",
"fromShift": false,
"totalType": "HOURSANDCOST"
}
]
}
},
...
],
"itemTotals": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"itemId": 30401,
"startApplyDate": "2017-11-08",
"endApplyDate": "2017-11-08",
"itemHours": 0
},
]
}
Remove Paycode Edits
The manager calls the Update Timecard as Manager operation using the POST HTTP method to remove a paycode edit.
- POST a request to the following URL:
https://<<hostName>>/api/v1/timekeeping/timecard - Include the standard Headers.
- Include an appropriate JSON call body. Refer to the examples below.
When constructing the JSON body of your request, keep the following points in mind:
- Use the payCodeEdits/removed array
- In the array, provide the employee ID, paycode name, durationInHours, amountType, and applyDate
- The operation requires an employee ID with start and end dates and times or a symbolic period
- Set the property
onlyValidateto false, or the removed paycode edit is not saved
Example request
{
"where": {
"employee": {
"id": 309
},
"dateRange": {
"startDate": "2017-11-06T00:00",
"EndDate": "2017-11-12T00:00"
}
},
"do":
{
"payCodeEdits": {
"removed": [
{
"employee": {
"id": 309
},
"paycode": {
"name": "Call Back"
},
"durationInHours": 3,
"amountType": "HOUR",
"applyDate": "2017-11-08"
}
]
},
"onlyValidate": false
}
}
Example response
{
"lastUpdates": [
{
"employeeId": 309,
"updateDateTime": "2018-02-08T02:52:24",
"updateByPersonFullName": "Ivan, Sean",
"isEditedInSignedOff": false
}
],
"projects": [],
"overtimeApprovals": [
{
"existingApprovalsOrDenials": [],
"unapprovedSegments": [],
"unapprovedAmount": 0,
"deniedAmount": 0
}
],
"punches": [
{
"id": 6001,
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"punchDtm": "2017-11-08T10:02:00",
"timeZone": {
"id": 134110,
"qualifier": "(GMT -05:00) Eastern Time (USA; Canada)",
"name": "(GMT -05:00) Eastern Time (USA; Canada)"
},
"enteredOnDtm": "2018-02-08T02:52:24",
"editByType": {
"id": -2
},
"dataSource": {
"id": 3275,
"qualifier": "Ivan, Sean",
"name": "Ivan, Sean"
},
"exceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"applyDate": "2017-11-08",
"id": 26456,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 17,
"name": "UNSCHEDULED",
"description": "UNSCHEDULED_DSC",
"displayName": "Unscheduled",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": true,
"endException": false
}
],
"commentsNotes": [],
"isPhantom": false,
"isScheduled": false,
"updatedOnDtm": "2018-02-08T02:52:24",
"exceptionResolved": false,
"editable": true
}
],
"workedShifts": [
{
"id": 30401,
"employee": {
"id": 309
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"startTimezone": {
"id": 134110
},
"endTimezone": {
"id": 134110
},
"roundedStartDateTime": "2017-11-08T10:02:00",
"roundedEndDateTime": "2017-11-08T10:02:00",
"roundedStartTimezone": {
"id": 134110
},
"roundedEndTimezone": {
"id": 134110
},
"unscheduledStartDateTime": "2017-11-08T10:02:00",
"unscheduledEndDateTime": "2017-11-08T18:02:00",
"unscheduledWorkRule": {
"id": 17
},
"inProgress": false,
"workedSpans": [
{
"id": 30401,
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"startTimezone": {
"id": 134110
},
"endTimezone": {
"id": 134110
},
"primaryOrgJob": {
"id": 440
},
"workRule": {
"id": 17
},
"primaryWorkRule": {
"id": 440
},
"orderNumber": 1,
"startPunch": {
"id": 6001,
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"punchDtm": "2017-11-08T10:02:00",
"timeZone": {
"id": 134110,
"qualifier": "(GMT -05:00) Eastern Time (USA; Canada)",
"name": "(GMT -05:00) Eastern Time (USA; Canada)"
},
"enteredOnDtm": "2018-02-08T02:52:24",
"editByType": {
"id": -2
},
"dataSource": {
"id": 3275,
"qualifier": "Ivan, Sean",
"name": "Ivan, Sean"
},
"exceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"applyDate": "2017-11-08",
"id": 26456,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 17,
"name": "UNSCHEDULED",
"description": "UNSCHEDULED_DSC",
"displayName": "Unscheduled",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": true,
"endException": false
}
],
"commentsNotes": [],
"isPhantom": false,
"isScheduled": false,
"updatedOnDtm": "2018-02-08T02:52:24",
"exceptionResolved": false,
"editable": true
},
"endPunch": {
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"typeOverride": {
"id": 4,
"qualifier": "Out Punch",
"typeOverrideId": 4,
"description": "Out Punch",
"name": "Out Punch"
},
"exceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T18:02:00",
"applyDate": "2017-11-08",
"id": 26522,
"exceptionType": {
"id": 16,
"name": "MISSED_OUT_PUNCH",
"description": "MISSED_OUT_PUNCH_DSC",
"displayName": "Missed Out Punch",
"category": "OUT_PUNCH_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": false,
"endException": true
}
],
"commentsNotes": [],
"isPhantom": true,
"isScheduled": false,
"exceptionResolved": false,
"editable": true
},
"scheduledOrgJob": false,
"scheduledWorkRule": false,
"userEnteredOrgJob": false,
"transferOrgJob": false,
"userEnteredWorkRule": false,
"transferWorkRule": false,
"projected": false
}
],
"shiftTotalHours": 0,
"scheduledShiftIds": [],
"projected": false,
"fromSchedule": false
}
],
"hoursWorked": [],
"payCodeEdits": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"paycode": {
"id": 784,
"qualifier": "Call Back",
"name": "Call Back"
},
"id": 2351,
"endDateTime": "2017-11-08T03:00:01",
"durationInHours": 3,
"amountType": "HOUR",
"scheduleAmountType": "AMOUNT_NOT_FROM_SCHEDULE",
"systemGenerated": false,
"editable": true,
"exceptions": [],
"commentsAvailable": false,
"commentsNotes": [],
"itemId": 30451,
"applyDate": "2017-11-08",
"editByType": {
"id": -2
}
},
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"paycode": {
"id": 784,
"qualifier": "Call Back",
"name": "Call Back"
},
"id": 2352,
"endDateTime": "2017-11-08T03:00:01",
"durationInHours": 3,
"amountType": "HOUR",
"scheduleAmountType": "AMOUNT_NOT_FROM_SCHEDULE",
"systemGenerated": false,
"editable": true,
"exceptions": [],
"commentsAvailable": false,
"commentsNotes": [],
"itemId": 30452,
"applyDate": "2017-11-08",
"editByType": {
"id": -2
}
},
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"paycode": {
"id": 784,
"qualifier": "Call Back",
"name": "Call Back"
},
"id": 2353,
"endDateTime": "2017-11-08T03:00:01",
"durationInHours": 3,
"amountType": "HOUR",
"scheduleAmountType": "AMOUNT_NOT_FROM_SCHEDULE",
"systemGenerated": false,
"editable": true,
"exceptions": [],
"commentsAvailable": false,
"commentsNotes": [],
"itemId": 30453,
"applyDate": "2017-11-08",
"editByType": {
"id": -2
}
}
],
"historicalCorrections": [],
"workHolidayCredits": [],
"exceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"applyDate": "2017-11-08",
"id": 26456,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 17,
"name": "UNSCHEDULED",
"description": "UNSCHEDULED_DSC",
"displayName": "Unscheduled",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workedShift": {
"id": -12
},
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": true,
"endException": false
},
...
],
"extendedExceptions": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"startDateTime": "2017-11-08T10:02:00",
"endDateTime": "2017-11-08T10:02:00",
"applyDate": "2017-11-08",
"id": 26456,
"endTimeZone": {
"id": 134110
},
"exceptionType": {
"id": 17,
"name": "UNSCHEDULED",
"description": "UNSCHEDULED_DSC",
"displayName": "Unscheduled",
"category": "SHIFT_EXCEPTIONS"
},
"orgJob": {
"id": 440
},
"overLimitInHours": 0,
"startTimeZone": {
"id": 134110
},
"violationInHours": 0,
"workedShift": {
"id": -12
},
"workRule": {
"id": 17,
"qualifier": "Full Time",
"name": "Full Time"
},
"commentsNotes": [],
"punchEvent": {
"id": 30401
},
"isExcusedAbsence": false,
"isUnExcusedAbsence": false,
"actualDateTime": "2017-11-08T10:02:00",
"comments": "",
"reviewed": false,
"transfer": false,
"eventDate": "2017-11-08",
"startException": true,
"endException": false
},
...
],
"dailyTotals": [
{
"id": 30401,
"durationInHours": 0,
"wages": 0,
"durationInDays": 0,
"timeItemId": 30401,
"amountType": "HOUR",
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"applyDate": "2017-11-08",
"fromShift": true,
"totalType": "HOURSANDCOST"
},
...
],
"totals": [
{
"employeeContext": {
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"timezone": {
"id": 13411,
"qualifier": "(GMT -05:00) Eastern Time (USA; Canada)",
"name": "(GMT -05:00) Eastern Time (USA; Canada)"
}
},
"totalContext": {
"totalType": "Actual totals",
"totalAggregationType": "All",
"totalGroupByType": "All"
},
"aggregatedTotals": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"location": {
"id": 440,
"qualifier": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse",
"name": "Organization/Metropolitan Hospital/Clin Op/WMNB/Labor/Nurse"
},
"job": {
"id": 440,
"qualifier": "RN",
"name": "RN"
},
"payCode": {
"id": 784,
"qualifier": "Call Back",
"name": "Call Back"
},
"amount": 9,
"wages": 0,
"jobTransfer": false,
"laborCategoryTransfer": false,
"timeItemType": {}
}
]
}
],
"dailyTotalSummary": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"applyDate": "2017-11-08",
"cumulativeTotal": 32400,
"dailyTotalAmount": {
"HOUR": 32400
},
"hoursAndCostSummaries": {
"HOUR": [
{
"id": 30401,
"durationInHours": 0,
"wages": 0,
"durationInDays": 0,
"timeItemId": 30401,
"amountType": "HOUR",
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"applyDate": "2017-11-08",
"fromShift": true,
"totalType": "HOURSANDCOST"
},
{
"id": 30451,
"durationInHours": 3,
"wages": 99,
"durationInDays": 0,
"amountType": "HOUR",
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"applyDate": "2017-11-08",
"fromShift": false,
"totalType": "HOURSANDCOST"
},
{
"id": 30452,
"durationInHours": 3,
"wages": 99,
"durationInDays": 0,
"amountType": "HOUR",
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"applyDate": "2017-11-08",
"fromShift": false,
"totalType": "HOURSANDCOST"
},
{
"id": 30453,
"durationInHours": 3,
"wages": 99,
"durationInDays": 0,
"amountType": "HOUR",
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"applyDate": "2017-11-08",
"fromShift": false,
"totalType": "HOURSANDCOST"
}
]
}
},
...
],
"itemTotals": [
{
"employee": {
"id": 309,
"qualifier": "20000",
"name": "20000"
},
"itemId": 30401,
"startApplyDate": "2017-11-08",
"endApplyDate": "2017-11-08",
"itemHours": 0
},
...
]
}
Updated over 1 year ago