Dayforce

App · 25 actions

Read Dayforce employees, time entries, schedules, time off, balances, pay and reports, add time entries, time off and pay adjustments, and start workflows when someone is hired, leaves, clocks in or asks for time off.

Actions

ActionWhat it does
Add pay adjustmentAdd a pay adjustment for an employee: hours or an amount on a pay adjustment code, such as a bonus, for one day.
Add time entryAdd a time entry (a worked shift) for an employee on one day, from a start time to an end time at their location's local time.
Delete time entryDelete a time entry, with its meals, breaks and transfers.
Get employeeGet one employee's record: name, number, badge, hire and start dates, and any of their work assignments, employment statuses, contacts, addresses, managers and more.
Get employee contactsGet an employee's contact details: work and personal emails and phone numbers.
Get employee employment statusesGet an employee's employment statuses: active or terminated, pay type, pay group, pay class and base rate, with when each applies.
Get employee work assignmentsGet an employee's work assignments: position, job, department, location, business title and FTE, with when each applies.
Get org unitGet one org unit with its name, address, contact and, if asked, the org units under it.
List clock swipesList raw clock swipes (clock in, out, breaks, meals and transfers) as the time clocks sent them, with whether Dayforce processed or rejected each.
List departmentsList the company's departments with their XRef codes.
List employeesFind employees by number, name, employment status, org unit, department, job, position, or hire, termination or change dates.
List job postingsList job postings with title, location, dates and the addresses to view and apply, open ones only unless asked.
List jobsList the company's jobs with their XRef codes.
List org unitsList the company's org units: locations, sites, regions and the rest of its organization, by XRef code.
List pay adjustmentsList pay adjustments (bonuses, extra hours, amounts) dated between two dates, optionally only those changed in a window.
List pay summariesList calculated pay lines between two dates: pay code, hours, rate and amount per employee and day.
List positionsList the company's positions (a job in a department) with their XRef codes.
List reportsList the reports the connection's user may run through the API.
List scheduled shiftsList scheduled shifts from a start date up to an end date, with times, hours, location, department and job, for everyone or one employee.
List time entriesList time entries (punches) added or changed in a window, with start, end, hours, location, department and job.
List time offList an employee's time-off requests with a given status between two dates, with reason, times and hours.
List time-off balancesList an employee's balances, such as vacation and sick time, with what is accrued and granted.
Request time offFile time off for an employee: whole days from a start to an end date, or part of one day between two times, as pending or approved.
Run reportRun a Dayforce report and get its rows, each with the report's columns.
Update time offApprove, deny or cancel a time-off request, or add a comment to it.

Add pay adjustment

Add a pay adjustment for an employee: hours or an amount on a pay adjustment code, such as a bonus, for one day.

Inputs

Employee XRef codeemployeetextRequired
The employee's XRef code, their reference code in Dayforce (often their employee number). 'List employees' and the triggers give it.
Pay adjustment codepay_adjustment_codetextRequired
The pay adjustment code's XRef code in Dayforce, such as BONUS.
Dateadjustment_datedateRequired
The day it applies to.
Hourshoursnumber
The hours, for an hours-based code.
Amountamountnumber
The amount, for an amount-based code.
Rateratenumber
A rate to pay the hours at. Defaults to the code's own.At least 0.
Org unitorg_unittext
The location to charge. Defaults to the employee's own.
Departmentdepartmenttext
The department to charge.
Jobjobtext
The job to charge.
Employee commentemployee_commenttext
A comment from the employee.
Manager commentmanager_commenttext
A comment from the manager.
Manager authorizedmanager_authorizedtrue/false
Turn on to mark it authorized by a manager.
Adjustment XRef codeadjustment_codetext
A reference code to give the adjustment. Dayforce makes one if left empty.
Check onlyvalidate_onlytrue/false
Turn on to have Dayforce check the values and say whether it would accept them, without saving anything.Default: false.

Outputs

adjustment_codetext
The adjustment's XRef code
employeetext
The employee's XRef code
pay_adjustment_codetext
The pay adjustment code used
validated_onlytrue/false
True if Dayforce only checked the values and saved nothing
Example output
{
  "adjustment_code": "778120",
  "employee": "42199",
  "pay_adjustment_code": "BONUS",
  "validated_only": false
}

Add time entry

Add a time entry (a worked shift) for an employee on one day, from a start time to an end time at their location's local time.

