Guides
Signup For Free

Ceridian Dayforce API Integration

Suggest Edits

These are the list of integration use cases supported by Knit for Ceridian Dayforce API as part of the HRIS category

RESTful Delete Employee Punches

  • ID: delete_employee_punches
  • Operation: write
  • Entities: punch, time entry, employee
  • Summary: The RESTful Delete Employee Punches API operation deletes a specific employee clock entry identified by the 'employeePunchXRefCode'. This DELETE request requires the 'employeePunchXRefCode' as a query parameter, which is a unique identifier for the clock entry. If the provided code does not match an existing entry, a 400 error is returned. Upon successful deletion, all data associated with the clock entry, including tardy pay adjustments, labor metrics, transfers, meals, and breaks, will be removed. The response includes a status and a message indicating the result of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

RESTful Delete Legacy Labor Metrics

  • ID: delete_legacy_labor_metrics
  • Operation: delete
  • Entities: legacy labor metric, role feature, parameter
  • Summary: This API operation deletes a specific legacy labor metric using the DELETE method. The endpoint requires two query parameters: 'legacyLaborMetricType', which specifies the type of legacy labor metric to be deleted, and 'legacyLaborMetricXRefCode', which is the unique identifier of the metric. Both parameters are required. The user must have appropriate role access to delete a legacy labor metric. Upon successful deletion, the API returns a status and message indicating the result.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

RESTful GET Assessment List

  • ID: get_assessment_list
  • Operation: read
  • Entities: creation date time, status info, assessment
  • Summary: The RESTful GET Assessment List API is implemented by the candidate assessment provider to allow Dayforce to retrieve a list of all active assessments configured for the client. The API does not require any input parameters and returns a JSON response containing the creation date and time, a list of assessments with their short names, long names, and reference codes, and status information about the request. Assessments not included in the response are considered deleted or inactive. The response includes a 'CreationDateTime' indicating when the details were sent or received, an 'Assessments' array with details of each assessment, and a 'StatusInfo' object with the status code and any additional error messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Attendance Details

  • ID: get_attendance_details
  • Operation: read
  • Entities:
  • Summary: The Get Attendance Details API retrieves a list of employee clock entry data for all employees within a specified date range. It uses a GET method and requires the client name as a path parameter, and the start and end dates for filtering transaction times, along with the employee reference code as query parameters. The response includes detailed information about each punch, such as punch reference code, employee reference code, punch status, start and end times, net hours worked, and additional details like location, position, department, job reference codes, and meal breaks. The API supports pagination, so users should check for the next page of the response if applicable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Company Details for a Specific Employee

  • ID: get_company_details_for_specific_employee
  • Operation: read
  • Entities:
  • Summary: This API retrieves the company details for a specific employee by accessing the organizational unit information associated with the employee. The request requires the company name and the employee's cross-reference code as path parameters. The response includes a list of organizational unit information, such as the ID, name, and type of each unit.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Department Details by XRefCode

  • ID: get_department_details_by_xrefcode
  • Operation: read
  • Entities: department, xrefcode, role
  • Summary: The Get Department Details by XRefCode API allows consuming applications to retrieve detailed information about a specific department using its XRefCode. The XRefCode is appended to the base URL to form the request endpoint. The API requires an Authorization header with a Bearer token for access. The response includes details such as the department's name, ID, manager, and location. The user's role must have the appropriate permissions to access this data.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

RESTful Get Department XRefCodes

  • ID: get_department_xrefcodes
  • Operation: read
  • Entities: company, department, xrefcode
  • Summary: The RESTful Get Department XRefCodes API allows the consuming application to retrieve a list of XRefCodes for departments. This API is the first step in a two-step process to obtain detailed department information. The request is made to the endpoint https://www.dayforcehcm.com/api/[CompanyName]/V1/Departments, where [CompanyName] is a required path parameter representing the name of the company. The response is a JSON object containing an array of XRefCodes for all departments configured in the organization. Departments without XRefCodes are not included in the response. No additional access control is applied to the results of this web services call.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Employee Availability Data

  • ID: get_employee_availability_data
  • Operation: read
  • Entities: attendance, leave, time
  • Summary: This API retrieves the availability data for a specific employee using their unique external reference code (xRefCode). The request requires specifying the employee's xRefCode in the path and includes query parameters for the start and end dates of the availability period. The response provides detailed availability information for the specified date range, including whether the employee is unavailable, default settings, and start and end times for each day.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Employee Details by XRefCode

  • ID: get_employee_details_by_xrefcode
  • Operation: read
  • Entities: employee detail, query parameter, employee
  • Summary: This API endpoint retrieves detailed information about an employee using their XRefCode. The request requires the client's name and the employee's XRefCode as path parameters. Optional query parameters include ContextDate to specify the date for which the employee data should be retrieved and expand to include additional properties such as Addresses, Contacts, and WorkAssignments. The response includes high-level information about the employee, such as their birth date, hire date, gender, and contact information. The API requires an Authorization header with a bearer token for authentication.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Employee Retro Pay Summaries

  • ID: get_employee_retro_pay_summaries
  • Operation: read
  • Entities: retro data, pay summary, employee
  • Summary: The Retrieve Employee Retro Pay Summaries API allows consumers to retrieve a list of employee pay summary retros using various query parameters. The required parameter is 'payGroupXRefCode', which specifies the pay group reference code. Optional parameters include 'periodStartDate', 'periodEndDate', 'payDate', 'employeeXRefCode', 'locationXRefCode', 'payCategoryXRefCode', 'onlyRetros', and 'payExportId'. The response includes detailed retro pay data for employees, process results, and paging information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

