VoidSalesBackorder


Description

This method voids a sales backorder.

Parameters

Parameter

Type

Description

key

SalesDocumentKey

A sales document key object that specifies the sales backorder to void.

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 voids the sales backorder with the sales document key “BKO1006”. The VoidSalesBackorder operation removes the sales backorder but does not delete it.

 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 salesBackorderKey;
			Policy salesBackorderVoidPolicy;

			// 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
			salesBackorderKey = new SalesDocumentKey();
			salesBackorderKey.Id = "BKO1006";

			// Get the void policy for sales backorder objects
			salesBackorderVoidPolicy = wsDynamicsGP.GetPolicyByOperation("VoidSalesBackorder", context);

			// Void the specified sales backorder
			wsDynamicsGP.VoidSalesBackorder(salesBackorderKey, context, salesBackorderVoidPolicy);
	}
}
}

 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 salesBackorderKey;
			Policy salesBackorderVoidPolicy;

			// 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
			salesBackorderKey = new SalesDocumentKey();
			salesBackorderKey.Id = "BKO1006";

			// Get the void policy for sales backorder objects
			salesBackorderVoidPolicy = wsDynamicsGP.GetPolicyByOperation("VoidSalesBackorder", context);

			// Void the specified sales backorder
			wsDynamicsGP.VoidSalesBackorder(salesBackorderKey, context, salesBackorderVoidPolicy);

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


Documentation Feedback