Connectors

HR & People

UKG Ready

HR, payroll, and time: employees, accruals, time-off requests, and compensation

Signs in with: OAuth 2.0 sign-in
Runs on: Cloud or On-Prem Worker
Operations: 559
Ready-made triggers: 0

Connect UKG Ready

In Neblex open Connect › Connections and click New Connection.
Search for UKG Ready and give the connection a clear name.
Fill in the fields. Secret values are encrypted and never shown again.
Click Test, then Create Connection.

For services offered under Connect a Service you only sign in and approve access. Otherwise use Connect with OAuth2 with your own OAuth app. See Authorize with OAuth.

Field	What to enter
HostRequired	Your UKG Ready host without https:// (for example secure.saashr.com or secure3.saashr.com).Example: `secure.saashr.com`
Token endpointRequired	https://<host>/ta/rest/v2/companies/<company ID>/oauth2/token for your company.Example: `https://secure.saashr.com/ta/rest/v2/companies/123456/oauth2/token`
Client IDRequired	The client ID of a Machine to Machine OAuth application (Company Setup > OAuth Applications).
Client secretRequiredSecret	That OAuth application's client secret.
Client authenticationOptional	UKG Ready reads the client credentials from the token request body.

Use it in a flow

Open a flow, open the node library and search for UKG Ready.
Drag it onto the canvas and choose an Operation and your connection.
Map the operation's fields from earlier steps, or click Map with Matt.
Use Test this step to see what it returns, then save.

To start a flow from UKG Ready without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if UKG Ready can send webhooks, a Webhook trigger receives them at its own URL.

Operations

559 operations in 346 groups. Each one is a step you can add to a flow.

/v2/companies/{cid}/config/announcements/{id}3

Deletes an announcement`deleteConfigAnnouncements`	DELETE	Deletes an announcement.
Retrieves an announcement by its ID`getConfigAnnouncements`	GET	Retrieves an announcement by its ID.
Updates an existing announcement`updateConfigAnnouncements`	PUT	Updates an existing announcement.

/v2/companies/{cid}/employees/{aid}/deductions/{id}3

Endpoint for fetching employee deduction by its id`getEmployeesDeductions`	GET	Endpoint for fetching employee deduction by its id.
Endpoint to update employee deduction by its id`deleteEmployeesDeductions`	DELETE	Endpoint to update employee deduction by its id.
Endpoint to update employee deduction by its id`updateEmployeesDeductions`	PUT	Endpoint to update employee deduction by its id.

/v2/companies/{cid}/payrolls/{id}/batches/{id}1

Delete specific Payroll BatchdeletePayrollsBatches DELETE Delete specific Payroll Batch.

Access Policy Profile3

Deletes an existing access policy profile by its ID`deleteAccessProfiles`	DELETE	Deletes an existing access policy profile by its ID.
Retrieves an existing access policy profile by its ID`getAccessProfiles`	GET	Retrieves an existing access policy profile by its ID.
Updates an existing access policy profile by its ID`updateAccessProfiles`	PUT	Updates an existing access policy profile by its ID.

Access Policy Profiles1

Creates a new access policy profilecreateAccessProfiles POST Creates a new access policy profile.

Account Assignments1

Returns the information of all the Current, Future or Only Past Dated assignments of the AccountgetPositionAssignments GET Returns the information of all the Current, Future or Only Past Dated assignments of the Account.

Account Group3

Deletes an existing regular account group by its ID`deleteConfigSecurityAccountGroups`	DELETE	Deletes an existing regular account group by its ID.
Replaces an existing regular account group`updateConfigSecurityAccountGroups`	PUT	Replaces an existing regular account group.
Retrieves an existing account group by its ID`getConfigSecurityAccountGroups`	GET	Retrieves an existing account group by its ID.

Account Groups2

Creates a new regular account group`createConfigSecurityAccountGroups`	POST	Creates a new regular account group.
Retrieves existing account groups including the "All Company Employees" group`listConfigSecurityAccountGroups`	GET	Retrieves existing account groups including the "All Company Employees" group.

Accrual Balances8

Applies a change to an employee's remaining accrual balance`updateAccrual2Balances`	PUT	Applies a change to an employee's remaining accrual balance.
Endpoint to update employee accrual balances`createEmployeeAccrualBalancesV1`	POST	Endpoint to update employee accrual balances.
Endpoint to update employee accrual balances`updateEmployeeAccrualBalancesV1`	PUT	Endpoint to update employee accrual balances.
Get EmployeeAccrualBalances`listEmployeeAccrualBalancesV1`	GET	Endpoint to search through employee's accrual balances.Restricted to companies with TA or PR subsystems and "Accruals" functionality.
Retrieves the accrual balance of an employee at the current or a specific date`listAccrual1Balances`	GET	Retrieves the accrual balance of an employee at the current or a specific date.
Retrieves the accrual balance of an employee for the current period or as of a specific date`listAccrual2Balances`	GET	Retrieves the accrual balance of an employee for the current period or as of a specific date.
Sets the accrual balance for an employee`createAccrual1Balances`	POST	Sets the accrual balance for an employee.
Updates the accrual balance for an employee`updateAccrual1Balances`	PUT	Updates the accrual balance for an employee.

Accruals1

Returns a list of Accruals Profiles in the specified companylistLookupProfilesAccruals GET Returns a list of Accruals Profiles in the specified company

Accruals(1.0)1

Returns a list of Accruals(1.0) Profiles in the specified companylistLookupProfilesAccrualProfiles GET Returns a list of Accruals(1.0) Profiles in the specified company

Actions1

Executes an Action on a given Schedule Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setuprunSchedulesActions POST Executes an Action on a given Schedule Advanced Scheduler ( SCHEDULE ) Subsystem must be enabled in company setup.

Additional Compensation6

Creates an Additional Compensation record for an employee`createEmployeesCompensationAdditional`	POST	Creates an Additional Compensation record for an employee.
Deletes an employee's Additional Compensation record`deleteCompensationAdditional`	DELETE	Deletes an employee's Additional Compensation record.
Retrieves a list of Additional Compensation Records for a specific employee`listEmployeesCompensationAdditional`	GET	Retrieves a list of Additional Compensation Records for a specific employee.
Retrieves additional compensation records for all subordinates`listCompensationAdditional`	GET	Retrieves additional compensation records for all subordinates.
Retrieves detailed information about an Additional Compensation record`getCompensationAdditional`	GET	Retrieves detailed information about an Additional Compensation record.
Updates an employee's Additional Compensation record`updateCompensationAdditional`	PUT	Updates an employee's Additional Compensation record.

Additional Compensation Types1

Returns Additional Compensation Types used in the companylistLookupAdditionalCompensationTypes GET Returns Additional Compensation Types used in the company.

All Employees3

__This resource has been deprecated as of June 22, 2017`createEmployeesV1`	POST	This resource has been deprecated as of June 22, 2017.
__This resource has been deprecated as of June 22, 2017`listEmployeesV1`	GET	This resource has been deprecated as of June 22, 2017.
__This resource has been deprecated as of June 22, 2017`updateEmployeesV1`	PUT	This resource has been deprecated as of June 22, 2017.

All Imports1

Endpoint to get list of Imports that available in companylistImportsV1 GET Endpoint to get list of Imports that available in company.

All PTO Requests2

Endpoint to list PTO requests for subordinate employees`listEmployeePtorequestAll`	GET	Endpoint to list PTO requests for subordinate employees.
Endpoint to list PTO requests for subordinate employees`listEmployeePtorequestAllV1`	GET	Endpoint to list PTO requests for subordinate employees.

Anniversary Calendar1

Retrieves a list of employee anniversaries within a required date rangelistCalendarAnniversary GET Retrieves a list of employee anniversaries within a required date range.

Announcement statistics1

Updates announcement popup statisticsupdateEmployeesAnnouncementsStatistics PUT Updates announcement popup statistics.

Announcements3

Creates a new announcement`createConfigAnnouncements`	POST	Creates a new announcement.
Retrieves active announcements for users`listEmployeesAnnouncements`	GET	Retrieves active announcements for users.
Retrieves announcement configurations`listConfigAnnouncements`	GET	Retrieves announcement configurations.

Applicant3

Deletes an existing applicant by their account ID`deleteApplicants`	DELETE	Deletes an existing applicant by their account ID.
Retrieves an existing applicant`getApplicants`	GET	Retrieves an existing applicant.
Updates an existing applicant by their account ID`updateApplicants`	PUT	Updates an existing applicant by their account ID.

Applicant Job Applications1

Retrieves a list of all job applications for an applicantlistApplicantsJobApplications GET Retrieves a list of all job applications for an applicant.

Applicants2

Creates a new applicant`createApplicants`	POST	Creates a new applicant.
Retrieves the list of applicants`listApplicants`	GET	Retrieves the list of applicants

Asset Assignment3

Deletes a specific asset assignment by its ID`deleteAssetAssignments`	DELETE	Deletes a specific asset assignment by its ID.
Replaces an existing asset assignment with the one provided in the payload`updateAssetAssignments`	PUT	Replaces an existing asset assignment with the one provided in the payload.
Retrieves a specific asset assignment by its ID`getAssetAssignments`	GET	Retrieves a specific asset assignment by its ID.

Asset Assignment Action1

Performs an action on an asset assignment, such as marking it as returned, lost, or destroyedrunAssetAssignmentsAction PUT Performs an action on an asset assignment, such as marking it as returned, lost, or destroyed.

Asset Assignments2

Creates a new asset assignment`createAssetAssignments`	POST	Creates a new asset assignment.
Retrieves a list of all asset assignments`listAssetAssignments`	GET	Retrieves a list of all asset assignments.

Asset Categories1

Endpoint to fetch list of all Asset categories within the companylistLookupAssetCategories GET Endpoint to fetch list of all Asset categories within the company.

Asset Types1

Endpoint to fetch list of all Asset Types within the companylistLookupAssetTypes GET Endpoint to fetch list of all Asset Types within the company.

Assets1

Endpoint to fetch list of all Company AssetslistLookupAssets GET Endpoint to fetch list of all Company Assets.

Attendance1

Retrieves a list of employees based on their attendance statuslistAttendance GET Retrieves a list of employees based on their attendance status.

Attestations1

