extractEmployeeDailySummsByFilekey() 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 a selected date

Syntax

  • AePayLineAry = AeXMLBridge.extractEmployeeDailySummsByFilekey(Filekey, Date, PayLineStateEnum, CalcedDataTypeEnum);

Parameters

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

int filekey = 1234;                                                        
// using employee# 1234
  
string parmDate = "2016-01-31";                                            
// looking at pay data on Jan 31, 2016
  
TPayLineStateEnum plState = TPayLineStateEnum.plsAsSaved;
TCalcedDataTypeEnum calced = TCalcedDataTypeEnum.cdtNormal;
  
try
{
   TAePayLine[] payLines = ws.extractEmployeeDailySummsByFilekey(filekey, parmDate, plState, calced);
}
catch
{
   MessageBox.Show(ex.Message);
}

VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

Dim filekey As Integer = 1234
' using employee# 1234
  
Dim parmDate As String = "2016-01-31"
' looking at pay data on Jan 31, 2016
  
Dim plState As TPayLineStateEnum = TPayLineStateEnum.plsAsSaved
Dim calced As TCalcedDataTypeEnum = TCalcedDataTypeEnum.cdtNormal
  
Try
     Dim payLines As TAePayLine() = ws.extractEmployeeDailySummsByFilekey(filekey, parmDate, plState, calced)
Catch
 MessageBox.Show(ex.Message)
End Try

Remarks

  • When using plsCalculated, the date must be within the previous, current or next pay periods
  • When using plsAsSaved, any historical date can be used
  • Date parameter must be in yyyy-mm-dd format

Possible Errors

  • yyyy-mm-dd is required [Date supplied in invalid format]
  • No Such Employee with Filekey

Preferred Method

extractEmployeeDailySummsByIDNum

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

Back to Top