GET Employee Schedules

  • ID: get_employee_schedules
  • Operation: read
  • Entities: employee schedule, department, job
  • Summary: The GET Employee Schedules API endpoint retrieves schedule details based on the provided cross-reference codes and date range. It accepts query parameters such as filterScheduleStartDate and filterScheduleEndDate to define the date range, and optional parameters like employeeXRefCode, departmentXRefCode, jobXRefCode, positionXRefCode, orgUnitXRefCode, unfill, and pageSize to filter the results. The response includes detailed schedule information, including employee schedule codes, time ranges, net hours, department and job codes, and more. It also provides information on breaks, activities, skills, labor metrics, and segments associated with the schedules. The response is paginated, and process results are included to indicate the success or failure of the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

RESTful Get HR Admin Details

  • ID: get_hr_admin_details
  • Operation: read
  • Entities: xrefcode, role, contact information type
  • Summary: The RESTful Get HR Admin Details API allows consuming applications to retrieve detailed information about HR Admin records using XRefCodes. The XRefCode is appended to the base URL to specify the record to be retrieved. The request requires an Authorization header with a Bearer token for authentication. The response is returned in JSON format and includes details such as the type of contact information and associated details like name and value. The user's primary role must have the appropriate permissions to access this data.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

RESTful Get HR Admin XRefCodes

  • ID: get_hr_admin_xrefcodes
  • Operation: read
  • Entities: hr admin sub-feature, contact information type, xrefcode
  • Summary: The RESTful Get HR Admin XRefCodes API allows the consuming application to retrieve a list of XRefCodes for various HR Admin sub-features such as Contact Information Types, Employment Statuses, Employment Status Reasons, Pay Class, and Pay Types. The API requires specifying the sub-feature as a path parameter and returns a JSON array of XRefCodes. These XRefCodes can be used in subsequent requests to retrieve detailed information about the specific HR Admin records. No additional access control is applied to the results of this web services call.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Details by XRefCode

  • ID: get_job_details_by_xrefcode
  • Operation: read
  • Entities: xrefcode, job, role
  • Summary: The Get Job Details by XRefCode API allows consuming applications to retrieve detailed information about a specific job using its unique XRefCode. The API requires an authenticated request with a Bearer token in the headers. The XRefCode is included as a path parameter in the URL. The response includes detailed job information such as job title, description, department, location, and employment type. The user's role must have the necessary permissions to access this data.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Job Posting Feeds

  • ID: get_job_posting_feeds
  • Operation: read
  • Entities: company, job posting, job feed
  • Summary: The 'Retrieve Job Posting Feeds' API endpoint allows users to retrieve a feed of job postings from Dayforce. The endpoint supports various query parameters to filter the job postings, such as companyName, parentCompanyName, internalJobBoardCode, includeActivePostingOnly, lastUpdateTimeFrom, lastUpdateTimeTo, datePostedFrom, and datePostedTo. The response can be in JSON or XML format, depending on the 'Accept' header in the request. The API returns detailed information about each job posting, including title, description, company details, location, education requirements, job function, employment type, posting dates, and more. Error codes such as JOBFEED_INVALID_CLIENT_PROPERTY, JOBFEED_QUERY_PARAMETER_NOT_FOUND, and JOBFEED_INVALID_DATE_RANGE may be returned in case of issues.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

RESTful Get Job XRefCodes

  • ID: get_job_xrefcodes
  • Operation: read
  • Entities: xrefcode, job
  • Summary: The RESTful Get Job XRefCodes API allows the consuming application to retrieve a list of XRefCodes for jobs configured in the specified organization. The request is made to the endpoint https://www.dayforcehcm.com/api/[CompanyName]/V1/Jobs, where [CompanyName] is a required path parameter representing the name of the company. The API returns a JSON response containing an array of XRefCodes, which can be used to retrieve more detailed job information using the Get Jobs by XRefCode request. No additional access control is applied to the results of this call.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

RESTful Get KPI Data

  • ID: get_kpi_data
  • Operation: read
  • Entities: organizational unit, time period, KPI data
  • Summary: The RESTful Get KPI Data API operation retrieves specific KPI data based on the provided XRefCode. It requires parameters such as orgUnitXRefCode, kpiXRefCode, kpiDataType, timePeriod, filterFrom, and filterTo. Optional parameters include zoneXRefCode, mdseXRefCode, and isValidateOnly. The response includes detailed KPI data and process results, providing insights into organizational performance metrics.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

RESTful Get Labor Metric Type XRefCodes

  • ID: get_labor_metric_type_xrefcodes
  • Operation: read
  • Entities: labor metric type, process result, xref code
  • Summary: This API operation retrieves the details of a specific labor metric type based on the provided XRefCode. The XRefCode is a required query parameter and must be an exact match to successfully retrieve the data. The response includes the name, description, clock transfer code, and the labor metric type's external reference code. Additionally, process results are returned, which include a code, context, level, and message for each result.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

RESTful Get Labor Metrics XRefCodes

  • ID: get_labor_metrics_xrefcodes
  • Operation: read
  • Entities: company, labor metric, xref code
  • Summary: The RESTful Get Labor Metrics XRefCodes API operation retrieves the details of a specific labor metric code based on the provided XRefCode. The XRefCode is a required query parameter that serves as the unique identifier for the labor metric code. The response includes detailed information about the labor metric, such as its name, description, effective start and end dates, associated codes, and organization reference codes. Additionally, the response contains process results that provide context and messages related to the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

