Paystream Integration REST API

Introduction

Restful Integration API for the Paystream system

Auth

API	Description
POST v1/auth/login	Authentication Cookie
POST v1/auth/logout	Authentication Logout

ImportPayGroups

API	Description
POST v1/imports/pay-groups?action={action}&allowSameFile={allowSameFile}	Import Pay Groups

ExportEmergencyContacts

API	Description
GET v1/export/clients/{clientCode}/emergency-contacts	Retrieve Employee Emergency Contacts by Client
GET v1/export/companies/{companyCode}/emergency-contacts	Retrieve Employee Emergency Contacts by Company
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/emergency-contacts	Retrieve Employee Emergency Contacts by Division
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/emergency-contacts	Retrieve Employee Emergency Contacts By Employee

ImportBillingItems

API	Description
POST v1/imports/billing-items?action={action}&allowSameFile={allowSameFile}	Import Division Billing Items
DELETE v1/imports/billing-items	Delete Division Billing Items

ImportDataControls

API	Description
POST v1/imports/data-controls?action={action}&allowSameFile={allowSameFile}	Import Data Controls

ExportDivisionPTOAccruals

API	Description
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/pto-accruals	Retrieve PTO Accruals by Division
GET v1/export/companies/{companyCode}/pto-accruals	Retrieve PTO Accruals by Company
GET v1/export/clients/{clientCode}/pto-accruals	Retrieve PTO Accruals by Client

LMSExportEmployees

API	Description
GET v1/lms/export/companies/{companyCode}/divisions/{divisionCode}/employees?employeeNumber={employeeNumber}&asOf={asOf}	Retrieves an employee by employeeNumber
GET v1/lms/export/clients/{clientCode}/employees?asOf={asOf}&startHireDate={startHireDate}&endHireDate={endHireDate}&rangeStart={rangeStart}&rangeEnd={rangeEnd}	No documentation available.
POST v1/lms/export/clients/{clientCode}/employees?asOf={asOf}&optionalEmployeeStatus={optionalEmployeeStatus}	No documentation available.
GET v1/lms/export/companies/{companyCode}/employees?asOf={asOf}&startHireDate={startHireDate}&endHireDate={endHireDate}&rangeStart={rangeStart}&rangeEnd={rangeEnd}	No documentation available.
POST v1/lms/export/companies/{companyCode}/employees?asOf={asOf}&optionalEmployeeStatus={optionalEmployeeStatus}	No documentation available.
GET v1/lms/export/companies/{companyCode}/divisions/{divisionCode}/employees?asOf={asOf}&startHireDate={startHireDate}&endHireDate={endHireDate}&rangeStart={rangeStart}&rangeEnd={rangeEnd}	No documentation available.
POST v1/lms/export/companies/{companyCode}/divisions/{divisionCode}/employees?asOf={asOf}&optionalEmployeeStatus={optionalEmployeeStatus}	No documentation available.
GET v1/lms/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeIdentifier}?asOf={asOf}	No documentation available.

ExportEmployeePTOAccruals

API	Description
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/employee-pto-accruals?effectiveDate={effectiveDate}&includeInactive={includeInactive}	Retrieve PTO Accruals by Employee Number
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employee-pto-accruals?effectiveDate={effectiveDate}&includeInactive={includeInactive}	Retrieve PTO Accruals by Division
GET v1/export/companies/{companyCode}/employee-pto-accruals?effectiveDate={effectiveDate}&includeInactive={includeInactive}	Retrieve PTO Accruals by Company
GET v1/export/clients/{clientCode}/employee-pto-accruals?effectiveDate={effectiveDate}&includeInactive={includeInactive}	Retrieve PTO Accruals by Client

ExportDeliveryPackages

API	Description
GET v1/export/delivery-packages?sinceDateTime={sinceDateTime}	Retrieve Delivery Packages
GET v1/export/delivery-packages	Retrieve all delivery packages created or modified since Today

ImportAccumulators

API	Description
POST v1/imports/accumulators?action={action}&allowSameFile={allowSameFile}	Import Division Accumulators

ExportBenefitEnrollments

API	Description
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employee-benefit-enrollments	Retrieve Benefit Enrollments by Division
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employee-benefit-enrollments?employeeNumber={employeeNumber}	Retrieve Benefit Enrollments by Employee Number

ImportShiftCodes

API	Description
POST v1/imports/shift-codes?action={action}&allowSameFile={allowSameFile}	Import Shift Codes

ImportPositions

