GetGLAccountList


Description

Retrieves a list of GL account summary objects that meet the specified criteria.

Parameters

Parameter

Type

Description

criteria

GLAccountCriteria

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

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetGLAccountListResult

ArrayOfGLAccountSummary

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


Interfaces

 

Examples

The following C# example retrieves the list of all active GL accounts and displays the total 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;
			GLAccountSummary[] GLAccountSummaryList;
			GLAccountCriteria GLAccountCriteria;
			RestrictionOfNullableOfBoolean accountActiveRestriction;

			// 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;

			// Set the criteria specifying wich accounts to retrieve
			GLAccountCriteria = new GLAccountCriteria();
			accountActiveRestriction = new RestrictionOfNullableOfBoolean();
			accountActiveRestriction.EqualValue = true;
			GLAccountCriteria.IsActive = accountActiveRestriction;

			// Retrieve the list of active accounts
			GLAccountSummaryList = wsDynamicsGP.GetGLAccountList(GLAccountCriteria, context);

			// Display the total number of active accounts
			MessageBox.Show("Total active accounts:" + GLAccountSummaryList.Length.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;
			GLAccountSummary[] GLAccountSummaryList;
			GLAccountCriteria GLAccountCriteria;
			RestrictionOfNullableOfboolean accountActiveRestriction;

			// 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;

			// Set the criteria specifying wich accounts to retrieve
			GLAccountCriteria = new GLAccountCriteria();
			accountActiveRestriction = new RestrictionOfNullableOfboolean();
			accountActiveRestriction.EqualValue = true;
			GLAccountCriteria.IsActive = accountActiveRestriction;

			// Retrieve the list of active accounts
			GLAccountSummaryList = wsDynamicsGP.GetGLAccountList(GLAccountCriteria, context);

			// Display the total number of active accounts
			MessageBox.Show("Total active accounts:" + GLAccountSummaryList.Length.ToString());

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


Documentation Feedback