Dayforce RESTful services use the POST verb to create an instance of the resource. In the case of the Employee Pay Adjustments resource, POST refers to creating a new pay adjustment.
Endpoint URL
The URL for POST Employee Pay Adjustments uses the following base URL:
https://www.dayforcehcm.com/api/CompanyName/V1/EmployeePayAdjustments
Important: This request writes data into Dayforce. When using this request, be sure that the consuming application/requester is using the correct Dayforce instance (for example, Test or Production). Watch out for inadvertently updating the wrong instance of Dayforce (for example, inserting test data in a production instance).
Overview
You can insert employee pay adjustment data using the POST Employee Pay Adjustments endpoint. The following is a list of some of the data entities that can be created using this endpoint:
- Pay Adjustment Date
- Hours
- Amount
- Department
- Pay Category
- Docket Data
- Rate
- Pay Date
- Reference Date
- Adjustment Period Start Date
- Adjustment Period End Date
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. See the Important note above.
- The URL syntax is:
https://www.dayforcehcm.com /api/CompanyName/V1/EmployeePayAdjustments?isValidateOnly=true
Request Body
The request body contains the values that need to be inserted into the available data entities. The example below shows all of the possible fields in the correct JSON format.
{
"EmployeePayAdjustXRefCode": "string",
"OrgUnitXRefCode": "string",
"EmployeeXRefCode": "string",
"PayAdjustmentCodeXRefCode": "string",
"PayAdjustmentDate": "2024-10-15T19:34:56.797Z",
"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:34:56.797Z",
"ReferenceDate": "2024-10-15T19:34:56.797Z",
"EmployeeComment": "string",
"ManagerComment": "string",
"ManagerAuthorized": true,
"EmployeeAuthorized": true,
"AdjustPeriodStartDate": "2024-10-15T19:34:56.797Z",
"AdjustPeriodEndDate": "2024-10-15T19:34:56.797Z",
"LaborMetrics": [
{
"LaborMetricsTypeXRefCode": "string",
"LaborMetricsCodeXRefCode": "string"
}
]
}