Dayforce
Overview
The Dayforce connector enables your AI Colleagues to integrate with your organization's Dayforce HCM platform, facilitating automated HR workflows such as employee lookups, leave balance checks, time-off requests and approvals, paystub retrieval, and report execution.
Dayforce (formerly Ceridian Dayforce) is a global human capital management (HCM) platform covering HR, payroll, benefits, workforce management, and talent management. The Dayforce connector allows Leena AI to automate HR and payroll workflows through REST API integration with the Dayforce web-services platform.
API Details
Leena AI integrates with Dayforce via REST APIs.
Documentation link: https://developers.dayforce.com/
Setup
The Dayforce connector supports two authentication types — Service account (an OAuth 2.0 password grant against the Dayforce Identity server, recommended) and Basic (username and password) (HTTP Basic authentication with the integration user's credentials).
Prerequisites
Before setting up the Dayforce connector, ensure you have:
- Administrator access to your Dayforce instance
- A dedicated integration user in Dayforce whose role has the HCM Anywhere > Web Services feature enabled
- Your Dayforce Company ID (client namespace, e.g.
panoramic) - Your Dayforce web-services base URL (the
-serviceshost, e.g.https://ustest261-services.dayforcehcm.com/api) - Access to your Leena AI workspace with connector management permissions
Get credentials
Here is how to prepare credentials in Dayforce:
- Log in to Dayforce as an administrator.
- Create (or identify) a dedicated integration user for Leena AI.
- Ensure the user's role has the HCM Anywhere > Web Services feature enabled — without it, all API calls are rejected.
- Note your Company ID (the client namespace used in Dayforce URLs).
- Note your API Base URL — the Dayforce web-services host up to
/api(use the-serviceshost, e.g.https://ustest261-services.dayforcehcm.com/api). The company ID and API version are appended automatically by Leena AI. - If using the Service account auth type, confirm the token endpoint:
- Production:
https://dfid.dayforcehcm.com/connect/token(pre-filled default) - Test/UAT:
https://dfidtst.np.dayforcehcm.com/connect/token
- Production:
Add connection
Here is how to add a connection on Leena AI:
-
Log in to your Leena AI workspace
-
Navigate to Settings > Integrations
-
Search for "Dayforce" and select it from the list to add its new connector
-
Select the Auth Type. Two authentication methods are supported:
- Service account — an OAuth 2.0 password grant against the Dayforce Identity server, minted for the dedicated web-services user (recommended)
- Basic (username and password) — HTTP Basic authentication with the integration user's credentials (used by some tenants instead of the OAuth 2.0 password grant)
-
Configure the connector fields:
Service account:
Field Description API Base URL Dayforce web-services host up to /api(use the "-services" host, e.g.https://ustest261-services.dayforcehcm.com/api). The company ID and API version are appended automatically.Company ID Dayforce company ID / client namespace (e.g. panoramic).Dayforce API Version API version segment appended to the base URL. Keep the default ( v1) unless Dayforce changes it.Username Dayforce user whose role has the "HCM Anywhere > Web Services" feature enabled. Password Password for the integration user. Token URL Dayforce Identity token endpoint. Keep the default for production ( https://dfid.dayforcehcm.com/connect/token). Test/UAT instances usehttps://dfidtst.np.dayforcehcm.com/connect/token.Client ID OAuth client ID. Keep the default ( Dayforce.HCMAnywhere.Client) unless Dayforce issues a different one.Basic (username and password):
Field Description API Base URL Dayforce web-services host up to /api(use the "-services" host). The company ID and API version are appended automatically.Company ID Dayforce company ID / client namespace (e.g. panoramic).Dayforce API Version API version segment appended to the base URL. Keep the default ( v1).Username Dayforce user whose role has the "HCM Anywhere > Web Services" feature enabled. Password Password for the integration user. -
Click Test Connection — Leena AI mints a token (for Service account auth) and performs a lightweight API call to verify that the base URL and company ID are real and the user's role has web-services access.
-
Save the connector.
Actions
The following actions are supported for the Dayforce connector:
List Employees
Lists the XRefCodes of all employees. The Agent can leverage the tool (workflow), which has been designed to list employees in Dayforce, once the user raises a query to do so.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
None.
Optional
| Name | Description |
|---|---|
| Employment status | Filter by employment status group. Leave empty to return all employees. Options: • Active • Inactive • Terminated |
| Updated from | Return employees updated on or after this date. Dayforce requires both updated dates to be provided together. |
| Updated to | Return employees updated on or before this date. Dayforce requires both updated dates to be provided together. |
Here is a sample JSON input:
{
"employmentStatusXRefCode": "ACTIVE",
"filterUpdatedStartDate": "2026-01-01",
"filterUpdatedEndDate": "2026-07-31"
}Response
The action returns the list of employee XRefCodes matching the optional filters.
Get Employee Details
Fetches an employee profile with expandable related entities. The Agent can leverage the tool (workflow), which has been designed to fetch an employee's full profile from Dayforce, once the user raises a query to do so.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Employee XRef code | Unique identifier for the employee. A dropdown pre-populated with all employees; manual XRefCode entry is also accepted. |
Optional
| Name | Description |
|---|---|
| Expand | Related entities to include in the response. Defaults to: WorkAssignments, EmploymentStatuses, Contacts, EmployeeManagers |
Here is a sample JSON input:
{
"employeeXRefCode": "EMP001",
"expand": "WorkAssignments,Contacts"
}Response
The action returns the complete employee profile with the selected related entities nested in the response (by default: work assignments, employment statuses, contacts, and employee managers).
Get Leave Balances
Fetches PTO/sick and other balance periods for an employee. The Agent can leverage the tool (workflow), which has been designed to look up an employee's leave balances in Dayforce, once the user raises a query to do so.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Employee XRef code | Unique identifier for the employee. A dropdown pre-populated with all employees; manual XRefCode entry is also accepted. |
Optional
None.
Here is a sample JSON input:
{
"employeeXRefCode": "EMP001"
}Response
The action returns the employee's balance periods — PTO, sick leave, and other time-off category balances, with available hours/days and pending accruals.
Get Time Away From Work
Lists leave requests for an employee within a date range. The Agent can leverage the tool (workflow), which has been designed to view an employee's requested leaves in Dayforce, once the user raises a query to do so.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Employee XRef code | Unique identifier for the employee. A dropdown pre-populated with all employees; manual XRefCode entry is also accepted. |
| Start date | Beginning of the date range to query for time-away requests. |
| End date | End of the date range to query for time-away requests. |
| Status | Request status to filter by. Dayforce requires exactly one status. Options: • Approved • Pending • Canceled |
Optional
None.
Here is a sample JSON input:
{
"employeeXRefCode": "EMP001",
"filterTAFWStartDate": "2026-07-01T00:00:00",
"filterTAFWEndDate": "2026-07-31T00:00:00",
"status": "APPROVED"
}Response
The action returns the employee's time-away-from-work requests within the date range, filtered by status. Each record includes:
- The request XRefCode (TAFW reference)
- Start and end dates
- Leave type
- Current status
Apply Leave
Submits a new time-off request for an employee. The Agent can leverage the tool (workflow), which has been designed to apply for leave on behalf of an employee in Dayforce, once the user raises a query to do so. New requests are always submitted with Pending status.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Employee XRef code | Unique identifier for the employee. A dropdown pre-populated with all employees; manual XRefCode entry is also accepted. |
| Pay adjustment code XRef code | Dayforce pay adjustment code that classifies the type of leave and decides which balance the hours draw from. Valid codes are configured per company by the Dayforce admin — e.g. PTO (vacation), SICK (sick leave), BRV (bereavement), JURY (jury duty). |
| Leave duration | All day books whole days using the start/end dates; Partial day books hours using explicit start and end times. Options: • All day (default) • Partial day |
| Start date | Date when the leave starts (YYYY-MM-DD). Required when Leave duration is "All day". |
| End date | Date when the leave ends, exclusive — use the day after the last day of leave. For example, a one-day leave on 22nd September 2026 has start date 2026-09-22 and end date 2026-09-23. Required when Leave duration is "All day". |
| Partial-day start date / time | Date (YYYY-MM-DD) and time (HH:mm) when the partial leave starts. Required when Leave duration is "Partial day". |
| Partial-day end date / time | Date (YYYY-MM-DD) and time (HH:mm) when the partial leave ends. Required when Leave duration is "Partial day". |
Optional
| Name | Description |
|---|---|
| Comment | Employee comment or reason for the leave request. |
Here is a sample JSON input:
//All-day leave
{
"employeeXRefCode": "EMP001",
"payAdjustmentCodeXRefCode": "PTO",
"allDay": true,
"timeStart": "2026-09-22",
"timeEnd": "2026-09-23",
"employeeComment": "Vacation"
}
//Partial-day leave
{
"employeeXRefCode": "EMP001",
"payAdjustmentCodeXRefCode": "SICK",
"allDay": false,
"partialDayStartDate": "2026-11-06",
"partialDayStartTime": "11:00",
"partialDayEndDate": "2026-11-06",
"partialDayEndTime": "13:00",
"employeeComment": "Doctor appointment"
}Response
Upon successful submission, the action returns the created time-off record, including:
- The assigned TAFW XRefCode (e.g.
DF_58147), which can be used later to approve or cancel the request - The request status — new requests are always submitted with Pending status
Update Time-Off Status
Updates the status of an existing time-off request (approve or cancel). The Agent can leverage the tool (workflow), which has been designed to approve or cancel a leave request in Dayforce, once the user raises a query to do so.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| TAFW XRef code | Reference code of the time-off request (e.g. DF_58147), returned by Apply Leave / Get Time Away From Work. |
| New status | Target status for the request. Options: • Approved • Pending • Canceled |
Optional
None.
Here is a sample JSON input:
{
"tafwXRefCode": "DF_58147",
"statusXRefCode": "APPROVED"
}Response
The action returns the updated time-off record with the new status reflected, confirming the status change.
Get Earning Statement Headers
Fetches paystub (earning statement) headers for employees. The Agent can leverage the tool (workflow), which has been designed to retrieve an employee's paystub headers from Dayforce, once the user raises a query to do so.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Employee XRef code | Unique identifier for the employee(s). A dropdown pre-populated with all employees; manual XRefCode entry is also accepted. |
| Employee last names | Last name(s) matching the XRefCodes. Required by Dayforce alongside XRefCodes; auto-populated based on the selected employee(s). |
Optional
None.
Here is a sample JSON input:
{
"employeeXRefCodes": "EMP001",
"employeeLastNames": "Smith"
}Response
The action returns earning statement header records for the specified employee(s), including:
- Payroll period information
- Gross earnings and net pay
- Metadata for retrieving detailed paystub content
If Dayforce returns a 500 error for this action, the earning statement encryption key is usually not configured on the Dayforce side. Ask your Dayforce administrator to configure it.
Get Direct Deposits
Fetches an employee's direct deposit bank account setup. The Agent can leverage the tool (workflow), which has been designed to view an employee's direct deposit configuration in Dayforce, once the user raises a query to do so.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Employee XRef code | Unique identifier for the employee. A dropdown pre-populated with all employees; manual XRefCode entry is also accepted. |
Optional
| Name | Description |
|---|---|
| Effective from | Start of the effective date range filter. Returns records whose effective period overlaps the range. A current open-ended record (no effective end date) matches every range from its start date onward. |
| Effective to | End of the effective date range filter. |
Here is a sample JSON input:
{
"employeeXRefCode": "EMP001",
"contextDateRangeFrom": "2026-01-01",
"contextDateRangeTo": "2026-12-31"
}Response
The action returns the employee's direct deposit account records, including:
- Bank routing numbers and account numbers
- Account types
- Effective date ranges for each configured direct deposit destination
Get US Federal Taxes (W4)
Fetches an employee's federal tax withholding elections. The Agent can leverage the tool (workflow), which has been designed to look up an employee's W4 elections in Dayforce, once the user raises a query to do so.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Employee XRef code | Unique identifier for the employee. A dropdown pre-populated with all employees; manual XRefCode entry is also accepted. |
Optional
| Name | Description |
|---|---|
| Effective from | Start of the effective date range filter. Returns records whose effective period overlaps the range. A current open-ended record (no effective end date) matches every range from its start date onward. |
| Effective to | End of the effective date range filter. |
Here is a sample JSON input:
{
"employeeXRefCode": "EMP001",
"contextDateRangeFrom": "2026-01-01",
"contextDateRangeTo": "2026-12-31"
}Response
The action returns the employee's federal tax withholding election records (W4 data), including:
- Filing status
- Allowances
- Additional withholding amounts
- Effective date ranges
Run Report
Runs a Dayforce report by reference code with optional parameters. The Agent can leverage the tool (workflow), which has been designed to execute a configured Dayforce report, once the user raises a query to do so.
Input Parameters
Here are the input parameters required to set up this action:
Mandatory
| Name | Description |
|---|---|
| Report | Report reference code configured in Dayforce (e.g. LEENA_INT). A dropdown pre-populated with all available reports; manual XRefCode entry is also accepted. |
Optional
| Name | Description |
|---|---|
| Report parameters | Optional key-value pairs of report parameters. Keys are the ReportParameterMetadataId GUIDs listed by GET /ReportMetadata/{reportXRefCode} under Parameters; values are the inputs — e.g. a manager employee number to filter a manager-pending report. |
Here is a sample JSON input:
{
"reportXRefCode": "LEENA_INT",
"parameters": [
{
"key": "87e0d602-5a21-42bc-851b-ca2b14d8d233",
"value": "101510"
}
]
}Response
The action returns the report rows matching the report's configuration and the applied parameter filters. The exact fields depend on the report's definition in Dayforce.
Updated about 16 hours ago
