Time & Labor

The Time and Labor API methods support the management of information related to Employee time cards, pay data, and Affordable Care Act data. These methods can be used to send or retrieve punch transactions, extract hours for payroll, or manage status and processing for the Affordable Care Act requirements. Explore what is available below.

Table of Contents

1. Methods
2. Data Structures
3. Data Types

Methods

ACA - Retrieve

Type	Name	Description
READ	extractACAEmployeesFTStatusAsOf	Retrieve ACA status of an employee as of specific date
READ	extractACALEDSummaries	Retrieve large employer designation summary for AC
READ	getClosedEmployeeMeasurementPeriods	Retrieve a list of closed measurement periods by employee
READ	getControlGroups	Retrieve a list of control groups for ACA
READ	getEmployeeACAByIDNum	Retrieve ACA data by employee ID
READ	getEmployeeACADateRange	Retrieve ACA measurement period start and end date
READ	getEmployeeACAPeriods	Retrieve ACA measurement period data for an employee
READ	getEmployeeEarliestStabilityPeriodStart	Retrieve the earliest stabilty period start date for an employee
READ	getEmployeeMeasurementPeriodRecommendation	Retrieve ACA status recommendation for an employee
READ	getEmployeeMeasurementPeriodWasClosed	Retrieve status of employee measurement period
READ	getEmptyEmployeeACA	Retrieve an empty TAeEmployeeACA structur
READ	getExpiredUnaddressedMeasurementPeriods	Retrieve list of expired measurement periods by employee
READ	getFirstDateOfACAServiceHours	Retrieve date of first service hours for an employee

ACA - Update

Type	Name	Description
WRITE	changeEmployeeACAFullTimeStatus	Change the ACA status on employee record
WRITE	closeEmployeeMeasurementPeriod	Close ACA measurement period on employee record
WRITE	restartEmployeeACAPeriods	Restart ACA period for employee
WRITE	ReverseClosedEmployeeMeasurementPeriod	Open closed measurement period for employee
WRITE	revertEmployeeACAAssignments	Revert ACA assignments to defaults for employee
WRITE	setEmployeeACA	Update ACA data for employee
WRITE	submitEmployeeEarnings	Add employee earnings information for ACA
WRITE	submitPayrollEmployees	Add employee information for ACA

Employee Transactions

Type	Name	Description
WRITE	appendEmployeeGeoPunchByIDNum	Add GPS location to employee punch
WRITE	appendEmployeePunchByIDNum	Add employee punch transaction
READ	employeeTransactionSampling	Punch operation testing for ability to punch
READ	extractEmployeeGPSRegistrationsByIDNum	Retrieve employee GPS registrations
READ	extractEmployeeTransactionsByIDNum	Retrieve punch transanctions for employee in pay period
READ	extractRangedTransactionsUsingHyperQuery	Retrieve transactions in date range for list of employees from hyperquery
READ	extractTimeClockStations	Retrieve time clock station settings
READ	getStationsSimple	Retrieve list of time clock stations
WRITE	punchEmployeeGeoNowByIDNum	Add employee punch transaction with gps location
WRITE	punchEmployeeNowByIDNum	Add employee punch transaction
WRITE	registerEmployeeGPSPresenceByIDNum	Add employee GPS location record

Payroll - Retrieve

Type	Name	Description
READ	getEmptyPayrollEmployee	Retrieve an empty TAePayrollEmployee structure
READ	getPayPeriodClosureEmployees	Retrieve list of employees with outstanding issues in pay period
READ	getPayPeriodClosureStats	Retrieve stats on open issues for pay period
READ	getPayrollEmployee	Retrieve payroll information for employee
READ	getPayrollEmployeesList	Retrieve list of employees for a pay class and pay period

Payroll - Update

Type	Name	Description
READ	maintainPayrollEmployee	Update/Add an employee payroll record

Time Card - Retrieve