Returns a list of Attestation Profiles in the specified companylistLookupProfilesAttestationProfiles GET Returns a list of Attestation Profiles in the specified company

Authentication1

Endpoint for initiating Authorization Code Flow by OAuth clientlistSessionOauthAuth GET Endpoint for initiating Authorization Code Flow by OAuth client.

Authorization code1

Endpoint for processing Authorization Code FlowlistSessionOauthCode GET Endpoint for processing Authorization Code Flow.

Authorize1

The authorization endpoint is used to interact with the resource owner and obtain an authorization grantlistOauth2Authorize GET The authorization endpoint is used to interact with the resource owner and obtain an authorization grant.

Badges2

Retrieves the employee's badge information`listEmployeesBadges`	GET	Retrieves the employee's badge information.
Updates the employee's badge information`updateEmployeesBadges`	PUT	Updates the employee's badge information.

Batch Update1

Allows to replace all existing time entries for given employee and date rangeupdateTimeEntriesCollection PUT Allows to replace all existing time entries for given employee and date range.

Batch Upload2

Creates multiple new applicants in a single request`createApplicantsCollection`	POST	Creates multiple new applicants in a single request.
Creates new cost centers within an existing cost center tree`createConfigCostCentersCollection`	POST	Creates new cost centers within an existing cost center tree.

Batches1

Get information about all payroll batcheslistPayrollsBatches GET Get information about all payroll batches.

Benefit Plan1

Retrieves an employee benefit plan by its IDgetBenefits GET Retrieves an employee benefit plan by its ID.

Benefit Plan List1

Retrieves a list of benefit plans including information about earnings, deductions, and coverageslistBenefitsBenefitPlans GET Retrieves a list of benefit plans including information about earnings, deductions, and coverages.

Benefit Plans3

Endpoint to fetch list of Benefit Plans`listLookupBenefitPlans`	GET	Endpoint to fetch list of Benefit Plans.
Retrieves a list of an employee's benefit plans`listEmployeesBenefits`	GET	Retrieves a list of an employee's benefit plans.
Retrieves a list of benefit plans for employees`listBenefits`	GET	Retrieves a list of benefit plans for employees.

Benefit Types1

Endpoint to fetch list of Benefit TypeslistLookupBenefitTypes GET Endpoint to fetch list of Benefit Types.

Birthday Calendar1

Retrieves a list of employee birthdays within a given date rangelistCalendarBirthday GET Retrieves a list of employee birthdays within a given date range.

Cancel Closing1

Cancel Closing the specified payrollsrunActionsCloseCancel POST Cancel Closing the specified payrolls.

Cancel Delete Sync Time1

Cancel Delete Sync Time on the specified payrollsrunActionsDeleteSyncTimeCancel POST Cancel Delete Sync Time on the specified payrolls.

Cancel Finalize Payroll1

Cancel Finalize Payroll on the specified payrollsrunActionsFinalizeCancel POST Cancel Finalize Payroll on the specified payrolls.

Cancel Initiate1

Cancel Initiating the specified payrollsrunActionsInitiateCancel POST Cancel Initiating the specified payrolls.

Cancel Recalculate1

Cancel Recalculate Payroll on the specified payrollsrunActionsRecalculateCancel POST Cancel Recalculate Payroll on the specified payrolls.

Cancel Reopen Payroll1

Cancel Reopen Payroll on the specified payrollsrunActionsReopenCancel POST Cancel Reopen Payroll on the specified payrolls.

Cancel Rollback Payroll1

Cancel Rollback Payroll on the specified payrollsrunActionsRollbackCancel POST Cancel Rollback Payroll on the specified payrolls.

Cancel Sync Time1

Cancel Sync Time on the specified payrollsrunActionsSyncTimeCancel POST Cancel Sync Time on the specified payrolls.

Case3

Endpoint for delete leave of absence case`deleteLoaCases`	DELETE	Endpoint for delete leave of absence case.
Endpoint for fetching leave of absence case by its id`getLoaCases`	GET	Endpoint for fetching leave of absence case by its id.
Endpoint for updating leave of absence case`updateLoaCases`	PUT	Endpoint for updating leave of absence case.

Cases3

Endpoint for creating new leave of absence case`createLoaCases`	POST	Endpoint for creating new leave of absence case.
Endpoint for fetching employee's leave of absence cases`listEmployeesLoaCases`	GET	Endpoint for fetching employee's leave of absence cases.
Endpoint for fetching leave of absence cases`listLoaCases`	GET	Endpoint for fetching leave of absence cases.

Change active status1

Changes the active status of an employee contactpatchContactsActiveStatus PATCH Changes the active status of an employee contact.

Changed employees1

Retrieves basic information about employee records that have been updated in a given time framelistEmployeesChanged GET Retrieves basic information about employee records that have been updated in a given time frame.

Clear error messages1

Performs to clear error messages for the specified payrollsrunPayrollsActionsClearMessages POST Performs to clear error messages for the specified payrolls.

Close1

Performs closing process on the specified payrollsrunPayrollsActionsClose POST Performs closing process on the specified payrolls.

Close Project1

Endpoint closes the ProjectupdateProjectsClose PUT Endpoint closes the Project.

Collection5

Bulk operation to create multiple Shifts Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setup`createSchedulesShiftsCollection`	POST	Bulk operation to create multiple Shifts Advanced Scheduler ( SCHEDULE ) Subsystem must be enabled in company setup.
Bulk operation to delete multiple Shifts Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setup`deleteSchedulesShiftsCollection`	DELETE	Bulk operation to delete multiple Shifts Advanced Scheduler ( SCHEDULE ) Subsystem must be enabled in company setup.
Bulk operation to edit multiple Shifts Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setup`updateSchedulesShiftsCollection`	PUT	Bulk operation to edit multiple Shifts Advanced Scheduler ( SCHEDULE ) Subsystem must be enabled in company setup.
Endpoint deletes multiple mailbox items`deleteNotificationsMailboxItemsCollection`	DELETE	Endpoint deletes multiple mailbox items
Update rate schedules collection`updateTablesSchedulesCollection`	PUT	Update rate schedules collection

Company Access1

Returns a list of Access Profiles in the specified companylistLookupProfilesSystemAccess GET Returns a list of Access Profiles in the specified company.

Company Assignments1

Returns the information of all the Current, Future or Only Past Dated assignments of the companylistPositionAssignments GET Returns the information of all the Current, Future or Only Past Dated assignments of the company.

Company or Account Groups1

Returns company or account groupslistLookupGroups GET Returns company or account groups.

Contact3

Deletes an employee contact`deleteContacts`	DELETE	Deletes an employee contact.
Retrieves an employee contact by its ID`getContacts`	GET	Retrieves an employee contact by its ID.
Updates an existing employee's contact information`updateContacts`	PUT	Updates an existing employee's contact information.

Contacts2

Creates employee contacts`createContacts`	POST	Creates employee contacts.
Endpoint to get list of employee contacts`listEmployeesContacts`	GET	Endpoint to get list of employee contacts.

Contracts3

Creates employee contracts`createEmployeeContracts`	POST	Creates employee contracts.
Deletes multiple employee contracts by their IDs`deleteEmployeeContracts`	DELETE	Deletes multiple employee contracts by their IDs.
Updates existing employee contracts`updateEmployeeContracts`	PUT	Updates existing employee contracts.

Cost Center3

Deletes a cost center by marking it as deleted (soft delete)`deleteConfigCostCenters`	DELETE	Deletes a cost center by marking it as deleted (soft delete).
Retrieves an existing cost center`getConfigCostCenters`	GET	Retrieves an existing cost center.
Updates an existing cost center by its ID using a full replacement of the resource`updateConfigCostCenters`	PUT	Updates an existing cost center by its ID using a full replacement of the resource.

Cost Center Action1

Performs an action on a Cost CenterrunConfigCostCentersActions PUT Performs an action on a Cost Center.

Cost Center Job3

Deletes a specific Cost Center Job within the company`deleteConfigCostCenterJobs`	DELETE	Deletes a specific Cost Center Job within the company.
Retrieves a specific Cost Center Job within the company`getConfigCostCenterJobs`	GET	Retrieves a specific Cost Center Job within the company.
Updates a specific Cost Center Job within the company`updateConfigCostCenterJobs`	PUT	Updates a specific Cost Center Job within the company.

Cost Center Jobs2

Creates a new Cost Center Job within the company`createConfigCostCenterJobs`	POST	Creates a new Cost Center Job within the company.
Retrieves all Cost Center Jobs available within the company`listConfigCostCenterJobs`	GET	Retrieves all Cost Center Jobs available within the company.

Cost Center Lists2

Creates a list that includes all specified cost centers`createConfigCostCentersLists`	POST	Creates a list that includes all specified cost centers.
Retrieves a collection of cost center lists, excluding the cost centers within each list`listConfigCostCentersLists`	GET	Retrieves a collection of cost center lists, excluding the cost centers within each list.

Cost Centers1

Retrieves existing cost centers as a flat listlistConfigCostCenters GET Retrieves existing cost centers as a flat list.

Counter adjustment2

Deletes a counter adjustment`deleteEmployeesCounterAdjustments`	DELETE	Deletes a counter adjustment.
Updates a counter adjustment`updateEmployeesCounterAdjustments`	PUT	Updates a counter adjustment.

Counter Adjustment Notes3

Creates notes for counter adjustments`createCounterAdjustmentsNotes`	POST	Creates notes for counter adjustments.
Deletes notes for counter adjustments`deleteCounterAdjustmentsNotes`	DELETE	Deletes notes for counter adjustments.
Retrieves notes for counter adjustments`listCounterAdjustmentsNotes`	GET	Retrieves notes for counter adjustments.

Counter adjustments2

Allows existing counters to be fetched for a specified account in a given date range`listEmployeesCounterAdjustments`	GET	Allows existing counters to be fetched for a specified account in a given date range.
Creates a counter adjustment`createEmployeesCounterAdjustments`	POST	Creates a counter adjustment.

Counter Distribution Profiles1

Returns a list of Counter Distribution Profiles in the specified companylistLookupProfilesCounterDistributionProfiles GET Returns a list of Counter Distribution Profiles in the specified company.

Counters2

