Other Methods

The Other section is for methods that do not have a defined API reference or have a preferred method already in another API reference section. Use the left-hand navigation to determine if the method you are using is one Attendance on Demand recommends.

Table of Contents

1. Methods
2. Data Structures

Methods

ACA

Type	Name	Description
READ	getEmployeeACAByBadge	Retrieve employee ACA information by badge number
READ	getEmployeeACAByFilekey	Retrieve employee ACA information by filekey
READ	getEmployeeACABySSN	Retrieve employee ACA information by SSN

Accruals

Type	Name	Description
WRITE	recomputeEmployeeAccrualsByFilekey	Recomputes an employee’s accruals from a selected starting date

Benefits

Type	Name	Description
WRITE	adjustEmployeeBenefitBalanceByFilekey	Set, credit or debit employee’s benefit balance on specified date
READ	employeeBenefitBalanceAsOfByFilekey	Retrieve a selected employee’s benefit balance for a specified date
READ	employeeQuickBalanceAsOfByFilekey	Retrieve a selected employee’s benefit balance for a specified date
READ	extractEmployeeBenefitActivityByFilekey	Retrieve a selected employee’s benefit balance adjustment activity within a defined date range
READ	getEmployeeBenefitBalancesAsOfByFilekey	Return an employee’s benefit balances as of the selected date
WRITE	recomputeEmployeeIncidentsByFilekey	Recomputes selected employee’s incident for selected date range
DELETE	removeEmployeeBenefitAdjustmentsByFilekey	Removes a selected employee’s benefit balance adjustment activity within the defined date range

Billing

Type	Name	Description
READ	loadBillingItemsExInRange	Returns array of billing items within defined date range
READ	loadBillingItemsInRange	Returns array of billing items within defined date range
READ	loadUsageItemsInRange	Return array of usage item structures containing daily database measurement data

Employees

