Fair Work Week and the Deputy API
Ongoing Development
The Fair Work Week initiative is an ongoing development in the Deputy product. You should visit this page frequently to find the most recent up to date API information surrounding the Fair Work Week features in Deputy.
As part of the Fair Work Week initiative in certain States and business sectors in the United States, Deputy has added a number of features to help clients comply with these regulations.
What is Fair Work Week
Several large cities and one state in the U.S. have enacted Fair Work Week laws. The intent behind these laws is to provide shift workers with predictable, stable work schedules and protect workers from unfair scheduling practices.
These laws are complex and, in the event a business does not comply, they may be liable for substantial fines and penalties. Fortunately, Deputy is here to help businesses with tools to aid in compliance with the laws.
Of particular note for Payroll, vendors is that Fair Work Week comes with a number of additional predictability pay premiums that get added when an employee’s schedule is changed with reduced notice. As Deputy is the source of truth for schedule changes, these calculated premiums need to be exported from Deputy.
Some information about Fair Work Week and the implementation within the Deputy product can be found here
General Fair Work Week Information
Applying Fair Work Week Pay Rates
New York City Fast Food Regulation Help Documentation
Along with these product changes, more data elements are now present in the timesheet API data when the user has Fair Work Week features enabled in Deputy.
TimesheetPayReturn Endpoint
The primary way you will be able to access Fair Work Week specific related data is the existing TimesheetPayReturn endpoint. If you have already built a payroll integration to Deputy, you would be aware that this endpoint returns the costings for the Timesheet broken down by export code and works hand in hand with the main Timesheet endpoint.
To assist with your development below is an example which shows you where changes have been made and how you can access this data.
Timesheets
The below example assumes you have already pulled out the initial Timesheet data from Deputy using the Timesheetsendpoint.
Once you have a list of timesheets you need the costings data for, you can retrieve those using the TimesheetsPayReturn endpoint.
curl --request POST --url 'https://{install}.{geo}.deputy.com/api/v1/resource/TimesheetPayReturn/QUERY'
Include this in the POST body
{
"search": {
"s1": {"field": "Timesheet", "data": 122, "type": "eq" }
},
"join": ["TimesheetObject", "PayRuleObject"]
}
Those who have previously implemented a payroll integration into Deputy are likely familiar with this format. In it we are requesting the TimesheetPayReturn linked to the Timesheet with the id of 122 and also attaching the linked TimesheetObject and PayRuleObject to ensure we have all the data required for payroll.
Here is a sample response to this request including some Fair Work Week information
[
{
"Id": 471,
"Timesheet": 122,
"PayRule": 234,
"Overridden": false,
"Value": 5.5,
"Cost": 88,
"OverrideComment": "",
"Creator": 446,
"Created": "2024-01-03T16:52:41-05:00",
"Modified": "2024-01-03T16:52:41-05:00",
"EventIds": null,
"_DPMetaData": {
"System": "TimesheetPayReturn",
"CreatorInfo": {
"Id": 446,
"DisplayName": "Chris Knight",
"EmployeeProfile": 446,
"Employee": 446,
"Photo": "https://photo2.deputy.com/deputec_b181016092617_7890/-135x135_40c2a595a5b33d9373eed55025ebafa5.jpg?Expires=1704473507&Signature=HCHkVYL9Da3UmEwxpnLPDwPxZcTVng0vB4CdCh6e5ZaNR8Q1I~Nddu5ebdIIbjUMlDVvP5jXzIgB3PJYYn~hT3Hp0VeT24YqJKkyKgrHgr9EH4VJ7pM6Z-bkD7oYVaGxNCMHRHGXAt7sSpCZ4VA-kah77NazQIk4wyk9qTsQMsg_&Key-Pair-Id=APKAINP5UVPK4IGBHXOQ",
"Pronouns": 0,
"CustomPronouns": ""
}
},
"TimesheetObject": {
"Id": 122,
"Employee": 441,
"EmployeeHistory": 2994,
"EmployeeAgreement": 813,
"Date": "2023-12-07T00:00:00-05:00",
"StartTime": 1701986400,
"EndTime": 1702008000,
"Mealbreak": "2023-12-07T00:30:00-05:00",
"MealbreakSlots": "",
"Slots": [
{
"blnEmptySlot": false,
"strType": "B",
"intStart": 0,
"intEnd": 1800,
"intUnixStart": 1701986400,
"intUnixEnd": 1701988200,
"mixedActivity": {
"intState": 4,
"blnCanStartEarly": 1,
"blnCanEndEarly": 1,
"blnIsMandatory": 1,
"strBreakType": "M"
},
"strTypeName": "Meal Break",
"strState": "Finished Duration"
}
],
"TotalTime": 5.5,
"TotalTimeInv": 5.5,
"Cost": 120,
"Roster": 357,
"EmployeeComment": null,
"SupervisorComment": null,
"Supervisor": null,
"Disputed": false,
"TimeApproved": true,
"TimeApprover": 446,
"Discarded": null,
"ValidationFlag": 0,
"OperationalUnit": 27,
"IsInProgress": null,
"IsLeave": false,
"LeaveId": null,
"LeaveRule": null,
"Invoiced": false,
"InvoiceComment": null,
"PayRuleApproved": true,
"Exported": null,
"StagingId": null,
"PayStaged": false,
"PaycycleId": 5157,
"MarkedPaidUnpaidAt": "",
"AccrualState": null,
"AccrualStateChangedAt": null,
"AccrualAttempts": null,
"File": null,
"CustomFieldData": 102,
"RealTime": false,
"AutoProcessed": false,
"AutoRounded": false,
"AutoTimeApproved": false,
"AutoPayRuleApproved": false,
"Metadata": "{\"borrowed_or_lent\":false,\"forecast_cost\":0}",
"ParentId": null,
"Creator": 446,
"Created": "2024-01-03T16:52:41-05:00",
"Modified": "2024-01-03T16:52:41-05:00",
"StartTimeLocalized": "2023-12-07T17:00:00-05:00",
"EndTimeLocalized": "2023-12-07T23:00:00-05:00",
"OnCost": 120,
"_DPMetaData": {
"System": "Timesheet",
"CreatorInfo": {
"Id": 446,
"DisplayName": "Chris Knight",
"EmployeeProfile": 446,
"Employee": 446,
"Photo": "https://photo2.deputy.com/deputec_b181016092617_7890/-135x135_40c2a595a5b33d9373eed55025ebafa5.jpg?Expires=1704473507&Signature=HCHkVYL9Da3UmEwxpnLPDwPxZcTVng0vB4CdCh6e5ZaNR8Q1I~Nddu5ebdIIbjUMlDVvP5jXzIgB3PJYYn~hT3Hp0VeT24YqJKkyKgrHgr9EH4VJ7pM6Z-bkD7oYVaGxNCMHRHGXAt7sSpCZ4VA-kah77NazQIk4wyk9qTsQMsg_&Key-Pair-Id=APKAINP5UVPK4IGBHXOQ",
"Pronouns": 0,
"CustomPronouns": ""
},
"OperationalUnitInfo": {
"Id": 27,
"OperationalUnitName": "Manager",
"Company": 12,
"CompanyName": "5th Ave",
"LabelWithCompany": "[UNQNY] Manager"
},
"EmployeeInfo": {
"Id": 441,
"DisplayName": "Asim Siddiqi",
"EmployeeProfile": 441,
"Employee": 441,
"Photo": "https://photo2.deputy.com/deputec_b181016092617_7890/-135x135_47bee8e6bfc2207329bb0de4638b129f.jpg?Expires=1704473507&Signature=NZk4s7svFme9kZgJMN0OioIP602lw2x4APSrEiW4CGDv1mjFkToR1yjy4-rnfQi5pslFkVRD8J41OFlEe9dlNBxlNaFm9zCq3-yYMpScOPJ~vNZpiFNDcUSYJ1M8W3mt8Reg1pxHWpZ5Jr5~nfghr8q9DndwsUlQrGOG6pcLCSw_&Key-Pair-Id=APKAINP5UVPK4IGBHXOQ",
"Pronouns": 0,
"CustomPronouns": ""
},
"CustomFieldData": {
"Id": 102,
"System": "Timesheet",
"F01": "",
"F02": "",
"F03": "",
"F04": false,
"F05": false,
"F06": "",
"F07": false,
"F08": false,
"F09": "",
"F10": "",
"F11": "",
"F12": "",
"F13": "",
"F14": "",
"F15": false,
"F16": false,
"F17": "",
"F18": "",
"Creator": 446,
"Created": "2024-01-03T16:52:41-05:00",
"Modified": "2024-01-03T16:52:41-05:00",
"leavingearly": "",
"leavinglate": "",
"cominginlate": "",
"agreedtostaylate": false,
"clopeningshift": false,
"consent": "",
"receivedallmealbreaks": false,
"receivedallrestbreaks": false,
"consent2": "",
"fwwagreedtoextendshift": "",
"fwwcominginearly": "",
"fwwcominginlate": "",
"fwwleavingearly": "",
"fwwleavinglate": "",
"fwwreceivedallmealbreaks": false,
"fwwreceivedallrestbreaks": false,
"fwwunscheduledshiftconsent": "",
"fwwunscheduledshifthours": "",
"_DPMetaData": {
"System": "CustomFieldData",
"CreatorInfo": {
"Id": 446,
"DisplayName": "Chris Knight",
"EmployeeProfile": 446,
"Employee": 446,
"Photo": "https://photo2.deputy.com/deputec_b181016092617_7890/-135x135_40c2a595a5b33d9373eed55025ebafa5.jpg?Expires=1704473507&Signature=HCHkVYL9Da3UmEwxpnLPDwPxZcTVng0vB4CdCh6e5ZaNR8Q1I~Nddu5ebdIIbjUMlDVvP5jXzIgB3PJYYn~hT3Hp0VeT24YqJKkyKgrHgr9EH4VJ7pM6Z-bkD7oYVaGxNCMHRHGXAt7sSpCZ4VA-kah77NazQIk4wyk9qTsQMsg_&Key-Pair-Id=APKAINP5UVPK4IGBHXOQ",
"Pronouns": 0,
"CustomPronouns": ""
}
}
}
}
},
"PayRuleObject": {
"Id": 234,
"PayTitle": "Ordinary",
"RemunerationType": 1,
"RemunerationBy": 1,
"AnnualSalary": null,
"HourlyRate": 0,
"IsMultiplier": false,
"MultiplierValue": null,
"MultiplierBaseRate": null,
"MinimumType": 3,
"MaximumType": 3,
"MinimumValue": null,
"MaximumValue": null,
"MinimumShiftLength": null,
"MaximumShiftLength": null,
"AdvancedCalculation": null,
"IsExported": true,
"UnitValue": null,
"Schedule": null,
"RecommendWith": null,
"DexmlScript": null,
"DexmlScriptParam": null,
"PeriodType": null,
"PayPortionRule": 2,
"PayrollCategory": "REGULAR",
"Comment": "Ordinary",
"RateType": 1,
"RateTag": null,
"Creator": 446,
"Created": "2023-11-12T22:57:55-05:00",
"Modified": "2023-11-12T22:57:55-05:00",
"CtId": "2QUX94TMEN3fRELiypnfM1eRsbw",
"CrId": "2SSQ1nmFxn8ujBNwxUYAy8jjkZE",
"Config": null,
"_DPMetaData": {
"System": "PayRules",
"CreatorInfo": {
"Id": 446,
"DisplayName": "Chris Knight",
"EmployeeProfile": 446,
"Employee": 446,
"Photo": "https://photo2.deputy.com/deputec_b181016092617_7890/-135x135_40c2a595a5b33d9373eed55025ebafa5.jpg?Expires=1704473507&Signature=HCHkVYL9Da3UmEwxpnLPDwPxZcTVng0vB4CdCh6e5ZaNR8Q1I~Nddu5ebdIIbjUMlDVvP5jXzIgB3PJYYn~hT3Hp0VeT24YqJKkyKgrHgr9EH4VJ7pM6Z-bkD7oYVaGxNCMHRHGXAt7sSpCZ4VA-kah77NazQIk4wyk9qTsQMsg_&Key-Pair-Id=APKAINP5UVPK4IGBHXOQ",
"Pronouns": 0,
"CustomPronouns": ""
}
}
}
},
{
"Id": 472,
"Timesheet": 122,
"PayRule": 222,
"Overridden": false,
"Value": 1,
"Cost": 16,
"OverrideComment": "",
"Creator": 446,
"Created": "2024-01-03T16:52:41-05:00",
"Modified": "2024-01-03T16:52:41-05:00",
"EventIds": "[\"2aSjDFm1NFVW8XuLDFmUKBzr8OA\"]",
"_DPMetaData": {
"System": "TimesheetPayReturn",
"CreatorInfo": {
"Id": 446,
"DisplayName": "Chris Knight",
"EmployeeProfile": 446,
"Employee": 446,
"Photo": "https://photo2.deputy.com/deputec_b181016092617_7890/-135x135_40c2a595a5b33d9373eed55025ebafa5.jpg?Expires=1704473507&Signature=HCHkVYL9Da3UmEwxpnLPDwPxZcTVng0vB4CdCh6e5ZaNR8Q1I~Nddu5ebdIIbjUMlDVvP5jXzIgB3PJYYn~hT3Hp0VeT24YqJKkyKgrHgr9EH4VJ7pM6Z-bkD7oYVaGxNCMHRHGXAt7sSpCZ4VA-kah77NazQIk4wyk9qTsQMsg_&Key-Pair-Id=APKAINP5UVPK4IGBHXOQ",
"Pronouns": 0,
"CustomPronouns": ""
}
},
"TimesheetObject": {
"Id": 122,
"Employee": 441,
"EmployeeHistory": 2994,
"EmployeeAgreement": 813,
"Date": "2023-12-07T00:00:00-05:00",
"StartTime": 1701986400,
"EndTime": 1702008000,
"Mealbreak": "2023-12-07T00:30:00-05:00",
"MealbreakSlots": "",
"Slots": [
{
"blnEmptySlot": false,
"strType": "B",
"intStart": 0,
"intEnd": 1800,
"intUnixStart": 1701986400,
"intUnixEnd": 1701988200,
"mixedActivity": {
"intState": 4,
"blnCanStartEarly": 1,
"blnCanEndEarly": 1,
"blnIsMandatory": 1,
"strBreakType": "M"
},
"strTypeName": "Meal Break",
"strState": "Finished Duration"
}
],
"TotalTime": 5.5,
"TotalTimeInv": 5.5,
"Cost": 120,
"Roster": 357,
"EmployeeComment": null,
"SupervisorComment": null,
"Supervisor": null,
"Disputed": false,
"TimeApproved": true,
"TimeApprover": 446,
"Discarded": null,
"ValidationFlag": 0,
"OperationalUnit": 27,
"IsInProgress": null,
"IsLeave": false,
"LeaveId": null,
"LeaveRule": null,
"Invoiced": false,
"InvoiceComment": null,
"PayRuleApproved": true,
"Exported": null,
"StagingId": null,
"PayStaged": false,
"PaycycleId": 5157,
"MarkedPaidUnpaidAt": "",
"AccrualState": null,
"AccrualStateChangedAt": null,
"AccrualAttempts": null,
"File": null,
"CustomFieldData": 102,
"RealTime": false,
"AutoProcessed": false,
"AutoRounded": false,
"AutoTimeApproved": false,
"AutoPayRuleApproved": false,
"Metadata": "{\"borrowed_or_lent\":false,\"forecast_cost\":0}",
"ParentId": null,
"Creator": 446,
"Created": "2024-01-03T16:52:41-05:00",
"Modified": "2024-01-03T16:52:41-05:00",
"StartTimeLocalized": "2023-12-07T17:00:00-05:00",
"EndTimeLocalized": "2023-12-07T23:00:00-05:00",
"OnCost": 120,
"_DPMetaData": {
"System": "Timesheet",
"CreatorInfo": {
"Id": 446,
"DisplayName": "Chris Knight",
"EmployeeProfile": 446,
"Employee": 446,
"Photo": "https://photo2.deputy.com/deputec_b181016092617_7890/-135x135_40c2a595a5b33d9373eed55025ebafa5.jpg?Expires=1704473507&Signature=HCHkVYL9Da3UmEwxpnLPDwPxZcTVng0vB4CdCh6e5ZaNR8Q1I~Nddu5ebdIIbjUMlDVvP5jXzIgB3PJYYn~hT3Hp0VeT24YqJKkyKgrHgr9EH4VJ7pM6Z-bkD7oYVaGxNCMHRHGXAt7sSpCZ4VA-kah77NazQIk4wyk9qTsQMsg_&Key-Pair-Id=APKAINP5UVPK4IGBHXOQ",
"Pronouns": 0,
"CustomPronouns": ""
},
"OperationalUnitInfo": {
"Id": 27,
"OperationalUnitName": "Manager",
"Company": 12,
"CompanyName": "5th Ave",
"LabelWithCompany": "[UNQNY] Manager"
},
"EmployeeInfo": {
"Id": 441,
"DisplayName": "Asim Siddiqi",
"EmployeeProfile": 441,
"Employee": 441,
"Photo": "https://photo2.deputy.com/deputec_b181016092617_7890/-135x135_47bee8e6bfc2207329bb0de4638b129f.jpg?Expires=1704473507&Signature=NZk4s7svFme9kZgJMN0OioIP602lw2x4APSrEiW4CGDv1mjFkToR1yjy4-rnfQi5pslFkVRD8J41OFlEe9dlNBxlNaFm9zCq3-yYMpScOPJ~vNZpiFNDcUSYJ1M8W3mt8Reg1pxHWpZ5Jr5~nfghr8q9DndwsUlQrGOG6pcLCSw_&Key-Pair-Id=APKAINP5UVPK4IGBHXOQ",
"Pronouns": 0,
"CustomPronouns": ""
},
"CustomFieldData": {
"Id": 102,
"System": "Timesheet",
"F01": "",
"F02": "",
"F03": "",
"F04": false,
"F05": false,
"F06": "",
"F07": false,
"F08": false,
"F09": "",
"F10": "",
"F11": "",
"F12": "",
"F13": "",
"F14": "",
"F15": false,
"F16": false,
"F17": "",
"F18": "",
"Creator": 446,
"Created": "2024-01-03T16:52:41-05:00",
"Modified": "2024-01-03T16:52:41-05:00",
"leavingearly": "",
"leavinglate": "",
"cominginlate": "",
"agreedtostaylate": false,
"clopeningshift": false,
"consent": "",
"receivedallmealbreaks": false,
"receivedallrestbreaks": false,
"consent2": "",
"fwwagreedtoextendshift": "",
"fwwcominginearly": "",
"fwwcominginlate": "",
"fwwleavingearly": "",
"fwwleavinglate": "",
"fwwreceivedallmealbreaks": false,
"fwwreceivedallrestbreaks": false,
"fwwunscheduledshiftconsent": "",
"fwwunscheduledshifthours": "",
"_DPMetaData": {
"System": "CustomFieldData",
"CreatorInfo": {
"Id": 446,
"DisplayName": "Chris Knight",
"EmployeeProfile": 446,
"Employee": 446,
"Photo": "https://photo2.deputy.com/deputec_b181016092617_7890/-135x135_40c2a595a5b33d9373eed55025ebafa5.jpg?Expires=1704473507&Signature=HCHkVYL9Da3UmEwxpnLPDwPxZcTVng0vB4CdCh6e5ZaNR8Q1I~Nddu5ebdIIbjUMlDVvP5jXzIgB3PJYYn~hT3Hp0VeT24YqJKkyKgrHgr9EH4VJ7pM6Z-bkD7oYVaGxNCMHRHGXAt7sSpCZ4VA-kah77NazQIk4wyk9qTsQMsg_&Key-Pair-Id=APKAINP5UVPK4IGBHXOQ",
"Pronouns": 0,
"CustomPronouns": ""
}
}
}
}
},
"PayRuleObject": {
"Id": 222,
"PayTitle": "Predictability Pay - Hours Increased or Changed - Less than 14 days notice",
"RemunerationType": 10,
"RemunerationBy": 2,
"AnnualSalary": null,
"HourlyRate": null,
"IsMultiplier": true,
"MultiplierValue": 1,
"MultiplierBaseRate": -2,
"MinimumType": 3,
"MaximumType": 3,
"MinimumValue": null,
"MaximumValue": null,
"MinimumShiftLength": null,
"MaximumShiftLength": "24",
"AdvancedCalculation": null,
"IsExported": true,
"UnitValue": null,
"Schedule": null,
"RecommendWith": null,
"DexmlScript": null,
"DexmlScriptParam": null,
"PeriodType": null,
"PayPortionRule": null,
"PayrollCategory": "SCHEDULE PREMIUM - INCREASE 14DAYS",
"Comment": "Predictability Pay - Hours Increased or Changed - Less than 14 days notice",
"RateType": 3,
"RateTag": null,
"Creator": 446,
"Created": "2023-11-12T22:57:55-05:00",
"Modified": "2023-11-12T22:57:55-05:00",
"CtId": "2QGnXdPmaKXpSOIOk1lnTcBql1n",
"CrId": "2RtAtZgercUtcStEt8dAWjplxta",
"Config": "{\"phEndTime\": \"0\", \"eventTypes\": [\"TIME_ADDED\", \"TIME_CHANGED_TOTAL_CHANGED\", \"TIME_CHANGED_TOTAL_SAME\", \"LOCATION_CHANGED\"], \"leavingLate\": \"ANSWER_UNSPECIFIED\", \"phStartTime\": \"0\", \"comingInLate\": \"ANSWER_UNSPECIFIED\", \"leavingEarly\": \"ANSWER_UNSPECIFIED\", \"comingInEarly\": \"ANSWER_UNSPECIFIED\", \"midnightSplit\": false, \"usePredictPay\": false, \"payPortionRule\": \"UNKNOWN\", \"returnTimeType\": \"PER_OCCURRENCE\", \"shiftQuestions\": [], \"mealbreakWaiver\": false, \"isLastShiftForDay\": false, \"isShiftInOvertime\": false, \"workPeriodEndTime\": \"0\", \"basePeriodStartDate\": \"0\", \"splitShiftTimestamp\": \"0\", \"workPeriodStartTime\": \"0\", \"ruleThresholdSeconds\": \"900\", \"consecutiveDaysWorked\": \"0\", \"receivedAllMealBreaks\": false, \"receivedAllRestBreaks\": false, \"useCombinedTimeChange\": false, \"useProrataCalculation\": false, \"dailyOvertimeThreshold\": \"0\", \"isShiftOnPublicHoliday\": false, \"basePeriodFrequencyDays\": 0, \"ignorePremiumInOvertime\": true, \"periodOvertimeThreshold\": \"0\", \"unscheduledShiftConsent\": \"ANSWER_UNSPECIFIED\", \"basePeriodDayOfWeekStart\": 0, \"schedulePremiumReference\": \"REFERENCE_UNKNOWN\", \"shiftLengthThresholdSeconds\": \"0\", \"changePeriodThresholdSeconds\": \"1209600\", \"dailyOrdinaryTimeTotalSeconds\": \"0\", \"consecutiveDaysWorkedThreshold\": \"0\", \"restBetweenShiftsThresholdSeconds\": \"0\", \"timesheetPayReturnOrdinaryTimeTotal\": \"0\"}",
"_DPMetaData": {
"System": "PayRules",
"CreatorInfo": {
"Id": 446,
"DisplayName": "Chris Knight",
"EmployeeProfile": 446,
"Employee": 446,
"Photo": "https://photo2.deputy.com/deputec_b181016092617_7890/-135x135_40c2a595a5b33d9373eed55025ebafa5.jpg?Expires=1704473507&Signature=HCHkVYL9Da3UmEwxpnLPDwPxZcTVng0vB4CdCh6e5ZaNR8Q1I~Nddu5ebdIIbjUMlDVvP5jXzIgB3PJYYn~hT3Hp0VeT24YqJKkyKgrHgr9EH4VJ7pM6Z-bkD7oYVaGxNCMHRHGXAt7sSpCZ4VA-kah77NazQIk4wyk9qTsQMsg_&Key-Pair-Id=APKAINP5UVPK4IGBHXOQ",
"Pronouns": 0,
"CustomPronouns": ""
}
}
}
},
{
"Id": 473,
"Timesheet": 122,
"PayRule": 224,
"Overridden": false,
"Value": 1,
"Cost": 16,
"OverrideComment": "",
"Creator": 446,
"Created": "2024-01-03T16:52:41-05:00",
"Modified": "2024-01-03T16:52:41-05:00",
"EventIds": null,
"_DPMetaData": {
"System": "TimesheetPayReturn",
"CreatorInfo": {
"Id": 446,
"DisplayName": "Chris Knight",
"EmployeeProfile": 446,
"Employee": 446,
"Photo": "https://photo2.deputy.com/deputec_b181016092617_7890/-135x135_40c2a595a5b33d9373eed55025ebafa5.jpg?Expires=1704473507&Signature=HCHkVYL9Da3UmEwxpnLPDwPxZcTVng0vB4CdCh6e5ZaNR8Q1I~Nddu5ebdIIbjUMlDVvP5jXzIgB3PJYYn~hT3Hp0VeT24YqJKkyKgrHgr9EH4VJ7pM6Z-bkD7oYVaGxNCMHRHGXAt7sSpCZ4VA-kah77NazQIk4wyk9qTsQMsg_&Key-Pair-Id=APKAINP5UVPK4IGBHXOQ",
"Pronouns": 0,
"CustomPronouns": ""
}
},
"TimesheetObject": {
"Id": 122,
"Employee": 441,
"EmployeeHistory": 2994,
"EmployeeAgreement": 813,
"Date": "2023-12-07T00:00:00-05:00",
"StartTime": 1701986400,
"EndTime": 1702008000,
"Mealbreak": "2023-12-07T00:30:00-05:00",
"MealbreakSlots": "",
"Slots": [
{
"blnEmptySlot": false,
"strType": "B",
"intStart": 0,
"intEnd": 1800,
"intUnixStart": 1701986400,
"intUnixEnd": 1701988200,
"mixedActivity": {
"intState": 4,
"blnCanStartEarly": 1,
"blnCanEndEarly": 1,
"blnIsMandatory": 1,
"strBreakType": "M"
},
"strTypeName": "Meal Break",
"strState": "Finished Duration"
}
],
"TotalTime": 5.5,
"TotalTimeInv": 5.5,
"Cost": 120,
"Roster": 357,
"EmployeeComment": null,
"SupervisorComment": null,
"Supervisor": null,
"Disputed": false,
"TimeApproved": true,
"TimeApprover": 446,
"Discarded": null,
"ValidationFlag": 0,
"OperationalUnit": 27,
"IsInProgress": null,
"IsLeave": false,
"LeaveId": null,
"LeaveRule": null,
"Invoiced": false,
"InvoiceComment": null,
"PayRuleApproved": true,
"Exported": null,
"StagingId": null,
"PayStaged": false,
"PaycycleId": 5157,
"MarkedPaidUnpaidAt": "",
"AccrualState": null,
"AccrualStateChangedAt": null,
"AccrualAttempts": null,
"File": null,
"CustomFieldData": 102,
"RealTime": false,
"AutoProcessed": false,
"AutoRounded": false,
"AutoTimeApproved": false,
"AutoPayRuleApproved": false,
"Metadata": "{\"borrowed_or_lent\":false,\"forecast_cost\":0}",
"ParentId": null,
"Creator": 446,
"Created": "2024-01-03T16:52:41-05:00",
"Modified": "2024-01-03T16:52:41-05:00",
"StartTimeLocalized": "2023-12-07T17:00:00-05:00",
"EndTimeLocalized": "2023-12-07T23:00:00-05:00",
"OnCost": 120,
"_DPMetaData": {
"System": "Timesheet",
"CreatorInfo": {
"Id": 446,
"DisplayName": "Chris Knight",
"EmployeeProfile": 446,
"Employee": 446,
"Photo": "https://photo2.deputy.com/deputec_b181016092617_7890/-135x135_40c2a595a5b33d9373eed55025ebafa5.jpg?Expires=1704473507&Signature=HCHkVYL9Da3UmEwxpnLPDwPxZcTVng0vB4CdCh6e5ZaNR8Q1I~Nddu5ebdIIbjUMlDVvP5jXzIgB3PJYYn~hT3Hp0VeT24YqJKkyKgrHgr9EH4VJ7pM6Z-bkD7oYVaGxNCMHRHGXAt7sSpCZ4VA-kah77NazQIk4wyk9qTsQMsg_&Key-Pair-Id=APKAINP5UVPK4IGBHXOQ",
"Pronouns": 0,
"CustomPronouns": ""
},
"OperationalUnitInfo": {
"Id": 27,
"OperationalUnitName": "Manager",
"Company": 12,
"CompanyName": "5th Ave",
"LabelWithCompany": "[UNQNY] Manager"
},
"EmployeeInfo": {
"Id": 441,
"DisplayName": "Asim Siddiqi",
"EmployeeProfile": 441,
"Employee": 441,
"Photo": "https://photo2.deputy.com/deputec_b181016092617_7890/-135x135_47bee8e6bfc2207329bb0de4638b129f.jpg?Expires=1704473507&Signature=NZk4s7svFme9kZgJMN0OioIP602lw2x4APSrEiW4CGDv1mjFkToR1yjy4-rnfQi5pslFkVRD8J41OFlEe9dlNBxlNaFm9zCq3-yYMpScOPJ~vNZpiFNDcUSYJ1M8W3mt8Reg1pxHWpZ5Jr5~nfghr8q9DndwsUlQrGOG6pcLCSw_&Key-Pair-Id=APKAINP5UVPK4IGBHXOQ",
"Pronouns": 0,
"CustomPronouns": ""
},
"CustomFieldData": {
"Id": 102,
"System": "Timesheet",
"F01": "",
"F02": "",
"F03": "",
"F04": false,
"F05": false,
"F06": "",
"F07": false,
"F08": false,
"F09": "",
"F10": "",
"F11": "",
"F12": "",
"F13": "",
"F14": "",
"F15": false,
"F16": false,
"F17": "",
"F18": "",
"Creator": 446,
"Created": "2024-01-03T16:52:41-05:00",
"Modified": "2024-01-03T16:52:41-05:00",
"leavingearly": "",
"leavinglate": "",
"cominginlate": "",
"agreedtostaylate": false,
"clopeningshift": false,
"consent": "",
"receivedallmealbreaks": false,
"receivedallrestbreaks": false,
"consent2": "",
"fwwagreedtoextendshift": "",
"fwwcominginearly": "",
"fwwcominginlate": "",
"fwwleavingearly": "",
"fwwleavinglate": "",
"fwwreceivedallmealbreaks": false,
"fwwreceivedallrestbreaks": false,
"fwwunscheduledshiftconsent": "",
"fwwunscheduledshifthours": "",
"_DPMetaData": {
"System": "CustomFieldData",
"CreatorInfo": {
"Id": 446,
"DisplayName": "Chris Knight",
"EmployeeProfile": 446,
"Employee": 446,
"Photo": "https://photo2.deputy.com/deputec_b181016092617_7890/-135x135_40c2a595a5b33d9373eed55025ebafa5.jpg?Expires=1704473507&Signature=HCHkVYL9Da3UmEwxpnLPDwPxZcTVng0vB4CdCh6e5ZaNR8Q1I~Nddu5ebdIIbjUMlDVvP5jXzIgB3PJYYn~hT3Hp0VeT24YqJKkyKgrHgr9EH4VJ7pM6Z-bkD7oYVaGxNCMHRHGXAt7sSpCZ4VA-kah77NazQIk4wyk9qTsQMsg_&Key-Pair-Id=APKAINP5UVPK4IGBHXOQ",
"Pronouns": 0,
"CustomPronouns": ""
}
}
}
}
},
"PayRuleObject": {
"Id": 224,
"PayTitle": "Missed Rest Break Premium",
"RemunerationType": 10,
"RemunerationBy": 2,
"AnnualSalary": null,
"HourlyRate": null,
"IsMultiplier": true,
"MultiplierValue": 1,
"MultiplierBaseRate": -2,
"MinimumType": 3,
"MaximumType": 3,
"MinimumValue": null,
"MaximumValue": null,
"MinimumShiftLength": null,
"MaximumShiftLength": "24",
"AdvancedCalculation": null,
"IsExported": true,
"UnitValue": null,
"Schedule": null,
"RecommendWith": null,
"DexmlScript": null,
"DexmlScriptParam": null,
"PeriodType": null,
"PayPortionRule": null,
"PayrollCategory": "RBP",
"Comment": "Missed Rest Break Premium",
"RateType": 3,
"RateTag": null,
"Creator": 446,
"Created": "2023-11-12T22:57:55-05:00",
"Modified": "2023-11-12T22:57:55-05:00",
"CtId": "2TmsUCDr9v11j05UBjqS2bDwGPC",
"CrId": "2RnZgvlM6r2tHYjGXxQz5W8Dg4o",
"Config": "{\"phEndTime\": \"0\", \"eventTypes\": [], \"leavingLate\": \"ANSWER_UNSPECIFIED\", \"phStartTime\": \"0\", \"comingInLate\": \"ANSWER_UNSPECIFIED\", \"leavingEarly\": \"ANSWER_UNSPECIFIED\", \"comingInEarly\": \"ANSWER_UNSPECIFIED\", \"midnightSplit\": false, \"usePredictPay\": false, \"payPortionRule\": \"UNKNOWN\", \"returnTimeType\": \"RETURN_TIME_TYPE_UNSPECIFIED\", \"shiftQuestions\": [], \"mealbreakWaiver\": false, \"isLastShiftForDay\": false, \"isShiftInOvertime\": false, \"workPeriodEndTime\": \"0\", \"basePeriodStartDate\": \"0\", \"splitShiftTimestamp\": \"0\", \"workPeriodStartTime\": \"0\", \"ruleThresholdSeconds\": \"0\", \"consecutiveDaysWorked\": \"0\", \"receivedAllMealBreaks\": false, \"receivedAllRestBreaks\": false, \"useCombinedTimeChange\": false, \"useProrataCalculation\": false, \"dailyOvertimeThreshold\": \"0\", \"isShiftOnPublicHoliday\": false, \"basePeriodFrequencyDays\": 0, \"ignorePremiumInOvertime\": false, \"periodOvertimeThreshold\": \"0\", \"unscheduledShiftConsent\": \"ANSWER_UNSPECIFIED\", \"basePeriodDayOfWeekStart\": 0, \"schedulePremiumReference\": \"REFERENCE_UNKNOWN\", \"shiftLengthThresholdSeconds\": \"0\", \"changePeriodThresholdSeconds\": \"0\", \"dailyOrdinaryTimeTotalSeconds\": \"0\", \"consecutiveDaysWorkedThreshold\": \"0\", \"restBetweenShiftsThresholdSeconds\": \"0\", \"timesheetPayReturnOrdinaryTimeTotal\": \"0\"}",
"_DPMetaData": {
"System": "PayRules",
"CreatorInfo": {
"Id": 446,
"DisplayName": "Chris Knight",
"EmployeeProfile": 446,
"Employee": 446,
"Photo": "https://photo2.deputy.com/deputec_b181016092617_7890/-135x135_40c2a595a5b33d9373eed55025ebafa5.jpg?Expires=1704473507&Signature=HCHkVYL9Da3UmEwxpnLPDwPxZcTVng0vB4CdCh6e5ZaNR8Q1I~Nddu5ebdIIbjUMlDVvP5jXzIgB3PJYYn~hT3Hp0VeT24YqJKkyKgrHgr9EH4VJ7pM6Z-bkD7oYVaGxNCMHRHGXAt7sSpCZ4VA-kah77NazQIk4wyk9qTsQMsg_&Key-Pair-Id=APKAINP5UVPK4IGBHXOQ",
"Pronouns": 0,
"CustomPronouns": ""
}
}
}
}
]
This may seem lengthy but it does include three actual API data blocks in the one data response. It also includes all lines from the Timesheet, which in this case is three.
Let's break down the Fair Work Week Component.
In the second entry of the array response, you will see three objects. The first which is unnamed is the TimeSheetPayreturn, the second which is named is the TimesheetObject and the third is the PayRuleObject.
You will notice in the TimesheetPayReturn object, there is a data element called PayRule which is the id of the PayRule assigned to this timesheet line. This is why we have included PayRuleObject in the original payload, so that this information is available to you in the data response.
Now focusing on the PayRuleObject data object, you will notice the id is 222 which lines up with the information in the TimesheetPayReturn object. The PayTitle is Predictability Pay - Hours Increased or Changed - Less than 14 days notice which is one of the Fair Work Week conditions.
The PayrollCategory is the export code and it is this item which you can use to map to the relevant Fair Work Week data elements in your payroll items. You will likely already be familiar with this if you have built a payroll integration with Deputy in the past.
Additional Changes for Fair Work Week
Along with the above, you will notice in CustomFieldData there are some additional data elements that have been added to the response for Fair Work Week. These data elements and what they can contain in a response are detailed below.
| Data Element | Potential Responses | Notes |
|---|---|---|
| fwwagreedtoextendshift | boolean true/false | |
| fwwcominginearly | "Yes, Manager Requested", "Yes, Personal Reasons", "No, I don't consent" | |
| fwwcominginlate | "Yes, Manager Requested", "Yes, Personal Reasons", "No I don't consent" | |
| fwwleavingearly | "Yes, Manager Requested", "Yes, Personal Reasons", "No I don't consent" | |
| fwwleavinglate | "Yes, Manager Requested", "Yes, Personal Reasons", "No I don't consent" | |
| fwwunscheduledshiftconsent | "Yes, Manager Requested", "Yes, I requested this", "No, I don't consent" | |
| fwwreceivedallmealbreaks | boolean true/false | California Only |
| fwwreceivedallrestbreaks | boolean true/false | California Only |
This can give some indication as to why penalties may have been applied to Timesheets when relevant.
Updated 4 months ago