Endpoint for fetching employee's leave of absence`listEmployeesLoaCounters`	GET	Endpoint for fetching employee's leave of absence.
Endpoint for updating leave of absence`updateEmployeesLoaCounters`	PUT	Endpoint for updating leave of absence.

Country Specific Fields2

Replaces the country-specific field values for the requested employee`updateEmployeesCountryFields`	PUT	Replaces the country-specific field values for the requested employee.
Returns the country-specific field values for the requested employee`listEmployeesCountryFields`	GET	Returns the country-specific field values for the requested employee.

Country Specific Fields Settings1

Returns the country-specific field configuration metadata for a given employee account or EINlistCountryFieldsSettings GET Returns the country-specific field configuration metadata for a given employee account or EIN.

Credential Types1

Endpoint to fetch list of credential typeslistLookupCredentialTypes GET Endpoint to fetch list of credential types.

Credentials1

Returns the employee credentials informationlistEmployeesCredentials GET Returns the employee credentials information.

Current employee1

Get EmployeesMelistEmployeesMe GET Retrieves basic information about the employee associated with the current 'Authentication Token', along with links to operations that provide detailed information about the employee.

Custom2

Endpoint returns available custom forms list`listEmployeesFormsCustom`	GET	Endpoint returns available custom forms list.
Endpoint returns available custom forms list`listFormsCustomIds`	GET	Endpoint returns available custom forms list.

Dashboard Widget API1

Retrieves a list of URLs for dashboard widgetslistDashboardWidgets GET Retrieves a list of URLs for dashboard widgets.

Data Export1

Retrieves a specific Data Export from the companygetDataExports GET Retrieves a specific Data Export from the company

Data Export Types1

Endpoint to get Data Export types available in companylistDatadeliveryDataExportTypes GET Endpoint to get Data Export types available in company.

Data Exports2

Creates a new Data Export in the company that a user can run`createDataExports`	POST	Creates a new Data Export in the company that a user can run.
Retrieves all available Data Exports in the company that the user can run`listDataExports`	GET	Retrieves all available Data Exports in the company that the user can run.

Data Retention Profiles1

Returns a list of Data Retention Profiles in the specified companylistLookupProfilesDataRetentionProfiles GET Returns a list of Data Retention Profiles in the specified company.

DataView1

Provides the requested data for an employeecreateDatadeliveryDataview POST Provides the requested data for an employee.

Deduction Codes1

Endpoint to fetch list of supported deduction codeslistLookupDeductionCodes GET Endpoint to fetch list of supported deduction codes.

Deductions2

Endpoint for creating new scheduled deduction for the employee`createEmployeesDeductions`	POST	Endpoint for creating new scheduled deduction for the employee.
Endpoint to get list of employee scheduled deductions`listEmployeesDeductions`	GET	Endpoint to get list of employee scheduled deductions.

Degrees1

Endpoint to fetch list of DegreeslistLookupDegrees GET Endpoint to fetch list of Degrees.

Delete multiple documents1

Deletes one or more documents using a list of document IDscreateIdsMassDelete POST Deletes one or more documents using a list of document IDs.

Delete Sync Time1

Delete Sync Time on the specified payrollsrunPayrollsActionsDeleteSyncTime POST Delete Sync Time on the specified payrolls.

Deliver1

Performs the delivery process on the specified payrolls if closedrunPayrollsActionsDeliver POST Performs the delivery process on the specified payrolls if closed.

Delivery Policies1

Returns a list of Delivery Policies in the specified companylistLookupProfilesDeliveryPolicies GET Returns a list of Delivery Policies in the specified company.

Demographic Profiles1

Returns a list of Demographic Profiles in the specified companylistLookupProfilesDemographicProfiles GET Returns a list of Demographic Profiles in the specified company.

Demographics2

Put EmployeesDemographics`updateEmployeesDemographics`	PUT	Additionally required field validation will not performed for fields that are marked as required as part of the demographic profile.
Returns the employee demographic information`listEmployeesDemographics`	GET	Returns the employee demographic information.

Device Access1

Returns a list of Device Access Profiles in the specified companylistLookupProfilesDeviceAccess GET Returns a list of Device Access Profiles in the specified company.

Direct Deposits1

Returns list of employee's direct deposit accountslistEmployeesDirectDeposits GET Returns list of employee's direct deposit accounts.

Disable Popup1

Disables the announcement popup on logindeleteEmployeesAnnouncementsPopup DELETE Disables the announcement popup on login.

Document3

Deletes the metadata of a specified document`deleteIds`	DELETE	Deletes the metadata of a specified document.
Retrieves the metadata of a specified document`getIds`	GET	Retrieves the metadata of a specified document.
Updates the metadata of an uploaded document`updateIds`	PUT	Updates the metadata of an uploaded document.

Document Preview1

Retrieves the document preview metadata of a specified documentlistIdsPreview GET Retrieves the document preview metadata of a specified document.

Document Storage2

Initiates the document upload process, which consists of three steps: 1`createIds`	POST	Initiates the document upload process, which consists of three steps: 1.
Retrieves a list of uploaded documents`listIds`	GET	Retrieves a list of uploaded documents.

Document Types1

Returns a list of defined document types in the companylistLookupDocumentTypes GET Returns a list of defined document types in the company.

Document Version1

Submits a Payment Service Platform document for processing and storagecreatePspDocuments POST Submits a Payment Service Platform document for processing and storage.

Earning Codes1

Endpoint to fetch list of supported earning codeslistLookupEarningCodes GET Endpoint to fetch list of supported earning codes.

Education Levels1

Endpoint to fetch list of Education LevelslistLookupEducationLevels GET Endpoint to fetch list of Education Levels.

EINs2

Endpoint to fetch list of supported eins`listLookupEins`	GET	Endpoint to fetch list of supported eins.
Endpoint to fetch list of supported eins based on the user's security profile configuration`listLookupProfileSpecificEins`	GET	Endpoint to fetch list of supported eins based on the user's security profile configuration.

Employee3

Deletes an employee`deleteEmployees`	DELETE	Deletes an employee.
Retrieves the core Employee record, which contains the bulk of the information about an employee`getEmployees`	GET	Retrieves the core Employee record, which contains the bulk of the information about an employee.
Updates the core employee information`updateEmployees`	PUT	Updates the core employee information.

Employee Attendance1

Retrieves attendance data for a specific employeelistEmployeesAttendance GET Retrieves attendance data for a specific employee.

Employee Currency1

Endpoint gets Employee CurrencylistEmployeesCurrency GET Endpoint gets Employee Currency

Employee Documents1

Endpoint for receiving list of uploaded documents for an employeelistEmployeesIds GET Endpoint for receiving list of uploaded documents for an employee.

Employee Perspectives Profiles1

Returns a list of Employee Perspectives Profiles in the specified companylistLookupProfilesEmployeePerspectiveProfiles GET Returns a list of Employee Perspectives Profiles in the specified company.

Employee Primary Assignment1

Get PrimaryAssignmentlistPrimaryAssignment GET Retrieves a list of Primary Assignments for all employees who have an active and effective primary assignment on a given date.

Employee Types3

Allows enabled employee types to be returned`listLookupEmployeeTypes`	GET	Allows enabled employee types to be returned.
Allows existing employee-types to be updated`updateCompanyEmployeeTypesV1`	PUT	Allows existing employee-types to be updated.
Allows new employee-types to be created, the `name` must be unique for each type`createCompanyEmployeeTypesV1`	POST	Allows new employee-types to be created, the name must be unique for each type.

Employees3

Allows caller to fetch list of employees based on request filter criteria i.e`createPayrollsEmployees`	POST	Allows caller to fetch list of employees based on request filter criteria i.e. EIN, pay period profile and employee list.
Creates a new Employee record`createEmployees`	POST	Creates a new Employee record.
Get Employees`listEmployees`	GET	Retrieves basic information about the employees a user has permission to view, along with links to operations that provide detailed information about each employee.

Employees Based on Pay Group Id1

Retrieve employees information specific to pay group idlistEmployeesInfo GET Retrieve employees information specific to pay group id.

Execute Accrual Balances1

Performs the execute accrual balances process on the specified payrolls, payroll or pay periodrunPayrollsActionsExecuteAccrualBalances POST Performs the execute accrual balances process on the specified payrolls, payroll or pay period.

Execute Accruals1

Performs the execute accruals process on the specified payrollsrunPayrollsActionsExecuteAccruals POST Performs the execute accruals process on the specified payrolls.

Execute Data Export2

Runs the Data Export specified by the URI parameter `data_export_id``createDataExportsExecute`	POST	Runs the Data Export specified by the URI parameter data export id.
Runs the Data Export specified by the URI parameter `data_export_id``listDataExportsExecute`	GET	Runs the Data Export specified by the URI parameter data export id.

Expense Item1

Creates a new expense item belonging to the specified reportupdateExpenseTrackingReportItem PUT Creates a new expense item belonging to the specified report.

Expense Item Summaries1

Returns summaries for all items on the expense reportlistExpenseTrackingReportItemSummaries GET Returns summaries for all items on the expense report

Expense Report3

Deletes specified expense report`deleteExpenseTrackingReport`	DELETE	Deletes specified expense report
Returns specified expense report`getExpenseTrackingReport`	GET	Returns specified expense report
Update an expense report`createExpenseTrackingReport`	POST	Update an expense report

Expense Report Metadata1

Returns metadata used to create an expense report, including expense tracking profile id and report level attributeslistExpenseTrackingReportMeta GET Returns metadata used to create an expense report, including expense tracking profile id and report level attributes.

Expense Reports1

Returns specified expense reports based on query parameterslistExpenseTrackingReportReports GET Returns specified expense reports based on query parameters

Expense Type Metadata1

Get ExpenseTrackingReportMetalistExpenseTrackingReportMeta2 GET Returns expense type metadata used to add expense item to an expense report, including all expense types and their attributes supported by the expense report.

Export Job Status2

Endpoint to get current export status`getExportsStatus`	GET	Endpoint to get current export status.
Returns the current status and result of an asynchronous export job`runPayPeriodsActionExport2`	GET	Returns the current status and result of an asynchronous export job.

External Pay Statements1

Allow user to upload their Pay Statements External pay statements upload is a two-phase processcreateExternalPayStatements POST Allow user to upload their Pay Statements External pay statements upload is a two-phase process.

External PayStatements2

