GetGLFixedAllocationAccountList


Description

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

Parameters

Parameter

Type

Description

criteria

GLFixedAllocationAccountCriteria

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

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetGLFixedAllocationAccountListResult

ArrayOfGLFixedAllocationAccountSummary

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


Interfaces

 

Examples

The following C# example retrieves the list of all active GL fixed allocation accounts and displays each account’s description 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;
			RestrictionOfNullableOfBoolean activeRestriction;
			GLFixedAllocationAccountCriteria fixedAllocationAccountCriteria;
			GLFixedAllocationAccountSummary[] fixedAllocationAccountSummary;

			// 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 active GL fixed allocation account 
			activeRestriction = new RestrictionOfNullableOfBoolean();
			activeRestriction.EqualValue = true;

			// Create a GL fixed allocation account criteria object
			fixedAllocationAccountCriteria = new GLFixedAllocationAccountCriteria();
			fixedAllocationAccountCriteria.IsActive = activeRestriction;

			// Retrieve the GL fixed allocation account summaries
			fixedAllocationAccountSummary = wsDynamicsGP.GetGLFixedAllocationAccountList(
			fixedAllocationAccountCriteria, context);

			// Display the description of each member of the summary list
			StringBuilder summaryList = new StringBuilder();
			foreach (GLFixedAllocationAccountSummary a in fixedAllocationAccountSummary)
			{
				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;
			RestrictionOfNullableOfboolean activeRestriction;
			GLFixedAllocationAccountCriteria fixedAllocationAccountCriteria;
			GLFixedAllocationAccountSummary[] fixedAllocationAccountSummary;

			// 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 active GL fixed allocation account 
			activeRestriction = new RestrictionOfNullableOfboolean();
			activeRestriction.EqualValue = true;

			// Create a GL fixed allocation account criteria object
			fixedAllocationAccountCriteria = new GLFixedAllocationAccountCriteria();
			fixedAllocationAccountCriteria.IsActive = activeRestriction;

			// Retrieve the GL fixed allocation account summaries
			fixedAllocationAccountSummary = wsDynamicsGP.GetGLFixedAllocationAccountList(
			fixedAllocationAccountCriteria, context);

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

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


Documentation Feedback