GetEmployeePayCodeList

Description

Retrieves a list of employee pay code summary objects that match the specified criteria.

Parameters

Return Value:

Interfaces

• Dynamics GP
• Human Resources/Payroll

Examples

The following C# example retrieves the list of employee pay code summary objects where the employee Id begins with "A". A message box displays the pay codes for each employee.

** Legacy endpoint**

using System;
using System.Collections.Generic;
using System.Text;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
    class Program
    {
        static void Main(string[] args)
        {
            CompanyKey companyKey;
            Context context;
            EmployeePayCodeSummary[] employeePayCodeList;
            EmployeePayCodeCriteria employeePayCodeCriteria;
            LikeRestrictionOfString employeeIdRestriction;

            // Create an instance of the service
            DynamicsGP wsDynamicsGP = new DynamicsGP();

            // Be sure that default credentials are being used
            wsDynamicsGP.UseDefaultCredentials = true;

            // Create a context with which to call the service
            context = new Context();

            // Specify which company to use (sample company)
            companyKey = new CompanyKey();
            companyKey.Id = (-1);

            // Set up the context
            context.OrganizationKey = (OrganizationKey)companyKey;

            // Create an employee pay code criteria object
            employeeIdRestriction = new LikeRestrictionOfString();
            employeeIdRestriction.Like = "A%";
            employeePayCodeCriteria = new EmployeePayCodeCriteria();
            employeePayCodeCriteria.EmployeeKeyId = employeeIdRestriction;

            // Get the list of employee pay codes
            employeePayCodeList = wsDynamicsGP.GetEmployeePayCodeList(employeePayCodeCriteria, context);

            // Display each member of the pay code summary list
            StringBuilder summaryList = new StringBuilder();
            foreach (EmployeePayCodeSummary a in employeePayCodeList)
            {
                summaryList.AppendLine("Employee: " + a.EmployeePayCodeKey.EmployeeKey.Id + "  Pay Code: " +
                a.EmployeePayCodeKey.PayCodeKey.Id);
            }
            MessageBox.Show(summaryList.ToString());
        }
    }
}

** Native endpoint **

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
    class Program
    {
        static void Main(string[] args)
        {
            CompanyKey companyKey;
            Context context;
            EmployeePayCodeSummary[] employeePayCodeList;
            EmployeePayCodeCriteria employeePayCodeCriteria;
            LikeRestrictionOfstring employeeIdRestriction;

            // Create an instance of the service
            DynamicsGPClient wsDynamicsGP = new DynamicsGPClient();

            // Create a context with which to call the service
            context = new Context();

            // Specify which company to use (sample company)
            companyKey = new CompanyKey();
            companyKey.Id = (-1);

            // Set up the context
            context.OrganizationKey = (OrganizationKey)companyKey;

            // Create an employee pay code criteria object
            employeeIdRestriction = new LikeRestrictionOfstring();
            employeeIdRestriction.Like = "A%";
            employeePayCodeCriteria = new EmployeePayCodeCriteria();
            employeePayCodeCriteria.EmployeeKeyId = employeeIdRestriction;

            // Get the list of employee pay codes
            employeePayCodeList = wsDynamicsGP.GetEmployeePayCodeList(employeePayCodeCriteria, context);

            // Display each member of the pay code summary list
            StringBuilder summaryList = new StringBuilder();
            foreach (EmployeePayCodeSummary a in employeePayCodeList)
            {
                summaryList.AppendLine("Employee: " + a.EmployeePayCodeKey.EmployeeKey.Id + "  Pay Code: " +
                a.EmployeePayCodeKey.PayCodeKey.Id);
            }
            MessageBox.Show(summaryList.ToString());

            // Close the service
            if(wsDynamicsGP.State != CommunicationState.Faulted)
            {
                wsDynamicsGP.Close();
            }
        }
    }
}