The consuming application can query Dayforce to retrieve a list of projects. The consuming application can also request details for a specific project by entering the project’s XRefCode in a separate GET request.
RESTful Get Projects
This GET operation returns a list containing all of the projects configured by an organization. The operation uses the following URL:
https://www.dayforcehcm.com/api/CompanyName/V1/Projects
Parameters
Consumers can retrieve projects data by using combinations of the following parameters:
shortName (string)
The project name.
longName (string)
The project description.
pageSize (integer)
The number of records returned per page in the paginated response.
projectClientXRefCode (string)
Reference code for the project client to be retrieved.
projectTypeXRefCode (string)
Reference code for the project type to be retrieved.
projectPhaseXRefCode (string)
Reference code for the project phase to be retrieved.
productGroupXRefCode (string)
Reference code for the product group to be retrieved.
productModuleXRefCode (string)
Reference code for the product module to be retrieved.
creationOrgUnitXRefCode (string)
Reference code for the organization to be retrieved.
lastModifiedStartDate (string)
The start date used when searching for projects with updates in a specified time frame.
lastModifiedEndDate (string)
The end date used when searching for projects with updates in a specified time frame.
filterStartDateFrom (string)
Use to search for projects with a start date value greater than or equal to the specified value.
filterStartDateTo (string)
Use to search for projects with a start date value less than or equal to the specified value.
filterDueDateFrom (string)
Use to search for projects with a due date value greater than or equal to the specified value.
filterDueDateTo (string)
Use to search for projects with a due date value less than or equal to the specified value.
filterCompletedDateFrom (string)
Use to search for projects with a completed date value greater than or equal to the specified value.
filterCompletedDateTo (string)
Use to search for projects with a completed date value less than or equal to the specified value.
certifiedPayrollProjectNumber (integer)
Use to search for projects with a certified payroll project number.
parentProjectXRefCode (string)
Reference code of the parent project to be retrieved.
isDeleted (boolean)
This filters the projects based on their deleted status (that is, whether it was deleted).
ledgerCode (string)
Use to search for projects with the specified ledger code.
clockTransferCode (string)
Use to search for projects with the specified clock code.
accountNum (string)
Use to search for projects with the specified account number.
iFRSClassification (boolean)
Use to filter accounts that are IFRS standardized accounts.
filterProjectPriorityForm (integer)
Use to search for projects with a project priority value greater than or equal to the specified value. When you use this parameter, you must also configure the filterProjectPriorityTo parameter.
filterProjectPriorityTo (integer)
Use to search for projects with a project priority value less than or equal to the specified value. When you use this parameter, you must also configure the filterProjectPriorityFrom parameter.
filterBudgetHoursFrom (number)
Use to search for projects with a budget hours value greater than or equal to the specified value. When you use this parameter, you must also configure the filterBudgetHoursTo parameter.
filterBudgetHoursTo (number)
Use to search for projects with a budget hours value less than or equal to the specified value. When you use this parameter, you must also configure the filterBudgetHoursFrom parameter.
filterBudgetAmountFrom (number)
Use to search for projects with a budget amount value greater than or equal to the specified value. When you use this parameter, you must also configure the filterBudgetAmountTo parameter.
filterBudgetAmountTo (number)
Use to search for projects with a budget amount value less than or equal to the specified value. When you use this parameter, you must also configure the filterBudgetAmountFrom parameter.
filterPctCompleteFrom (number)
Use to search for projects with a percentage complete value greater than or equal to the specified value. When you use this parameter, you must also configure the filterPctCompleteTo parameter.
filterPctCompleteTo (number)
Use to search for projects with a percentage complete value less than or equal to the specified value. When you use this parameter, you must also configure the filterPctCompleteFrom parameter.
Response
The response from this request contains data from the referenced project. Here is an example response:
"ParentProjectXRefCode": "string",
"CreationOrgUnitXRefCode": "string",
"StartDate": "2021-11-15T21:54:24.353Z",
"DueDate": "2021-11-15T21:54:24.353Z",
RESTful Get Projects XRefCodes
This GET operation returns the details of a specific project based on the XRefCode you enter. The operation uses the following URL:
https://www.dayforcehcm.com/api/CompanyName/V1/Projects/xRefCode
Parameters
Consumers can retrieve projects data by using combinations of the following parameters:
XRefCode (string)
The unique identifier (external reference code) of the project that will be retrieved. The value provided must be an exact match, otherwise a bad request (400) error will be returned. This setting is required.
Response
The response from this request will contain data from the referenced XRefCode. Here is an example response:
{
"Data": {
"ProjectXRefCode": "string",
"ShortName": "string",
"ParentProjectXRefCode": "string",
"CreationOrgUnitXRefCodes": [
"string"
],
"StartDate": "2022-02-24T00:51:10.464Z",
"DueDate": "2022-02-24T00:51:10.464Z",
"LongName": "string",
"ClockTransferCode": "string",
"ProjectPriority": 0,
"AccountNum": "string",
"LedgerCode": "string",
"IFRSClassification": true,
"CertifiedPayrollProjectNumber": "string",
"CompletedDate": "2022-02-24T00:51:10.464Z",
"PctComplete": 0,
"BudgetHours": 0,
"BudgetAmount": 0,
"ProjectClientXRefCode": "string",
"ProjectTypeXRefCode": "string",
"ProjectPhaseXRefCode": "string",
"ProductGroupXRefCode": "string",
"ProductModuleXRefCode": "string",
"Deleted": true,
"TaxLocationAddressXRefCode": "string",
"ChildProjectXRefCodes": [
"string"
],
"EmployeeXRefCodes": {
"IsAssignedAll": true,
"XrefCodes": [
"string"
]
},
"DeptJobXRefCodes": {
"IsAssignedAll": true,
"XrefCodes": [
"string"
]
},
"DepartmentXRefCodes": {
"IsAssignedAll": true,
"XrefCodes": [
"string"
]
},
"PayCodeXRefCodeChargeToHours": {
"IsAssignedAll": true,
"XrefCodes": [
"string"
]
},
"PayCodeXRefCodeChargeToAmount": {
"IsAssignedAll": true,
"XrefCodes": [
"string"
]
},
"IsResidentAddressUsedForTaxation": true
},
"ProcessResults": [
{
"Code": "string",
"Context": "string",
"Level": "string",
"Message": "string"
}
]
}