extractEmployeeBenefitActivityByIDNum() 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

  • Retrieve a selected employee’s benefit balance adjustment activity within a defined date range

Syntax

  • AeEmpBenefitActivityAry := AeXMLBridge.extractEmployeeBenefitActivityByIDNum(IDNum, BenefitID, FromDate, ToDate);

Parameters

  • String - employee ID
  • Integer - benefit ID
  • String - date from (yyyy-MM-dd format)
  • String - date to (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
18
19
TAeBasicDataItem[] benefits = ws.getBenefitsSimple();                      
// retrieve list of benefits and code if needed
 
string empID = "1234";                                                     
// using employee "1234"

string dateFrom = DateTime.Now.AddDays(-30).ToString("yyyy-MM-dd");        
// set date range to prior 30 days

string dateTo = DateTime.Now.ToString("yyyy-MM-dd");
 
try
{
   TAeEmpBenefitActivity[] empBenefits = ws.extractEmployeeBenefitActivityByIDNum(empID, benefits[1].Num, dateFrom, dateTo);
}
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 benefits As TAeBasicDataItem() = ws.getBenefitsSimple()
' retrieve list of benefits and code if needed
 
Dim empID As String = "1234"
' using employee "1234"
 
Dim dateFrom As String = DateTime.Now.AddDays(-30).ToString("yyyy-MM-dd")
' set date range to prior 30 days
Dim dateTo As String = DateTime.Now.ToString("yyyy-MM-dd")
 
Try
    Dim empBenefits As TAeEmpBenefitActivity() = ws.extractEmployeeBenefitActivityByIDNum(empID, benefits(1).Num, dateFrom, dateTo)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

  • Use getBenefitsSimple to retrieve a list of benefits and codes if needed
  • Parameter dates must be in yyyy-MM-dd format

Possible Errors

  • yyyy-mm-dd is required [Date supplied in invalid format]
  • Unable to locate employee with identifier

Alternate Method

extractEmployeeBenefitActivityByFilekey

adjustEmployeeBenefitBalanceByIDNum
employeeBenefitBalanceAsOfByIDNum
extractEmployeeBenefitActivityByIDNum
extractEmployeeBenefitBalancesAsOfUsingHyperQuery
getCorrectiveActionsSimple
getEmployeeBenefitBalancesAsOfByIDNum
recomputeEmployeeAccrualsByIDNum
removeEmployeeBenefitAdjustmentsByIDNum

Back to Top