extractEmployeeSummsByFilekey() 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 a day by day list of employee summary calculations for an employee and a specified date range

Syntax

  • AePayLineAry: = AeXMLBridge.extractEmployeeSummsByFilekey(Filekey, DateRangeEnum, MinDate, MaxDate);

Parameters

  • Integer - employee filekey
  • Enumeration - TDateRangeEnum
  • String - begin date (yyyy-mm-dd format)
  • String - end date (yyyy-mm-dd format)

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
int filekey = 1234;                                               
// using employee 1234

TDateRangeEnum dateRange = TDateRangeEnum.drPrevWeek;                      

// when not using drCustom value, we the begin and end date parameters to nothing
string beginDate = string.Empty;
string endDate = string.Empty;
 
try
{
   TAePayLine[] paylines = ws.extractEmployeeSummsByFilekey(filekey, dateRange, beginDate, endDate);
}
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
Dim filekey As Integer = 1234
' using employee 1234
 
Dim dateRange As TDateRangeEnum = TDateRangeEnum.drPrevWeek
' when not using drCustom value, we the begin and end date parameters to nothing

Dim beginDate As String = String.Empty
Dim endDate As String = String.Empty
 
Try
    Dim paylines As TAePayLine() = ws.extractEmployeeSummsByFilekey(filekey, dateRange, beginDate, endDate)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

  • When using drCustom as the enum value for TDateRangeEnum, you must set the begin and end date parameters. Otherwise set the dates to nothing

Possible Errors

  • Unable to locate employee with filekey
  • yyyy-mm-dd required [Date supplied in invalid format]

Preferred Method

extractEmployeeSummsByIDNum

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

Back to Top