Inputs

Employee XRef codeemployeetextRequired
The employee's XRef code, their reference code in Dayforce (often their employee number). 'List employees' and the triggers give it.
Datework_datedateRequired
The day the shift started.
Start timestart_timetimeRequired
When the shift started.
End timeend_timetimeRequired
When the shift ended. A time at or before the start means the next day.
Org unitorg_unittext
The location worked at. Defaults to the employee's own.
Department job codedepartment_jobtext
The department job worked, by its XRef code. Defaults to the employee's own.
Entry XRef codepunch_codetext
A reference code to give the entry, so a later step can find or delete it. Dayforce makes one if left empty.
Check onlyvalidate_onlytrue/false
Turn on to have Dayforce check the values and say whether it would accept them, without saving anything.Default: false.

Outputs

employeetext
The employee's XRef code
punch_codetext
The entry's XRef code, for 'Delete time entry'
time_endtext
When it ends, local time
time_starttext
When it starts, local time
validated_onlytrue/false
True if Dayforce only checked the values and saved nothing
Example output
{
  "employee": "42199",
  "punch_code": "LODOL-1A2B3C",
  "time_end": "2026-11-12T17:00:00",
  "time_start": "2026-11-12T09:00:00",
  "validated_only": false
}

Delete time entry

Delete a time entry, with its meals, breaks and transfers.

Inputs

Entry XRef codepunch_codetextRequired
The time entry's XRef code, from 'List time entries' or 'Add time entry'.

Outputs

deletedtrue/false
True once Dayforce deleted it
punch_codetext
The deleted entry's XRef code
Example output
{
  "deleted": true,
  "punch_code": "LODOL-1A2B3C"
}

Get employee

Get one employee's record: name, number, badge, hire and start dates, and any of their work assignments, employment statuses, contacts, addresses, managers and more.

Inputs

Employee XRef codeemployeetextRequired
The employee's XRef code, their reference code in Dayforce (often their employee number). 'List employees' and the triggers give it.
Includeexpandlist
Collections to add to the record.One or more of: WorkAssignments (Work assignments (job, position, location)), EmploymentStatuses (Employment statuses (pay type, pay group, policies)), Contacts (Contact details (emails, phones)), Addresses, EmployeeManagers (Managers), Roles, Locations, OrgUnitInfos (Organization assignments), CompensationSummary (Compensation summary), EmergencyContacts (Emergency contacts), and 3 more.
As ofas_of_datedate
The date to read the records as of, for records that change over time. Defaults to today.

Outputs

employeeobject
The employee
Example output
{
  "employee": {
    "BadgeNumber": "42199",
    "BirthDate": "1990-06-02T00:00:00",
    "DisplayName": "Jordan Rivera",
    "EmployeeNumber": "42199",
    "FirstName": "Jordan",
    "Gender": "F",
    "HireDate": "2022-03-14T00:00:00",
    "HomePhone": "555 010 0199",
    "LastName": "Rivera",
    "LoginId": "jrivera",
    "OriginalHireDate": "2022-03-14T00:00:00",
    "StartDate": "2022-03-14T00:00:00",
    "XRefCode": "42199"
  }
}

Get employee contacts

Get an employee's contact details: work and personal emails and phone numbers.

Inputs

Employee XRef codeemployeetextRequired
The employee's XRef code, their reference code in Dayforce (often their employee number). 'List employees' and the triggers give it.
As ofas_of_datedate
The date to read the records as of, for records that change over time. Defaults to today.

Outputs

contactslist
The contact details
countnumber
How many were returned
Example output
{
  "contacts": [
    {
      "ContactInformationType": {
        "LongName": "Business Email",
        "ShortName": "Business Email",
        "XRefCode": "BusinessEmail"
      },
      "ContactNumber": null,
      "EffectiveStart": "2022-03-14T00:00:00",
      "ElectronicAddress": "jordan.rivera@example.com",
      "IsPreferredContactMethod": true
    }
  ],
  "count": 1
}

Get employee employment statuses

Get an employee's employment statuses: active or terminated, pay type, pay group, pay class and base rate, with when each applies.

Inputs

Employee XRef codeemployeetextRequired
The employee's XRef code, their reference code in Dayforce (often their employee number). 'List employees' and the triggers give it.
As ofas_of_datedate
The date to read the records as of, for records that change over time. Defaults to today.