Type	Name	Description
READ	extractAttendanceMultiFormActivityUsingHyperQuery	Retrieve archive of timecard data
READ	extractEmployeeDailySummsByIDNum	Retrieve employee daily hours summaries
READ	extractEmployeeDailySummsInPeriodByIDNum	Retrieve employee daily hours summaries in a pay period
READ	extractEmployeeDurationTotalsByIDNum	Retrieve employee hours totals
READ	extractEmployeeEditsByIDNum	Retrieve employee time card edits
READ	extractEmployeePeriodFrameByIDNum	Retrieve dates of previous, current, next pay period for employee
READ	extractEmployeePeriodShiftDetailsByIDNum	Retrieve details for an employee shift
READ	extractEmployeePeriodShiftsByIDNum	Retrieve summary hours and punch times for employee shift
READ	extractEmployeePeriodShiftTransactionsByIDNum	Retrieve punch transanctions for employee shift in pay period
READ	extractEmployeePeriodSummsByIDNum	Retrieve summary hours and dollars for employee in pay period
READ	extractEmployeeSummsByIDNum	Retrieve summary hours and dollars for employee for each day in date range
READ	extractPayPeriodSummaries	Retrieve summary hours for all employees in pay period
READ	getManuallySelectedCalculatedData	Retrieve list of employees and hours for period of time

Time Card - Update

Type	Name	Description
WRITE	authPeriodTimeCardByIDNum	Approve employee time card
WRITE	cancelTimeCardEdit	Cancel an edit on employee time card
DELTE	deleteTimeCardEdit	Delete an edit on employee time card
WRITE	performTimeCardEdit	Edit an employee time card
WRITE	recomputeEmployeeByIDNum	recompute employee’s pay period
WRITE	unAuthPeriodTimeCardByIDNum	Remove an approval from employee time card

Data Structures

Name	Description
TAeACALEDMonthSumm	ACA monthly summaries
TAeACAMperiodRecommendation	ACA - full time or not
TAeControlGroup	Measurement and stability dates
TAeDateRange	Minimum and maximum date values
TAeEdit	Supervisor edits for employee time and pay
TAeEmpACAPeriod	Employee ACA period information
TAeEmpClosedMeasurementPeriod	ACA - has measurement period been closed
TAeEmpGeoRegistration	Employee geogrpahic registration
TAeEmployeeACA	Employee ACA information
TAeEmployeeTransactionSampling	Ability to Punch
TAeEmployeeTransactionSamplingResult	Ability to Punch Results
TAeEmpTransaction	Employee Basic and Punch Information
TAeExchangeStruct	Manually selected data
TAeMultiForm	Archived time card data
TAePayLine	Employee pay summary
TAePayPeriodCloseInfo	Open issues by pay period class
TAePayPeriodFrame	Start and end dates of pay periods
TAePayrollEarning	Employee payroll earning
TAePayrollEmployee	Employee payroll
TAeShiftLineDetail	Web Services version of the shift detail export
TAeShiftLineSimple	Shift information by employee
TAeShiftTransaction	Single transactions within the shift line detail
TAeTimeClockStation	Time clock information
TAeTransaction	Employee punch information
TAeWorkgroupSet	Workgroup information

Enumerated Data Types

Name	Description
TAeACAPeriodTypeOptions	ACA Pepriods
TAeEmpACAAutoApplyACAOptions	ACA automatically apply options
TAeEmpACAFullTimeStatusOptions	ACA full time status
TAeEmpACAMPeriodMode	ACA measurement period
TAeEmpACANoReviewOptions	ACA review options
TAeEmpACASeasonalOptions	ACA seasonal options
TAePayrollACAAutoApplyOptions	ACA payroll automatically apply options
TAePayrollACANoReviewOptions	ACA payroll review options
TAePayrollACASeasonalOptions	ACA payroll seasonal options
TAePayrollACAStatusOptions	ACA payroll status options
TAePayrollActiveStatusEnum	Payroll active statuses
TAePayrollHourlyStatusOptions	Payroll hourly statuses
TAePayrollPayTypeOptions	Payroll pay types
TAuthTimeCardOptionEnum	Time card authorizations
TDestinationOptionsEnum	Mail delivery options
TDurationDetailEnum	Pay duration types
TESSTransResultEnum	Result of the Sampling Operation
TFileConversionOptionsEnum	File conversions
TFileFormatEnum	File format
TGPSCoordsEnum	GPS information
TMultiFormItemTypeEnum	Form types
TNoActivityInclusion	Activity or no activity
TPayLineStateEnum	Pay line states
TPayPeriodEnum	Pay periods

Back to Top