Absence Management API

The Absence Management APIs support the management of employee benefit time and leave requests in Attendance on Demand. Benefit balances can be updated or retrieved, while leave requests can be added, approved, updated, retrieved, or deleted using the various methods below.

Table of Contents

1. Methods
2. Data Structures
3. Data Types

Methods

Benefits - Retrieve

Type	Name	Description
READ	employeeBenefitBalanceAsOfByIDNum	Retrieve employee benefit balance
READ	employeeQuickBalanceAsOfByIDNum	Retrieve employee benefit balance
READ	extractEmployeeBenefitBalancesAsOfUsingHyperQuery	Retrieve employee benefit balances by hyperquery
READ	extractEmployeeBenefitActivityByIDNum	Retrieve employee benefit activity
READ	getBenefitsSimple	Retrieve benefit types and values
READ	getEmployeeBenefitBalancesAsOfByIDNum	Retrieve benefit balances for an employee

Benefits - Updates

Type	Name	Description
WRITE	adjustEmployeeBenefitBalanceByIDNum	Update employee benefit balance
WRITE	recomputeEmployeeAccrualsByIDNum	Recompute an employee’s accruals
DELETE	removeEmployeeBenefitAdjustmentsByIDNum	Delete employee benefit balance

Leave Requests - Create

Type	Name	Description
WRITE	submitTimeOffRequest	Create an employee leave request
WRITE	submitTimeOffRequestEx	Create an employee leave request w/rediect to LinkBack url
WRITE	submitTimeOffRequestMess	Create an employee leave request w/email notification

Leave Requests - Delete

Type	Name	Description
DELETE	empRemoveLeaveRequestEntry	Delete an employee leave request
DELETE	empRemoveLeaveRequestEntryMess	Delete an employee leave request w/email notification
DELETE	removeLeaveRequestEntry	Delete an employee leave request

Leave Requests - Manage

Type	Name	Description
WRITE	approveCancelLeaveRequestEntry	Approve a cancelled employee leave request
WRITE	approveCancelLeaveRequestEntryMess	Approve a cancelled employee leave request w/email notification
WRITE	approveLeaveRequestEntry	Approve an employee leave request
WRITE	approveLeaveRequestEntryEx	Approve an employee leave request w/comments
WRITE	approveLeaveRequestEntryMess	Approve an employee leave request w/email notification
WRITE	denyCancelLeaveRequestEntry	Deny a cancelled employee leave request
WRITE	denyCancelLeaveRequestEntryMess	Deny an employee leave request w/email notification
WRITE	denyLeaveRequestEntry	Deny an employee leave request
WRITE	denyLeaveRequestEntryEx	Deny an employee leave request with comments
WRITE	denyLeaveRequestEntryMess	Deny an employee leave request with email notification
WRITE	empCancelLeaveRequestEntry	Request to cancel employee leave request
WRITE	empCancelLeaveRequestEntryMess	Request to cancel employee leave request w/email notification

Leave Requests - Retrieve

Type	Name	Description
READ	describeLeaveRequestEntry	Returns a description of the leave request
READ	extractEmployeeLeaveRequest	Retrieve an employee leave request
READ	extractEmployeeLeaveRequestHist	Retrieve history of employee leave request
READ	extractEmployeeLeaveRequestsByIDNum	Retrieve an employee’s leave requests
READ	extractLeaveRequestsByState	Retrieve leave requests by stat

Leave Requests - Rules

Type	Name	Description
READ	extractTimeOffRequestStates	Retrieve list of leave requests statuses
READ	getCorrectiveActionsSimple	Returns list of corrective actions available within system
READ	leaveRequestIsCancelable	Identify if leave request can be cancelled
READ	leaveRequestIsRemovable	Identify if leave request can be deleted
READ	recomputeEmployeeIncidentsByIDNum	Recomputes employee work incidents

Data Structures

Name	Description
TAeEmpBenefitActivity	Debited, credited and remaining hours by benefit ID and event date
TAeEmpBenefitBalance	Remaining hours by benefit ID as of a specified date
TAeEmpBenefitBalanceDate	Start and end hours or amounts by benefit ID as of a specified date
TAeTimeOffRequest	Information required to approve/deny/cancel a benefit-based leave request
TAeTimeOffRequestHist	History of a leave request by its different request states
TAeTimeOffRequestNotification	Email an employee regarding their time off
TAeTimeOffRequestState	Time off request state

Enumerated Data Types

Name	Description
TBenAdjTypeEnum	Benefit adjustment types
TCalcedDataTypeEnum	Date range options
TDateRangeEnum	Calculation options
TDayOfWeekEnum	Day of the week
TRequestTimeOffTypeEnum	Leave request types
TRTOFilterEnum	Leave request states
TTRTOShiftPartTypeEnum	Shift parts
TRTOUsageStateEnum	Usage states

Back to Top