API	Description
POST v1/imports/positions?action={action}&allowSameFile={allowSameFile}	Import Positions

ExportLicenses

API	Description
GET v1/export/clients/{clientCode}/licenses	Retrieve Licenses by Client
GET v1/export/companies/{companyCode}/licenses	Retrieve Licenses by Company
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employee-licenses	Retrieve Licenses by Division
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/licenses	Retrieve Licenses by Employee Number

ExportLocations

API	Description
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/locations	Retrieve Locations by Division

ImportLicenses

API	Description
POST v1/imports/licenses?importAction={importAction}&allowSameFile={allowSameFile}	Import Licenses
DELETE v1/import/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/licenses/{licenseKey}	Delete Employee License
DELETE v1/imports/licenses	Delete Licenses

ExportBenefitCategories

API	Description
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/benefit-categories	Retrieve Benefit Categories by Division

CopyPTOPlans

API	Description
POST v1/copy/pto-plans?importAction={importAction}	Copy Division PTO Plans
POST v1/copy/companies/{companyCode}/divisions/{divisionCode}/pto-plans/{ptoCode}?targetCompanyCode={targetCompanyCode}&targetDivisionCode={targetDivisionCode}&targetOptionalPlanCode={targetOptionalPlanCode}&targetOptionalPlanDescription={targetOptionalPlanDescription}&importAction={importAction}	Copy Division PTO Plan

ExportJobs

API	Description
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/jobs	Retrieve Jobs by Division

ImportScheduledDeductions

API	Description
POST v1/imports/scheduled-deductions?importAction={importAction}&allowSameFile={allowSameFile}	Import Scheduled Deductions
DELETE v1/import/companies/{companyCode}/divisions/{divisionCode}/employee-scheduled-deductions/{deductionCode}	Delete ScheduledDeductions by Division
DELETE v1/import/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/scheduled-deductions/{deductionCode}	Delete ScheduledDeductions by Employee Number
DELETE v1/imports/scheduled-deductions	Delete Scheduled Deductions

ExportChecks

API	Description
GET v1/export/clients/{clientCode}/checks?startDate={startDate}&endDate={endDate}	Retrieve Checks
GET v1/export/companies/{companyCode}/checks?startDate={startDate}&endDate={endDate}	Retrieve Checks by Company
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/checks?startDate={startDate}&endDate={endDate}	Retrieve Checks by Division
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/checks?startDate={startDate}&endDate={endDate}	Retrieve Checks by Employee Number

ExportScheduledDeductions

API	Description
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/scheduled-deductions?effectiveDate={effectiveDate}	Retrieve Scheduled Deduction by Division
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/scheduled-deductions?effectiveDate={effectiveDate}&divisionDeductionCode={divisionDeductionCode}	Retrieve Scheduled Deduction by Employee Number

ExportBillingItems

API	Description
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/billing-items	Retrieve Billable Items by Division
GET v1/export/companies/{companyCode}/billing-items	Retrieve Billable Items by Company
GET v1/export/clients/{clientCode}/billing-items	Retrieve Billable Items by Client

ImportEmployeeStatuses

API	Description
POST v1/imports/employee-statuses?action={action}&allowSameFile={allowSameFile}	Import Division Employee Statuses
DELETE v1/imports/employee-statuses	Delete Division Employee Statuses

ImportPayEntries

API	Description
POST v1/imports/pay-entries?importAction={importAction}&allowSameFile={allowSameFile}	Import Pay Entries
POST v1/divisions/{divisionId}/payrolls/{payrollId}/_actions/revert/{importSubmissionId}	Revert Pay Entry Imports

ImportScheduledEarnings

API	Description
POST v1/imports/scheduled-earnings?importAction={importAction}&allowSameFile={allowSameFile}	Import Scheduled Earnings

ImportRateCodes

API	Description
POST v1/imports/rates?action={action}&allowSameFile={allowSameFile}	Import Division Rate Codes

ImportBenefitPlans

API	Description
POST v1/imports/benefit-plans?action={action}&allowSameFile={allowSameFile}	Import Benefit Plans

ImportBenefitEnrollments

API	Description
POST v1/imports/employee-benefit-enrollments?importAction={importAction}&allowSameFile={allowSameFile}	Import Benefit Enrollments
DELETE v1/import/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/employee-benefit-enrollments?enrollmentStartDate={enrollmentStartDate}&waivePlanType={waivePlanType}&planName={planName}&ruleName={ruleName}	Delete Benefit Enrollment
DELETE v1/imports/employee-benefit-enrollments	Delete Benefit Enrollments

