getPayrollEmployeesList() Method

Table of Contents

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

Function

• Returns basic level employee information by Pay period Class and Pay Period

Syntax

• AeEmployeeBasicAry = AeXMLBridge.getPayrollEmployeesList(PayPeriodClass, PayPeriod);

Parameters

• Integer - use getPayPeriodClasses to retrun a list of pay period values
• Enumeration - TPayPeriod

Return Value

• Returns an array of TAeEmployeeBasic structures

Sample Code

C#

try
{
   TAePayPeriodInfo[] ppInfo = ws.getPayPeriodClasses();
   // get a list of available pay period classes

   TPayPeriodEnum ppe = TPayPeriodEnum.ppeCurrent;
   // let's use the current pay period

   TAeEmployeeBasic[] payrollEmployees = ws.getPayrollEmployeesList(ppInfo[0].PayPeriodClassNum, ppe);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

VB.Net

Try
    Dim ppInfo As TAePayPeriodInfo() = ws.getPayPeriodClasses()
    ' get a list of available pay period classes
    
    Dim ppe As TPayPeriodEnum = TPayPeriodEnum.ppeCurrent
    ' let's use the current pay period

    Dim payrollEmployees As TAeEmployeeBasic() = ws.getPayrollEmployeesList(ppInfo(0).PayPeriodClassNum, ppe)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

• none

Possible Errors

• No employee with ID number found

Related Methods

getEmptyPayrollEmployee
getPayPeriodClosureEmployees
getPayPeriodClosureStats
getPayrollEmployee
maintainPayrollEmployee
submitPayrollEmployees

Back to Top