getEmployeeBenefitBalancesAsOfByFilekey() Method

Table of Contents

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

Function

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

Syntax

  • AeEmpBenefitBalanceAry = AeXMLBridge.getEmployeeBenefitBalancesAsOfByFilekey(Filekey, SelDate);

Parameters

  • Integer - employee filekey
  • 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
int filekey = 1234;                                              
 // using employee with filekey 1234

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

VB.Net

1
2
3
4
5
6
7
8
9
10
11
Dim filekey As Integer = 1234
' using employee with filekey 1234
 
Dim selectedDate As String = DateTime.Now.ToString("yyyy-MM-dd")
' as of today
 
Try
    Dim balances As TAeEmpBenefitBalance() = ws.getEmployeeBenefitBalancesAsOfByFilekey(filekey, 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 filekey
  • Date supplied in invalid format (must be yyyy-MM-dd format)

Preferred Method

getEmployeeBenefitBalancesAsOfByIDNum

adjustEmployeeBenefitBalanceByIDNum
employeeBenefitBalanceAsOfByIDNum
extractEmployeeBenefitActivityByIDNum
extractEmployeeBenefitBalancesAsOfUsingHyperQuery
getCorrectiveActionsSimple
recomputeEmployeeAccrualsByIDNum
removeEmployeeBenefitAdjustmentsByIDNum

Back to Top