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

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

Syntax

• AeEmpBenefitBalanceDate = AeXMLBridge.employeeQuickBalanceAsOfByFilekey(Filekey, BenefitID, SelectedDate);

Parameters

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

Return Value

• Returns a TAeEmpBenefitBalanceDate structure containing the employee’s benefit balance for the selected benefit ID

Sample Code

C#

int filekey = 1234;                                               
// using employee with filekey 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
{
   TAeEmpBenefitBalanceDate ebbd = ws.employeeQuickBalanceAsOfByFilekey(filekey, benefitID, asOfDate);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

VB.Net

Dim filekey As Integer = 1234
' using employee with filekey  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 ebbd As TAeEmpBenefitBalabceDate = ws.employeeQuickBalanceAsOfByFilekey(filekey, benefitID, asOfDate)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

• use getBenefitsSimple to retrieve a list of benefits and their codes

Possible Errors

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

Preferred Method

employeeQuickBalanceAsOfByIDNum

Related Methods

adjustEmployeeBenefitBalanceByIDNum
extractEmployeeBenefitActivityByIDNum
extractEmployeeBenefitBalancesAsOfUsingHyperQuery
getEmployeeBenefitBalancesAsOfByIDNum
recomputeEmployeeAccrualsByIDNum
removeEmployeeBenefitAdjustmentsByIDNum

Back to Top