Dayforce RESTful services use the POST verb to create an instance of the resource. In the case of the Projects resource, POST refers to creating a new project.
Endpoint URL
The URL for POST Projects uses the following base URL:
https://www.dayforcehcm.com/api/CompanyName/V1/Projects
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).
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/Projects?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.
{
"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-07T19:56:31.648Z",
"DueDate": "2022-04-07T19:56:31.648Z",
"BudgetHours": 0,
"BudgetAmount": 0,
"EmployeeAssignment": {
"IsAssignedAll": true,
"XrefCodes": [
"string"
]
},
"DeptJobAssignment": {
"IsAssignedAll": true,
"XrefCodes": [
"string"
]
},
"DepartmentAssignment": {
"IsAssignedAll": true,
"XrefCodes": [
"string"
]
},
"CompletedDate": "2022-04-07T19:56:31.648Z",
"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 create using this operation is assigned to the proper org unit. You cannot create 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 displayed.
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.
Security
Adding a new project requires role access to the HCM Anywhere > Web Services > Patch/Post Projects role feature in the Features tab of System Admin > Roles.