ImportEmergencyContacts

API	Description
POST v1/imports/emergency-contacts?importAction={importAction}&allowSameFile={allowSameFile}	Import Emergency Contacts
DELETE v1/import/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/emergency-contacts/{emergencyContactKey}	Delete Emergency Contact
DELETE v1/imports/emergency-contacts	Delete Emergency Contacts

ImportEarnings

API	Description
POST v1/imports/earnings?action={action}&allowSameFile={allowSameFile}	Import Division Earnings

ImportTrainingDocuments

API	Description
POST v1/imports/training-documents?importAction={importAction}&allowSameFile={allowSameFile}	Import Training Documents

ImportReviews

API	Description
POST v1/imports/reviews?importAction={importAction}&allowSameFile={allowSameFile}	Import Reviews
DELETE v1/import/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/reviews/{reviewKey}	Delete Review
DELETE v1/imports/reviews	Delete Reviews

OnDemandPayExportApi

API	Description
GET v1/on-demand-pay/export/companies	Retrieve Modified OnDemandPay Companies
GET v1/on-demand-pay/export/payrolls?companyCode={companyCode}&divisionCode={divisionCode}&modifiedSince={modifiedSince}&optionalEmployeeNumber={optionalEmployeeNumber}	Retrieve Modified OnDemandPay Payrolls
GET v1/on-demand-pay/export/employees?companyCode={companyCode}&divisionCode={divisionCode}&asOf={asOf}&rangeStart={rangeStart}&rangeEnd={rangeEnd}	Retrieve OnDemandPay Employees by Division
GET v1/on-demand-pay/export/employees/{employeeNumber}?companyCode={companyCode}&divisionCode={divisionCode}&asOf={asOf}	Retrieve OnDemandPay Employee by Division
GET v1/on-demand-pay/export/employee-scheduled-deductions?companyCode={companyCode}&divisionCode={divisionCode}&employeeNumber={employeeNumber}&optionalEffectiveDate={optionalEffectiveDate}&optionalDivisionDeductionCode={optionalDivisionDeductionCode}	Retrieve Filtered Scheduled Deductions by Division
GET v1/on-demand-pay/export/employee-scheduled-deductions?companyCode={companyCode}&divisionCode={divisionCode}&effectiveDate={effectiveDate}	Retrieve Scheduled Deduction by Division
GET v1/on-demand-pay/export/deductions?companyCode={companyCode}&divisionCode={divisionCode}	Retrieve Deductions by Division
GET v1/on-demand-pay/export/pay-calendars?companyCode={companyCode}&divisionCode={divisionCode}&payrollStatus={payrollStatus}&beginDate={beginDate}&endDate={endDate}	Retrieve Pay Calendars by Division

ExportOnboardingPlans

API	Description
GET v1/export/clients/{clientCode}/onboarding-plans	Retrieve Onboarding Plans by Client
GET v1/export/companies/{companyCode}/onboarding-plans	Retrieve Onboarding Plans by Company
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/onboarding-plans	Retrieve Onboarding Plans by Division

ExportAssets

API	Description
GET v1/export/clients/{clientCode}/employee-assets	Retrieve Employee Assets by Client
GET v1/export/companies/{companyCode}/employee-assets	Retrieve Employee Assets by Company
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employee-assets	Retrieve Employee Assets by Division
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/assets	Retrieve Employee Assets by Employee Number

ImportLicenseDocuments

API	Description
POST v1/imports/license-documents?importAction={importAction}&allowSameFile={allowSameFile}	Import License Documents

ImportWorkersCompCodes

API	Description
POST v1/imports/workers-comp-codes?action={action}&allowSameFile={allowSameFile}	Import Division Workers Comp Codes

ImportPayRates

API	Description
POST v1/imports/pay-rates?importAction={importAction}&allowSameFile={allowSameFile}	Import Pay Rates

ImportDependents

API	Description
POST v1/imports/employee-dependents?importAction={importAction}&allowSameFile={allowSameFile}	Import Employee Dependents
DELETE v1/import/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/employee-dependents	Delete Employee Dependents by Employee Number
DELETE v1/import/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/employee-dependents/ssn	Delete Employee Dependent by SSN by Employee Number
DELETE v1/import/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/employee-dependents?birthDate={birthDate}&firstName={firstName}&lastName={lastName}	Delete Employee Dependents by Employee Number
DELETE v1/imports/employee-dependents	Delete Employee Dependents

TimeAttendanceImportApi

