getEmployeeBenefitBalancesAsOfByIDNum() Method

Table of Contents

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

Function

  • Return an employee’s benefit balances as of the selected date.

Syntax

  • AeEmpBenefitBalanceAry = AeXMLBridge.getEmployeeBenefitBalancesAsOfByIDNum(IDNum, SelDate);

Parameters

  • String - employee ID
  • String - selected date (yyyy-MM-dd format)

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
string empID = "1234";                                                    
 // using employee with ID "1234"

string selectedDate = DateTime.Now.ToString("yyyy-MM-dd");                 
// as of today
 
try
{
   TAeEmpBenefitBalance[] balances = ws.getEmployeeBenefitBalancesAsOfByIDNum(empID, selectedDate);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

VB.Net

1
2
3
4
5
6
7
8
9
10
11
Dim empID As String = "1234"
' using employee with ID "1234"
 
Dim selectedDate As String = DateTime.Now.ToString("yyyy-MM-dd")
' as of today
 
Try
    Dim balances As TAeEmpBenefitBalance() = ws.getEmployeeBenefitBalancesAsOfByIDNum(empID, selectedDate)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

  • Date parameter must be in yyyy-MM-dd format
  • Returned structure array will include all benefit types

Possible Errors

  • Unable to locate employee with ID
  • Date supplied in invalid format (must be yyyy-MM-dd format)

Alternate Method

getEmployeeBenefitBalancesAsOfByFilekey

adjustEmployeeBenefitBalanceByIDNum
employeeBenefitBalanceAsOfByIDNum
extractEmployeeBenefitActivityByIDNum
extractEmployeeBenefitBalancesAsOfUsingHyperQuery
getCorrectiveActionsSimple
recomputeEmployeeAccrualsByIDNum
removeEmployeeBenefitAdjustmentsByIDNum

Back to Top