Allow user to delete Pay statements data`deleteExternalPayStatements`	DELETE	Allow user to delete Pay statements data.
Allow user to get Pay statement data`getExternalPayStatements`	GET	Allow user to get Pay statement data.

Eye Color1

Endpoint to get list of colors of the eye based on the already filled data in account demographics for other accountslistLookupEyeColor GET Endpoint to get list of colors of the eye based on the already filled data in account demographics for other accounts.

Finalize1

Performs the finalize process on the specified payrolls if closedrunPayrollsActionsFinalize POST Performs the finalize process on the specified payrolls if closed.

Finalyze and Deliver1

Performs the finalize and delivery process on the specified payrolls if closedrunPayrollsActionsFinalizeDeliver POST Performs the finalize and delivery process on the specified payrolls if closed.

First Screens1

Endpoint to fetch list of supported first screenslistLookupFirstScreens GET Endpoint to fetch list of supported first screens.

Forward1

Endpoint forwards mailbox itemsrunMailboxItemsActionForward POST Endpoint forwards mailbox items

Get/Update/Delete Expense Item3

Deletes specified expense item from the expense report`deleteExpenseTrackingReportItem`	DELETE	Deletes specified expense item from the expense report
Returns specified expense item`getExpenseTrackingReportItem`	GET	Returns specified expense item
Update an expense item`createExpenseTrackingReportItem`	POST	Update an expense item

Global Report2

Endpoint to specify settings and receive a report with the applied settings as a Response`createReportGlobalV1`	POST	Endpoint to specify settings and receive a report with the applied settings as a Response.
Run the report specified by the Uri parameter 'id' and return the content in the format specified by the 'Accept' header`getReportGlobalV1`	GET	Run the report specified by the Uri parameter 'id' and return the content in the format specified by the 'Accept' header.

Global Report Metadata1

This endpoint receives the report metadatalistReportGlobalMetadataV1 GET This endpoint receives the report metadata.

Grants1

Gets all active authorized OAuth applications for a specified user within a companylistOauth2Grants GET Gets all active authorized OAuth applications for a specified user within a company.

HCM Application Details Widget3

Enables the Dimensions HCM Application Details Widget`createHcmAppDetails`	POST	Enables the Dimensions HCM Application Details Widget.
Retrieves information about fields in the Dimensions HCM Application Details Widget`listHcmAppDetails`	GET	Retrieves information about fields in the Dimensions HCM Application Details Widget.
Updates fields in the Dimensions HCM Application Details Widget`updateHcmAppDetails`	PUT	Updates fields in the Dimensions HCM Application Details Widget.

HCM System Details Widget3

Enables the Dimensions HCM System Details Widget`createHcmWidgetConfig`	POST	Enables the Dimensions HCM System Details Widget.
Retrieves information about fields in the Dimensions HCM System Details Widget`listHcmWidgetConfig`	GET	Retrieves information about fields in the Dimensions HCM System Details Widget.
Updates fields in the Dimensions HCM System Details Widget`updateHcmWidgetConfig`	PUT	Updates fields in the Dimensions HCM System Details Widget.

Hiring Stages1

Endpoint to fetch list of all Hiring Stages within the companylistLookupHiringStages GET Endpoint to fetch list of all Hiring Stages within the company.

History6

Creates an Employee Base Compensation entry`createCompensationHistory`	POST	Creates an Employee Base Compensation entry.
Deletes a specific Employee Base Compensation entry`deleteCompensationHistory`	DELETE	Deletes a specific Employee Base Compensation entry.
Retrieves a list of Base Compensation entries for all subordinates`listCompensationHistory`	GET	Retrieves a list of Base Compensation entries for all subordinates.
Retrieves detailed information about an Employee Base Compensation entry`getCompensationHistory`	GET	Retrieves detailed information about an Employee Base Compensation entry.
Retrieves the list of Base Compensation entries for a specific employee`listEmployeesCompensationHistory`	GET	Retrieves the list of Base Compensation entries for a specific employee.
Updates an Employee Base Compensation entry`updateCompensationHistory`	PUT	Updates an Employee Base Compensation entry.

Holiday Profiles3

Allows existing holiday profiles to be updated`updateCompanyProfilesHolidayV1`	PUT	Allows existing holiday profiles to be updated.
Allows new holiday profiles to be created, the `name` must be unique for each holiday profile`createCompanyProfilesHolidayV1`	POST	Allows new holiday profiles to be created, the name must be unique for each holiday profile.
Returns a list of Holiday Profiles in the specified company`listLookupProfilesHolidayProfiles`	GET	Returns a list of Holiday Profiles in the specified company.

Holidays1

Endpoint returns Holidays from a Holiday Profile assigned to a single EmployeelistEmployeesHolidays GET Endpoint returns Holidays from a Holiday Profile assigned to a single Employee.

HR Action Audit Request1

Retrieves the details of a specific HR Action Audit Request by its unique identifiergetHrActionsAuditRequests GET Retrieves the details of a specific HR Action Audit Request by its unique identifier.

HR Action Audit Requests2

Creates a new HR Action Audit Request`createHrActionsAuditRequests`	POST	Creates a new HR Action Audit Request.
Retrieves a list of HR Action Audit Requests`listHrActionsAuditRequests`	GET	Retrieves a list of HR Action Audit Requests.

HR Custom Fields2

Returns the employee hr custom fields`listEmployeesHrCustomFields`	GET	Returns the employee hr custom fields.
Update the employee hr custom fields`updateEmployeesHrCustomFields`	PUT	Update the employee hr custom fields.

Import Job Status1

Endpoint to get current status of importgetImportStatusV1 GET Endpoint to get current status of import

Incoming Webhook Events1

Endpoint to submit webhook payloads from third party applications to ready APIcreateIntegrationsEvents POST Endpoint to submit webhook payloads from third party applications to ready API.

Incoming Webhook Events Acknowledgement1

Retrieves the current processing status for an event identified by its unique acknowledgementIdgetIntegrationsEvents GET Retrieves the current processing status for an event identified by its unique acknowledgementId.

Initiate1

Endpoint to initiate one or more payrollsrunPayrollsActionsInitiate POST Endpoint to initiate one or more payrolls.

Interview Locations1

Endpoint to fetch list of interview locationslistLookupInterviewLocations GET Endpoint to fetch list of interview locations.

Interview Names1

Endpoint to fetch list of interview nameslistLookupInterviewNames GET Endpoint to fetch list of interview names.

Inventory Item3

End point to fetch specific employee inventory item by id`getInventoryProfilesInventoryItems`	GET	End point to fetch specific employee inventory item by id.
Endpoint replaces given employee inventory item by id with a new one provided in payload`updateInventoryProfilesInventoryItems`	PUT	Endpoint replaces given employee inventory item by id with a new one provided in payload.
Endpoint to delete specific employee inventory item by id`deleteInventoryProfilesInventoryItems`	DELETE	Endpoint to delete specific employee inventory item by id.

Inventory Items2

Endpoint creates a new employee inventory item`createInventoryProfilesInventoryItems`	POST	Endpoint creates a new employee inventory item.
Endpoint returns a list of all employee inventory items`listInventoryProfilesInventoryItems`	GET	Endpoint returns a list of all employee inventory items.

Inventory Profiles1

Endpoint returns a list of all inventory profileslistInventoryProfiles GET Endpoint returns a list of all inventory profiles.

Job Application3

End point to fetch specific job application by job_app_id`getJobApplications`	GET	End point to fetch specific job application by job app id.
Endpoint replaces given job application by job_app_id with a new one provided in payload`updateJobApplications`	PUT	Endpoint replaces given job application by job app id with a new one provided in payload.
Endpoint to delete specific job application by job_app_id`deleteJobApplications`	DELETE	Endpoint to delete specific job application by job app id.

Job Application Status1

Endpoint to fetch list of job application statuseslistLookupJobApplicationStatus GET Endpoint to fetch list of job application statuses.

Job Applications2

Endpoint creates a new job application`createJobApplications`	POST	Endpoint creates a new job application.
Endpoint returns a list of all job applications present in a company`listJobApplications`	GET	Endpoint returns a list of all job applications present in a company.

Job Categories1

Endpoint to fetch list of Job CategorieslistLookupJobCategories GET Endpoint to fetch list of Job Categories.

Job Change Reasons1

Endpoint to fetch list of supported job change reasonslistLookupJobChangeReasons GET Endpoint to fetch list of supported job change reasons.

Job Processing Status1

Endpoint for retrieving a job processing statuslistSystemJobsStatus GET Endpoint for retrieving a job processing status

Job Requisition Categories1

Endpoint to get list of Job Categories present inside the open and active Job Requisitions within the companylistLookupJobReqJobCategories GET Endpoint to get list of Job Categories present inside the open and active Job Requisitions within the company.

Job Requisition Details1

Endpoint returns details of specific Job RequisitiongetRecruitmentJobRequisitions GET Endpoint returns details of specific Job Requisition.

Job Requisition Locations1

Endpoint to get list of Job Locations present inside the open and active Job Requisitions within the companylistLookupJobReqJobLocations GET Endpoint to get list of Job Locations present inside the open and active Job Requisitions within the company.

Job Requisition Questionnaire1

Endpoint returns Questionnaire questions of a Job RequisitionlistRecruitmentJobRequisitionsQuestionnaire GET Endpoint returns Questionnaire questions of a Job Requisition.

Job Requisitions1

Endpoint returns List of Job Requisitions available within the companylistRecruitmentJobRequisitions GET Endpoint returns List of Job Requisitions available within the company.

Jobs1

Endpoint to fetch list of JobslistLookupJobs GET Endpoint to fetch list of Jobs.

Leave of Absence Profiles1

Returns a list of Leave of Absence Profiles in the specified companylistLookupProfilesLeaveOfAbsenceProfiles GET Returns a list of Leave of Absence Profiles in the specified company.

List3

Deletes a cost center list`deleteConfigCostCentersLists`	DELETE	Deletes a cost center list.
Retrieves the details of a cost center list`getConfigCostCentersLists`	GET	Retrieves the details of a cost center list.
Updates a cost center list`updateConfigCostCentersLists`	PUT	Updates a cost center list.

LOA Reasons1

Returns the list of defined leave of absence reasons in the companylistLookupLoaReasons GET Returns the list of defined leave of absence reasons in the company.

