GetSalesOrderByKey

Description

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

Parameters

Parameter	Type	Description
key	SalesDocumentKey	The sales document key object that specifies the sales order to retrieve.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetSalesOrderByKeyResult	SalesOrder	A sales order object.

Interfaces

• Dynamics GP
• Sales

Examples

The following C# example retrieves a sales order object with the key value "ORDST2229". A message box displays the customer name.

** 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;
            SalesDocumentKey salesOrderKey;
            SalesOrder salesOrder;

            // 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 document key
            salesOrderKey = new SalesDocumentKey();
            salesOrderKey.Id = "ORDST2229";

            // Retrieve the sales order
            salesOrder = wsDynamicsGP.GetSalesOrderByKey(salesOrderKey, context);

            // Display the sales order customer name
            MessageBox.Show("Customer: " + salesOrder.CustomerName);
        }
    }
}

** 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;
            SalesDocumentKey salesOrderKey;
            SalesOrder salesOrder;

            // 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 document key
            salesOrderKey = new SalesDocumentKey();
            salesOrderKey.Id = "ORDST2229";

            // Retrieve the sales order
            salesOrder = wsDynamicsGP.GetSalesOrderByKey(salesOrderKey, context);

            // Display the sales order customer name
            MessageBox.Show("Customer: " + salesOrder.CustomerName);

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