RESTful Get Legacy Labor Metrics

  • ID: get_legacy_labor_metrics
  • Operation: read
  • Entities: legacy labor metric, product, project
  • Summary: The RESTful Get Legacy Labor Metrics API operation retrieves the details of a specific legacy labor metric using the GET method. The endpoint URL is https://www.dayforcehcm.com/api/CompanyName/V1/LegacyLaborMetric. It requires two query parameters: 'legacyLaborMetricType', which specifies the type of legacy labor metric to retrieve, and 'legacyLaborMetricXRefCode', which is the unique identifier for the metric. Both parameters are required. The response is in JSON format and includes the name, description, type, and external reference code of the legacy labor metric, along with process results that provide additional context and messages about the retrieval operation. Access to this API requires specific role features in the system administration settings.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Employees and Retrieve Details by XRefCode

  • ID: get_list_employees_and_details_by_xrefcode
  • Operation: read
  • Entities: employee
  • Summary: This configuration involves two API calls. First, it retrieves a list of employees using the List Employees API, which can be filtered using various query parameters such as ContextDate, EmployeeNumber, EmploymentStatusXRefCode, and more. The response includes the XRefCode of employees that match the filter criteria. For each XRefCode obtained, the Retrieve Employee Details by XRefCode API is called to get detailed information about each employee. This includes data such as birth date, hire date, gender, contact information, and more. The final output is a compiled list of detailed employee information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve List of Report Metadata

  • ID: get_list_of_report_metadata
  • Operation: read
  • Entities: data, metadata, report
  • Summary: This API retrieves a list of report definitions for reports accessible via RESTful web service. It provides metadata about each report, including the report's name, description, cross-reference code, and the maximum number of rows. The content of each report is not available through this function. The API requires the client name as a path parameter to specify the organization.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

RESTful Get Operating Hours

  • ID: get_operating_hours
  • Operation: read
  • Entities: exception, location, operating hour
  • Summary: The RESTful Get Operating Hours API in Dayforce retrieves the operating hours for specified locations and periods. The API endpoint is accessed via a GET request to the URL 'https://www.dayforcehcm.com/api/CompanyName/V1/OperatingHours/GetOperatingHours'. The request can include query parameters such as 'startDate', 'endDate', and 'orgUnitId' to specify the date range and organization unit for which to retrieve operating hours. The 'clientNamespace' header is required to uniquely identify the client's Dayforce instance. The response includes details about the operating hours, such as the effective start and end dates, organization unit ID, and an array of operating hours for each day, including open and close times, and whether the location is closed or if the day is an exception.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Org Unit Details by XRefCode

  • ID: get_org_unit_details_by_xrefcode
  • Operation: read
  • Entities: org unit, parent org unit, legal entity
  • Summary: The Get Org Unit Details by XRefCode API allows consuming applications to retrieve detailed information about organizational units using their XRefCodes. The API requires the XRefCode to be included in the URL path and supports optional query parameters such as ContextDate, Expand, and IncludeChildOrgUnits to customize the data returned. The response includes details about the org unit's level, legal entities, parent units, and child units in JSON format. Security permissions are required for accessing this data.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

RESTful Get Org Unit XRefCodes

  • ID: get_org_unit_xrefcodes
  • Operation: read
  • Entities: xrefcode, org unit
  • Summary: The RESTful Get Org Unit XRefCodes API allows the consuming application to retrieve a list of organizational unit XRefCodes. This is the first step in a two-step process to obtain detailed information about organizational units. The API returns a list of XRefCodes in JSON format, which can be used to retrieve more information about the org units using another API call. The request does not require any specific headers, path parameters, query parameters, or body content. The response contains a 'Data' array with objects that have 'XRefCode' properties, representing the cross-reference codes for the organizational units. No additional access control is applied to the results of this web services call.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

GET Payroll Elections

  • ID: get_payroll_elections
  • Operation: read
  • Entities:
  • Summary: The GET Payroll Elections API retrieves information about payroll deductions and elections for employees. It requires the 'clientNamespace' path parameter to uniquely identify the client's Dayforce instance. The API accepts several optional query parameters such as 'source', 'codeType', 'electionStatus', 'payGroupXRefCode', 'employeeXRefCodes', 'employmentStatusXRefCode', and 'pageSize' to filter the results. The response includes detailed information about each employee's payroll elections, including election details, deduction and earning parameters, limits, and payee information. The response also provides process results and paging information for navigating through large datasets.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

RESTful Get Plan Targets

  • ID: get_plan_targets
  • Operation: read
  • Entities: KPI, plan target, organization unit
  • Summary: The RESTful Get Plan Targets API retrieves details of a plan target based on the provided XRefCode parameters. It requires the 'planTargetXRefCode' and 'orgUnitXRefCode' as mandatory query parameters, while 'kpiXRefCode', 'zoneXRefCode', and 'axisXRefCode' are optional. The 'isActive' parameter is used to filter active plan targets. The response includes detailed information about the plan targets, such as their name, description, effective dates, target value, and associated codes. Additionally, process results are provided to indicate the success or failure of the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

RESTful Get Position Details by XRefCode

  • ID: get_position_details_by_xrefcode
  • Operation: read
  • Entities: xrefcode, position assignment, position
  • Summary: The RESTful Get Position Details by XRefCode API allows consuming applications to retrieve detailed information about positions using a unique XRefCode. The API requires an Authorization header with a bearer token for authentication. The XRefCode is a required path parameter, while ContextDate and Expand are optional query parameters. ContextDate specifies the as-of date for the data, defaulting to the current datetime if not provided. Expand allows specifying which position details to include, such as 'PositionAssignments'. The response is returned in JSON format, containing position details like PositionID, PositionName, and PositionAssignments. The user's role must have the appropriate permissions to access this data.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

RESTful Get Position XRefCodes

  • ID: get_position_xrefcodes
  • Operation: read
  • Entities: xrefcode, position
  • Summary: The RESTful Get Position XRefCodes API allows the consuming application to retrieve a list of XRefCodes for positions configured in the organization. The API uses a GET method and requires the company name as a path parameter. The response is a JSON object containing an array of XRefCodes. These XRefCodes can be used to retrieve more detailed information about the positions in a subsequent API call. The API does not apply additional access control to the results and only returns positions that have XRefCodes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

