getPayPeriodClosureStats 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

  • Return payroll closure statistics

Syntax

  • AePayPeriodCloseInfo = AeXMLBridge.getPayPeriodClosureStats(PayPeriodEnum, PayPeriodClassNum, HyperQueryName);

Parameters

  • Enumeration - TPayPeriodEnum
  • Integer - pay period class number
  • String - valid hyperquery name

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
TAeBasicDataItem[] payClasses = ws.getPayClassesSimple();                  
// retrieve a list of pay classes if pay class number is unknown
 
string[] queries = ws.getHyperQueriesSimple();                             
// retrieve a list of hyper query names if unknown
 
TPayPeriodEnum payPeriod = TPayPeriodEnum.ppeCurrent;                      
// using the current pay period
 
try
{
   TAePayPeriodCloseInfo = ws.getPayPeriodClosureStats(payPeriod, payClasses[0].Num, string[0]);
}
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

Dim payClasses As TAeBasicDataItem() = ws.getPayClassesSimple()
' retrieve a list of pay classes if pay class number is unknown
 
Dim queries As String() = ws.getHyperQueriesSimple()
' retrieve a list of hyper query names if unknown
 
Dim payPeriod As TPayPeriodEnum = TPayPeriodEnum.ppeCurrent
' using the current pay period
 
Try
    TAePayPeriodCloseInfo = ws.getPayPeriodClosureStats(payPeriod, payClasses(0).Num, String(0))
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

Possible Errors

  • Hyper Query does not exist

getEmptyPayrollEmployee
getPayPeriodClosureEmployees
getPayrollEmployee
getPayrollEmployeesList
maintainPayrollEmployee
submitPayrollEmployees

Back to Top