submitPayrollEmployees 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

  • Uploads multiple employees and their respective payroll information

Syntax

  • String: = AeXMLBridge.submitPayrollEmployees(AePayrollEmployeeAry);

Parameters

Return Value

  • Returns an array of

Sample Code C

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
string empID = "1234";                                                         // using employee with ID 1234
TAeEmployeeBasic empBasic = ws.getEmployeeBasicByIDNum(empID);
 
TAePayrollEmployee payrollEmp = new TAePayrollEmployee();
payrollEmp.ActiveStatus = TAePayrollActiveStatusEnum.pasActive;
payrollEmp.AutoApply = TAePayrollACAAutoApplyOptions.epaaEnabledAlways;
payrollEmp.Badge = empBasic.Badge.ToString();
 
TAeControlGroup[] controlGroups = ws.getControlGroups();
payrollEmp.ControlGroup = controlGroups[0].CGName;
 
payrollEmp.DateOfHire = empBasic.DateOfHire;
payrollEmp.EmpID = empID;
payrollEmp.FirstName = empBasic.FirstName;
payrollEmp.HourlyStatusType = TAePayrollHourylStausOptions.epftsFullTime;
payrollEmp.Initial = empBasic.Initial;
payrollEmp.LastName = empBasic.LastName;
payrollEmp.NoReview = TAePayrollACANoReviewOptions.epnrNormal;
 
TAeBasicDataItem[] payClasses = ws.getPayClassesSimple();
payrollEmp.PayClass = payClasses[0].NameLabel;
 
payrollEmp.PayType = TAePayrollPayTypeOptions.apptHourly;
payrollEmp.Seasonal = TAePayrollACASeasonalOptions.epsNormal;
payrollEmp.StartOfServiceDate = empBasic.DateOfHire;
 
TAePayrollEmployee[] payrollEmps = new TAePayrollEmployee[1];
payrollEmps[0] = payrollEmp;
 
try
{
   string guid = ws.submitPayrollEmployees(payrollEmps);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}
Sample Code - VB.Net

Sample Code VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
Dim empID As String = "1234"
' using employee with ID 1234
 
Dim empBasic As TAeEmployeeBasic = ws.getEmployeeBasicByIDNum(empID)
 
Dim payrollEmp As New TAePayrollEmployee()
payrollEmp.ActiveStatus = TAePayrollActiveStatusEnum.pasActive
payrollEmp.AutoApply = TAePayrollACAAutoApplyOptions.epaaEnabledAlways
payrollEmp.Badge = empBasic.Badge.ToString()
 
Dim controlGroups As TAeControlGroup() = ws.getControlGroups()
payrollEmp.ControlGroup = controlGroups(0).CGName
 
payrollEmp.DateOfHire = empBasic.DateOfHire
payrollEmp.EmpID = empID
payrollEmp.FirstName = empBasic.FirstName
payrollEmp.HourlyStatusType = TAePayrollHourylStausOptions.epftsFullTime
payrollEmp.Initial = empBasic.Initial
payrollEmp.LastName = empBasic.LastName
payrollEmp.NoReview = TAePayrollACANoReviewOptions.epnrNormal
 
Dim payClasses As TAeBasicDataItem() = ws.getPayClassesSimple()
payrollEmp.PayClass = payClasses(0).NameLabel
 
payrollEmp.PayType = TAePayrollPayTypeOptions.apptHourly
payrollEmp.Seasonal = TAePayrollACASeasonalOptions.epsNormal
payrollEmp.StartOfServiceDate = empBasic.DateOfHire
 
Dim payrollEmps As TAePayrollEmployee() = New TAePayrollEmployee(0) {}
payrollEmps(0) = payrollEmp
 
Try
    Dim guid As String = ws.submitPayrollEmployees(payrollEmps)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

Possible Errors

  • Employee not found

getEmptyPayrollEmployee
getPayPeriodClosureEmployees
getPayPeriodClosureStats
getPayrollEmployee
getPayrollEmployeesList
maintainPayrollEmployee

Back to Top