RESTful Get Projects XRefCodes

  • ID: get_projects_xrefcodes
  • Operation: read
  • Entities: project, department, employee
  • Summary: The RESTful Get Projects XRefCodes API operation retrieves the details of a specific project based on the provided XRefCode. The GET method is used with the endpoint https://www.dayforcehcm.com/api/CompanyName/V1/Projects/xRefCode. The required query parameter is XRefCode, which is a string representing the unique identifier of the project. The response includes detailed information about the project, such as its short and long names, start and due dates, budget, and associated codes. The response also includes process results with codes, context, levels, and messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

RESTful Get Projects

  • ID: get_restful_projects
  • Operation: read
  • Entities: client, project, organization
  • Summary: The RESTful Get Projects API operation retrieves a list of all projects configured by an organization. It supports various query parameters to filter the projects based on attributes such as project name, description, client reference code, type, phase, and more. The API also allows filtering by date ranges for last modified, start, due, and completed dates, as well as filtering by project priority, budget hours, budget amount, and percentage complete. The response includes details such as the parent project reference code, creation organization unit reference code, start date, and due date of the projects.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve and Compile Document Details

  • ID: get_retrieve_and_compile_document_details
  • Operation: read
  • Entities: document, attachment
  • Summary: This API configuration retrieves a list of documents associated with an employee's XRefCode and then fetches detailed information for each document using its DocumentGUID. The initial request to the 'List of documents' API provides metadata for each document, including the DocumentGUID. For each DocumentGUID, a subsequent request is made to the 'Fetch document' API to retrieve detailed metadata and content of the document. The final output is a compiled list of document details, including metadata such as document name, type, upload date, and detailed information like document group, publish date, and contents in base64 format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Patch Candidate Background Screening

  • ID: patch_candidate_background_screening
  • Operation: write
  • Entities: screening status, candidate background screening, candidate PII
  • Summary: The Patch Candidate Background Screening API allows providers to update the background screening status, URL, and report containing Personal Identifiable Information (PII) to Dayforce. The API requires a ScreeningRequestId as a mandatory parameter, which serves as a reference for the Dayforce candidate background screening. Optional parameters include a URL for accessing the candidate result, a ScreeningStatus object containing the status and adjudication status, and a CandidatePII object containing personal details such as date of birth, social security number, social insurance number, and driver license. The API does not return any specific response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Patch Candidate Background Screening Adjudication Status

  • ID: patch_candidate_background_screening_adjudication_status
  • Operation: write
  • Entities: background screening, adjudication status, candidate
  • Summary: This API endpoint is used to update the candidate background screening adjudication status in Dayforce. It requires two parameters: 'ScreeningRequestId', which is the Dayforce candidate background screening reference, and 'AdjudicationStatus', which is the current status of the candidate's background screening adjudication. The API uses the PATCH method to update the status and expects a JSON body with these parameters. The response will echo back the 'ScreeningRequestId' and 'AdjudicationStatus' provided in the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Patch Candidate Background Screening Personal Identifiable Information

  • ID: patch_candidate_background_screening_personal_identifiable_information
  • Operation: write
  • Entities: background screening, personal identifiable information, candidate
  • Summary: This API allows the provider to update the candidate's Personal Identifiable Information (PII) to Dayforce. It uses the PATCH method to update details such as the candidate's date of birth, social security number, social insurance number, and driver license. The request body must include a ScreeningRequestId, which is the Dayforce candidate background screening reference, and a CandidatePII object containing the PII details. The response will echo back the updated information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Patch Candidate Background Screening Right to Work

  • ID: patch_candidate_background_screening_right_to_work
  • Operation: write
  • Entities: document, work right, candidate
  • Summary: The Patch Candidate Background Screening Right to Work API updates the candidate's right to work status in Dayforce. The API endpoint is used to send the candidate's work rights status, which is displayed on the candidate grid in the Indicators field. The request body requires a ScreeningRequestId and a CandidateRightToWorkResults object, which includes details such as WorkRightStatus, Status, DateIssued, PartnerIdentifier, DateCompleted, WorkRightEffectiveStart, WorkRightEffectiveEnd, RejectionOrCancellationReasons, and Documents. Each document can include details like DocumentName, DocumentExtension, DateAdded, DateExpire, Type, PathwayCode, CountryCode, Sources, Details, and DocumentErrors. The response returns the updated candidate right to work results.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Patch Candidate Background Screening Status

  • ID: patch_candidate_background_screening_status
  • Operation: write
  • Entities: background screening, status, candidate
  • Summary: The Patch Candidate Background Screening Status API is used to update the candidate background screening status in Dayforce. It requires two parameters in the request body: 'ScreeningRequestId', which is the Dayforce candidate background screening reference, and 'ScreeningStatus', which indicates the current status of the candidate's background screening order. The API expects a PATCH request to the specified URL endpoint, and the response will include the updated screening request ID and status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Department Data

  • ID: patch_department_data
  • Operation: write
  • Entities: department, requester, data entity
  • Summary: The Update Department Data API allows users to update existing department information in Dayforce using the PATCH method. The API requires the XRefCode of the department to be included in the URL path. The request body should contain only the data entities and elements that need to be updated. An optional query parameter, isValidateOnly, can be used to perform validations without committing changes. The response indicates whether the update was successful and provides additional information about the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

