VoidSalesOrder

2010-07-23

Description

This method voids a sales order.

Parameters

Parameter	Type	Description
key	SalesDocumentKey	A sales document key object that specifies the sales order 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

Dynamics GP
Sales

Examples

The following C# example voids the sales order with the sales document key "ORDST2228". The VoidSalesOrder operation removes the sales order 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 salesOrderKey;
            Policy salesOrderVoidPolicy;

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

            // Get the void policy for sales orders
            salesOrderVoidPolicy = wsDynamicsGP.GetPolicyByOperation("VoidSalesOrder", context);

            // Void the specified sales order
            wsDynamicsGP.VoidSalesOrder(salesOrderKey, context, salesOrderVoidPolicy);
        }
    }
}

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

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

            // Get the void policy for sales orders
            salesOrderVoidPolicy = wsDynamicsGP.GetPolicyByOperation("VoidSalesOrder", context);

            // Void the specified sales order
            wsDynamicsGP.VoidSalesOrder(salesOrderKey, context, salesOrderVoidPolicy);

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

Share via