GetGLPostingAccountList


Description

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

Parameters

Parameter

Type

Description

criteria

GLPostingAccountCriteria

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

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetGLPostingAccountListResult

ArrayOfGLPostingAccountSummary

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


Interfaces

 

Examples

The following C# example retrieves the list of GL posting accounts with an account category of “Cash”. A message box displays the description property for each account.

 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 accountCategoryRestriction;
			GLPostingAccountCriteria postingAccountCriteria;
			GLPostingAccountSummary[] postingAccountSummaries;

			// 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
			// Retrieve all the posting accounts in the Cash category
			accountCategoryRestriction = new LikeRestrictionOfString();
			accountCategoryRestriction.EqualValue = "Cash";

			// Create a GL posting account criteria object
			postingAccountCriteria = new GLPostingAccountCriteria();
			postingAccountCriteria.GLAccountCategoryId = accountCategoryRestriction;

			// Retrieve the list of GL posting summary objects
			postingAccountSummaries = wsDynamicsGP.GetGLPostingAccountList(postingAccountCriteria, context);

			// Display the description of each member of the summary list
			StringBuilder summaryList = new StringBuilder();
			foreach (GLPostingAccountSummary a in postingAccountSummaries)
			{
				summaryList.AppendLine("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 accountCategoryRestriction;
			GLPostingAccountCriteria postingAccountCriteria;
			GLPostingAccountSummary[] postingAccountSummaries;

			// 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
			// Retrieve all the posting accounts in the Cash category
			accountCategoryRestriction = new LikeRestrictionOfstring();
			accountCategoryRestriction.EqualValue = "Cash";

			// Create a GL posting account criteria object
			postingAccountCriteria = new GLPostingAccountCriteria();
			postingAccountCriteria.GLAccountCategoryId = accountCategoryRestriction;

			// Retrieve the list of GL posting summary objects
			postingAccountSummaries = wsDynamicsGP.GetGLPostingAccountList(postingAccountCriteria, context);

			// Display the description of each member of the summary list
			StringBuilder summaryList = new StringBuilder();
			foreach (GLPostingAccountSummary a in postingAccountSummaries)
			{
				summaryList.AppendLine("Description: " + a.Description);
		}
			MessageBox.Show(summaryList.ToString());

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


Documentation Feedback