Outputs

countnumber
How many were returned
employment_statuseslist
The employment statuses
Example output
{
  "count": 1,
  "employment_statuses": [
    {
      "BaseRate": 18.5,
      "EffectiveEnd": null,
      "EffectiveStart": "2022-03-14T00:00:00",
      "EmploymentStatus": {
        "LongName": "Active",
        "ShortName": "Active",
        "XRefCode": "ACTIVE"
      },
      "EmploymentStatusGroup": {
        "LongName": "Active",
        "ShortName": "Active",
        "XRefCode": "ACTIVE"
      },
      "PayClass": {
        "LongName": "Full Time",
        "ShortName": "Full Time",
        "XRefCode": "FT"
      },
      "PayGroup": {
        "LongName": "US Biweekly",
        "ShortName": "US Biweekly",
        "XRefCode": "USA_BW"
      },
      "PayType": {
        "LongName": "Hourly",
        "ShortName": "Hourly",
        "XRefCode": "HourlyNon"
      }
    }
  ]
}

Get employee work assignments

Get an employee's work assignments: position, job, department, location, business title and FTE, with when each applies.

Inputs

Employee XRef codeemployeetextRequired
The employee's XRef code, their reference code in Dayforce (often their employee number). 'List employees' and the triggers give it.
As ofas_of_datedate
The date to read the records as of, for records that change over time. Defaults to today.

Outputs

countnumber
How many were returned
work_assignmentslist
The work assignments
Example output
{
  "count": 1,
  "work_assignments": [
    {
      "BusinessTitle": "Cashier",
      "EffectiveEnd": null,
      "EffectiveStart": "2022-03-14T00:00:00",
      "FTE": 1.0,
      "IsPrimary": true,
      "Location": {
        "LongName": "Store 101 - Main Street",
        "ShortName": "Store 101",
        "XRefCode": "STORE_101"
      },
      "Position": {
        "Department": {
          "LongName": "Front End",
          "ShortName": "Front End",
          "XRefCode": "FRONT"
        },
        "Job": {
          "LongName": "Cashier",
          "ShortName": "Cashier",
          "XRefCode": "CASHIER"
        },
        "ShortName": "Front End Cashier",
        "XRefCode": "FRONT_CASHIER"
      }
    }
  ]
}

Get org unit

Get one org unit with its name, address, contact and, if asked, the org units under it.

Inputs

Org unitorg_unittextRequired
The org unit.
Include org units under itinclude_childrentrue/false
Turn on to add the org units directly under it.
As ofas_of_datedate
The date to read the records as of, for records that change over time. Defaults to today.

Outputs

org_unitobject
The org unit
Example output
{
  "org_unit": {
    "Address": "101 Main Street",
    "City": "Springfield",
    "ContactEmail": "store101@example.com",
    "CountryCode": "USA",
    "LongName": "Store 101 - Main Street",
    "PhysicalLocation": true,
    "PostalCode": "62701",
    "ShortName": "Store 101",
    "StateCode": "IL",
    "XRefCode": "STORE_101"
  }
}

List clock swipes

List raw clock swipes (clock in, out, breaks, meals and transfers) as the time clocks sent them, with whether Dayforce processed or rejected each.

Inputs

Frompunched_fromdate and timeRequired
The start of the window, in UTC.
Topunched_todate and timeRequired
The end of the window, in UTC.
Employee XRef codeemployeetext
Only this employee, by XRef code. Leave empty for everyone.
Badge numberbadgetext
Only swipes with this badge.
Statepunch_statetext
Only processed or only rejected swipes. Defaults to all.One of: ALL, PROCESSED, REJECTED.
Kindspunch_typeslist
Only these kinds of swipe. Leave empty for all.One or more of: Punch_In (Clock in), Punch_Out (Clock out), Break_Out (Break start), Break_In (Break end), Meal_Out (Meal start), Meal_In (Meal end), Job_Transfer (Job transfer).
Limitlimitnumber
The most records to return, 1 to 5,000. Defaults to 200.From 1 to 5000.

Outputs

