WSTimeTimeExport Method

Gets time slice export information as a List<TimeExportParamOut> collection

Namespace: AppOne.Web.Service.Services.V1R0.Customer
Assembly: AppOne.Web.Service (in AppOne.Web.Service.dll) Version: 1.0.141

Syntax

JavaScript

Copy

public List<TimeExportParamOut> TimeExport(
	TimeExportParamIn paramIn
)

function TimeExport(paramIn);

Parameters

paramIn TimeExportParamIn: A new TimeExportParamIn object

Return Value

ListTimeExportParamOut
A List<TimeExportParamOut> collection

Exceptions

Exception	Condition
ServiceException	Invalid/missing data

Remarks

Use this method to get time information based on the configuration setup rules.

Note
Setup: Configuration > Payroll Processing > Export Code Matrices Configuration > Payroll Processing > Pay Adjustment Types Employee Selection: All Employees: To export all employees present in the selected time frame set the EmpIdentifiers value to an empty string or null. Any specification of EmpIdentifier values will return only the specified employees Examples: "EmpIdentifiers"=null "EmpIdentifiers"=[null] "EmpIdentifiers"=[""] Specific Employees: To export a specific subset of employees enter their Employee Identifiers in string format within the EmpIdentifiers property Examples: "EmpIdentifiers"=["1234"] "EmpIdentifiers"=["1234","5678"] When searching for users - if no users are found with any of the specified EmpIdentifier criteria (e.g. ["1234","4567"] is passed in as a value but no employees are found with those identifiers) then the search will return no results. Business Rules: In the export code matrixes setup screen be sure that the pay type for which you need time exports is setup with both a paid and unpaid code. For example if a user enters a work shift and that work shifts is tied to a 'Work' pay type then the export matrices pay type for 'Work' will need to be mapped to any character code you designate in the paid and unpaid values. This rule is true of all pay types, so if the same users pay type for a different entry is tied to a custom overtime rule i.e. 'OT1' then that value will need to be mapped as well. If these value are not mapped then time based punch data will not be returned from this service. If the values are mapped for only one pay type, such as 'Work' only and the 'OT1' pay type was not mapped, then only the 'Work' pay type data would be returned from the service.

Note

Setup:
Configuration > Payroll Processing > Export Code Matrices
Configuration > Payroll Processing > Pay Adjustment Types

Employee Selection:

All Employees: To export all employees present in the selected time frame set the EmpIdentifiers value to an empty string or null. Any specification of EmpIdentifier values will return only the specified employees

Examples:
"EmpIdentifiers"=null
"EmpIdentifiers"=[null]
"EmpIdentifiers"=[""]

Specific Employees: To export a specific subset of employees enter their Employee Identifiers in string format within the EmpIdentifiers property

Examples:
"EmpIdentifiers"=["1234"]
"EmpIdentifiers"=["1234","5678"]

When searching for users - if no users are found with any of the specified EmpIdentifier criteria (e.g. ["1234","4567"] is passed in as a value but no employees are found with those identifiers) then the search will return no results.

Business Rules:
In the export code matrixes setup screen be sure that the pay type for which you need time exports is setup with both a paid and unpaid code. For example if a user enters a work shift and that work shifts is tied to a 'Work' pay type then the export matrices pay type for 'Work' will need to be mapped to any character code you designate in the paid and unpaid values.

This rule is true of all pay types, so if the same users pay type for a different entry is tied to a custom overtime rule i.e. 'OT1' then that value will need to be mapped as well. If these value are not mapped then time based punch data will not be returned from this service. If the values are mapped for only one pay type, such as 'Work' only and the 'OT1' pay type was not mapped, then only the 'Work' pay type data would be returned from the service.

Caution
Please note that time will be exported only if there is a non-empty export code associated with the respective pay type in the payroll export matrices configuation tool. All pay adjustments (identifiable when Type is equal to 1) will be exported using pay adjustment code and do not require any setup instructions from the export matrices configuration tool. If this is your first time working with the TimeExport service or if you need assistance in general with the export matrices setup tool please contact support.

Caution

Please note that time will be exported only if there is a non-empty export code associated with the respective pay type in the payroll export matrices configuation tool. All pay adjustments (identifiable when Type is equal to 1) will be exported using pay adjustment code and do not require any setup instructions from the export matrices configuration tool. If this is your first time working with the TimeExport service or if you need assistance in general with the export matrices setup tool please contact support.

Required Fields

* AuthToken
* StartDate
* EndDate

Example

Report flags can effect the way in which data is returned. There are currently two flags which change the way in which time is exported which shown below under "Report Flags".

Report Flags:

Name	Overview
EnableDuplicateDifferentialAsRegular	If true the shift differential values will also be returned as regular work hours.
EnableDuplicateOvertimeAsRegular	If true the overtime values will also be returned as regular work hours.

Possible Results:

If an employee works 45 hours in a week and 5 of these hours are overtime and 20 of these are worked second shift the following flags would each returns different results.

No flags set or both report flags set to false:
- 20 Hrs Regular
- 20 Hrs Shift 2
- 5 Hrs OT

EnableDuplicateDifferentialAsRegular only set to true:
- 40 Hrs Regular
- 20 Hrs Shift2
- 5 hours OT

EnableDuplicateOvertimeAsRegular only set to true:
- 25 hrs Regular
- 20 hrs Shift 2
- 5 Hrs OT

Same Scenario with both flags:
- 45 hrs Regular
- 20 hrs Shift2
- 5 hrs OT

Reference

WSTime Class

AppOne.Web.Service.Services.V1R0.Customer Namespace