Get Calculated Payroll Details
The Payroll service actively processes punch data according to defined pay rules and outputs estimated wages per employee for a given business date. The/PayrollDetail API Resource provides this information to data consumers.
See the Parameters and Response Fields topics for additional details.
Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier of the company to manage data for |
header | [ | array, csv of string | No | The identifiers of the site to manage data for |
Sample Payroll Detail Response Body
{
"Data": [
{
"PayrollDetailId": "9999999999999999",
"EmployeeId": "9999999999999999",
"EmployeeWorkTimeId": "9999999999999999",
"TenderTypeId": null,
"BusinessDate": "20YY-04-27",
"ClockIn": "20YY-04-27T10:59:33-04:00",
"ClockOut": "20YY-04-27T11:48:06-04:00",
"JobCodeId": "9999999999999999",
"Rate": 7.25,
"RateOriginal": 7.25,
"RatePrecision": 4,
"CompensationTypeId": "9999999999999999",
"Multiplier": 1.0,
"Hours": 0.81,
"HoursOriginal": 0.809280555555556,
"HoursPrecision": 2,
"WorkTypeId": "9999999999999999",
"TotalPay": 5.87,
"TotalPayOriginal": 5.86728402777778100,
"TotalPayPrecision": 2,
"RoundingMethod": "nearest",
"PayrollBatchId": null,
"PayRuleId": null,
"RateTypeId": "9999999999999999",
"SiteId": "9999999999999999",
"IsStillClockedIn": true,
"Source": null,
"ActualUpdateDate": "20YY-04-27T15:48:06.690"
},
{
"PayrollDetailId": "9999999999999999",
"EmployeeId": "9999999999999999",
"EmployeeWorkTimeId": "9999999999999999",
"TenderTypeId": null,
"BusinessDate": "20YY-04-27",
"ClockIn": "20YY-04-27T11:00:45-04:00",
"ClockOut": "20YY-04-27T11:48:06-04:00",
"JobCodeId": "9999999999999999",
"Rate": 10.0,
"RateOriginal": 10.0,
"RatePrecision": 4,
"CompensationTypeId": "9999999999999999",
"Multiplier": 1.0,
"Hours": 0.79,
"HoursOriginal": 0.789378888888889,
"HoursPrecision": 2,
"WorkTypeId": "9999999999999999",
"TotalPay": 7.90,
"TotalPayOriginal": 7.893788888888890,
"TotalPayPrecision": 2,
"RoundingMethod": "nearest",
"PayrollBatchId": null,
"PayRuleId": null,
"RateTypeId": "9999999999999999",
"SiteId": "9999999999999999",
"IsStillClockedIn": true,
"Source": null,
"ActualUpdateDate": "20YY-04-27T15:48:07.043"
},
{
"PayrollDetailId": "9999999999999999",
"EmployeeId": "9999999999999999",
"EmployeeWorkTimeId": "9999999999999999",
"TenderTypeId": null,
"BusinessDate": "20YY-04-27",
"ClockIn": "20YY-04-27T07:59:49-04:00",
"ClockOut": "20YY-04-27T11:50:21-04:00",
"JobCodeId": "9999999999999999",
"Rate": 10.0,
"RateOriginal": 10.0,
"RatePrecision": 4,
"CompensationTypeId": "9999999999999999",
"Multiplier": 1.0,
"Hours": 3.84,
"HoursOriginal": 3.84227722222222,
"HoursPrecision": 2,
"WorkTypeId": "9999999999999999",
"TotalPay": 38.40,
"TotalPayOriginal": 38.42277222222220,
"TotalPayPrecision": 2,
"RoundingMethod": "nearest",
"PayrollBatchId": null,
"PayRuleId": null,
"RateTypeId": "9999999999999999",
"SiteId": "9999999999999999",
"IsStillClockedIn": true,
"Source": null,
"ActualUpdateDate": "20YY-04-27T15:50:21.581"
},
{
"PayrollDetailId": "9999999999999999",
"EmployeeId": "9999999999999999",
"EmployeeWorkTimeId": "9999999999999999",
"TenderTypeId": null,
"BusinessDate": "20YY-04-27",
"ClockIn": "20YY-04-27T08:01:45-04:00",
"ClockOut": "20YY-04-27T11:50:27-04:00",
"JobCodeId": "9999999999999999",
"Rate": 7.25,
"RateOriginal": 7.25,
"RatePrecision": 4,
"CompensationTypeId": "9999999999999999",
"Multiplier": 1.0,
"Hours": 3.81,
"HoursOriginal": 3.81172194444444,
"HoursPrecision": 2,
"WorkTypeId": "9999999999999999",
"TotalPay": 27.62,
"TotalPayOriginal": 27.6349840972221900,
"TotalPayPrecision": 2,
"RoundingMethod": "nearest",
"PayrollBatchId": null,
"PayRuleId": null,
"RateTypeId": "9999999999999999",
"SiteId": "9999999999999999",
"IsStillClockedIn": true,
"Source": null,
"ActualUpdateDate": "20YY-04-27T15:50:27.630"
}
],
"TotalCount": 4
}Response Fields
Field Name | Description | Notes |
|---|---|---|
| The unique identifier (UID) for this Payroll Detail Record | This UUID will change every time the Payroll Engine processes Punch Data. |
| The universally unique identifier (UUID) for the Employee associated with this Payroll Detail record | Lookup can be performed against |
| The UUID for the associated Work Time (punch) record | Lookup can be performed against |
| The business date associated with this Payroll Detail record | YYYY-MM-DD |
| The date and time that this | For example, 20YY-04-27T10:59:33-04:00 |
| The date and time that this | |
| The UUID for the job code associated with this | |
| The decimal value of the actual rate associated with this | |
| The original rate value for an employee's shift | |
| Defines the number of decimals associated with the | |
| The UUID of the compensation type associated with this Work Time value | Lookup can be performed against |
| Indicates the multiplier applied to the | |
| The decimal value in base 100 reflecting the number of aggregate hours for this Work Time. This value is rounded typically. | |
| The decimal value in base 100 reflecting the number of aggregate hours for this Work Time. This value is NOT rounded typically. | |
| Defines the number of decimal places for rounding | |
| The UUID associated with the Work Type (Work Time or Vacation Time) | |
| The decimal value reflecting the total wages calculated for this Work Time. This value is rounded. | |
| The decimal value reflecting the total wages calculated for this Work Time. This value is NOT rounded. | |
| Reflects the number of decimals used for rounding | |
| Describes the rounding method used for calculations | |
| The UUID referencing the Rate Type, either Hourly or Salary | |
| The UUID of the site associated with this Payroll Detail record |