Locales1

Endpoint to fetch list of supported localeslistLookupLocales GET Endpoint to fetch list of supported locales.

Lock2

Endpoint provides ability to delete accounts's lock`deleteAccountsLock`	DELETE	Endpoint provides ability to delete accounts's lock.
Endpoint provides ability to lock an account`updateAccountsLock`	PUT	Endpoint provides ability to lock an account.

Login1

__This resource has been deprecated as of November 25, 2025createLoginV1 POST This resource has been deprecated as of November 25, 2025.

Login endpoint that supports impersonation allowing to login as "System Account"listLoginAsV1 GET Login endpoint that supports impersonation allowing to login as "System Account".

Logout2

Logout endpoint that ends session for authorized user`listLogoutV1`	GET	Logout endpoint that ends session for authorized user.
The logout endpoint is used to log out the user associated with the access token`listOauth2Logout`	GET	The logout endpoint is used to log out the user associated with the access token.

Mailbox item1

Endpoint deletes single mailbox itemdeleteNotificationsMailboxItems DELETE Endpoint deletes single mailbox item

Mailbox items3

Endpoint creates new mailbox item`createEmployeesNotificationsMailboxItems`	POST	Endpoint creates new mailbox item.
Endpoint returns a list of mailbox items in the system`listNotificationsMailboxItems`	GET	Endpoint returns a list of mailbox items in the system.
Endpoint returns a list of mailbox items in the system for a particular employee`listEmployeesNotificationsMailboxItems`	GET	Endpoint returns a list of mailbox items in the system for a particular employee.

Managed Cost Center2

Endpoint for fetching MCC by Maneged Cost Center ACL id`getEmployeesManagedCostCenters`	GET	Endpoint for fetching MCC by Maneged Cost Center ACL id.
Endpoint for updating MCC by Maneged Cost Center ACL id`updateEmployeesManagedCostCenters`	PUT	Endpoint for updating MCC by Maneged Cost Center ACL id.

Managed Cost Centers2

Endpoint for fetching Managed Cost Centers list`listEmployeesManagedCostCenters`	GET	Endpoint for fetching Managed Cost Centers list.
Endpoint to create Managed Cost Center`createEmployeesManagedCostCenters`	POST	Endpoint to create Managed Cost Center.

Management Companies1

Adds companies to management companies list and makes one of the company primarycreateManagementCompanies POST Adds companies to management companies list and makes one of the company primary.

Manager3

Deletes an existing regular account group manager by its ID`deleteSecurityAccountGroupsManagers`	DELETE	Deletes an existing regular account group manager by its ID.
Replaces an existing regular account group manager`updateSecurityAccountGroupsManagers`	PUT	Replaces an existing regular account group manager.
Retrieves an existing regular account group manager by its ID`getSecurityAccountGroupsManagers`	GET	Retrieves an existing regular account group manager by its ID.

Manager Replacements1

Endpoint for fetching employee Manager ReplacementslistEmployeesManagerReplacements GET Endpoint for fetching employee Manager Replacements.

Managers2

Creates a new regular account group manager`createSecurityAccountGroupsManagers`	POST	Creates a new regular account group manager.
Retrieves existing regular account group managers`listSecurityAccountGroupsManagers`	GET	Retrieves existing regular account group managers.

Manual Counters1

Returns the list of defined counters in the companylistLookupManualCounters GET Returns the list of defined counters in the company.

Marketplace Products1

Adds marketplace products to the company by product namescreateMarketplaceProducts POST Adds marketplace products to the company by product names.

Member2

Deletes an existing regular account group member by its ID`deleteSecurityAccountGroupsMembers`	DELETE	Deletes an existing regular account group member by its ID.
Retrieves an existing regular account group member by its ID`getSecurityAccountGroupsMembers`	GET	Retrieves an existing regular account group member by its ID.

Members2

Creates a new regular account group member`createSecurityAccountGroupsMembers`	POST	Creates a new regular account group member.
Retrieves existing regular account group members`listSecurityAccountGroupsMembers`	GET	Retrieves existing regular account group members.

Metadata1

Retrieves all categories and fields for a companylistDatadeliveryMetadata GET Retrieves all categories and fields for a company.

Migrate Service Account1

Migrates a regular account to a Service AccountupdateServiceAccountsMigrate PUT Migrates a regular account to a Service Account.

Multi Pay Statements1

Post PayrollsMultiPayStatementscreatePayrollsMultiPayStatements POST Endpoint to create new pay statement for multiple employees in a bulk with provided payroll(start date/end date) and ein(id/display name) for the given employees, allows to enter complex...

My Currency1

Retrieves the currency for the current employeelistEmployeesMeCurrency GET Retrieves the currency for the current employee.

My Navigation Menu1

Get EmployeesMeNavigationMenulistEmployeesMeNavigationMenu GET Retrieves the navigation menu for the current employee, organised into four groups: employee, manager, settings, and favorites.

Navigation1

Provides the hierachy of navigation links available to the user based on security and enabled featureslistNavigation GET Provides the hierachy of navigation links available to the user based on security and enabled features.

New Expense Report1

Create a new expense reportupdateExpenseTrackingReport PUT Create a new expense report.

Note3

Endpoint for deleting notes of leave of absence case`deleteLoaCasesNotes`	DELETE	Endpoint for deleting notes of leave of absence case.
Endpoint for deleting notes of leave of absence request`deleteLoaRequestsNotes`	DELETE	Endpoint for deleting notes of leave of absence request.
Endpoint to delete note by it's ID`deleteNotes`	DELETE	Endpoint to delete note by it's ID.

Notes8

Endpoint for creating notes of leave of absence case`createLoaCasesNotes`	POST	Endpoint for creating notes of leave of absence case.
Endpoint for creating notes of leave of absence request`createLoaRequestsNotes`	POST	Endpoint for creating notes of leave of absence request.
Endpoint for fetching a notes of a specified overtime request`listOvertimeRequestsNotes`	GET	Endpoint for fetching a notes of a specified overtime request.
Endpoint for fetching notes of leave of absence case`listLoaCasesNotes`	GET	Endpoint for fetching notes of leave of absence case.
Endpoint for fetching notes of leave of absence request`listLoaRequestsNotes`	GET	Endpoint for fetching notes of leave of absence request.
Enpoint for creating notes`createNotes`	POST	Enpoint for creating notes.
Enpoint returns list of notes`listNotes`	GET	Enpoint returns list of notes.
Retrieves a list of notes for a specified Base Compensation entry`listCompensationHistoryNotes`	GET	Retrieves a list of notes for a specified Base Compensation entry.

Notification Profiles1

Endpoint to fetch list of all notification ProfileslistLookupNotificationProfiles GET Endpoint to fetch list of all notification Profiles.

Notification Tags1

Endpoint to fetch list of all notification tagslistLookupNotificationTags GET Endpoint to fetch list of all notification tags.

OAuth Application2

Endpoint for fetching OAuth application by id`getOauthApplications`	GET	Endpoint for fetching OAuth application by id.
Update an existing OAuth application`updateOauthApplications`	PUT	Update an existing OAuth application.

OAuth Applications2

Allows a new OAuth application to be created`createOauthApplications`	POST	Allows a new OAuth application to be created.
Gets all OAuth applications available within the company`listOauthApplications`	GET	Gets all OAuth applications available within the company.

Object Lists1

Allows object lists to be returnedgetLookupObjectLists GET Allows object lists to be returned.

OpenID Configuration1

Get Oauth2WellKnownOpenidConfigurationlistOauth2WellKnownOpenidConfiguration GET The OpenID Configuration endpoint is used to retrieve the OpenID Connect configuration details for the authorization server.

Order Status1

Receives push notifications for Background Screening order statusescreateBackgroundScreeningOrderStatus POST Receives push notifications for Background Screening order statuses.

Overtime Reasons1

Returns the list of defined overtime reasons in the companylistLookupOvertimeReasons GET Returns the list of defined overtime reasons in the company.

Overtime Requests3

Endpoint for creating overtime requests`createOvertimeRequests`	POST	Endpoint for creating overtime requests.
Endpoint for fetching employee overtime requests within required date range`listEmployeesOvertimeRequests`	GET	Endpoint for fetching employee overtime requests within required date range.
Endpoint for fetching overtime requests of manager's group members`listOvertimeRequests`	GET	Endpoint for fetching overtime requests of manager's group members.

Password1

Allows existing password to be updated for current logged in userupdateEmployeePasswordV1 PUT Allows existing password to be updated for current logged in user.

Password Policy1

Returns the employee password policylistEmployeesPasswordPolicy GET Returns the employee password policy

Pay1

__This resource has been deprecated as of October 8, 2022listEmployeesFormsPay GET This resource has been deprecated as of October 8, 2022.

Pay Calculation 2.0 Profiles1

Returns a list of Pay Calculation 2.0 Profiles in the specified companylistLookupProfilesPayCalc2Profiles GET Returns a list of Pay Calculation 2.0 Profiles in the specified company.

Pay Calculation Profiles2

Returns a list of Pay Calculation Profiles in the specified company`listLookupProfilesPayCalcProfiles`	GET	Returns a list of Pay Calculation Profiles in the specified company.
Returns the list of defined pay calculation profiles in the company when Pay Calculation 1 or 2 is enabled`listLookupPayCalProfiles`	GET	Returns the list of defined pay calculation profiles in the company when Pay Calculation 1 or 2 is enabled.

Pay Categories1

Returns the list of defined pay categories in the companylistLookupPayCategories GET Returns the list of defined pay categories in the company.

Pay Grades2

Endpoint to fetch list of supported pay grades`listLookupPayGrades`	GET	Endpoint to fetch list of supported pay grades.
Returns a list of Pay Grades in the specified company`listLookupProfilesPayGrades`	GET	Returns a list of Pay Grades in the specified company

Pay Information2

Returns the employee pay information`listEmployeesPayInfo`	GET	Returns the employee pay information.
Update the employee pay information`updateEmployeesPayInfo`	PUT	Update the employee pay information.

Pay Period Export1

Submits an asynchronous job to export payroll data for the given pay periodrunPayPeriodsActionExport POST Submits an asynchronous job to export payroll data for the given pay period.

Pay Period Profiles5

