extractEmployeeBenefitBalancesAsOfUsingHyperQuery() Method

Table of Contents

  1. Function
  2. Syntax
  3. Parameters
  4. Return Value
  5. Sample Code
  6. Remarks
  7. Possible Errors
  8. Related Methods

Function

  • Returns all benefit balances, as of a specified date, for the selected subset of employees

Syntax

  • AeEmpBenefitBalanceAry = AeXMLBridge.extractEmployeeBenefitBalancesAsOfUsingHyperQuery(HyperQueryName, PayPerClass, SelDate);

Parameters

  • String - hyperquery name
  • Integer - pay period class ID
  • String - as of date (yyyy-MM-dd format)

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
string[] queryNames = ws.getHyperQueriesSimple();                          
// retrieve a list of HyperQueries
 
TAePayPeriodInfo[] ppi = ws.getPayPeriodClasses();                        
 // retrieve a list of Pay Classes and ID's
 
string asOfDate = "2015-01-01";                                            
// want benefit balances as of 1/1/2015
 
try
{
   TAeEmpBenefitBalance[] balances = ws.extactEmployeeBenefitBalancesAsOfUsingHyperQuery(queryName[0], ppi[0].PayPeriodClassNum, asOfDate);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
13
14
Dim queryNames As String() = ws.getHyperQueriesSimple()
' retrieve a list of HyperQueries
 
Dim ppi As TAePayPeriodInfo() = ws.getPayPeriodClasses()
' retrieve a list of Pay Classes and ID's
 
Dim asOfDate As String = "2015-01-01"
' want benefit balances as of 1/1/2015
 
Try
    Dim balances As TAeEmpBenefitBalance() = ws.extactEmployeeBenefitBalancesAsOfUsingHyperQuery(queryName(0), ppi(0).PayPeriodClassNum, asOfDate)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

  • You can use getHyperQueriesSimple to retrieve a list of valid hyperquery values if needed
  • You can use getPayPeriodClasses to retrieve a list of pay period classes and codes if needed
  • Date parameter must be in yyyy-MM-dd format

Possible Errors

  • yyyy-mm-dd is required [Invalid argument to date encode]
  • Hyperquery name does not exist

adjustEmployeeBenefitBalanceByIDNum
employeeBenefitBalanceAsOfByIDNum
extractEmployeeBenefitActivityByIDNum
getCorrectiveActionsSimple
getEmployeeBenefitBalancesAsOfByIDNum
recomputeEmployeeAccrualsByIDNum
removeEmployeeBenefitAdjustmentsByIDNum

Back to Top