GetGLUnitAccountList


Description

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

Parameters

Parameter

Type

Description

criteria

GLUnitAccountCriteria

The GL unit account criteria object that specifies which unit account summaries are to be retrieved.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetGLUnitAccountListResult

ArrayOfGLUnitAccountSummary

A list of the GL unit account summary objects that match the specified criteria.


Interfaces

 

Examples

The following C# example retrieves the list of GL unit accounts with an account number containing “9010”. A message box displays the account number and description from 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;
			LikeRestrictionOfString accountIdRestriction;
			GLUnitAccountCriteria unitAccountCriteria;
			GLUnitAccountSummary[] unitAccountSummaries;

			// 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 restriction object
			accountIdRestriction = new LikeRestrictionOfString();
			accountIdRestriction.Like = "%9010%";

			// Create a GL unit account criteria object
			unitAccountCriteria = new GLUnitAccountCriteria();
			unitAccountCriteria.GLAccountId = accountIdRestriction;

			// Retrieve the list of GL unit account summary objects
			unitAccountSummaries = wsDynamicsGP.GetGLUnitAccountList(unitAccountCriteria, context);

			// Display the account number and description of each member of the summary list
			StringBuilder summaryList = new StringBuilder();
			foreach (GLUnitAccountSummary a in unitAccountSummaries)
			{
				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.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			LikeRestrictionOfstring accountIdRestriction;
			GLUnitAccountCriteria unitAccountCriteria;
			GLUnitAccountSummary[] unitAccountSummaries;

			// 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 restriction object
			accountIdRestriction = new LikeRestrictionOfstring();
			accountIdRestriction.Like = "%9010%";

			// Create a GL unit account criteria object
			unitAccountCriteria = new GLUnitAccountCriteria();
			unitAccountCriteria.GLAccountId = accountIdRestriction;

			// Retrieve the list of GL unit account summary objects
			unitAccountSummaries = wsDynamicsGP.GetGLUnitAccountList(unitAccountCriteria, context);

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

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


Documentation Feedback