The RESTful GET Employee Pay Summaries Retro operation returns a list containing employee pay summary retros. The operation uses the following URL:
https://www.dayforcehcm.com/api/CompanyName/V1/EmployeePaySummariesRetro
Parameters
Consumers can retrieve retro data by using combinations of the following parameters:
payGroupXRefCode (string)
Pay group reference code value. Use this to retrieve employees who are assigned to a specific pay group. This parameter is required.
periodStartDate (string)
Inclusive period start date to determine which employee retro data to retrieve.
periodEndDate (string)
Inclusive period end date to determine which employee retro data to retrieve.
payDate (string)
The retro pay date. Use this to retrieve retros that were paid on a specific date.
employeeXRefCode (string)
Employee reference code value. Use this to retrieve specific employees.
locationXRefCode (string)
Location reference code value. Use this to retrieve employees who are assigned to a specific location.
payCategoryXRefCode (string)
Pay category reference code value. Use this to retrieve employees who have the specific pay category in their pay summary.
payCodeXRefCode (string)
Pay code reference code value. Use this to review employees who have the specific pay code in their pay summary.
onlyRetros (boolean)
Determines whether the operation retrieves only retro data or all pay summary data.
payExportId
Pay export ID value. Use this to retrieve pay export data.
If you enable this parameter and the periodStartDate and periodEndDate parameters, the payExportId parameter takes precedence and the operation retrieves data for the duration that was configured in the pay export.
Response
The response from this request contains data from the referenced retro. Here is an example response:
{
"Data": [
{
"IsRetro": true,
"EmployeeXRefCode": "string",
"PositionXRefCode": "string",
"DepartmentXRefCode": "string",
"JobXRefCode": "string",
"PayCodeXRefCode": "string",
"PayCategoryXRefCode": "string",
"PayDate": "2024-02-05T22:27:29.426Z",
"BusinessDate": "2024-02-05T22:27:29.426Z",
"TimeStart": "2024-02-05T22:27:29.426Z",
"TimeEnd": "2024-02-05T22:27:29.426Z",
"PunchSegmentStart": "2024-02-05T22:27:29.426Z",
"LocationXRefCode": "string",
"NetHours": 0,
"MinuteDuration": 0,
"Rate": 0,
"PayAmount": 0,
"IsPremium": true,
"ProjectXRefCode": "string",
"DocketXRefCode": "string",
"PieceQuantity": 0,
"PayExportId": 0,
"LaborMetricsCode0XRefCode": "string",
"LaborMetricsCode1XRefCode": "string",
"LaborMetricsCode2XRefCode": "string",
"LaborMetricsCode3XRefCode": "string",
"LaborMetricsCode4XRefCode": "string",
"LaborMetricsCode5XRefCode": "string",
"LaborMetricsCode6XRefCode": "string",
"LaborMetricsCode7XRefCode": "string",
"LaborMetricsCode8XRefCode": "string",
"LaborMetricsCode9XRefCode": "string"
}
],
"ProcessResults": [
{
"Code": "string",
"Context": "string",
"Level": "string",
"Message": "string"
}
],
"Paging": {
"Next": "string"
}
}