Dayforce RESTful services use the PATCH verb to update projects.
Overview
You can update projects data using the PATCH Projects endpoint. The operation uses the following URL:
https://www.dayforcehcm.com/api/CompanyName/V1/Projects
Parameters
projectXRefCode (string)
- Reference code of the project from which data must be retrieved.
- The URL syntax is: https://www.dayforcehcm.com/api/CompanyName/V1/Projects?projectxrefcode=[XRefCode]
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/Projects?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 example below shows all of the possible fields in the correct JSON format.
{
"ProjectXRefCode": "string",
"ShortName": "string",
"CreationOrgUnitXRefCodes": [
"string"
],
"ClockTransferCode": "string",
"ProjectPriority": 0,
"AccountNum": "string",
"IFRSClassification": true,
"LongName": "string",
"LedgerCode": "string",
"CertifiedPayrollProjectNumber": "string",
"ProjectClientXRefCode": "string",
"ProjectTypeXRefCode": "string",
"ProjectPhaseXRefCode": "string",
"ProductGroupXRefCode": "string",
"ProductModuleXRefCode": "string",
"StartDate": "2022-04-08T14:28:49.243Z",
"DueDate": "2022-04-08T14:28:49.243Z",
"BudgetHours": 0,
"BudgetAmount": 0,
"EmployeeAssignment": {
"IsAssignedAll": true,
"XrefCodes": [
"string"
]
},
"DeptJobAssignment": {
"IsAssignedAll": true,
"XrefCodes": [
"string"
]
},
"DepartmentAssignment": {
"IsAssignedAll": true,
"XrefCodes": [
"string"
]
},
"CompletedDate": "2022-04-08T14:28:49.244Z",
"PctComplete": 0,
"IsDeleted": true,
"PayCodeXRefCodeChargeToHours": {
"IsAssignedAll": true,
"XrefCodes": [
"string"
]
},
"PayCodeXRefCodeChargeToAmount": {
"IsAssignedAll": true,
"XrefCodes": [
"string"
]
},
"ParentProjectXRefCode": "string",
"TaxLocationAddressXRefCode": "string",
"IsResidentAddressUsedForTaxation": true
}
Validation of Org Unit Level
Dayforce validates that any project you update using this operation is assigned to the proper org unit. You can’t update a project that’s assigned to a department-level org unit. The application validates that the org unit referenced in the request’s "CreationOrgUnitXRefCode" field isn’t assigned as a department-level org unit in Org Setup > Organization. When the application detects that a project is assigned to a department, an error message is shown.
The "CreationOrgUnitXRefCode" field provides multiple org level support. That is, the field supports multiple locations and doesn’t require that the locations are directly tied to each other as org units. For example, you can include locations that are nested at different or indirect levels in your organizational hierarchy.
Important: If you include org units that are nested deep in your organizational hierarchy (for example, 16 levels) in this field, it might impact the performance of this operation.
Validation of IFRS Classification
Dayforce validates that any request containing the "IFRSClassification" field is configured correctly. When your request contains this field, it must be set to either true or false.
Validation of Parent Project
When updating a child project, this operation uses a project’s ID in the database to determine the correct parent project. The "ParentProjectXRefCode" field isn’t used to identify a child project’s parent project because several different parent projects can be given the same XRefCode in the Projects feature.
Security
Updating the details for an existing project requires role access to the HCM Anywhere > Web Services > Patch/Post Projects role feature in the Features tab of System Admin > Roles.