Dayforce RESTful services use the PATCH verb to update employee pay adjustments.
Overview
Use the PATCH request to do the following:
- Create an effective-dated subordinate record (LaborMetrics)
- Update an existing pay adjustment for an employee or a currently-effective subordinate record
The URL for PATCH operations uses the base URL and employee pay adjustments XRefCode:
https://www.dayforcehcm.com/api/CompanyName/V1/EmployeePayAdjustments/[XRefCode]
The XRefCode must be included in the request URL because Dayforce web services assumes the requester means to update an existing employee pay adjustment when PATCH is used. The XRefCode doesn't need to be included in the request body. If included in the request body, the XRefCode must match the XRefCode in the request URL.
The request body needs to include the data entities and elements that need to be inserted or updated only. The request doesn't need to include values for all of the information available in the employee pay adjustments data model.
Additionally, you assume the responsibility for committing data to your instance of Dayforce web services. If data isn’t to be committed (for example, test data in a production instance), you must send the request using the parameter and value IsValidateOnly=true.
Important: This request modifies existing data in Dayforce. When using this request, be sure that the consuming application/requester is using the correct instance of Dayforce (for example, Test or Production). Watch out for inadvertently modifying the wrong Dayforce instance (for example, test data in a production instance).
Parameters
IsValidateOnly (boolean)
- Used to specify that all of the validations need to be performed without committing any changes.
- Use this parameter to control whether committing information to your instance of Dayforce is your responsibility.
- The URL syntax is: https://www.dayforcehcm.com/api/CompanyName/V1/EmployeePayAdjustments/[XRefCode]?isValidateOnly=true
Request Body
The request body contains the data entities and elements that need to be processed within a structure that can be interpreted by Dayforce web services. The same JSON structure used to return data retrieved from Dayforce using the RESTful Get Employee Pay Adjustments by XRefCode request is used for PATCH operations.
{
"EmployeePayAdjustXRefCode": "string",
"OrgUnitXRefCode": "string",
"EmployeeXRefCode": "string",
"PayAdjustmentCodeXRefCode": "string",
"PayAdjustmentDate": "2024-10-15T19:36:02.120Z",
"Hours": 0,
"Amount": 0,
"JobXRefCode": "string",
"DepartmentXRefCode": "string",
"PayCategoryXRefCode": "string",
"ProjectXRefCode": "string",
"DocketXRefCode": "string",
"PieceQuantity": 0,
"IsPremium": true,
"IsDeleted": true,
"Rate": 0,
"PayDate": "2024-10-15T19:36:02.120Z",
"ReferenceDate": "2024-10-15T19:36:02.120Z",
"EmployeeComment": "string",
"ManagerComment": "string",
"ManagerAuthorized": true,
"EmployeeAuthorized": true,
"AdjustPeriodStartDate": "2024-10-15T19:36:02.120Z",
"AdjustPeriodEndDate": "2024-10-15T19:36:02.120Z",
"LaborMetrics": [
{
"LaborMetricsTypeXRefCode": "string",
"LaborMetricsCodeXRefCode": "string"
}
]
}