PATCH Employee Pay Adjustments Data

  • ID: patch_employee_pay_adjustments_data
  • Operation: write
  • Entities: pay adjustment, labor metrics, employee
  • Summary: The PATCH Employee Pay Adjustments Data API is used to update existing employee pay adjustments or create effective-dated subordinate records in Dayforce. The API requires the XRefCode in the URL to identify the specific pay adjustment to update. The request body should include only the data entities and elements that need to be updated. The API supports a validation-only mode using the IsValidateOnly query parameter, which allows for validation without committing changes. The request body includes various fields such as EmployeePayAdjustXRefCode, OrgUnitXRefCode, EmployeeXRefCode, and others, which are used to specify the details of the pay adjustment. The response indicates the success of the operation and provides a message detailing the result.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

PATCH Employee Schedules

  • ID: patch_employee_schedules
  • Operation: write
  • Entities: employee schedule, activity, labor metric
  • Summary: The PATCH Employee Schedules API is used to create or update employee schedules in Dayforce. It allows for creating effective-dated subordinate records or updating existing schedules. The API requires the XRefCode in the request URL to identify the specific employee schedule to update. The request body should include only the data entities and elements that need to be inserted or updated. The API also supports a validation-only mode using the IsValidateOnly query parameter, which performs all validations without committing changes. The response includes the status and message indicating the result of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Job Data in Dayforce

  • ID: patch_job_data
  • Operation: write
  • Entities: company, data element, job
  • Summary: The PATCH Job Data API allows users to update existing job data in Dayforce using the job's unique reference code (XRefCode). The XRefCode must be included in the URL path, and the request body should contain only the data entities and elements that need to be updated. An optional query parameter, isValidateOnly, can be used to perform validations without committing changes. This API modifies existing data, so it is crucial to ensure the correct Dayforce instance is being used to avoid unintended modifications.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

PATCH KPI Data

  • ID: patch_kpi_data
  • Operation: write
  • Entities: KPI, organizational unit, Dayforce instance
  • Summary: The PATCH KPI Data API allows users to update KPI data for specific organizational units and KPIs. Users must provide the cross-reference codes for the organizational units and KPIs, specify the type of KPI data (Actual, Forecast, Plan, or Supplementary), and the time period (minute, day, or week). The request body should contain the data entities and elements to be processed. The API supports validation-only mode, where changes are not committed. The response includes the status and a message indicating the result of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Labor Metric Types

  • ID: patch_labor_metric_types
  • Operation: write
  • Entities: labor metric type, company, role
  • Summary: The Update Labor Metric Types API allows users to update labor metrics data using the PATCH method. The endpoint requires a unique identifier 'laborMetricTypeXRefCode' to specify which labor metric type to update. An optional 'isValidateOnly' parameter can be used to perform validations without committing changes. The request body can include fields such as 'ShortName', 'LongName', 'LaborMetricTypeXRefCode', 'ClockTransferCode', and 'IsDeleted'. Proper role access is required to use this API.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Legacy Labor Metrics

  • ID: patch_legacy_labor_metrics
  • Operation: write
  • Entities: legacy labor metric
  • Summary: The Update Legacy Labor Metrics API allows users to update existing legacy labor metrics using the PATCH method. The API requires the unique identifier 'legacyLaborMetricXRefCode' as a query parameter to specify which metric to update. An optional 'isValidateOnly' parameter can be used to perform validations without committing changes. The request body must include the fields 'ShortName', 'LongName', 'LegacyLaborMetricType', and 'LegacyLaborMetricXRefCode'. The response includes the status and a message indicating the result of the update operation. Proper role access is required to perform this operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

PATCH Operating Hours

  • ID: patch_operating_hours
  • Operation: write
  • Entities: company, operating hour, instance
  • Summary: The PATCH Operating Hours API allows users to update the operating hours for a specified company in Dayforce. The API requires the company name as a path parameter and optionally accepts a query parameter 'isValidateOnly' to specify if the request should only validate without committing changes. The request body must contain the data entities and elements structured according to Dayforce web services requirements. The response indicates whether the operation was successful and provides a message detailing the result.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