API	Description
POST v1/time-attendance/import/companies/{companyCode}/divisions/{divisionCode}/payrolls/{checkDate}/{runNumber}/pay-batches/{batchCode}	Import Pay Entries

ExportAllocations

API	Description
GET v1/export/clients/{clientCode}/employee-allocations	Retrieve Employee Allocations by Client
GET v1/export/companies/{companyCode}/employee-allocations	Retrieve Employee Allocations by Company
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employee-allocations	Retrieve Employee Allocations by Division
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/employee-allocations	Retrieve Employee Allocations by Employee Number

ImportDirectDeposits

API	Description
POST v1/imports/direct-deposits?importAction={importAction}&allowSameFile={allowSameFile}	Import Direct Deposits
DELETE v1/import/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/direct-deposits	Delete Direct Deposits by Employee Number
DELETE v1/imports/direct-deposits	Delete Direct Deposits

ImportDeductions

API	Description
POST v1/imports/deductions?action={action}&allowSameFile={allowSameFile}	Import Division Deductions

ImportPTORequests

API	Description
POST v1/imports/employee-pto-requests?action={action}&allowSameFile={allowSameFile}	Import PTO Requests

LMSExportEmployeeTrainings

API	Description
GET v1/lms/export/clients/{clientCode}/employee-trainings	Retrieve Trainings by Client
GET v1/lms/export/companies/{companyCode}/employee-trainings	Retrieve Trainings by Company
GET v1/lms/export/companies/{companyCode}/divisions/{divisionCode}/employee-trainings	Retrieve Trainings by Division
GET v1/lms/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/trainings	Retrieve Trainings by Employee Number

ImportFrequencies

API	Description
POST v1/imports/frequencies?action={action}&allowSameFile={allowSameFile}	Import Division Frequencies

ExportEmployeePersonals

API	Description
POST v1/export/companies/{companyCode}/divisions/{divisionCode}/employee-personals/bySSNs?scope={scope}	Retrieve Employee Personal Headers by Division

ExportDirectDeposits

API	Description
GET v1/export/clients/{clientCode}/direct-deposits	Retrieve Direct Deposits by Client
GET v1/export/companies/{companyCode}/direct-deposits	Retrieve Direct Deposits by Company
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/direct-deposits	Retrieve Direct Deposits by Division
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/direct-deposits	Retrieve Direct Deposits by Employee Number

ExportDeductions

API	Description
GET v1/export/clients/{clientCode}/deductions	Retrieve Deductions by Client
GET v1/export/companies/{companyCode}/deductions	Retrieve Deductions by Company
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/deductions	Retrieve Deductions by Division
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/deductions?includeInactive={includeInactive}	Retrieve Deductions by Division

ImportEmployeePTOAccruals

API	Description
POST v1/imports/pto-accruals?importAction={importAction}&allowSameFile={allowSameFile}	Import PTO Accruals
DELETE v1/import/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/pto-accruals/{ptoCode}	Delete PTO accrual by Employee Number
DELETE v1/import/companies/{companyCode}/divisions/{divisionCode}/employee-pto-accruals/{ptoCode}	Delete PTO Accruals by Division
DELETE v1/imports/pto-accruals	Delete PTO Accruals

ImportJobs

API	Description
POST v1/imports/jobs?action={action}&allowSameFile={allowSameFile}	Import Division Jobs

LMSImportEmployeeTrainings

API	Description
POST v1/lms/import/trainings?importAction={importAction}&allowSameFile={allowSameFile}	Import Trainings
DELETE v1/lms/import/trainings	Delete Trainings

ImportCostCenters

API	Description
POST v1/imports/cost-centers?action={action}&allowSameFile={allowSameFile}	Import Cost Centers

MergeEmployeePersonals

API	Description
POST v1/merge/employee-personals?allowSameFile={allowSameFile}	Merge Employee Personal Profiles

ExportRates

API	Description
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/rates	Retrieve Rates by Division

ExportCostCenters

API	Description
GET v1/export/clients/{clientCode}/cost-centers	Retrieve Cost Centers by Client
GET v1/export/companies/{companyCode}/cost-centers	Retrieve Cost Centers by Company
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/cost-centers	Retrieve Cost Centers by Division

ImportOnboardingTasks

API	Description
POST v1/imports/onboarding-tasks?action={action}&allowSameFile={allowSameFile}	Import Division Onboarding Task Groups

ExportEmployeeStatuses

API	Description
GET v1/export/clients/{clientCode}/employee-statuses	Retrieve Employee Statuses by Client
GET v1/export/companies/{companyCode}/employee-statuses	Retrieve Employee Statuses by Company
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employee-statuses	Retrieve Employee Statuses by Division

