GetGLVariableAllocationAccountList

Description

Retrieves a list of general ledger variable allocation account summary objects that meet the specified criteria.

Parameters

Parameter	Type	Description
criteria	GLVariableAllocationAccountCriteria	The GL variable allocation account criteria object that specifies which variable allocation account summaries are to be retrieved.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetGLVariableAllocationAccountListResult	ArrayOfGLVariableAllocationAccountSummary	A list of the GL variable allocation account summary objects that match the specified criteria.

Interfaces

• Dynamics GP
• Financials

Examples

The following C# example retrieves the list of GL variable allocation accounts created prior to 2006. A message box displays the account number and description of each member of the list.

** 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;
            DateTime date;
            BetweenRestrictionOfNullableOfDateTime dateRestriction;
            GLVariableAllocationAccountCriteria variableAllocationAccountCriteria;
            GLVariableAllocationAccountSummary[] variableAllocationAccountSummaries;

            // 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 a datetime object
            date = new DateTime(2006, 1, 1);

            // Create a restriction object
            // Retrieve GL variable allocation accounts created before 2006
            dateRestriction = new BetweenRestrictionOfNullableOfDateTime();
            dateRestriction.LessThan = date;

            // Create a GL variable allocation account criteria object
            variableAllocationAccountCriteria = new GLVariableAllocationAccountCriteria();
            variableAllocationAccountCriteria.CreatedDate = dateRestriction;

            // Retrieve the list of GL variable allocation account summary objects
            variableAllocationAccountSummaries = wsDynamicsGP.GetGLVariableAllocationAccountList(
            variableAllocationAccountCriteria, context);

            // Display the account number and description of each member of the summary list
            StringBuilder summaryList = new StringBuilder();
            foreach (GLVariableAllocationAccountSummary a in variableAllocationAccountSummaries)
            {
                summaryList.AppendLine("Account: " + a.Key.Id + "  Description: " + a.Description);
            }
            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;
            DateTime date;
            BetweenRestrictionOfNullableOfdateTime dateRestriction;
            GLVariableAllocationAccountCriteria variableAllocationAccountCriteria;
            GLVariableAllocationAccountSummary[] variableAllocationAccountSummaries;

            // 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 a datetime object
            date = new DateTime(2006, 1, 1);

            // Create a restriction object
            // Retrieve GL variable allocation accounts created before 2006
            dateRestriction = new BetweenRestrictionOfNullableOfdateTime();
            dateRestriction.LessThan = date;

            // Create a GL variable allocation account criteria object
            variableAllocationAccountCriteria = new GLVariableAllocationAccountCriteria();
            variableAllocationAccountCriteria.CreatedDate = dateRestriction;

            // Retrieve the list of GL variable allocation account summary objects
            variableAllocationAccountSummaries = wsDynamicsGP.GetGLVariableAllocationAccountList(
            variableAllocationAccountCriteria, context);

            // Display the account number and description of each member of the summary list
            StringBuilder summaryList = new StringBuilder();
            foreach (GLVariableAllocationAccountSummary a in variableAllocationAccountSummaries)
            {
                summaryList.AppendLine("Account: " + a.Key.Id + "  Description: " + a.Description);
            }
            MessageBox.Show(summaryList.ToString());

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