RESTful Get Employee Pay Summaries

The Get Employee Pay Summaries request allows the consuming application to retrieve employee pay summaries by using the employee XRefCode.

Overview

The base URL used to retrieve a list of pay summaries is:

https://www.dayforcehcm.com/api/[CompanyName]/V1/EmployeePaySummaries

Parameters

Consumers can retrieve employee pay summary data by using combinations of the following common query parameters:

filterPaySummaryStartDate* (datetime)

• The start date of the filter period for which pay summaries are returned.
• The datetime value should be expressed as yyyy-mm-ddThh:mm:ss, where T is a separator used between the date and time. For example, 2017-01-01T13:24:56.

filterPaySummaryEndDate* (datetime)

• The end date of the filter period for which pay summaries are returned.
• The datetime value should be expressed as yyyy-mm-ddThh:mm:ss, where T is a separator used between the date and time. For example, 2017-01-01T13:24:56.

employeeXRefCode (string)

• Reference code of the employee for whom the pay summaries must be retrieved.

locationXRefCode (string)

• Reference code of the locations for which the pay summaries must be retrieved.

payGroupXRefCode (string)

• Pay group reference code value, which can be specific to a client.
• Use this to search employees with the given pay group.

payCategoryXRefCode (string)

• Pay category reference code value, which can be specific to a client.
• Use this to search employees with the given pay category.

payCodeXRefCode (string)

• Pay code reference code value, which can be specific to a client.
• Use this to search employees with the given pay code.
• Multiple parameter values can be added with a comma separator.

Response

The response is in JSON format as illustrated in the example below:

{
  "Data": [
    {
      "EmployeeXRefCode": "string",
      "PositionXRefCode": "string",
      "DepartmentXRefCode": "string",
      "JobXRefCode": "string",
      "PayCodeXRefCode": "string",
      "PayCategoryXRefCode": "string",
      "PayDate": "2020-07-20T15:44:51.720Z",
      "BusinessDate": "2020-07-20T15:44:51.720Z",
      "TimeStart": "2020-07-20T15:44:51.720Z",
      "TimeEnd": "2020-07-20T15:44:51.720Z",
      "PunchSegmentStart": "2020-07-20T15:44:51.720Z",
      "LocationXRefCode": "string",
      "NetHours": 0,
      "MinuteDuration": 0,
      "Rate": 0,
      "PayAmount": 0,
      "IsPremium": true,
      "ProjectXRefCode": "string",
      "DocketXRefCode": "string",
      "PieceQuantity": 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"
  }
}