Endpoint to create pay period profiles`createCompanyPayPeriodProfilesV1`	POST	Endpoint to create pay period profiles.
Endpoint to delete pay period profiles by ids`deleteCompanyPayPeriodProfilesV1`	DELETE	Endpoint to delete pay period profiles by ids.
Endpoint to get pay period profiles`listCompanyPayPeriodProfilesV1`	GET	Endpoint to get pay period profiles.
Endpoint to update existing pay period profiles`updateCompanyPayPeriodProfilesV1`	PUT	Endpoint to update existing pay period profiles.
Returns a list of Pay Period Profiles in the specified company`listLookupProfilesPayPeriodProfiles`	GET	Returns a list of Pay Period Profiles in the specified company.

Pay period profiles1

Returns a list of Pay period profiles in the specified companylistLookupPayPeriodProfiles GET Returns a list of Pay period profiles in the specified company

Pay Period Snapshot1

Creates a snapshot of the current pay period datarunPayPeriodsActionSnapshot POST Creates a snapshot of the current pay period data.

Pay Prep Profiles1

Returns a list of Pay Prep Profiles in the specified companylistLookupProfilesPayPrepProfiles GET Returns a list of Pay Prep Profiles in the specified company

Pay Statement2

Delete specific Pay Statement`deletePayrollsPayStatements`	DELETE	Delete specific Pay Statement.
Get detailed information about the employee pay statement`getPayrollsPayStatements`	GET	Get detailed information about the employee pay statement.

Pay Statement Mass Delete1

Delete multiple pay statements via a key_set_ref or list of pay statement idscreatePayrollsPayStatementsMassDelete POST Delete multiple pay statements via a key set ref or list of pay statement ids

Pay Statement Types1

Endpoint to fetch list of supported pay statement typeslistLookupPayStatementTypes GET Endpoint to fetch list of supported pay statement types.

Pay Statements2

Endpoint to create new pay statement with provided type for a given employee, allows to enter complex data entry`createPayrollsPayStatements`	POST	Endpoint to create new pay statement with provided type for a given employee, allows to enter complex data entry.
Get information about all payroll pay statements`listPayrollsPayStatements`	GET	Get information about all payroll pay statements.

Pay Types5

Endpoint to create pay types`createCompanyPayTypesV1`	POST	Endpoint to create pay types.
Endpoint to delete multiple pay types in one call by ids`deleteCompanyPayTypesV1`	DELETE	Endpoint to delete multiple pay types in one call by ids.
Endpoint to fetch list of Pay Types`listLookupPayTypes`	GET	Endpoint to fetch list of Pay Types.
Endpoint to get all existed pay types in a company`listCompanyPayTypesV1`	GET	Endpoint to get all existed pay types in a company.
Endpoint to update pay types`updateCompanyPayTypesV1`	PUT	Endpoint to update pay types.

Payroll2

Delete specific payroll`deletePayrolls`	DELETE	Delete specific payroll.
Get detailed information about the payroll`getPayrolls`	GET	Get detailed information about the payroll.

Payroll Batch Types1

Endpoint to fetch list of supported payroll batch typeslistLookupPayrollBatchTypes GET Endpoint to fetch list of supported payroll batch types.

Payroll Types1

Endpoint to fetch list of supported payroll typeslistLookupPayrollTypes GET Endpoint to fetch list of supported payroll types.

Payrolls2

Endpoint to create a new payroll that has not been scheduled`createPayrolls`	POST	Endpoint to create a new payroll that has not been scheduled.
Endpoint to fetch list of company payrolls normally accessed to process payroll`listPayrolls`	GET	Endpoint to fetch list of company payrolls normally accessed to process payroll.

paystatement population1

Returns a list of paystatement population Profiles in the specified companylistLookupProfilesPstPopulation GET Returns a list of paystatement population Profiles in the specified company

Performance Review1

Returns a list of Performance Review Profiles in the specified companylistLookupProfilesPerformanceReview GET Returns a list of Performance Review Profiles in the specified company

Points profiles1

Returns a list of Points profiles in the specified companylistLookupProfilesPoints GET Returns a list of Points profiles in the specified company

Position1

Return the details of that position irrespective of whether its active and effective as of todaygetPositionPositions GET Return the details of that position irrespective of whether its active and effective as of today.

Position Assignments Changed1

Return the information of all the assignment that has been created/modified/deleted in given time framelistPositionPositionAssignmentsChanged GET Return the information of all the assignment that has been created/modified/deleted in given time frame.

Positions1

Get PositionPositionslistPositionPositions GET Return the information of all the Positions which are active and effective as on specified date(if not provided then today) .

Process Records1

Submits an asynchronous job to process pay prep records for the given pay periodrunPayPeriodsActionProcessRecords POST Submits an asynchronous job to process pay prep records for the given pay period.

Process Records Job Status1

Returns the current status and result of an asynchronous process records jobrunPayPeriodsActionProcessRecords2 GET Returns the current status and result of an asynchronous process records job.

Profiles2

Returns the employee profiles information`listEmployeesProfiles`	GET	Returns the employee profiles information.
Update the employee profiles information`updateEmployeesProfiles`	PUT	Update the employee profiles information.

Project2

Endpoint returns Project information`getProjects`	GET	Endpoint returns Project information.
Endpoint updates Project information`updateProjects`	PUT	Endpoint updates Project information.

Project Management1

Endpoint creates new ProjectcreateProjects POST Endpoint creates new Project.

Project Metrics1

Endpoint returns information related to the Project MetricslistProjectsMetrics GET Endpoint returns information related to the Project Metrics.

PTO Request8

Endpoint for creating new Time Off Request`createEmployeePtorequest`	POST	Endpoint for creating new Time Off Request.
Endpoint for creating new Time Off Request`createEmployeePtorequestV1`	POST	Endpoint for creating new Time Off Request.
Endpoint for deleting time off requests`deleteEmployeePtorequest`	DELETE	Endpoint for deleting time off requests.
Endpoint for deleting time off requests`deleteEmployeePtorequestV1`	DELETE	Endpoint for deleting time off requests.
Endpoint provides information about single time off request`getEmployeePtorequest`	GET	Endpoint provides information about single time off request.
Endpoint provides information about single time off request`getEmployeePtorequestV1`	GET	Endpoint provides information about single time off request.
Endpoint to list of time off requests for self`listEmployeePtorequest`	GET	Endpoint to list of time off requests for self.
Endpoint to list of time off requests for self`listEmployeePtorequestV1`	GET	Endpoint to list of time off requests for self.

PTO Request Notes2

Get all notes for time off request`listEmployeePtorequestNotes`	GET	Get all notes for time off request.
Get all notes for time off request`listEmployeePtorequestNotesV1`	GET	Get all notes for time off request.

Questionnaire1

Endpoint to fetch Questionnaire for Job Requisition, Benefit Enrollment, Recruitment Evaluation or Peer FeedbacklistLookupQuestionnaire GET Endpoint to fetch Questionnaire for Job Requisition, Benefit Enrollment, Recruitment Evaluation or Peer Feedback.

Rate Items4

Allows existing rate items to be updated`updateCompanyRateItemsV1`	PUT	Allows existing rate items to be updated.
Allows existing rate table items to be deleted`deleteCompanyRateItemsV1`	DELETE	Allows existing rate table items to be deleted.
Allows new rate items to be created`createCompanyRateItemsV1`	POST	Allows new rate items to be created.
Get CompanyRateItems`listCompanyRateItemsV1`	GET	Allows existing rate table items to be fetched, the data returned must be filtered by one or more of the fields defined below.

Rate Schedule2

Endpoint to delete rate schedule by id`deleteRatesTablesSchedules`	DELETE	Endpoint to delete rate schedule by id.
Update rate schedule`updateRatesTablesSchedules`	PUT	Update rate schedule.

Rate Schedules2

Create rate schedule`createRatesTablesSchedules`	POST	Create rate schedule.
Get all rate schedules data of a rate table`listRatesTablesSchedules`	GET	Get all rate schedules data of a rate table.

Rate Table3

Endpoint for fetching rate table details by its id`getRatesTables`	GET	Endpoint for fetching rate table details by its id.
Endpoint for updating rate table`updateRatesTables`	PUT	Endpoint for updating rate table.
Endpoint to delete rate table by id, only company rate tables which don't used could be deleted`deleteRatesTables`	DELETE	Endpoint to delete rate table by id, only company rate tables which don't used could be deleted.

Rate Tables6

Allows existing rate tables to be deleted`deleteCompanyRateTablesV1`	DELETE	Allows existing rate tables to be deleted.
Allows existing rate tables to be updated`updateCompanyRateTablesV1`	PUT	Allows existing rate tables to be updated.
Allows new rate tables to be created`createCompanyRateTablesV1`	POST	Allows new rate tables to be created.
Create rate table`createRatesTables`	POST	Create rate table.
Get all rate tables (comany and personal) configured in the company`listRatesTables`	GET	Get all rate tables (comany and personal) configured in the company.
Get CompanyRateTables`listCompanyRateTablesV1`	GET	Allows existing rate tables to be fetched, the data returned can be optionally filtered by one or more fields as defined below using the filter parameter.

Endpoint marks mailbox items as readrunMailboxItemsActionRead POST Endpoint marks mailbox items as read

Ready Learning Items3

Allows learning items (Course/Curricula) to be created`createLearningItems`	POST	Allows learning items (Course/Curricula) to be created.
Allows learning items (Course/Curricula) to be deleted`deleteLearningItems`	DELETE	Allows learning items (Course/Curricula) to be deleted.
Allows learning items (Course/Curricula) to be updated`updateLearningItems`	PUT	Allows learning items (Course/Curricula) to be updated.

Ready Learning Status1

Allows ready learning item assignments to be created and updatedcreateLearning POST Allows ready learning item assignments to be created and updated.

Reapply Rates1

Reapply RatesrunTablesActionsReapplyRates PUT Reapply Rates.

Reason codes1

Returns the list of defined reason codes in the companylistLookupReasonCodes GET Returns the list of defined reason codes in the company.

Recalculate1

Recalculates pay statements on the specified payrollsrunPayrollsActionsRecalculate POST Recalculates pay statements on the specified payrolls.

Recalculate Tax Year1

