extractEmployeePeriodSummsByFilekey() 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 calculated employee pay data for the specified pay period

Syntax

  • AePayLineAry = AeXMLBridgeservice.extractEmployeePeriodSummsByFilekey(Filekey, PayPeriodEnum, PayLineStateEnum, CalcedDataTypeEnum);

Parameters

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
int filekey = 1234  ;
// using employee with filekey 1234 for this example
 
TPayPeriodEnum payPeriod = TPayPeriodEnum.ppeCurrent;
TPayLineStateEnum plState = TPayLineStateEnum.plsAsSaved;
TCalcedDataTypeEnum calced = TCalcedDataTypeEnum.cdtEstimated;
 
try
{
    TAePayLine[] payLines = ws.extractEmployeePeriodSummsByFilekey(filekey, payPeriod, plState, calced);
}
catch (Exception ex)
{
    MessageBox.Show(ex.Message);
}

Sample Code

VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
Dim filekey As Integer = 134
' using employee with filekey 1234 for this example
 
Dim payPeriod As TPayPeriodEnum = TPayPeriodEnum.ppeCurrent
Dim plState As TPayLineStateEnum = TPayLineStateEnum.plsAsSaved
Dim calced As TCalcedDataTypeEnum = TCalcedDataTypeEnum.cdtEstimated
 
Try
    Dim payLines As TAePayLine() = ws.extractEmployeePeriodSummsByFilekey(filekey, payPeriod, plState, calced)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

  • When using the value ‘asCalculated’ for the TPayLineStateEnum parameter, the data value returned in the TAePayLine structure is not relevant and should be ignored

Possible Errors

  • No Such Employee with filekey

Preferred Method

extractEmployeePeriodSummsByIDNum

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

Back to Top