EmployeesImportApi

API	Description
POST v1/imports/employees	Import Employees
DELETE v1/import/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}	Delete Employee by Division
DELETE v1/import/companies/{companyCode}/divisions/{divisionCode}/employees	Delete Employees by Division
DELETE v1/imports/employees	Delete employees.

ExportEarnings

API	Description
GET v1/export/clients/{clientCode}/earnings	Retrieve Earnings by Client
GET v1/export/companies/{companyCode}/earnings	Retrieve Earnings by Company
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/earnings	Retrieve Active Earnings by Division
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/earnings?includeInactive={includeInactive}	Retrieve Earnings by Division

ImportEmployeeCategories

API	Description
POST v1/imports/employee-categories?action={action}&allowSameFile={allowSameFile}	Import Division Employee Categories

ExportTaxes

API	Description
GET v1/export/clients/{clientCode}/taxes	Retrieve Taxes by Client
GET v1/export/companies/{companyCode}/taxes	Retrieve Taxes by Company
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/taxes	Retrieve Taxes by Division

ExportIdpMetadata

API	Description
GET v1/idp_metadata	Export IDP Metadata

ImportRateCodeRules

API	Description
POST v1/imports/rate-rules?action={action}&allowSameFile={allowSameFile}	Import Division Rate Code Rules
POST v1/divisions/{divisionId}/rates/{rateCode}?action={action}&isValidateOnly={isValidateOnly}&behavior={behavior}&hasHeaderRecord={hasHeaderRecord}&ignoreUnknownHeader={ignoreUnknownHeader}&templateColumnBehavior={templateColumnBehavior}	Import Rate Code Rules
GET v1/divisions/{divisionId}/imports/rate-rules/_actions/sample?rateCode={rateCode}&isInline={isInline}	Retrieve Rate Code Rule Import Sample

ImportLocations

API	Description
POST v1/imports/locations?action={action}&allowSameFile={allowSameFile}	Import Division Locations
DELETE v1/imports/locations	Delete Division Locations

TimeAttendanceChecksExportApi

API	Description
GET v1/time-attendance/export/clients/{clientCode}/checks?startDate={startDate}&endDate={endDate}	Retrieve Employee Checks by Client
GET v1/time-attendance/export/companies/{companyCode}/checks?startDate={startDate}&endDate={endDate}	Retrieve Employee Checks by Company
GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/checks?startDate={startDate}&endDate={endDate}	Retrieve Employee Checks by Division
GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/checks?startDate={startDate}&endDate={endDate}	Retrieve Employee Checks by Employee Number

ExportDependents

API	Description
GET v1/export/clients/{clientCode}/employee-dependents	Retrieve Employee Dependents by Client
GET v1/export/companies/{companyCode}/employee-dependents	Retrieve Employee Dependents by Company
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employee-dependents	Retrieve Employee Dependents by Division
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/employee-dependents	Retrieve Employee Dependents by Employee Number

BenefitsEmployeesExport

API	Description
GET v1/benefits/export/clients/{clientCode}/employees?asOf={asOf}&startHireDate={startHireDate}&endHireDate={endHireDate}&rangeStart={rangeStart}&rangeEnd={rangeEnd}	No documentation available.
POST v1/benefits/export/clients/{clientCode}/employees?asOf={asOf}&optionalEmployeeStatus={optionalEmployeeStatus}	No documentation available.
GET v1/benefits/export/companies/{companyCode}/employees?asOf={asOf}&startHireDate={startHireDate}&endHireDate={endHireDate}&rangeStart={rangeStart}&rangeEnd={rangeEnd}	No documentation available.
POST v1/benefits/export/companies/{companyCode}/employees?asOf={asOf}&optionalEmployeeStatus={optionalEmployeeStatus}	No documentation available.
GET v1/benefits/export/companies/{companyCode}/divisions/{divisionCode}/employees?asOf={asOf}&startHireDate={startHireDate}&endHireDate={endHireDate}&rangeStart={rangeStart}&rangeEnd={rangeEnd}	No documentation available.
POST v1/benefits/export/companies/{companyCode}/divisions/{divisionCode}/employees?asOf={asOf}&optionalEmployeeStatus={optionalEmployeeStatus}	No documentation available.
GET v1/benefits/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeIdentifier}?asOf={asOf}	No documentation available.

ExportReviews

