GetGLAccountByKey

Description

Retrieves a single general ledger account object based on the key value supplied.

Parameters

Parameter	Type	Description
key	GLAccountNumberKey	A general ledger account number key object that specifies the account to retrieve.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetGLAccountByKeyResult	GLAccount	A general ledger account object.

Interfaces

• Dynamics GP
• Financials

Examples

The following C# example retrieves the general ledger account with the key value "000-1100-00". The description of the account is displayed 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;
            GLAccountNumberKey accountKey;
            GLAccount account;

            // 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 GL account number key object
            accountKey = new GLAccountNumberKey();
            accountKey.Id = "000-1100-00";

            // Retrieve the GL account object
            account = wsDynamicsGP.GetGLAccountByKey(accountKey, context);

            // Display the account description in a message box
            MessageBox.Show("Account: " + account.Description);
        }
    }
}

** 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;
            GLAccountNumberKey accountKey;
            GLAccount account;

            // 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 GL account number key object
            accountKey = new GLAccountNumberKey();
            accountKey.Id = "000-1100-00";

            // Retrieve the GL account object
            account = wsDynamicsGP.GetGLAccountByKey(accountKey, context);

            // Display the account description in a message box
            MessageBox.Show("Account: " + account.Description);

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