PATCH Org Unit Data

  • ID: patch_org_unit_data
  • Operation: write
  • Entities: org unit legal entity, org unit parent, org unit
  • Summary: The PATCH Org Unit Data API allows users to update existing organizational units or create new effective-dated subordinate records within Dayforce. The API requires the XRefCode in the URL to identify the org unit to be updated. The request body should contain only the data entities and elements that need to be inserted or updated. The 'isValidateOnly' query parameter can be used to validate the request without committing changes. The API modifies existing data, so it is crucial to ensure the correct instance of Dayforce is being used to avoid unintended modifications.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Plan Targets

  • ID: patch_plan_targets
  • Operation: write
  • Entities: KPI, plan target, organization unit
  • Summary: The Update Plan Targets API allows users to update plan targets using the PATCH method. The endpoint is located at https://www.dayforcehcm.com/api/CompanyName/V1/PlanTargets. Users can specify the 'isValidateOnly' query parameter to perform validations without committing changes. The request body includes fields such as 'PlanTargetXRefCode', 'Name', 'Description', 'EffectiveStart', 'EffectiveEnd', 'TargetValue', 'KpiXRefCode', 'ZoneXRefCode', 'DaysOfWeek', 'OrgUnitXRefCodes', and 'CreationOrgUnitXRefCode'. The response indicates whether the update was successful and provides a message with additional information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Position Data in Dayforce

  • ID: patch_position_data
  • Operation: write
  • Entities: element, data entity, position
  • Summary: The PATCH Position Data API allows users to update existing position data in Dayforce using the XRefCode in the URL. The request body should include only the data entities and elements that need to be updated. The 'isValidateOnly' query parameter can be used to perform validations without committing changes. This API modifies existing data, so it is important to ensure the correct Dayforce instance is being used to avoid unintended modifications.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Request to Update an Employee

  • ID: patch_request_to_update_an_employee
  • Operation: write
  • Entities: country, employee, contact
  • Summary: The Request to Update an Employee API allows you to update the details of an employee using a PATCH request. The endpoint requires the XRefCode of the employee to be updated as a path parameter. The request body should contain a JSON object representing the employee's contact information, including contact type, number, country, effective start date, preferred contact method, and verification requests. The API supports both Employee type and anonymous type for the request body, allowing flexibility in handling null values. The response includes the status and a message indicating the success or failure of the update operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee's I-9 Order Status

  • ID: patch_update_employee_i9_order_status
  • Operation: write
  • Entities: i9 order, order status, employee
  • Summary: This API allows updating an employee's I-9 order status in Dayforce. The PATCH request requires the I9OrderId as both a path parameter and in the request body. The order status can be updated using the orderStatusXRefCode, which supports several predefined values. An optional query parameter, isValidateOnly, can be used to perform validations without committing changes. A successful request returns an HTTP 200 response with an empty body, while errors return a standard error response with details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Information

  • ID: patch_update_employee_information
  • Operation: write
  • Entities: employee, contact
  • Summary: The Update Employee Information API allows updating an employee's details using the PATCH method. The endpoint requires the client's name and the employee's XRefCode as path parameters. The request body should contain the employee's contact information and other details in JSON format. Optionally, a query parameter 'isValidateOnly' can be used to validate the data without saving it. If the data is valid, the API returns a 200 OK status; otherwise, it returns a 400 Bad Request status with validation error messages in the 'ProcessResult'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Labor Metrics Data

  • ID: patch_update_labor_metrics_data
  • Operation: write
  • Entities: ledger code, labor metric, organization unit
  • Summary: The Update Labor Metrics Data API allows users to update labor metrics data using the PATCH method. The endpoint URL is https://www.dayforcehcm.com/api/CompanyName/V1/LaborMetrics. Users can specify the 'isValidateOnly' query parameter to perform validations without committing changes. The request body includes fields such as ShortName, LongName, EffectiveFrom, EffectiveEnd, LaborMetricsCodeXRefCode, ClockTransferCode, LedgerCode, OrgUnitXRefCodes, LaborMetricsTypeXRefCode, and IsDeleted. Security access requires role permissions to the HCM Anywhere > Web Services > Patch/Post Labor Metrics Code role feature.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Projects Data

  • ID: patch_update_projects_data
  • Operation: write
  • Entities: project, employee assignment, organization unit
  • Summary: The Update Projects Data API allows users to update project details using the PATCH method on the Dayforce platform. The API endpoint is 'https://www.dayforcehcm.com/api/CompanyName/V1/Projects'. It accepts query parameters such as 'projectXRefCode' to specify the project and 'isValidateOnly' to perform validations without committing changes. The request body includes various fields like 'ProjectXRefCode', 'ShortName', 'CreationOrgUnitXRefCodes', and more, which define the project details to be updated. The API performs validations on fields like 'CreationOrgUnitXRefCodes' and 'IFRSClassification'. The response indicates the success of the operation and provides error messages if any issues are encountered. Security access is required to update project details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Employee Information

  • ID: post_add_employee_information
  • Operation: write
  • Entities: database, request, employee
  • Summary: This API endpoint allows for the addition of a new employee to the Dayforce database using a POST request. The request requires a complete representation of the employee's information, including personal details such as birth date, gender, and social security number. The endpoint also supports a query parameter 'isValidateOnly' to validate the request without actually adding the employee. Once an employee is added, they cannot be removed from the database. The response includes the unique identifier of the newly added employee and the status of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Employee Raw Clock Entries

  • ID: post_add_employee_raw_clock_entries
  • Operation: write
  • Entities: labor metric, clock entry, employee
  • Summary: The Add Employee Raw Clock Entries API allows clients to submit raw clock entries for employees. The API endpoint is https://www.dayforcehcm.com/api/{clientName}/v1/EmployeeRawPunches. It accepts a POST request with a JSON body containing details such as EmployeeBadge, RawPunchTime, PunchType, and PunchDevice, among others. The PunchType field supports various clock entry types like Punch_In, Break_Out, Meal_Out, etc. The API can also validate requests without creating records by using the IsValidateOnly query parameter. Successful responses include informational messages about the clock entry, while errors are returned with HTTP 400 or 200 status codes, depending on the nature of the error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

POST Background Screening Billing Codes

  • ID: post_background_screening_billing_codes
  • Operation: write
  • Entities: provider, package, billing code
  • Summary: The POST Background Screening Billing Codes API endpoint allows providers to send a list of billing codes to Dayforce. Providers can also include associated packages with each billing code. The 'ProviderReference' is a required unique identifier for the provider. Each billing code must have a 'BillingCodeId', and associated packages must have a 'PackageId' and 'Name'. The API considers billing codes not included in the request as deleted or inactive. The response includes the billing code details and associated packages, with an option to specify if a package supports Right to Work.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

POST Background Screening Packages

  • ID: post_background_screening_packages
  • Operation: write
  • Entities: provider, package, billing code
  • Summary: The POST Background Screening Packages API endpoint allows providers to send a list of background screening packages to Dayforce. Each package can include associated billing codes. The request body must include a 'ProviderReference', which is a unique identifier for the provider, and a list of 'Packages'. Each package must have a 'PackageId', 'Name', and optionally a 'Description' and 'IncludeRTW' flag indicating if the package supports Right to Work. Packages can also include 'AssociatedBillingCodes', each with a 'BillingCodeId', 'Name', and 'Description'. Packages not included in the request are considered deleted or inactive. The response echoes back the submitted data.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

POST Background Screening Provider Statuses

  • ID: post_background_screening_provider_statuses
  • Operation: write
  • Entities: background screening, provider, status
  • Summary: The POST Background Screening Provider Statuses API allows providers to send background screening statuses to Dayforce. Providers can send any combination of Order Status, Adjudication Status, and Result Status, but at least one status must be included in the request. The request body must include a 'ProviderReference' which is a unique identifier for the provider, and optionally lists of strings for 'OrderStatuses', 'AdjudicationStatuses', and 'ResultStatuses'. The response will echo back the provided statuses.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

