GetGLAccountFormatList

Description

Retrieves a list of general ledger account format objects that meet the specified criteria.

Parameters

Parameter	Type	Description
criteria	GLAccountFormatCriteria	The GL account format criteria object that specifies which account format objects are to be retrieved.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetGLAccountFormatListResult	ArrayOfGLAccountFormat	A list of the GL account format objects that match the specified criteria.

Interfaces

• Dynamics GP
• Common
• Field Service
• Financials
• Human Resources/Payroll
• Inventory
• Manufacturing
• Project Accounting
• Purchasing
• Sales

Examples

The following C# example retrieves all GL account formats and displays each format object's segment name and segment length property in a message box.

** 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;
            GLAccountFormatCriteria accountFormatCriteria;
            GLAccountFormat[] accountFormats;

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

            // Be sure the default credentials are 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 object
            context.OrganizationKey = (OrganizationKey)companyKey;

            // Create an account format criteria object
            accountFormatCriteria = new GLAccountFormatCriteria();

            // Retrieve the account format list
            accountFormats = wsDynamicsGP.GetGLAccountFormatList(accountFormatCriteria, context);

            // Display the name and length of each member of the GL account format object list
            StringBuilder summaryList = new StringBuilder();
            foreach (GLAccountFormat a in accountFormats)
            {
                summaryList.AppendLine("Name: " + a.SegmentName + "  Length " +
                a.SegmentLength.ToString());
            }
            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;
            GLAccountFormatCriteria accountFormatCriteria;
            GLAccountFormat[] accountFormats;

            // 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 object
            context.OrganizationKey = (OrganizationKey)companyKey;

            // Create an account format criteria object
            accountFormatCriteria = new GLAccountFormatCriteria();

            // Retrieve the account format list
            accountFormats = wsDynamicsGP.GetGLAccountFormatList(accountFormatCriteria, context);

            // Display the name and length of each member of the GL account format object list
            StringBuilder summaryList = new StringBuilder();
            foreach (GLAccountFormat a in accountFormats)
            {
                summaryList.AppendLine("Name: " + a.SegmentName + "  Length " +
                a.SegmentLength.ToString());
            }
            MessageBox.Show(summaryList.ToString());

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