DeleteSalesOrder

Description

Deletes a sales order based on the key value supplied.

Parameters

Parameter

Type

Description

key

SalesDocumentKey

The sales document key that specifies the sales order to delete.

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

 

Examples

The following C# example deletes the sales order with the key value “ORDST2226”.

 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;
			SalesDocumentKey salesOrderKey;
			Policy salesOrderDeletePolicy;

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

			// Get the sales order delete policy
			salesOrderDeletePolicy = wsDynamicsGP.GetPolicyByOperation("DeleteSalesOrder", context);

			// Delete the specified sales order
			wsDynamicsGP.DeleteSalesOrder(salesOrderKey, context, salesOrderDeletePolicy);
	}
}
}

 Native endpoint 

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

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			SalesDocumentKey salesOrderKey;
			Policy salesOrderDeletePolicy;

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

			// Get the sales order delete policy
			salesOrderDeletePolicy = wsDynamicsGP.GetPolicyByOperation("DeleteSalesOrder", context);

			// Delete the specified sales order
			wsDynamicsGP.DeleteSalesOrder(salesOrderKey, context, salesOrderDeletePolicy);

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

Documentation Feedback