API	Description
GET v1/export/clients/{clientCode}/employee-reviews	No documentation available.
GET v1/export/companies/{companyCode}/employee-reviews	No documentation available.
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employee-reviews	No documentation available.
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/reviews	No documentation available.

ImportPriorHours

API	Description
POST v1/imports/prior-hours?action={action}&allowSameFile={allowSameFile}	Import Prior Hours
DELETE v1/imports/prior-hours	Delete Prior Hour Checks
DELETE v1/imports/prior-hours?companyCode={companyCode}&divisionCode={divisionCode}&checkdate={checkdate}&runNumber={runNumber}	Delete Prior Hour Checks by Payroll

ExportPayGroups

API	Description
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/pay-groups	Retrieve Pay Groups by Division

EDIBenefitsExport

API	Description
GET v1/edi-benefits/export/clients/{clientCode}/employee-enrollments	Retrieve EDI Employee Benefit Enrollments
GET v1/edi-benefits/export/clients/{clientCode}/census	Retrieve EDI Censuses
GET v1/edi-benefits/export/clients/{clientCode}/enrollments	Retrieve EDI Benefit Enrollments

ImportAllocations

API	Description
POST v1/imports/employee-allocations?action={action}&allowSameFile={allowSameFile}	Import Employee Allocations

ImportPTOPlans

API	Description
POST v1/imports/pto-plans?action={action}&allowSameFile={allowSameFile}	Import PTO Plans

ATSExport

API	Description
GET v1/ats/export/companies/{companyCode}/divisions	Retrieve Divisions by Company Code
GET v1/ats/export/companies/{companyCode}/divisions/{divisionCode}/locations	Retrieve Locations by Division
GET v1/ats/export/companies/{companyCode}/divisions/{divisionCode}/benefit-categories	Retrieve Benefit Categories by Division
GET v1/ats/export/companies/{companyCode}/divisions/{divisionCode}/work-locations	Retrieve Work Locations by Division
GET v1/ats/export/companies/{companyCode}/divisions/{divisionCode}/cost-centers	Retrieve Cost Centers by Division
GET v1/ats/export/companies/{companyCode}/divisions/{divisionCode}/onboarding-plans	Retrieve Onboarding Plans by Division

OnDemandPayImportApi

API	Description
POST v1/on-demand-pay/import/direct-deposits	Import Direct Deposits
POST v1/on-demand-pay/import/employee-scheduled-deductions?importAction={importAction}&allowSameFile={allowSameFile}	Import Scheduled Deductions

ImportUnionCodes

API	Description
POST v1/imports/union-codes?action={action}&allowSameFile={allowSameFile}	Import Union Codes

ImportPayCalendars

API	Description
POST v1/imports/payrolls?action={action}&allowSameFile={allowSameFile}	Import Pay Calendars

ImportOnboardingPlans

API	Description
POST v1/imports/onboarding-plans?action={action}&allowSameFile={allowSameFile}	Import Division Onboarding Plans

MergeEmployees

API	Description
POST v1/merge/employees?allowSameFile={allowSameFile}	Merge Employee Profiles

ImportPayees

API	Description
POST v1/imports/payees?action={action}&allowSameFile={allowSameFile}	Import Payees

TimeAttendanceExportApi

API	Description
GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/employees?asOf={asOf}&rangeStart={rangeStart}&rangeEnd={rangeEnd}	Retrieve Employees by Division
GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}?asOf={asOf}	Retrieve Employee by Employee Number
GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/payrolls	Retrieve Payrolls by Division
GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/departments	Retrieve Departments by Division
GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/cost-centers	Retrieve Cost Centers by Division
GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/jobs	Retrieve Jobs by Division
GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/pay-groups	Retrieve Pay Groups by Division
GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/locations	Retrieve Locations by Division
GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/work-locations	Retrieve Work Locations by Division
GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/earnings	Retrieve Earnings by Division
GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/deductions	Retrieve Deductions by Division
GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/users	Retrieve Users by Division
GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/rates	Retrieve Rates by Division
GET v1/time-attendance/export/companies/{companyCode}/divisions/{divisionCode}/employee-schedules?employeeNumber={employeeNumber}&asOf={asOf}&modifiedOn={modifiedOn}	Retrieve Employee Schedules by Division
GET v1/time-attendance/export/companies	Retrieve Companies

ExportClients

API	Description
GET v1/export/clients	Retrieve Clients
GET v1/export/clients/{clientCode}	Retrieve Specific Client

CMSExport

