GetPurchaseOrderByKey

Description

Retrieves a single purchase order object based on the specified purchase transaction key.

Parameters

Parameter	Type	Description
key	PurchaseTransactionKey	The purchase transaction key object that specifies the purchase order to retrieve.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetPurchaseOrderByKeyResult	PurchaseOrder	A purchase order object.

Interfaces

• Dynamics GP
• Purchasing

Examples

The following C# example retrieves a purchase order object with the key value "PO1007". A message box displays the Remaining Subtotal property from the purchase order object.

** 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;
            PurchaseTransactionKey purchaseOrderKey;
            PurchaseOrder purchaseOrder;

            // 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 purchase transaction key to specify the purchase order
            purchaseOrderKey = new PurchaseTransactionKey();
            purchaseOrderKey.Id = "PO1007";

            // Retrieve the purchase order object
            purchaseOrder = wsDynamicsGP.GetPurchaseOrderByKey(purchaseOrderKey, context);

            // Display the purchase order object's remaining subtotal property
            MessageBox.Show("Purchase order amount: " + purchaseOrder.RemainingSubtotal.Value.ToString("C"));
        }
    }
}

** 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;
            PurchaseTransactionKey purchaseOrderKey;
            PurchaseOrder purchaseOrder;

            // 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 purchase transaction key to specify the purchase order
            purchaseOrderKey = new PurchaseTransactionKey();
            purchaseOrderKey.Id = "PO1007";

            // Retrieve the purchase order object
            purchaseOrder = wsDynamicsGP.GetPurchaseOrderByKey(purchaseOrderKey, context);

            // Display the purchase order object's remaining subtotal property
            MessageBox.Show("Purchase order amount: " + purchaseOrder.RemainingSubtotal.Value.ToString("C"));

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