POST Candidate Assessment Registration

  • ID: post_candidate_assessment_registration
  • Operation: write
  • Entities: job requisition, assessment, candidate
  • Summary: The POST Candidate Assessment Registration API allows Dayforce to register candidates for assessments. The request includes candidate details, job requisition information, and assessment references. The response provides an assessment URL, a unique candidate assessment GUID, a receipt ID, and status information. This API is used to send assessment links to candidates for completion.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

POST Candidate Assessment Reports

  • ID: post_candidate_assessment_reports
  • Operation: write
  • Entities: candidate assessment, status information, report
  • Summary: The POST Candidate Assessment Reports API is used to submit candidate assessment reports to Dayforce when a candidate completes their assessment. The request body must include the creation date and time, a unique candidate assessment GUID, and a list of reports with their short names and links. The response includes the same details along with status information indicating the success or failure of the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Post Candidate Assessment Scores to Dayforce

  • ID: post_candidate_assessment_scores_to_dayforce
  • Operation: write
  • Entities: score, report, candidate
  • Summary: The 'Post Candidate Assessment Scores to Dayforce' API endpoint is used to submit candidate assessment scores to Dayforce when a candidate completes their assessment. The scores are displayed in candidate profiles within the Recruiting module. The request requires a JSON body containing details such as the creation date and time, candidate assessment GUID, overall score, recommendation status, detailed scores for each assessment, and any associated reports. The response includes a status code and message indicating the success or failure of the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

POST Candidate Assessment Status

  • ID: post_candidate_assessment_status
  • Operation: write
  • Entities: status, assessment, candidate
  • Summary: The POST Candidate Assessment Status API allows Dayforce to retrieve the status of a candidate's assessment from the assessment provider. The request includes the creation date and a unique candidate assessment GUID. The response provides the assessment status, which can be 'Not Started', 'Pending', 'In Progress', or 'Completed', along with status information including a code and an optional message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Department in Dayforce

  • ID: post_create_department
  • Operation: write
  • Entities: company, department
  • Summary: This API endpoint allows consuming applications to create a new department record in Dayforce. The request must include a unique XRefCode in the request body, which serves as the department's unique identifier. The API also supports a query parameter 'isValidateOnly' to perform validations without committing changes. If the XRefCode matches an existing department, an error will be returned. The response includes a success flag, a message, and error details if applicable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Employee Schedule

  • ID: post_create_employee_schedule
  • Operation: write
  • Entities: employee schedule, position, organization unit
  • Summary: The Create Employee Schedule API allows you to insert new employee schedule data into Dayforce using the POST method. The API endpoint requires a base URL and supports optional query parameters such as OrgUnitXRefCode to specify the organizational unit and IsValidateOnly to perform validations without committing changes. The request body must include details like StartTime, EndTime, and Position, with optional fields like DocketData and PayCategory. The response indicates the success of the operation and provides a ScheduleId for the created schedule.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Job in Dayforce

  • ID: post_create_job_in_dayforce
  • Operation: write
  • Entities: company, xrefcode, job
  • Summary: The Create Job in Dayforce API allows consuming applications to create a new job record in Dayforce by sending a POST request to the specified endpoint. The request must include a unique XRefCode in the request body, which serves as the job's unique identifier. The API also accepts an optional query parameter 'isValidateOnly' to perform validations without committing changes. If the XRefCode matches an existing job, an error is returned. The response includes a success status, a message, and the jobId of the created job if successful.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Labor Metric Code

  • ID: post_create_labor_metric_code
  • Operation: write
  • Entities: role access, labor metric, instance
  • Summary: The Create Labor Metric Code API allows users to create a new labor metric code in the Dayforce system. The API requires role access to specific features in the system. The request can include a query parameter 'isValidateOnly' to perform validations without committing changes. The request body must include details such as ShortName, LongName, EffectiveFrom, EffectiveEnd, and other relevant codes. The API writes data into Dayforce, so it is important to ensure the correct instance is being used to avoid unintended data updates.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Labor Metric Type

  • ID: post_create_labor_metric_type
  • Operation: write
  • Entities: labor metric type, feature, role access
  • Summary: The Create Labor Metric Type API allows users to create a new labor metric type in the Dayforce system. The API endpoint is accessed via a POST request to the specified URL. Users can optionally use the 'isValidateOnly' query parameter to perform validations without committing changes. The request body must include details such as 'ShortName', 'LongName', 'LaborMetricTypeXRefCode', 'ClockTransferCode', and 'IsDeleted'. Proper role access is required to use this API.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Legacy Labor Metric

  • ID: post_create_legacy_labor_metric
  • Operation: write
  • Entities: legacy labor metric, system admin, role feature
  • Summary: The Create Legacy Labor Metric API allows users to create a new legacy labor metric in the Dayforce system. The API endpoint is accessed via a POST request to the specified URL. Users can optionally validate the request without committing changes by using the 'isValidateOnly' query parameter. The request body must include 'ShortName', 'LongName', 'LegacyLaborMetricType', and 'LegacyLaborMetricXRefCode' fields. Proper role access is required to use this API, including access to features such as HCM Anywhere, Web Services, and Legacy Labor Metrics.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create New Plan Targets

  • ID: post_create_new_plan_targets
  • Operation: write
  • Entities: plan target, kpi, zone
  • Summary: The 'Create New Plan Targets' API allows users to create new plan targets in the Dayforce system. The API accepts a POST request with optional query parameter 'isValidateOnly' to specify if the request should only validate without committing changes. The request body includes details such as PlanTargetXRefCode, Name, Description, EffectiveStart, EffectiveEnd, TargetValue, KpiXRefCode, ZoneXRefCode, DaysOfWeek, OrgUnitXRefCodes, and CreationOrgUnitXRefCode. The response indicates the success of the operation and provides a message and the unique identifier of the created plan target.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Project in Dayforce

  • ID: post_create_new_project
  • Operation: write
  • Entities: organization unit, project, employee
  • Summary: This API endpoint allows the creation of a new project in Dayforce. It requires a POST request to the specified URL with a detailed JSON body containing project details such as ProjectXRefCode, ShortName, CreationOrgUnitXRefCodes, and more. The query parameter 'isValidateOnly' can be used to perform validations without committing changes. The request body includes various fields like ProjectPriority, AccountNum, IFRSClassification, and others. The response indicates whether the project creation was successful and provides the ID of the newly created project. Proper role access is required to use this API.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Operating Hours in Dayforce

  • ID: post_create_operating_hours
  • Operation: write
  • Entities: operating hour, client namespace, xref code
  • Summary: The POST Operating Hours API allows consuming applications to create new operating hours in Dayforce. The request requires a unique identifier (XRefCode) to be provided in the request body, which must be generated by the requester. The API also accepts an optional parameter, IsValidateOnly, to perform validations without committing changes. The clientNamespace parameter is required to identify the client's Dayforce instance. The response indicates whether the operation was successful and provides any error messages if applicable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Org Unit in Dayforce

  • ID: post_create_org_unit
  • Operation: write
  • Entities: request body, xrefcode, org unit
  • Summary: This API endpoint allows consuming applications to create an org unit in Dayforce. The request must include a unique identifier (XRefCode) in the request body, which is the responsibility of the requester to generate. The API also supports a query parameter 'isValidateOnly' to perform validations without committing changes. If the XRefCode matches an existing org unit, an error will be returned. The response includes a success flag, a message, and error details if applicable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Position in Dayforce

  • ID: post_create_position
  • Operation: write
  • Entities: application, instance, position
  • Summary: The Create Position API in Dayforce allows consuming applications to create a new position record by sending a POST request to the specified endpoint. The request must include a unique XRefCode in the request body, which serves as the unique identifier for the position. Optionally, a query parameter 'isValidateOnly' can be used to perform validations without committing changes. The API returns a success status, a message, and the positionId of the newly created position. If the XRefCode already exists, an error is returned, and the consuming application must handle it appropriately.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Employee Availability Record

  • ID: post_employee_availability_record
  • Operation: write
  • Entities: manager, availability, employee
  • Summary: The Create Employee Availability Record API allows the creation of a new availability record for a specified employee in the Dayforce system. The API requires the employee's XRefCode as a path parameter and optionally accepts a query parameter 'isValidateOnly' to perform validations without committing changes. The request body must include details such as whether the availability is default, the effective start and end times, manager comments, and weekly availability details. The response indicates the success of the operation and provides a message detailing the result. Proper role access is required to use this API.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Employee Pay Adjustments

  • ID: post_employee_pay_adjustments
  • Operation: write
  • Entities: department, pay adjustment, employee
  • Summary: The Create Employee Pay Adjustments API allows you to insert employee pay adjustment data into Dayforce. This API uses the POST method to create a new pay adjustment record. The request can include various parameters such as Pay Adjustment Date, Hours, Amount, Department, Pay Category, and more. The 'isValidateOnly' query parameter can be used to perform validations without committing changes. The request body must contain the necessary fields in JSON format. The response indicates whether the pay adjustment was successfully created and provides additional information about the result.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

