DeleteSalesReturn

Description

Deletes a sales return based on the key value supplied.

Parameters

Parameter	Type	Description
key	SalesDocumentKey	The sales document key that specifies the sales return 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

• Dynamics GP
• Sales

Examples

The following C# example deletes the sales return with the key value "STDINV2258".

** 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 salesReturnDeletePolicy;

            // 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 and specify a sales return object
            salesReturnKey = new SalesDocumentKey();
            salesReturnKey.Id = "STDINV2258";

            // Retrieve the delete policy for sales returns
            salesReturnDeletePolicy = wsDynamicsGP.GetPolicyByOperation("DeleteSalesReturn", context);

            // Delete the sales return
            wsDynamicsGP.DeleteSalesReturn(salesReturnKey, context, salesReturnDeletePolicy);
        }
    }
}

** 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 salesReturnDeletePolicy;

            // 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 and specify a sales return object
            salesReturnKey = new SalesDocumentKey();
            salesReturnKey.Id = "STDINV2258";

            // Retrieve the delete policy for sales returns
            salesReturnDeletePolicy = wsDynamicsGP.GetPolicyByOperation("DeleteSalesReturn", context);

            // Delete the sales return
            wsDynamicsGP.DeleteSalesReturn(salesReturnKey, context, salesReturnDeletePolicy);

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