countnumber
How many were returned
has_moretrue/false
True if Dayforce has more than the limit; raise it or narrow the dates
raw_puncheslist
The clock swipes
Example output
{
  "count": 1,
  "has_more": false,
  "raw_punches": [
    {
      "EmployeeBadge": "42199",
      "EmployeeXRefCode": "42199",
      "LocationXRefCode": "STORE_101",
      "PunchDevice": "00-1B-44-11-3A-B7",
      "PunchState": "PROCESSED",
      "PunchType": "Punch_In",
      "RawPunchTime": "2026-11-12T08:58:41-05:00",
      "RawPunchXRefCode": "88231",
      "RejectedReason": null
    }
  ]
}

List departments

List the company's departments with their XRef codes.

Inputs

None.

Outputs

countnumber
How many were returned
departmentslist
The departments
Example output
{
  "count": 1,
  "departments": [
    {
      "LastModifiedTimestamp": "2025-04-01T10:00:00",
      "LongName": "Front End",
      "ShortName": "Front End",
      "XRefCode": "FRONT"
    }
  ]
}

List employees

Find employees by number, name, employment status, org unit, department, job, position, or hire, termination or change dates. Gives each one's XRef code, for 'Get employee'.

Inputs

Employee numberemployee_numbertext
Employees whose number contains this.
Namedisplay_nametext
Employees whose name contains this.
Employment statusemployment_statustext
Only employees with this employment status.
Org unitorg_unittext
Only employees in this org unit, at any level.
Departmentdepartmenttext
Only this department.
Jobjobtext
Only this job.
Positionpositiontext
Only this position.
Hired on or afterhired_fromdate
Only employees hired on or after this date.
Hired on or beforehired_todate
Only employees hired on or before this date.
Terminated on or afterterminated_fromdate
Only employees terminated on or after this date.
Terminated on or beforeterminated_todate
Only employees terminated on or before this date.
Changed sincechanged_fromdate and time
Only employees whose records changed since this time (UTC).
Changed untilchanged_todate and time
With 'Changed since', only changes up to this time. Defaults to now.
As ofas_of_datedate
The date to read the records as of, for records that change over time. Defaults to today.

Outputs

countnumber
How many were returned
employeeslist
The employees, by XRef code
Example output
{
  "count": 1,
  "employees": [
    {
      "XRefCode": "42199"
    }
  ]
}

List job postings

List job postings with title, location, dates and the addresses to view and apply, open ones only unless asked.

Inputs

Open postings onlyactive_onlytrue/false
Turn off to include closed postings, which needs 'Changed since' and 'Changed until'.Default: true.
Posted on or afterposted_fromdate
Only postings posted on or after this date.
Posted on or beforeposted_todate
Only postings posted on or before this date.
Changed sincechanged_fromdate and time
Only postings changed since this time.
Changed untilchanged_todate and time
Only postings changed up to this time.
Company namecompany_nametext
Only postings for this company.
Job board codejob_boardtext
Only postings on this job board, such as CANDIDATEPORTAL.

Outputs

countnumber
How many were returned
job_postingslist
The job postings
Example output
{
  "count": 1,
  "job_postings": [
    {
      "ApplyUrl": "https://jobs.dayforcehcm.com/en-US/example/CANDIDATEPORTAL/jobs/1187/apply",
      "City": "Springfield",
      "CompanyName": "Example Retail",
      "Country": "USA",
      "DatePosted": "2026-11-10T15:00:00",
      "EmploymentIndicator": "Full Time",
      "JobDetailsUrl": "https://jobs.dayforcehcm.com/en-US/example/CANDIDATEPORTAL/jobs/1187",
      "LastUpdated": "2026-11-11T09:12:00",
      "ReferenceNumber": 1187,
      "State": "IL",
      "Title": "Store Supervisor"
    }
  ]
}

List jobs

List the company's jobs with their XRef codes.

Inputs

As ofas_of_datedate
The date to read the records as of, for records that change over time. Defaults to today.

Outputs

countnumber
How many were returned
jobslist
The jobs
Example output
{
  "count": 1,
  "jobs": [
    {
      "EffectiveStart": "2020-01-01T00:00:00",
      "LastModifiedTimestamp": "2025-04-01T10:00:00",
      "LongName": "Cashier",
      "ShortName": "Cashier",
      "XRefCode": "CASHIER"
    }
  ]
}

List org units

List the company's org units: locations, sites, regions and the rest of its organization, by XRef code.

Inputs

None.

Outputs

countnumber
How many were returned
org_unitslist
The org units
Example output
{
  "count": 1,
  "org_units": [
    {
      "ShortName": "Store 101",
      "XRefCode": "STORE_101"
    }
  ]
}

