GetPlannedOrderByKey

Description

Retrieves a single planned order object based on the specified planned order key.

Parameters

Return Value:

Interfaces

• Dynamics GP
• Manufacturing

Examples

The following C# example retrieves a planned order object with the planned order key value “PO0001”. A message box displays the quantity to order information for the specified planned order.

 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;
			PlannedOrder plannedOrder;
			PlannedOrderKey plannedOrderKey;

			// 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 planned order key object
			plannedOrderKey = new PlannedOrderKey();
			plannedOrderKey.Id = "PO0001";

			// Get the list of planned order summary objects
			plannedOrder = wsDynamicsGP.GetPlannedOrderByKey(plannedOrderKey, context);

			// Display the list of planned orders
			MessageBox.Show("Quantity to order: " + plannedOrder.QuantityToOrder.Value.ToString());
	}
}
}

 Native endpoint

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			PlannedOrder plannedOrder;
			PlannedOrderKey plannedOrderKey;

			// 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 planned order key object
			plannedOrderKey = new PlannedOrderKey();
			plannedOrderKey.Id = "PO0001";

			// Get the list of planned order summary objects
			plannedOrder = wsDynamicsGP.GetPlannedOrderByKey(plannedOrderKey, context);

			// Display the list of planned orders
			MessageBox.Show("Quantity to order: " + plannedOrder.QuantityToOrder.Value.ToString());

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

Documentation Feedback

---