getPayPeriodClosureEmployees 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 a list of employees with outstanding issues that must be addressed before a payroll is closed.

Syntax

  • AeEmployeeBasicAry = AeXMLBridge.getPayPeriodClosureEmployees(PayPeriodEnum, PayPeriodClassNum, HyperQueryName, CriticalOnly, UserUniqueID);

Parameters

  • Enumeration - TPayPeriodEnum
  • Integer - pay period class number
  • String - valid hyperquery name
  • Boolean - critical exceptions only
  • Integer - reserved for future use. Set to zero for now

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
string[] queries = ws.getHyperQueriesSimple();                             
// return a list of hyperquery names

TAeBasicDataItem[] payClasses = ws.getPayClassesSimple();                  
// return a list of Pay Classes

TPayPeriodEnum payPeriod = TPayPeriodEnum.ppeCurrent;                      
// using current pay period
 
bool critical = true;                                                      
// return only those employee's with critical exceptions

int userUniqueID = 0;
 
try
{
   TAeEmployeeBasic[] emps = ws.getPayPeriodClosureEmployees(payPeriod, payClasses[0].Num, queries[0], critical, userUniqueID);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

Sample Code

VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Dim queries As String() = ws.getHyperQueriesSimple()
' return a list of hyperquery names
 
Dim payClasses As TAeBasicDataItem() = ws.getPayClassesSimple()
' return a list of Pay Classes
 
Dim payPeriod As TPayPeriodEnum = TPayPeriodEnum.ppeCurrent
' using current pay period
 
Dim critical As Boolean = True
' return only those employee's with critical exceptions
 
Dim userUniqueID As Integer = 0
 
Try
    Dim emps As TAeEmployeeBasic() = ws.getPayPeriodClosureEmployees(payPeriod, payClasses(0).Num, queries(0), critical, userUniqueID)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

  • Use getHyperQueriesSimple to retrieve a list of HyperQueryName values if needed
  • Use getPayClassesSimple to retrieve a list of pay classes if needed
  • Setting the critical parameter to true will retrieve only the employees with critical exceptions. Setting to false will retrieve all
  • useUniqueID is for future use. Set value to zero for now

Possible Errors

  • Hyper Query does not exist
  • invalid Pay Class

getEmptyPayrollEmployee
getPayPeriodClosureStats
getPayrollEmployee
getPayrollEmployeesList
maintainPayrollEmployee
submitPayrollEmployees

Back to Top