POST KPI Data

  • ID: post_kpi_data
  • Operation: write
  • Entities: data, organizational unit, kpi
  • Summary: The POST KPI Data API allows users to create new KPI data by providing the necessary parameters such as organizational unit cross-reference codes, KPI cross-reference codes, and the type of KPI data. The request body must include details like the day, week, minute, value, adjusted value, and other relevant information. The response indicates whether the KPI data was successfully created and provides a message with additional information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

POST and PATCH Employee Subordinate Resources

  • ID: post_patch_employee_subordinate_resources
  • Operation: write
  • Entities: address, employee, contact
  • Summary: The POST and PATCH Employee Subordinate Resources API allows for the insertion and updating of employee HR data in Dayforce. The API endpoint is constructed using the company name, employee cross-reference code, and the specific sub-resource name. Sub-resources include Addresses, CANFederalTaxes, Contacts, DirectDeposits, and more. The API requires headers for content type and authorization, path parameters for company name, employee code, and sub-resource name, and a request body containing the data for the sub-resource. The response includes a request ID and process results, which detail any errors or messages related to the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Submit New Leave Request for Employee

  • ID: post_submit_new_leave_request
  • Operation: write
  • Entities:
  • Summary: This API allows you to submit a new leave request for an employee using the Employee Time Away from Work API. The request requires an isValidateOnly query parameter to determine if the request should only be validated. The request body includes details such as EmployeeXRefCode, TAFWXRefCode, PayAdjustmentCodeXRefCode, StatusXRefCode, TimeStart, TimeEnd, NetHours, NetHoursPerDay, ManagerComment, EmployeeComment, AllDay, HalfDay, and Days. The response includes the same details along with process results that provide additional information about the request processing.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Time Away Requests

  • ID: retrieve_time_away_requests
  • Operation: read
  • Entities:
  • Summary: The Retrieve Time Away Requests API allows you to retrieve time away from work (TAFW) requests for a specific employee. The API requires the Employee XRefCode as a path parameter and the filter start date, end date, and status as query parameters. The response includes details about the employee's time away requests, such as the request date, start and end times, net hours, comments, reason, and whether the time away is for a full or half day.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated about 1 month ago