Submits an asynchronous job to recalculate tax forms for the given tax yearrunYearsActionsRecalculate POST Submits an asynchronous job to recalculate tax forms for the given tax year.

Recent Punches1

Returns list of last N puncheslistEmployeesPunchesRecent GET Returns list of last N punches.

Referrals1

Endpoint to fetch list of supported referralslistLookupReferrals GET Endpoint to fetch list of supported referrals.

Refresh Token1

Allows to get a newly generated tokenlistRefreshTokenV1 GET Allows to get a newly generated token.

Reopen1

Performs reopening process on the specified payrollsrunPayrollsActionsReopen POST Performs reopening process on the specified payrolls.

Reports1

Get list of available reportslistReportsV1 GET Get list of available reports.

Request4

Delete specific leave request`deleteLoaRequests`	DELETE	Delete specific leave request.
Endpoint for deleting overtime requests`deleteOvertimeRequests`	DELETE	Endpoint for deleting overtime requests.
Endpoint for fetching single overtime request`getOvertimeRequests`	GET	Endpoint for fetching single overtime request.
Get detailed information about the leave of absence request`getLoaRequests`	GET	Get detailed information about the leave of absence request.

Requests3

Returns employee's leave of absence requests within required date range`listEmployeesLoaRequests`	GET	Returns employee's leave of absence requests within required date range.
Returns leave of absence requests for all subordinates`listLoaRequests`	GET	Returns leave of absence requests for all subordinates.
Submit new leave of absence request`createLoaRequests`	POST	Submit new leave of absence request.

Retirement Plan Profiles1

Returns a list of retirement plan profiles in the specified companylistLookupProfilesRetirementPlanProfiles GET Returns a list of retirement plan profiles in the specified company.

Revoke1

TbdlistOauth2Revoke GET Tbd

Revoke OAuth Application1

Revokes an OAuth ApplicationrunApplicationsActionRevoke PUT Revokes an OAuth Application.

Role Profiles1

Returns a list of role profiles in the specified companylistLookupProfilesRoleProfiles GET Returns a list of role profiles in the specified company.

Rollback1

Performs the rollback process on the specified payrolls if finalizedrunPayrollsActionsRollback POST Performs the rollback process on the specified payrolls if finalized.

Saved Report2

Endpoint to specify settings and receive a report with the applied settings as a Response`createReportSavedV1`	POST	Endpoint to specify settings and receive a report with the applied settings as a Response.
Run the report specified by the Uri parameter 'id' and return the content in the format specified by the 'Accept' header`getReportSavedV1`	GET	Run the report specified by the Uri parameter 'id' and return the content in the format specified by the 'Accept' header.

Saved Report Metadata1

This endpoint receives the report metadatalistReportSavedMetadataV1 GET This endpoint receives the report metadata.

Schedule2

Deletes a Schedule Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setup`deleteSchedules`	DELETE	Deletes a Schedule Advanced Scheduler ( SCHEDULE ) Subsystem must be enabled in company setup.
Gets a Schedule by ID Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setup`getSchedules`	GET	Gets a Schedule by ID Advanced Scheduler ( SCHEDULE ) Subsystem must be enabled in company setup.

Schedule Employee Cost Estimates1

Get SchedulesCostEstimateslistSchedulesCostEstimates GET Returns a list of cost estimates for each schedule, giving both the full schedule estimated costs for each employee on each schedule, and the daily cost estimates for each employee on...

Schedule Mass Delete1

Deletes multiple schedules asynchronously via a background jobrunSchedulesActionsMassDelete POST Deletes multiple schedules asynchronously via a background job.

Scheduler2

Creates a new Schedule Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setup`createSchedules`	POST	Creates a new Schedule Advanced Scheduler ( SCHEDULE ) Subsystem must be enabled in company setup.
Returns the list of Schedules Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setup`listSchedules`	GET	Returns the list of Schedules Advanced Scheduler ( SCHEDULE ) Subsystem must be enabled in company setup.

Scheduler Profiles1

Returns a list of scheduler profiles in the specified companylistLookupProfilesSchedulerProfiles GET Returns a list of scheduler profiles in the specified company.

Schedules3

Deletes employee schedule on specified date range`deleteEmployeeSchedules`	DELETE	Deletes employee schedule on specified date range
Endpoint to update employees' schedule on specified date range`updateEmployeeSchedules`	PUT	Endpoint to update employees' schedule on specified date range.
Fetch Schedule items for a single user`listEmployeeSchedules`	GET	Fetch Schedule items for a single user.

Security Profiles1

Returns a list of Security profiles in the specified companylistLookupProfilesSecurityProfiles GET Returns a list of Security profiles in the specified company.

Security Question1

Endpoint to change security question for an employeeupdateAccountsSecurityQuestion PUT Endpoint to change security question for an employee.

Service Account3

Deletes a Service Account`deleteServiceAccounts`	DELETE	Deletes a Service Account.
Retrieves a Service Account by its ID`getServiceAccounts`	GET	Retrieves a Service Account by its ID.
Updates an existing Service Account`updateServiceAccounts`	PUT	Updates an existing Service Account.

Service Accounts2

Creates a new Service Account`createServiceAccounts`	POST	Creates a new Service Account.
Retrieves a list of Service Accounts`listServiceAccounts`	GET	Retrieves a list of Service Accounts.

Settings1

Retrieves the list of Schedule SettingslistSchedulesSettings GET Retrieves the list of Schedule Settings.

Shift2

Deletes a Shift Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setup`deleteSchedulesShifts`	DELETE	Deletes a Shift Advanced Scheduler ( SCHEDULE ) Subsystem must be enabled in company setup.
Gets a Shift by ID Advanced Scheduler (__SCHEDULE__) Subsystem must be enabled in company setup`getSchedulesShifts`	GET	Gets a Shift by ID Advanced Scheduler ( SCHEDULE ) Subsystem must be enabled in company setup.

Shift Actions1

Posts or unposts an individual Shift, independently of the rest of the SchedulerunSchedulesShiftsActions POST Posts or unposts an individual Shift, independently of the rest of the Schedule.

Shift Premiums1

Returns the list of defined shifts premium in the companylistLookupShiftPremiums GET Returns the list of defined shifts premium in the company.

Shifts1

Get SchedulesShiftslistSchedulesShifts GET Gets the list of Shifts being housed in a Schedule Advanced Scheduler ( SCHEDULE ) Subsystem must be enabled in company setup.

Skills6

Allows existing skills to be deleted`deleteCompanySkillsV1`	DELETE	Allows existing skills to be deleted.
Allows existing skills to be updated`updateCompanySkillsV1`	PUT	Allows existing skills to be updated.
Allows new skills to be created`createCompanySkillsV1`	POST	Allows new skills to be created.
Endpoint to fetch list of defined skills in the company`listLookupSkills`	GET	Endpoint to fetch list of defined skills in the company.
Returns the employee skills information`listEmployeesSkills`	GET	Returns the employee skills information.
Update the employee skills information`updateEmployeesSkills`	PUT	Update the employee skills information.

Status1

Allows account status to be changedupdateEmployeesStatusV1 PUT Allows account status to be changed.

Submit1

Performs the submit process on the specified payrolls if closedrunPayrollsActionsSubmit POST Performs the submit process on the specified payrolls if closed.

Succession Profiles1

Returns a list of Succession profiles in the specified companylistLookupProfilesSuccessionProfiles GET Returns a list of Succession profiles in the specified company.

Sync Time1

Sync Time on the specified payrollsrunPayrollsActionsSyncTime POST Sync Time on the specified payrolls.

System2

Endpoint returns list of the companies system forms for a period of time`listFormsSystemIds`	GET	Endpoint returns list of the companies system forms for a period of time.
Get EmployeesFormsSystem`listEmployeesFormsSystem`	GET	Endpoint returns list of employee's system forms for a period of time.This endpoint can be accessed by both employees and admin to get pay forms.

System Account3

Endpoint to delete system account`deleteAccounts`	DELETE	Endpoint to delete system account.
Returns the core system account record containing the bulk of the information about the account`getAccounts`	GET	Returns the core system account record containing the bulk of the information about the account.
Update the core system account information`updateAccounts`	PUT	Update the core system account information.

System Accounts2

API to allow the creation of new system account record`createAccounts`	POST	API to allow the creation of new system account record.
Returns basic information about the system account a user has permissions to view`listAccounts`	GET	Returns basic information about the system account a user has permissions to view.

Tax Codes1

Endpoint to fetch list of supported tax codeslistLookupTaxCodes GET Endpoint to fetch list of supported tax codes.

Tax Information2

Returns the employee tax information`listEmployeesTaxInfo`	GET	Returns the employee tax information.
Update the employee tax information`updateEmployeesTaxInfo`	PUT	Update the employee tax information.

Tax Quarter1

Returns the tax quarter record for the specified year, quarter, and company EINgetTaxesYearsQuarters GET Returns the tax quarter record for the specified year, quarter, and company EIN.

Tax Quarter Status1

Transitions the tax quarter to a new status (LOCKED or SIGNED_OFF)updateYearsQuartersStatus PUT Transitions the tax quarter to a new status (LOCKED or SIGNED OFF).

Tax Year1

Returns the tax year record for the specified calendar year and company EINgetTaxesYears GET Returns the tax year record for the specified calendar year and company EIN.

Tax Year Status1

Transitions the tax year to a new status (LOCKED or SIGNED_OFF)updateTaxesYearsStatus PUT Transitions the tax year to a new status (LOCKED or SIGNED OFF).

Team Time Off Calendar Sync1

Endpoint to sync time off calendar of an employee/manager for teamlistEmployeesTimeoffTeamCalendarSync GET Endpoint to sync time off calendar of an employee/manager for team.

Termination Reasons1

Endpoint to fetch list of termination reasons in the companylistLookupTerminationReason GET Endpoint to fetch list of termination reasons in the company.

Time Entries3

Allows existing time entries to be deleted for specified employee in given date range`deleteEmployeesTimeEntries`	DELETE	Allows existing time entries to be deleted for specified employee in given date range.
Allows existing time entries to be fetched for specified company in given date range`listTimeEntries`	GET	Allows existing time entries to be fetched for specified company in given date range.
Allows existing time entries to be fetched for specified employee in given date range`listEmployeesTimeEntries`	GET	Allows existing time entries to be fetched for specified employee in given date range.

Time Entry1