Type	Name	Description
WRITE	appendEmpAttribsAssignByFilekey	Adds an employee attribute
WRITE	appendEmpCertAssignByFilekey	Adds an employee certification
WRITE	appendEmployeeTransferByFilekey	Add workgroup transfer transaction to employee’s time card
READ	extractEmpAttribsAssignsByFilekey	Retrieve an employees assigned attributes
READ	extractEmpCertAssignsByFilekey	Retrieve an employees assigned certifications
READ	extractEmployeeRatePayTypeAssignmentByFilekey	Returns information representing employee’s current rate and pay type
READ	extractEmployeeSelfServiceOperationsByFilekey	Retrieves ESS entries and corresponding information
READ	extractEmployeeWorkgroupAssignmentByFilekey	Returns employee’s workgroup assignment level values
READ	getEmployeeBasicByBadge	Returns basic level information about selected employee
READ	getEmployeeBasicByFilekey	Returns basic level information about selected employee
READ	getEmployeeBasicByIDNum	Returns basic level information about selected employee
READ	getEmployeeBasicBySSN	Returns basic level information about selected employee
READ	getEmployeeDetail2ByBadge	Returns detail level information about selected employee
READ	getEmployeeDetail2ByFilekey	Returns detail level information about selected employee
READ	getEmployeeDetail2BySSN	Returns detail level information about selected employee
READ	getEmployeeDetailByBadge	Returns detail level information about selected employee
READ	getEmployeeDetailByFilekey	Returns detail level information about selected employee
READ	getEmployeeDetailByIDNum	Returns detail level information about selected employee
READ	getEmployeeDetailBySSN	Returns detail information about selected employee
READ	getEmployeeESSEMailByFilekey	Returns employee’s ESS email address
READ	getEmployeeESSPINByFilekey	Returns employee’s ESS PIN
READ	getEmployeeFilekeyByBadge	Returns employee’s unique interval filekey given distinct badge number
READ	getEmployeeRateHistoryByFilekey	Returns employee’s rate history for specified time period
READ	getEmployeesListBasicFromHyperQuery	Returns basic level employee information for each employee in the HyperQuery
READ	getEmployeesListBasicFromHyperQueryWorkgroupFilter	Returns basic level employee information for each employee in the HyperQuery/Worgkroup
READ	getEmployeesListDetailFromHyperQuery	Returns detail level employee information for each employee in the HyperQuery
READ	getEmployeesListDetailFromHyperQueryWorkgroupFilter	Returns detail level employee information for each employee in the HyperQuery/Worgkroup
READ	getEmployeesSearchListBasic	Performs wildcard search on employee’s first and last names
READ	getEmployeesSearchListDetail	Performs wildcard search on employee’s first and last names
READ	getEmployeeTransferRatesByFilekey	Returns list of transfer rates for selected employee
READ	getEmployeeTZObservesDSTByFilekey	Returns if employee resides in time zone observing daylight savings time
READ	getEmployeeTZOffsetByFilekey	Returns employee’s time zone offset
READ	getEmptyEmployeeBasic	Returns empty TAeEmployeeBasic structure
READ	getEmptyEmployeeDetail	Returns empty TAeEmployeeDetail structure
WRITE	maintainEmployeeBasic	Add new employee or update existing one with basic level information
WRITE	maintainEmployeeDetail	Add new employee or update existing one with detail level information
DELETE	removeEmployeeRateHistoryByFilekey	Removes employee’s existing rate history records within defined date range
WRITE	setEmployeeBasic	Add new employee or update existing one detail level information
WRITE	setEmployeeDetail	Add new employee or update existing one detail level information
WRITE	setemployeeDetail2	Add new employee or update existing one detail level information
WRITE	setEmployeeESSEMailByFilekey	Sets employee’s ESS email address
WRITE	setEmployeeESSEMailByIDNum	Sets employee’s ESS email address
WRITE	setEmployeeESSPINByFilekey	Sets employee’s ESS PIN
WRITE	setEmployeeESSPINByIDNum	Sets employee’s ESS PIN
WRITE	setEmployeeTZByFilekey	Sets employee’s time zone offset and daylight savings observance settings
WRITE	setEmployeeTZByIDNum	Sets employee’s time zone offset and daylight savings observance settings
WRITE	setManuallySelectedEmployeeData	Allows user to enter time card edits in bulk
WRITE	transferEmployeeNowByFilekey	Adds workgroup transfer transaction to employee’s time card

Leave Requests

Type	Name	Description
READ	extractEmployeeLeaveRequestsByFilekey	Extracts submitted employee leave requests in specified date range

Reporting

Type	Name	Description
READ	executeExportOperation	Executes export previously defined in client’s database
READ	executeExportOperationStrings	Executes export previously defined in client’s database
READ	executeImportOperation	Executes import previously defined in client’s database
READ	executeReportOperation	Executes report previously defined in client’s database
WRITE	executeVendorOperation	Executes vendor operation previously defined in client’s database
READ	extractImportLogsFromImportEvent	Method still under construction
READ	getEmptyClientExport	Returns empty TAeClientExport structure
READ	getEmptyClientReport	Returns empty TAeClientReport structure
READ	getEmptyClientVendorOp	Returns empty TAeClientVendorOp structure
READ	getSystemExportsBasic	Returns the names of the system based Export Operations
READ	getSystemImportsBasic	Returns the names of the system based Import Operations
READ	getSystemReportsBasic	Returns the names of the system based Report Operations
READ	getSystemVendorOpsBasic	Returns the names of the system based Vendor Operations

Scheduling

Type	Name	Description
WRITE	appendEmployeeSchedule2ByFilekey	Add schedule for specific employee
WRITE	appendEmployeeScheduleByFilekey	Add schedule for specific employee
WRITE	appendEmployeeScheduleByIDNum	Add schedule for specific employee
READ	evalEmpTemplateEligByFilekey	Evaluate an employees scheduling eligibility
READ	extractEmployeePeriodShiftSchedulesByFilekey	Extracts employee’s shift work schedules for selected pay period
READ	extractEmployeeSchedules2ByFilekey	Returns employee’s schedule data for specified date range
READ	extractEmployeeSchedulesByFilekey	Returns employee’s punch data for specified date range
READ	extractEmployeeSchedulesByIDNum	Returns employee’s punch data for specified date range
READ	extractRangedSchedulesUsingHyperQuery	Retrieve schedules for employees from hyperquery
DELETE	removeEmployeeSchedulesInRangeByFilekey	Removes schedules for employee that fall within desired date range