List pay adjustments

List pay adjustments (bonuses, extra hours, amounts) dated between two dates, optionally only those changed in a window.

Inputs

Fromstart_datedateRequired
The first day.
Toend_datedateRequired
The last day.
Employee XRef codeemployeetext
Only this employee, by XRef code. Leave empty for everyone.
Org unitorg_unittext
Only this org unit (location). Leave empty for all.
Departmentdepartmenttext
Only this department.
Jobjobtext
Only this job.
Pay adjustment codepay_adjustment_codetext
Only this pay adjustment code, such as BONUS.
Changed sincechanged_fromdate and time
Only those changed since this time (UTC).
Changed untilchanged_todate and time
Only those changed up to this time (UTC).
Limitlimitnumber
The most records to return, 1 to 5,000. Defaults to 200.From 1 to 5000.

Outputs

countnumber
How many were returned
has_moretrue/false
True if Dayforce has more than the limit; raise it or narrow the dates
pay_adjustmentslist
The pay adjustments
Example output
{
  "count": 1,
  "has_more": false,
  "pay_adjustments": [
    {
      "Amount": 150.0,
      "DepartmentXRefCode": "FRONT",
      "EmployeeAuthorized": false,
      "EmployeePayAdjustXRefCode": "778120",
      "EmployeeXRefCode": "42199",
      "Hours": 0.0,
      "IsDeleted": false,
      "JobXRefCode": "CASHIER",
      "LastModifiedTimestampUtc": "2026-11-12T19:30:00",
      "ManagerAuthorized": true,
      "ManagerComment": "Holiday bonus",
      "OrgUnitXRefCode": "STORE_101",
      "PayAdjustmentCodeXRefCode": "BONUS",
      "PayDate": "2026-11-20T00:00:00",
      "Rate": 0.0
    }
  ]
}

List pay summaries

List calculated pay lines between two dates: pay code, hours, rate and amount per employee and day.

Inputs

Fromstart_datedateRequired
The first day.
Toend_datedateRequired
The last day.
Employee XRef codeemployeetext
Only this employee, by XRef code. Leave empty for everyone.
Org unitorg_unittext
Only this org unit (location). Leave empty for all.
Limitlimitnumber
The most records to return, 1 to 5,000. Defaults to 200.From 1 to 5000.

Outputs

countnumber
How many were returned
has_moretrue/false
True if Dayforce has more than the limit; raise it or narrow the dates
pay_summarieslist
The pay lines
Example output
{
  "count": 1,
  "has_more": false,
  "pay_summaries": [
    {
      "BusinessDate": "2026-11-12T00:00:00",
      "DepartmentXRefCode": "FRONT",
      "EmployeeXRefCode": "42199",
      "JobXRefCode": "CASHIER",
      "LocationXRefCode": "STORE_101",
      "NetHours": 7.5,
      "PayAmount": 138.75,
      "PayCategoryXRefCode": "Regular",
      "PayCodeXRefCode": "REG",
      "PayDate": "2026-11-20T00:00:00",
      "Rate": 18.5,
      "TimeEnd": "2026-11-12T17:00:00",
      "TimeStart": "2026-11-12T09:00:00"
    }
  ]
}

List positions

List the company's positions (a job in a department) with their XRef codes.

Inputs

As ofas_of_datedate
The date to read the records as of, for records that change over time. Defaults to today.

Outputs

countnumber
How many were returned
positionslist
The positions
Example output
{
  "count": 1,
  "positions": [
    {
      "Department": {
        "LongName": "Front End",
        "ShortName": "Front End",
        "XRefCode": "FRONT"
      },
      "EffectiveStart": "2020-01-01T00:00:00",
      "Job": {
        "LongName": "Cashier",
        "ShortName": "Cashier",
        "XRefCode": "CASHIER"
      },
      "LongName": "Front End Cashier",
      "ShortName": "Front End Cashier",
      "XRefCode": "FRONT_CASHIER"
    }
  ]
}

List reports

List the reports the connection's user may run through the API.

Inputs

None.

Outputs

countnumber
How many were returned
reportslist
The reports
Example output
{
  "count": 1,
  "reports": [
    {
      "Description": "Active employees by location",
      "MaxRows": 100000,
      "Name": "Headcount by location",
      "XRefCode": "EMP_HEADCOUNT"
    }
  ]
}

