VoidSalesReturn

Description

This method voids a sales return.

Parameters

Interfaces

• Dynamics GP
• Sales

Examples

The following C# example voids the sales return with the sales document key "STDINV2257". The VoidSalesReturn operation removes the unposted sales return 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 salesReturnKey;
            Policy salesReturnVoidPolicy;

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

            // Get the void policy for sales returns
            salesReturnVoidPolicy = wsDynamicsGP.GetPolicyByOperation("VoidSalesReturn", context);

            // Void the specified sales return
            wsDynamicsGP.VoidSalesReturn(salesReturnKey, context, salesReturnVoidPolicy);
        }
    }
}

** 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 salesReturnKey;
            Policy salesReturnVoidPolicy;

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

            // Get the void policy for sales returns
            salesReturnVoidPolicy = wsDynamicsGP.GetPolicyByOperation("VoidSalesReturn", context);

            // Void the specified sales return
            wsDynamicsGP.VoidSalesReturn(salesReturnKey, context, salesReturnVoidPolicy);

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