extractPayPeriodSummaries 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 each employee’s pay data in a selected pay period class for a specified pay period

Syntax

• AePayLineAry = AeXMLBridge.extractPayPeriodSummaries(PayPerClass, PayPeriodEnum, PayLineStateEnum, CalcedDataTypeEnum, NoActivityInclusion)

Parameters

• Integer - pay period class
• Enumeration - TPayPeriodEnum
• Enumeration - TPayLineStateEnum
• Enumeration - TCalcedDataTypeEnum
• Enumeration - TNoActivityInclusion

Return Value

• Returns an array of TAePayLine structures

Sample Code

C#

TAePayPeriodInfo[] payPeriodClass = ws.getPayPeriodClasses();                    
// list of pay period classes
 
TPayPeriodEnum payPeriod = TPayPeriodEnum.ppePrevious;                     
// using the previous pay period

TPayLineStateEnum payLineState = TPayLineStateEnum.plsCalculated;     
TCalcedDataTypeEnum calced = TCalcedDataTypeEnum.cdtNormal;
TNoActivityInclusion activity = TNoActivityInclusion.naiSkip;              
// skip employees with no pay data
 
try
{
   TAePayLine[] pl = ws.extractPayPeriodSummaries(payPeriodClass[0].PayPeriodClassNum, payPeriod, payLineState, calced, activity);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

Sample Code VB.Net

 
Dim payPeriod As TPayPeriodEnum = TPayPeriodEnum.ppePrevious
' using the previous pay period
 
Dim payLineState As TPayLineStateEnum = TPayLineStateEnum.plsCalculated
' calculate the pay line data
 
Dim calced As TCalcedDataTypeEnum = TCalcedDataTypeEnum.cdtNormal
 
Dim activity As TNoActivityInclusion = TNoActivityInclusion.naiSkip
' skip employees with no pay data
 
Try
    Dim pl As TAePayLine() = ws.extractPayPeriodSummaries(payPeriodClass(0).PayPeriodClassNum, payPeriod, payLineState, calced, activity)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

• Use getPayPeriodClasses to retrieve a list of pay period classes if needed

Possible Errors

• Pay Class not found

Related Methods

extractAttendanceMultiFormActivityUsingHyperQuery
extractEmployeeDailySummsByIDNum
extractEmployeeDailySummsInPeriodByIDNum
extractEmployeeDurationTotalsByIDNum
extractEmployeeEditsByIDNum
extractEmployeePeriodFrameByIDNum
extractEmployeePeriodShiftDetailsByIDNum
extractEmployeePeriodShiftsByIDNum
extractEmployeePeriodShiftTransactionsByIDNum
extractEmployeePeriodSummsByIDNum
extractEmployeeSummsByIDNum
extractEmployeeTransactionsByIDNum
extractRangedTransactionsUsingHyperQuery
getManuallySelectedCalculatedData

Back to Top