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

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

Syntax

  • AeXMLBridge.removeEmployeeBenefitAdjustmentsByFilekey(Filekey, BenefitID, FromDate, ToDate);

Parameters

  • Integer - employee filekey
  • Integer - benefit ID number
  • String - begin date (yyyy-MM-dd format)
  • String - end date (yyyy-MM-dd format)

Return Value

  • None

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
int filekey = 1234;                                              
 // working with employee 1234
 
TAeBasicDataItem[] benefits = ws.getBenefitsSimple();                      
// get a list of the benefits and their values
int benefitID = benefits[0].Num;
 
string fromDate = DateTime.Now-AddDays(-30).ToString("yyyy-MM-dd");        
// set date range for prior 30 days
string toDate = DateTime.Now.ToString("yyyy-MM-dd");
 
try
{
   ws.removeEmployeeBenefitAdjustmentsByFilekey(filekey, benefitID, fromDate, toDate);
}
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 filekey As Integer =  1234
' working with employee 1234
 
Dim benefits As TAeBasicDataItem() = ws.getBenefitsSimple()
' get a list of the benefits and their values
Dim benefitID As Integer = benefits(0).Num
 
Dim fromDate As String = DateTime.Now - AddDays(-30).ToString("yyyy-MM-dd")
' set date range for prior 30 days
Dim toDate As String = DateTime.Now.ToString("yyyy-MM-dd")
 
Try
    ws.removeEmployeeBenefitAdjustmentsByFilekey(filekey, benefitID, fromDate, toDate)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

Possible Errors

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

Preferred Method

removeEmployeeBenefitAdjustmentsByIDNum

adjustEmployeeBenefitBalanceByIDNum
employeeBenefitBalanceAsOfByIDNum
extractEmployeeBenefitActivityByIDNum
extractEmployeeBenefitBalancesAsOfUsingHyperQuery
getCorrectiveActionsSimple
getEmployeeBenefitBalancesAsOfByIDNum
recomputeEmployeeAccrualsByIDNum

Back to Top