UpdateSalesBackorder


Description

Updates the specified sales backorder object, storing the current values in the database.

Parameters

Parameter

Type

Description

salesBackorder

SalesBackorder

The sales backorder 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

 

Examples

The following C# example retrieves the sales backorder with the sales document key value “BKO1005” and sets the comment property to “Transferred from an order”. The UpdateSalesBackorder operation saves the new comment and all the sales backorder object’s existing properties 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;
			SalesBackorder salesBackorder;
			SalesDocumentKey salesBackorderKey;
			Policy salesBackorderUpdatePolicy;

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

			// Retrieve the sales backorder object
			salesBackorder = wsDynamicsGP.GetSalesBackorderByKey(salesBackorderKey, context);

			// Populate the comment property
			salesBackorder.Comment = "Transferred from an order";

			// Retrieve the update policy for sales backorders
			salesBackorderUpdatePolicy = wsDynamicsGP.GetPolicyByOperation("UpdateSalesBackorder", context);

			// Update the sales backorder object
			wsDynamicsGP.UpdateSalesBackorder(salesBackorder, context, salesBackorderUpdatePolicy);
	}
}
}

 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;
			SalesBackorder salesBackorder;
			SalesDocumentKey salesBackorderKey;
			Policy salesBackorderUpdatePolicy;

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

			// Retrieve the sales backorder object
			salesBackorder = wsDynamicsGP.GetSalesBackorderByKey(salesBackorderKey, context);

			// Populate the comment property
			salesBackorder.Comment = "Transferred from an order";

			// Retrieve the update policy for sales backorders
			salesBackorderUpdatePolicy = wsDynamicsGP.GetPolicyByOperation("UpdateSalesBackorder", context);

			// Update the sales backorder object
			wsDynamicsGP.UpdateSalesBackorder(salesBackorder, context, salesBackorderUpdatePolicy);

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


Documentation Feedback