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

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

Syntax

  • AeEmpBenefitActivityAry := AeXMLBridge.extractEmployeeBenefitActivityByFilekey(Filekey, BenefitID, FromDate, ToDate);

Parameters

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

string dateFrom = DateTime.Now.AddDays(-365).ToString("yyyy-MM-dd");       
string dateTo = DateTime.Now.Tostring("yyyy-MM-dd");
// use prior 365 days from today as date range
  
try
{
   TAeEmpBenefitActivity[] benefits = ws.extractEmployeeBenefitActivityByFilekey(filekey, benefits[0].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
16

Dim benefits As TAeBasicDataItem() = ws.getBenefitsSimple()
' retrieve list of benefits and codes if needed
  
Dim filekey As Integer = 1234
' using employee 1234
  
Dim dateFrom As String = DateTime.Now.AddDays(-365).ToString("yyyy-MM-dd")
' use prior 365 days from today as date range
Dim dateTo As String = DateTime.Now.Tostring("yyyy-MM-dd")
  
Try
     Dim benefits As TAeEmpBenefitActivity() = ws.extractEmployeeBenefitActivityByFilekey(filekey, benefits(0).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 filekey

Preferred Method

extractEmployeeBenefitActivityByIDNum

adjustEmployeeBenefitBalanceByIDNum
employeeBenefitBalanceAsOfByIDNum
extractEmployeeBenefitBalancesAsOfUsingHyperQuery
getEmployeeBenefitBalancesAsOfByIDNum
recomputeEmployeeAccrualsByIDNum
removeEmployeeBenefitAdjustmentsByIDNum

Back to Top