RESTful Get Employee Pay Adjustments

Dayforce RESTful Web Services Developer Guide
Version
R2025.2.1
RESTful Get Employee Pay Adjustments

Pay adjustments represent corrections made to employees’ time and attendance records or pay.

Overview

The Get Employee Pay Adjustments request allows the consuming application to retrieve employee pay adjustment data for multiple employees per a set of search criteria. Required parameters for the call include FilterPayAdjustmentStartDate and FilterPayAdjustmentEndDate. The system searches for all employee pay adjustment records that were modified between these two dates. The two dates must be seven days apart or less.

Parameters

Note: An asterisk (*) next to a parameter name denotes a required parameter.

filterPayAdjustmentStartDate* (datetime)

  • Start date of the filter period for which pay adjustments are returned.
  • The date time 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.

filterPayAdjustmentEndDate* (datetime)

  • End date of the filter period for which pay adjustments 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.

filterLastModifiedStartDateUTC

  • Inclusive start date (in UTC format) of the filter period for which pay adjustments were modified.

filterLastModifiedEndDateUTC

  • Inclusive end date (in UTC format) of the filter period for which pay adjustments were modified.

orgUnitXRefCode (string)

  • Reference code of the org units for which the pay adjustments must be retrieved.

employeeXRefCode (string)

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

payAdjustmentCodeXRefCode (string)

  • Reference code of the pay codes for which the pay adjustments must be retrieved.

projectXRefCode (string)

  • Reference code of the projects for which the pay adjustments must be retrieved.

departmentXRefCode (string)

  • Reference code of the departments for which the pay adjustments must be retrieved.

jobXRefCode (string)

  • Reference code of the jobs for which the pay adjustments must be retrieved.

docketXRefCode (string)

  • Reference code of the dockets for which the pay adjustments must be retrieved.

referenceDate (string)

  • Reference date used to link the pay adjustment to a different date than the one it’s being recorded on, in a timesheet. For example, if you're creating an adjustment for a commission payment, you might reference the date that the employee made the sale on that earned them the commission.

managerAuthorized (boolean)

  • If true, then only manager authorized pay adjustments are included in the results.
  • If false, then manager authorized pay adjustments are excluded from the results.
  • Because this is a boolean value, it can only be expressed as true or false.

employeeAuthorized (boolean)

  • If true, then only employee authorized pay adjustments are included in the results.
  • If false, then employee authorized pay adjustments are excluded from the results.
  • Because this is a boolean value, it can only be expressed as true or false.

employeePayAdjustXRefCode (string)

The XRefCode of the employee pay adjustment that should be retrieved.

isDeleted (boolean)

  • If true, then only deleted pay adjustments are included in the results.
  • If false, then deleted pay adjustments excluded from the results.
  • Because this is a boolean value, it can only be expressed as true or false.

pageSize (integer)

  • Designates the number of records returned in one result page. A link to subsequent pages containing remaining records will be part of the response.

Response

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

Copy 
{
  "Data": [
    {
      "EmployeePayAdjustXRefCode": "string",
      "AdjustPeriodStartDate": "2024-10-15T19:30:55.581Z",
      "AdjustPeriodEndDate": "2024-10-15T19:30:55.581Z",
      "EmployeeXRefCode": "string",
      "DepartmentXRefCode": "string",
      "JobXRefCode": "string",
      "PayAdjustmentCodeXRefCode": "string",
      "PayCategoryXRefCode": "string",
      "PayDate": "2024-10-15T19:30:55.581Z",
      "OrgUnitXRefCode": "string",
      "IsPremium": true,
      "IsDeleted": true,
      "TimeStart": "2024-10-15T19:30:55.581Z",
      "TimeEnd": "2024-10-15T19:30:55.581Z",
      "Hours": 0,
      "Rate": 0,
      "Amount": 0,
      "ReferenceDate": "2024-10-15T19:30:55.581Z",
      "ProjectXRefCode": "string",
      "DocketXRefCode": "string",
      "PieceQuantity": 0,
      "EmployeeComment": "string",
      "ManagerComment": "string",
      "EmployeeAuthorized": true,
      "ManagerAuthorized": true,
      "LaborMetrics": [
        {
          "LaborMetricsTypeXRefCode": "string",
          "LaborMetricsCodeXRefCode": "string"
        }
      ],
      "LastModifiedTimestampUtc": "2024-10-15T19:30:55.581Z"
    }
  ],
  "ProcessResults": [
    {
      "Code": "string",
      "Context": "string",
      "Level": "string",
      "Message": "string"
    }
  ],
  "Paging": {
    "Next": "string"
  }
}