List scheduled shifts

List scheduled shifts from a start date up to an end date, with times, hours, location, department and job, for everyone or one employee.

Inputs

Fromstart_datedateRequired
The first day.
Untilend_datedateRequired
The day after the last day (not included).
Employee XRef codeemployeetext
Only this employee, by XRef code. Leave empty for everyone.
Org unitorg_unittext
Only this org unit (location). Leave empty for all.
Departmentdepartmenttext
Only this department.
Jobjobtext
Only this job.
Positionpositiontext
Only this position.
Includeincludelist
Details to add to each shift.One or more of: Breaks, Activities, Skills, LaborMetrics (Labor metrics).
Limitlimitnumber
The most records to return, 1 to 5,000. Defaults to 200.From 1 to 5000.

Outputs

countnumber
How many were returned
has_moretrue/false
True if Dayforce has more than the limit; raise it or narrow the dates
scheduleslist
The shifts
Example output
{
  "count": 1,
  "has_more": false,
  "schedules": [
    {
      "Comment": null,
      "DepartmentXRefCode": "FRONT",
      "EmployeeScheduleXRefCode": "5520193",
      "EmployeeXRefCode": "42199",
      "JobXRefCode": "CASHIER",
      "NetHours": 7.5,
      "OrgUnitXRefCode": "STORE_101",
      "Published": true,
      "TimeEnd": "2026-11-16T17:00:00",
      "TimeStart": "2026-11-16T09:00:00"
    }
  ]
}

List time entries

List time entries (punches) added or changed in a window, with start, end, hours, location, department and job. Dayforce may refuse a window longer than 7 days.

Inputs

Changed fromchanged_fromdate and timeRequired
The start of the window, in UTC.
Changed tochanged_todate and timeRequired
The end of the window, in UTC.
Employee XRef codeemployeetext
Only this employee, by XRef code. Leave empty for everyone.
Org unitorg_unittext
Only this org unit (location). Leave empty for all.
Departmentdepartmenttext
Only this department.
Jobjobtext
Only this job.
Positionpositiontext
Only this position.
Shift statusshift_statustext
Only shifts in this state. Defaults to all.One of: ALL, ACTIVE (Active (still clocked in)), COMPLETED, PROBLEM (Problem (needs attention)).
Limitlimitnumber
The most records to return, 1 to 5,000. Defaults to 200.From 1 to 5000.

Outputs

countnumber
How many were returned
has_moretrue/false
True if Dayforce has more than the limit; raise it or narrow the dates
puncheslist
The time entries
Example output
{
  "count": 1,
  "has_more": false,
  "punches": [
    {
      "BusinessDate": "2026-11-12T00:00:00",
      "DepartmentXRefCode": "FRONT",
      "EmployeeXRefCode": "42199",
      "IsDeleted": false,
      "JobXRefCode": "CASHIER",
      "LastModifiedTimestampUtc": "2026-11-12T22:04:11",
      "LocationXRefCode": "STORE_101",
      "NetHours": 7.5,
      "PunchStatus": "c",
      "PunchXRefCode": "1002395",
      "TimeEnd": "2026-11-12T17:00:00",
      "TimeStart": "2026-11-12T09:00:00"
    }
  ]
}

List time off

List an employee's time-off requests with a given status between two dates, with reason, times and hours.

Inputs

Employee XRef codeemployeetextRequired
The employee's XRef code, their reference code in Dayforce (often their employee number). 'List employees' and the triggers give it.
Fromstart_datedateRequired
The first day to look at.
Toend_datedateRequired
The last day to look at.
StatusstatustextRequired
Which requests to list.One of: PENDING, APPROVED, DENIED, CANCELED, CANCELPENDING (Cancellation pending).

Outputs

countnumber
How many were returned
time_offlist
The time-off requests
Example output
{
  "count": 1,
  "time_off": [
    {
      "AllDay": true,
      "DateOfRequest": "2026-11-02T14:20:00",
      "EmployeeComment": "Holiday trip",
      "ManagerComment": null,
      "NetHours": 16.0,
      "ReasonName": "Vacation",
      "TAFWXRefCode": "301457",
      "TimeEnd": "2026-12-24T00:00:00",
      "TimeStart": "2026-12-22T00:00:00"
    }
  ]
}

List time-off balances