API	Description
GET v1/cms/export/companies?companyCount={companyCount}&afterCompanyCode={afterCompanyCode}	Retrieve CMS Companies
GET v1/cms/export/division-payroll-infos?companyCount={companyCount}&afterCompanyCode={afterCompanyCode}	Retrieve CMS Division Payrolls
GET v1/cms/export/division-billing-setups?companyCount={companyCount}&afterCompanyCode={afterCompanyCode}	Retrieve CMS Division Billing Setups

ImportOnboardingRequests

API	Description
POST v1/imports/employee-onboarding-requests?allowSameFile={allowSameFile}	Import Employee Onboarding Requests

ExportCompanies

API	Description
GET v1/export/companies/byClient/{clientCode}	Retrieve Companies
GET v1/export/companies/{companyCode}	Retrieve Specific Company
GET v1/export/companies	Retrieve all companies

ImportTermReasons

API	Description
POST v1/imports/term-reasons?action={action}&allowSameFile={allowSameFile}	Import Term Reasons

ImportDependentCoverages

API	Description
POST v1/imports/employee-dependent-coverages?importAction={importAction}&allowSameFile={allowSameFile}	Import Employee Dependent Coverages

ImportCompanyTaxJurisdictions

API	Description
POST v1/imports/company-tax-jurisdictions?action={action}&allowSameFile={allowSameFile}	Import Company Tax Jurisdictions

ImportJobTrainingCodes

API	Description
POST v1/imports/job-training-codes?action={action}&allowSameFile={allowSameFile}	Import Job Training Codes

ExportEmployees

API	Description
POST v1/export/companies/{companyCode}/divisions/{divisionCode}/employees/bySSNs?asOf={asOf}	Retrieve Employees by SSN by Division
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees?employeeNumber={employeeNumber}&asOf={asOf}	Retrieves an employee by employeeNumber
GET v1/export/clients/{clientCode}/employees?asOf={asOf}&startHireDate={startHireDate}&endHireDate={endHireDate}&rangeStart={rangeStart}&rangeEnd={rangeEnd}	No documentation available.
POST v1/export/clients/{clientCode}/employees?asOf={asOf}&optionalEmployeeStatus={optionalEmployeeStatus}	No documentation available.
GET v1/export/companies/{companyCode}/employees?asOf={asOf}&startHireDate={startHireDate}&endHireDate={endHireDate}&rangeStart={rangeStart}&rangeEnd={rangeEnd}	No documentation available.
POST v1/export/companies/{companyCode}/employees?asOf={asOf}&optionalEmployeeStatus={optionalEmployeeStatus}	No documentation available.
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees?asOf={asOf}&startHireDate={startHireDate}&endHireDate={endHireDate}&rangeStart={rangeStart}&rangeEnd={rangeEnd}	No documentation available.
POST v1/export/companies/{companyCode}/divisions/{divisionCode}/employees?asOf={asOf}&optionalEmployeeStatus={optionalEmployeeStatus}	No documentation available.
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeIdentifier}?asOf={asOf}	No documentation available.

ATSOnboardingImport

API	Description
POST v1/ats/import/employee-onboarding-requests?allowSameFile={allowSameFile}	Import Employee Onboarding Requests

ImportTrainings

API	Description
POST v1/imports/trainings?importAction={importAction}&allowSameFile={allowSameFile}	Import Trainings
DELETE v1/import/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/trainings/{TrainingKey}	Delete Training
DELETE v1/imports/trainings	Delete Trainings

ImportCheckHistories

API	Description
POST v1/imports/check-history?action={action}&allowSameFile={allowSameFile}	Import Historical Checks
DELETE v1/imports/check-history	Delete Historical Checks
DELETE v1/imports/check-history?companyCode={companyCode}&divisionCode={divisionCode}&checkdate={checkdate}&runNumber={runNumber}	Delete Historical Checks

ExportTermReasons

API	Description
GET v1/export/clients/{clientCode}/term-reasons	Retrieve Term Reasons by Client
GET v1/export/companies/{companyCode}/term-reasons	Retrieve Term Reasons by Company
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/term-reasons	Retrieve Term Reasons by Division

CopyBenefitPlans

API	Description
POST v1/copy/benefit-plans?importAction={importAction}	Copy Division Benefit Plans
POST v1/copy/companies/{companyCode}/divisions/{divisionCode}/benefit-plans/{planName}?targetCompanyCode={targetCompanyCode}&targetDivisionCode={targetDivisionCode}&targetOptionalPlanName={targetOptionalPlanName}&targetOptionalPlanDescription={targetOptionalPlanDescription}&importAction={importAction}	Copy Benefit Plan

