employeeBenefitBalanceAsOfByIDNum() Method

Table of Contents

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

Function

  • Returns selected employee’s benefit balance “As Of” the selected date

Syntax

  • double = AeXMLBridge.employeeBenefitBalanceAsOfByIDNum(IDNum, BenefitID, SelectedDate);

Parameters

  • String - employee ID
  • Integer - benefit ID
  • String - “as of” date (yyyy-MM-dd format)

Return Value

  • Returns a double data type containing the employee’s benefit balance for the selected benefit ID

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
string empID = "1234";                                                     
// using employee# "1234"
 
TAeBasicDataItem[] benefits = ws.getBenefitsSimple();                      
// retrieve list of benefit codes

int benefitID = benefits[0].Num;
 
string asOfDate = DateTime.Now.AddDays(-14).ToString("yyyy-MM-dd");        
// as of date set to 14 days prior
 
try
{
   double balance = ws.employeeBenefitBalanceAsOfByIDNum(empID, benefitID, asOfDate);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Dim empID As String = "1234"
' using employee# "1234"
 
Dim benefits As TAeBasicDataItem() = ws.getBenefitsSimple()
' retrieve list of benefit codes
Dim benefitID As Integer = benefits(0).Num
 
Dim asOfDate As String = DateTime.Now.AddDays(-14).ToString("yyyy-MM-dd")
' as of date set to 14 days prior
 
Try
    Dim balance As Double = ws.employeeBenefitBalanceAsOfByIDNum(empID, benefitID, asOfDate)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

Possible Errors

  • No such employee with identifier
  • yyyy-mm-dd is required [Date supplied in invalid format]

Alternate Methods

employeeBenefitBalanceAsOfByFilekey

adjustEmployeeBenefitBalanceByIDNum
extractEmployeeBenefitActivityByIDNum
extractEmployeeBenefitBalancesAsOfUsingHyperQuery
getCorrectiveActionsSimple
getEmployeeBenefitBalancesAsOfByIDNum
recomputeEmployeeAccrualsByIDNum
removeEmployeeBenefitAdjustmentsByIDNum

Back to Top