GetSalesTerritoryByKey

Description

Retrieves a single sales territory object based on the specified sales territory key. The value returned by this method can be affected by entity ID filtering.

Parameters

Return Value:

Interfaces

• Dynamics GP
• Common
• Field Service
• Financials
• Human Resources/Payroll
• Inventory
• Manufacturing
• Project Accounting
• Purchasing
• Sales

Examples

The following C# example retrieves a sales territory object with the key value "TERRITORY 1". A message box displays the territory description and country.

** 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;
            SalesTerritoryKey territoryKey;
            SalesTerritory territory;

            // 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 sales territory key object to specify the sales territory
            territoryKey = new SalesTerritoryKey();
            territoryKey.Id = "TERRITORY 1";

            // Retrieve the sales territory object
            territory = wsDynamicsGP.GetSalesTerritoryByKey(territoryKey, context);

            // Display a description of the sales territory
            MessageBox.Show("Territory: " + territory.Description +
            "  Country: " + territory.Country);
        }
    }
}

** 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;
            SalesTerritoryKey territoryKey;
            SalesTerritory territory;

            // 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 sales territory key object to specify the sales territory
            territoryKey = new SalesTerritoryKey();
            territoryKey.Id = "TERRITORY 1";

            // Retrieve the sales territory object
            territory = wsDynamicsGP.GetSalesTerritoryByKey(territoryKey, context);

            // Display a description of the sales territory
            MessageBox.Show("Territory: " + territory.Description +
            "  Country: " + territory.Country);

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