MyRapidi
MyRapidi

Search our Wiki

Dayforce Schema Structure and Field Management

Overview

The Dayforce integration uses a single hosted JSON schema (Dayforce_full_schema_rapidi.json), shared across all REST WebService connections for the tenant. Each top-level definition matches a Dayforce API endpoint name exactly.

The schema currently defines eight objects:

ObjectDescription
EmployeesEmployee master data.
EmployeePayAdjustmentsEmployee pay adjustment transactions.
LaborMetricsLabor Metrics item for a Pay Adjustment or Punch.
EmployeePunchesClock-in/clock-out time entries.
MealBreaksMeal break records nested within an Employee Punch.
TransfersMid-shift department/job/project transfer, nested within an Employee Punch.
PunchLaborMetricsLabor Metrics items attached to an Employee Punch.
TransferLaborMetricsLabor Metrics items attached to a Transfer within an Employee Punch.

LaborMetrics

FieldTypeDescriptionExample
LaborMetricsTypeXRefCodestringExternal reference code for the Labor Metric type.JobCode
LaborMetricsCodeXRefCodestringExternal reference code for the Labor Metric code.25-910
Each entry in EmployeePayAdjustments.LaborMetrics (below) must reference a Labor Metric that already exists in Dayforce, which is why this sync has to run first.

EmployeePayAdjustments


FieldTypeDescriptionExample
EmployeePayAdjustXRefCodestringUnique identifier for the record.EPA123456
EmployeeXRefCodestringExternal reference code for the employee.E0066
OrgUnitXRefCodestringExternal reference code for the organizational unit.NORTHERN_MAT_AND_BRIDGE_EAST_LIMITED_PARTNERSHIP_TORONTO_OPERATIONS_UNION
PayAdjustmentCodeXRefCodestringExternal reference code for the pay adjustment code.REG_ICI
PayAdjustmentDatestring (date-time)Date of the pay adjustment.2025-12-10T03:30:00Z
HoursnumberNumber of hours for the pay adjustment.9.0
AmountnumberAmount of the pay adjustment.150.5
JobXRefCodestringExternal reference code for the job.JOB001
DepartmentXRefCodestringExternal reference code for the department.DEPT001
PayCategoryXRefCodestringExternal reference code for the pay category.REGULAR
ProjectXRefCodestringExternal reference code for the project.PROJ001
DocketXRefCodestringExternal reference code for the docket.NIGHT_SHIFT
RatenumberRate associated with the pay adjustment.25.5
PayDatestring (date-time)Pay date for the adjustment.2025-12-15T00:00:00Z
ManagerAuthorized / EmployeeAuthorizedbooleanWhether the manager/employee has authorized the adjustment.true
AdjustPeriodStartDate / AdjustPeriodEndDatestring (date-time)Adjustment period bounds.2025-12-01T00:00:00Z
LaborMetricsarrayArray of LaborMetrics items attached to the adjustment.array of LaborMetrics objects
(A few lower-relevance fields, PieceQuantity, IsPremium, IsDeleted, ReferenceDate, EmployeeComment, ManagerComment, exist on this object but aren't central to the current mapping.)

Employees

FieldTypeDescriptionExample
EmployeeXRefCodestringExternal reference code for the employee (unique identifier).E0066
EmployeeNumberstringEmployment identification number.12345
DisplayName / FirstName / LastNamestringEmployee name fields.John Doe
HireDate / OriginalHireDate / TerminationDatestring (date-time)Employment date fields.2020-01-15T00:00:00Z
EmploymentStatusXRefCodestringEmployment status (Active, Terminated, Leave of Absence, etc.).ACTIVE
OrgUnitXRefCode / DepartmentXRefCode / JobXRefCode / PositionXRefCodestringOrganizational placement.DEPT001
Email / PhonestringContact details.john.doe@company.com
ManagerXRefCodestringExternal reference code for the employee's manager.E0001
IsActivebooleanWhether the employee is currently active.true
(Additional fields covering pay class/group/type, salary/rate, and address are also present, standard employee master-data attributes not called out individually here.)

Managing the Schema

One schema file covers every endpoint for the tenant. To add or change a field: update the field's definition (name, type, description, example) in the hosted JSON schema, then click Read Design on the WebService in Rapidi. No connection changes needed.



Content


Dayforce_full_schema_rapidi.json

json


Dayforce_Full_Schema_Updated.json

json