System Configuration

Type	Name	Description
READ	dateRangeEmpEnumListSimple	Returns available DateRangeEnum values, employee-centric date range “periods
READ	dateRangeEnumDescr	Returns description of DateRangeEnum value
READ	dateRangeEnumEndDate	Returns end date passed in DateRangeEnum
READ	dateRangeEnumListSimple	Returns available DateRangeEnum values; system-wide date range “periods”
READ	dateRangeEnumStartDate	Returns start date passed in DateRangeEnum
READ	getSystemVendorOpsBasic	Returns a list of VendorOps available within the client’s system
WRITE	setGlobalPayDesMappingSet	Update or create a global pay designation mapping set
WRITE	setManuallySelectedSetupData	Upload client configuration data to Attendance on Demand
WRITE	setWorkgroup	Updates a workgroup’s properties
WRITE	setWorkgroupLevelLabels	Updates a workgroup level’s label/description

Time & Labor

Type	Name	Description
WRITE	appendEmployeeGeoPunchByFilekey	Appends employee punch with geographical information
WRITE	appendEmployeePunchByFilekey	Appends employee punch
WRITE	authPeriodTimeCardByFilekey	Authorize specific employee’s time card for selected pay period
READ	extractEmployeeDailySummsByFilekey	Returns calculated employee pay data for selected date
READ	extractEmployeeDailySummsInPeriodByFilekey	Returns employee’s day by day work summaries for selected pay period
READ	extractEmployeeDurationTotalsByFilekey	Returns employee’s duration totals
READ	extractEmployeeEditsByFilekey	Returns supervisor edit adjustments to selected employee’s time card in defined period
READ	extractEmployeeGPSRegistrationsByFilekey	Returns information containing an employee’s GPS activity
READ	extractEmployeePeriodFrameByFilekey	Returns information representing employee’s pay period framing data
READ	extractEmployeePeriodShiftDetailsByFilekey	Extracts employee’s shift details for selected pay period
READ	extractEmployeePeriodShiftsByFilekey	Returns calculated employee time card shift data for specified pay period
READ	extractEmployeePeriodShiftTransactionsByFilekey	Extracts employee’s punch transactions for selected pay period
READ	extractEmployeePeriodSummsByFilekey	Returns calculated employee pay data for specified pay period
READ	extractEmployeeSummsByFilekey	Returns a day by day list of employee summary calculations
READ	extractEmployeeTransactionsByFilekey	Returns employee’s punch data for specified pay period
READ	extractEmployeeLeaveRequestsByFilekey	Extracts previously submitted employee leave requests in specified date range
WRITE	punchEmployeeGeoNowByFilekey	Adds employee punch while recording geographic location information
WRITE	punchEmployeeNowByFilekey	Add punch transaction to employee’s time card for current pay period
WRITE	recomputeEmployeeByFilekey	Recomputes employee’s pay data for selected pay period
WRITE	registerEmployeeGPSPresenceByFilekey	Registers employee’s location using GPS coordinates
WRITE	unAuthPeriodTimeCardByFilekey	Reverses previously authorized time card

Data Structures

Name	Description
TAeBillingItem	Billing item
TAeBillingItemEx	Billing item
TAeClientExport	Client Exports
TAeClientImportDetail	Client Imports
TAeClientReport	Client Reports
TAeClientVendorOp	Client Vendor Operations
TAeClientVendorOpResults	Client Vendor Operations Results
TAeImportLogItem	Import a log item
TAeUsageItem	Manually selected data

Enumerated Data Types

Name	Description
TDestinationOptionsEnum	Mail delivery options
TFileConversionOptionsEnum	File conversions
TFileFormatEnum	File formats

Back to Top