UpdatePurchaseOrder

Description

Updates the specified purchase order object, storing the current values in the database.

Parameters

Parameter	Type	Description
purchaseOrder	PurchaseOrder	The purchase order object that is being updated.
context	Context	Specifies information about how the method will be called.
policy	Policy	Specifies the set of behaviors and behavior options to be applied during the operation.

Interfaces

• Dynamics GP
• Purchasing

Examples

The following C# example retrieves and updates the purchase order with the Id "PO4055". The UpdatePurchaseOrder operation saves the changes to the purchase order object to the database.

** Legacy endpoint**

using System;
using System.Collections.Generic;
using System.Text;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
    class Program
    {
        static void Main(string[] args)
        {
            CompanyKey companyKey;
            Context context;
            PurchaseTransactionKey purchaseOrderKey;
            PurchaseOrder purchaseOrder;
            Policy purchaseOrderUpdatePolicy;

            // 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 = "PO4055";

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

            // Change the status of the purchase order
            purchaseOrder.Status = PurchaseOrderStatus.Canceled;

            // Get the update policy for purchase orders
            purchaseOrderUpdatePolicy = wsDynamicsGP.GetPolicyByOperation("UpdatePurchaseOrder", context);

            // Update the purchase oder
            wsDynamicsGP.UpdatePurchaseOrder(purchaseOrder, context, purchaseOrderUpdatePolicy);
        }
    }
}

** Native endpoint **

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
    class Program
    {
        static void Main(string[] args)
        {
            CompanyKey companyKey;
            Context context;
            PurchaseTransactionKey purchaseOrderKey;
            PurchaseOrder purchaseOrder;
            Policy purchaseOrderUpdatePolicy;

            // 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 = "PO4055";

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

            // Change the status of the purchase order
            purchaseOrder.Status = PurchaseOrderStatus.Canceled;

            // Get the update policy for purchase orders
            purchaseOrderUpdatePolicy = wsDynamicsGP.GetPolicyByOperation("UpdatePurchaseOrder", context);

            // Update the purchase oder
            wsDynamicsGP.UpdatePurchaseOrder(purchaseOrder, context, purchaseOrderUpdatePolicy);

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