ImportCompanyTaxCodes

API	Description
POST v1/imports/company-tax-codes?action={action}&allowSameFile={allowSameFile}	Import Company Tax Codes

ExclusionMonitoringExport

API	Description
GET v1/exclusion-monitoring/export/clients/{clientCode}/employees?asOf={asOf}	Retrieve Employees By Client
POST v1/exclusion-monitoring/export/clients/{clientCode}/employees?asOf={asOf}	Retrieve Employees by SSN by Client
GET v1/exclusion-monitoring/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/licenses	Retrieve Employee Licenses
GET v1/exclusion-monitoring/export/clients/{clientCode}	Retrieve Client

ExportWorkLocations

API	Description
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/work-locations	Retrieve Work Locations by Division

IncomeVerificationExport

API	Description
GET v1/income-verification/export/clients/{clientCode}/employees?asOf={asOf}	Retrieve Employee Headers by Client
POST v1/income-verification/export/clients/{clientCode}/employees	Retrieve Employees by SSN by Client
GET v1/income-verification/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}	Retrieve Employees by Employee Number
GET v1/income-verification/export/companies/{companyCode}/employees?asOf={asOf}	Retrieve Employee Headers by Company
POST v1/income-verification/export/companies/{companyCode}/employees?asOf={asOf}	Retrieve Employees by SSN by Company
GET v1/income-verification/export/companies/{companyCode}/divisions/{divisionCode}/employees?asOf={asOf}	Retrieve Employee Headers by Division
POST v1/income-verification/export/companies/{companyCode}/divisions/{divisionCode}/employees?asOf={asOf}	Retrieve Employees by SSN by Division
GET v1/income-verification/export/clients/{clientCode}/earnings?includeInactive={includeInactive}	Retrieve Earnings by Client
GET v1/income-verification/export/companies/{companyCode}/earnings?includeInactive={includeInactive}	Retrieve Earnings by Company
GET v1/income-verification/export/companies/{companyCode}/divisions/{divisionCode}/earnings?includeInactive={includeInactive}	Retrieve Earnings by Division
GET v1/income-verification/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/checks?startDate={startDate}&endDate={endDate}	Retrieve Checks by Employee Number
POST v1/income-verification/export/clients/{clientCode}/check-summary?asOf={asOf}	Retrieve Check Summaries by SSN by Client
POST v1/income-verification/export/companies/{companyCode}/check-summary?asOf={asOf}	Retrieve Check Summaries by SSN by Company
POST v1/income-verification/export/companies/{companyCode}/divisions/{divisionCode}/check-summary?asOf={asOf}	Retrieve Check Summaries by SSN by Division
GET v1/income-verification/export/clients	Retrieve Clients
GET v1/income-verification/export/clients/{clientCode}	Retrieve Client
GET v1/income-verification/export/clients/{clientCode}/deductions?includeInactive={includeInactive}	Retrieve Deductions by Client
GET v1/income-verification/export/companies/{companyCode}/deductions?includeInactive={includeInactive}	Retrieve Deductions by Company
GET v1/income-verification/export/companies/{companyCode}/divisions/{divisionCode}/deductions?includeInactive={includeInactive}	Retrieve Deductions by Division
GET v1/income-verification/export/clients/{clientCode}/taxes	Retrieve Taxes by Client
GET v1/income-verification/export/companies/{companyCode}/taxes	Retrieve Taxes by Company
GET v1/income-verification/export/clients/{clientCode}/term-reasons	Retrieve Term Reasons by Client
GET v1/income-verification/export/companies/{companyCode}/term-reasons	Retrieve Term Reasons by Company
GET v1/income-verification/export/companies/{companyCode}/divisions/{divisionCode}/term-reasons	Retrieve Term Reasons by Division
GET v1/income-verification/export/clients/{clientCode}/employee-statuses	Retrieve Employee Statuses by Client
GET v1/income-verification/export/companies/{companyCode}/employee-statuses	Retrieve Employee Statuses by Company
GET v1/income-verification/export/companies/{companyCode}/divisions/{divisionCode}/employee-statuses	Retrieve Employee Statuses by Division

ExportTrainings

API	Description
GET v1/export/clients/{clientCode}/employee-trainings	Retrieve Trainings by Client
GET v1/export/companies/{companyCode}/employee-trainings	Retrieve Trainings by Company
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employee-trainings	Retrieve Trainings by Division
GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employees/{employeeNumber}/trainings	Retrieve Trainings by Employee Number