Endpoint for deleting time entrydeleteTimeEntries DELETE Endpoint for deleting time entry.

Time Entry Notes3

Endpoint for deleting time entry notes`deleteTimeEntriesNotesCollection`	DELETE	Endpoint for deleting time entry notes
Endpoint for posting time entry notes`createTimeEntriesNotesCollection`	POST	Endpoint for posting time entry notes
Endpoint for retrieving time entry notes`listTimeEntriesNotes`	GET	Endpoint for retrieving time entry notes

Time Off1

Retrieves a single time off category by its unique identifiergetCompanyTimeoffsV1 GET Retrieves a single time off category by its unique identifier.

Time Off Calendar Sync1

Endpoint to sync time off calendar for an employee to a personal calendarlistEmployeesTimeoffCalendarSync GET Endpoint to sync time off calendar for an employee to a personal calendar.

Time Off Definition1

Retrieves a single time off type definition by IDgetTimeOffs GET Retrieves a single time off type definition by ID.

Time Off Definitions4

Creates one or more time off type definitions for the company`createTimeOffs`	POST	Creates one or more time off type definitions for the company.
Deletes one or more time off type definitions by ID`deleteTimeOffs`	DELETE	Deletes one or more time off type definitions by ID.
Returns time off type definitions for the company`listTimeOffs`	GET	Returns time off type definitions for the company.
Updates one or more existing time off type definitions`updateTimeOffs`	PUT	Updates one or more existing time off type definitions.

Time Off Planning Profiles1

Returns a list of Time Off Planning Profiles in the specified companylistLookupProfilesTimeOffPlanningProfiles GET Returns a list of Time Off Planning Profiles in the specified company.

Time Off Request Profile2

Delete TimeOffRequestProfiles`deleteTimeOffRequestProfiles`	DELETE	Permanently deletes a Time Off Request Profile and all its child records (settings per time-off, utilization groups, day equivalents, waiting periods, and utilization policies).
Get TimeOffRequestProfiles`getTimeOffRequestProfiles`	GET	Returns the full detail of a single Time Off Request Profile, including all nested sub-objects (available request options, population settings, default settings, limit requests, excess...

Time Off Request Profiles2

Creates a new Time Off Request Profile for the authenticated company`createTimeOffRequestProfiles`	POST	Creates a new Time Off Request Profile for the authenticated company.
Returns a shallow list of all Time Off Request Profiles for the authenticated company`listTimeOffRequestProfiles`	GET	Returns a shallow list of all Time Off Request Profiles for the authenticated company.

Time Offs4

Endpoint to create time off categories`createCompanyTimeoffsV1`	POST	Endpoint to create time off categories.
Endpoint to delete multiple time off categories by ids`deleteCompanyTimeoffsV1`	DELETE	Endpoint to delete multiple time off categories by ids.
Endpoint to get time off categories from a company`listCompanyTimeoffsV1`	GET	Endpoint to get time off categories from a company.
Endpoint to update time off categories`updateCompanyTimeoffsV1`	PUT	Endpoint to update time off categories.

Time Punches1

Post TimePunchesCollectioncreateTimePunchesCollection POST Endpoint for import punches The Time Punches APIs use a separate security profile item to control access rights which is located in the company security profile in the following location: 1.

Timesheet Action1

Endpoint to perform actions on a timesheetrunTimesheetsAction PUT Endpoint to perform actions on a timesheet.

Timesheet Profiles1

Returns a list of Timesheet Profiles in the specified companylistLookupProfilesTimesheetProfiles GET Returns a list of Timesheet Profiles in the specified company.

Timesheets1

Endpoint to search timesheets for a single employeelistEmployeesTimesheets GET Endpoint to search timesheets for a single employee.

TimeZones1

Endpoint to fetch list of defined timezoneslistLookupTimezones GET Endpoint to fetch list of defined timezones

To-Do items1

Endpoint returns a list of to-do items in the system for a particular employeelistEmployeesNotificationsTodoItems GET Endpoint returns a list of to-do items in the system for a particular employee.

Todo1

Fetch Workflow To Do items for a userlistEmployeeTodoV1 GET Fetch Workflow To Do items for a user.

Todo Action1

Post EmployeeTodoActioncreateEmployeeTodoActionV1 POST Allows to do action for only next workflow types: Overtime Request, Time Off Request, Timesheet Approval, Timesheet Change Request.

Todo Count1

Returns count of all employee's To DoslistEmployeeTodoCountV1 GET Returns count of all employee's To Dos.

Total Compensation2

Get Total Compensation for specific employee`listEmployeesCompensationTotal`	GET	Get Total Compensation for specific employee.
Retrieves Total Compensation information for all subordinates`listCompensationTotal`	GET	Retrieves Total Compensation information for all subordinates.

Training1

Returns a list of Training Profiles in the specified companylistLookupProfilesTraining GET Returns a list of Training Profiles in the specified company

Training and Certifications1

Returns the employee training and certifications informationlistEmployeesTrainingCertifications GET Returns the employee training and certifications information.

TS Auto Population Profiles1

Returns a list of TS Auto Population Profiles in the specified companylistLookupProfilesTsAutoPopulationProfiles GET Returns a list of TS Auto Population Profiles in the specified company.

Unions1

Allows active unions to be returnedlistLookupUnions GET Allows active unions to be returned.

Unread1

Endpoint marks mailbox items as unreadrunMailboxItemsActionUnread POST Endpoint marks mailbox items as unread

Userinfo1

Retrieves user information for the authenticated userlistOauth2Userinfo GET Retrieves user information for the authenticated user.

VCA Report Dialogs Settings2

Returns the employee VCA configuration for report dialog in notifications`listEmployeesVcaReportDialogSettings`	GET	Returns the employee VCA configuration for report dialog in notifications.
Updates the employee VCA configuration for report dialogs in notifications`updateEmployeesVcaReportDialogSettings`	PUT	Updates the employee VCA configuration for report dialogs in notifications.

Vehicle Assignment3

End point to fetch specific vehicle assignment by id`getVehicleAssignments`	GET	End point to fetch specific vehicle assignment by id.
Endpoint replaces given vehicle assignment by id with a new one provided in payload`updateVehicleAssignments`	PUT	Endpoint replaces given vehicle assignment by id with a new one provided in payload.
Endpoint to delete specific vehicle assignment by id`deleteVehicleAssignments`	DELETE	Endpoint to delete specific vehicle assignment by id.

Vehicle Assignment Action1

Endpoint to perform actions(mark as returned, mark as lost/destroyed) on a vehicle assignmentrunVehicleAssignmentsAction PUT Endpoint to perform actions(mark as returned, mark as lost/destroyed) on a vehicle assignment.

Vehicle Assignments2

Endpoint creates a new vehicle assignment`createVehicleAssignments`	POST	Endpoint creates a new vehicle assignment.
Endpoint returns a list of all vehicles assignments`listVehicleAssignments`	GET	Endpoint returns a list of all vehicles assignments.

Vehicle Insurance1

Endpoint to delete specific vehicle insurance by iddeleteVehicleInsurances DELETE Endpoint to delete specific vehicle insurance by id.

Vehicle Insurances1

Endpoint creates a new vehicle insurancecreateVehicleInsurances POST Endpoint creates a new vehicle insurance.

Vehicle Maintenance1

Endpoint to delete specific vehicle maintenance by iddeleteVehicleMaintenances DELETE Endpoint to delete specific vehicle maintenance by id.

Vehicle Maintenances1

Endpoint creates a new vehicle maintenancecreateVehicleMaintenances POST Endpoint creates a new vehicle maintenance.

Vehicles1

Endpoint to fetch list of all vehicles within the companylistLookupVehicles GET Endpoint to fetch list of all vehicles within the company.

Vendors1

Endpoint to fetch list of active vendorslistLookupVendors GET Endpoint to fetch list of active vendors.

Version 52

Post PspDocumentsReversalConfirmation`createPspDocumentsReversalConfirmation`	POST	Submits a Reversal Confirmation document from the payment processor confirming that a previously initiated direct deposit reversal has been completed.
Submits a Direct Deposit Reject/Return document from the payment processor`createPspDocumentsDirectDepositReject`	POST	Submits a Direct Deposit Reject/Return document from the payment processor.

Web Clock1

Endpoint for recording a punch for the currently logged-in employeecreateWebclockV1 POST Endpoint for recording a punch for the currently logged-in employee.

Work Schedule Profiles1

Returns a list of Work Schedule profiles in the specified companylistLookupProfilesWorkscheduleProfiles GET Returns a list of Work Schedule profiles in the specified company.

Work Time Preferences4

Endpoint to create employee work time preferences`createEmployeeWorkTimePreferencesV1`	POST	Endpoint to create employee work time preferences.
Endpoint to delete multiple work time preferences by ids and by employee specific fields`deleteEmployeeWorkTimePreferencesV1`	DELETE	Endpoint to delete multiple work time preferences by ids and by employee specific fields.
Fetch work time preferences for a user`listEmployeeWorkTimePreferencesV1`	GET	Fetch work time preferences for a user.
Update existing employee work time preferences`updateEmployeeWorkTimePreferencesV1`	PUT	Update existing employee work time preferences.

Workday Breakdown Profiles1

Returns a list of Workday Breakdown Profiles in the specified companylistLookupProfilesWorkdayBreakdownProfiles GET Returns a list of Workday Breakdown Profiles in the specified company

Worker Types1

Endpoint to fetch list of Worker TypeslistLookupWorkerTypes GET Endpoint to fetch list of Worker Types.

Workers Comp Codes1

Endpoint to fetch list of active workers comp codeslistLookupWorkersCompCodes GET Endpoint to fetch list of active workers comp codes.

Working Time Regulation1

Returns a list of Working Time Regulation Profiles in the specified companylistLookupProfilesWorkingTimeRegulation GET Returns a list of Working Time Regulation Profiles in the specified company

Workload Manager2

Provides the ability to delete volume data, workload coverage and generated open shifts from a schedule`deleteSchedulesWorkloadManagerTransactions`	DELETE	Provides the ability to delete volume data, workload coverage and generated open shifts from a schedule.
Provides the ability to send volume data to Scheduler`createSchedulesWorkloadManagerTransactions`	POST	Provides the ability to send volume data to Scheduler.