List an employee's balances, such as vacation and sick time, with what is accrued and granted.

Inputs

Employee XRef codeemployeetextRequired
The employee's XRef code, their reference code in Dayforce (often their employee number). 'List employees' and the triggers give it.
As ofas_of_datedate
The date to work out the balances on. Defaults to today.
Periods fromstart_datedate
Balance periods from this date. Defaults to today.
Periods toend_datedate
Balance periods up to this date. Defaults to the start.

Outputs

balanceslist
The balances
countnumber
How many were returned
Example output
{
  "balances": [
    {
      "BalanceName": "Vacation",
      "BalanceXRefCode": "VAC",
      "CurrentAccruedValue": 64.0,
      "CurrentGrantValue": 0.0,
      "EffectiveEnd": "2027-01-01T00:00:00",
      "EffectiveStart": "2026-01-01T00:00:00",
      "EmployeeXRefCode": "42199",
      "InitialAccruedValue": 0.0
    }
  ],
  "count": 1
}

Request time off

File time off for an employee: whole days from a start to an end date, or part of one day between two times, as pending or approved.

Inputs

Employee XRef codeemployeetextRequired
The employee's XRef code, their reference code in Dayforce (often their employee number). 'List employees' and the triggers give it.
Reason codereasontextRequired
The time-off reason's XRef code in Dayforce, such as VACATION or SICK (Setup > Pay Adjustment Codes).
First daystart_datedateRequired
The first day off.
Last dayend_datedate
The last day off. Defaults to the first day.
Start timestart_timetime
For part of a day: when it starts.
End timeend_timetime
For part of a day: when it ends.
Statusstatustext
File it as pending (a manager approves it) or approved. Defaults to pending.One of: PENDING (Pending (a manager approves it)), APPROVED. Default: PENDING.
Employee commentemployee_commenttext
A comment from the employee.
Manager commentmanager_commenttext
A comment from the manager.
Request XRef codetime_off_codetext
A reference code to give the request. Dayforce makes one if left empty.
Check onlyvalidate_onlytrue/false
Turn on to have Dayforce check the values and say whether it would accept them, without saving anything.Default: false.

Outputs

employeetext
The employee's XRef code
statustext
The request's status
time_endtext
When it ends, local time
time_off_codetext
The request's XRef code, for 'Update time off'
time_starttext
When it starts, local time
validated_onlytrue/false
True if Dayforce only checked the values and saved nothing
Example output
{
  "employee": "42199",
  "status": "PENDING",
  "time_end": "2026-12-24T00:00:00",
  "time_off_code": "301457",
  "time_start": "2026-12-22T00:00:00",
  "validated_only": false
}

Run report

Run a Dayforce report and get its rows, each with the report's columns.

Inputs

ReportreporttextRequired
The report to run.
Limitlimitnumber
The most records to return, 1 to 5,000. Defaults to 200.From 1 to 5000.

Outputs

countnumber
How many were returned
has_moretrue/false
True if Dayforce has more than the limit; raise it or narrow the dates
reporttext
The report's XRef code
rowslist
The rows, each named by the report's columns
Example output
{
  "count": 1,
  "has_more": false,
  "report": "EMP_HEADCOUNT",
  "rows": [
    {
      "Employee_Count": "42",
      "OrgUnit_ShortName": "Store 101"
    }
  ]
}

Update time off

Approve, deny or cancel a time-off request, or add a comment to it.

Inputs

Request XRef codetime_off_codetextRequired
The request's XRef code, from 'List time off' or a trigger.
Employee XRef codeemployeetextRequired
The XRef code of the employee the request is for.
New statusstatustext
The status to set. Leave empty to only add a comment.One of: PENDING, APPROVED, DENIED, CANCELED, CANCELPENDING (Cancellation pending).
Manager commentmanager_commenttext
A comment from the manager.
Employee commentemployee_commenttext
A comment from the employee.
Check onlyvalidate_onlytrue/false
Turn on to have Dayforce check the values and say whether it would accept them, without saving anything.Default: false.

Outputs

employeetext
The employee's XRef code
statustext
The status set, if one was
time_off_codetext
The request's XRef code
validated_onlytrue/false
True if Dayforce only checked the values and saved nothing
Example output
{
  "employee": "42199",
  "status": "APPROVED",
  "time_off_code": "301457",
  "validated_only": false
}

On this page