VoidReceivablesReturn

Description

This method voids a receivables return.

Parameters

Interfaces

• Dynamics GP
• Sales

Examples

The following C# example voids the receivables return with the receivables document key "TRN2550". This example uses the receivables return created by the CreateReceivablesReturn example. The VoidReceivableReturn operation can only void the receivables return after it has been posted. The VoidReceivablesReturn removes the receivables 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;
            ReceivablesDocumentKey receivablesReturnKey;
            Policy receivablesReturnVoidPolicy;

            // 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 receivables document key to specify the receivables return
            receivablesReturnKey = new ReceivablesDocumentKey();
            receivablesReturnKey.Id = "TRN2550";

            // Get the void policy for receivable return objects
            receivablesReturnVoidPolicy = wsDynamicsGP.GetPolicyByOperation(
            "VoidReceivablesReturn", context);

            // Void the specified receivables return
            wsDynamicsGP.VoidReceivablesReturn(receivablesReturnKey, context, receivablesReturnVoidPolicy);
        }
    }
}

** 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;
            ReceivablesDocumentKey receivablesReturnKey;
            Policy receivablesReturnVoidPolicy;

            // 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 receivables document key to specify the receivables return
            receivablesReturnKey = new ReceivablesDocumentKey();
            receivablesReturnKey.Id = "TRN2550";

            // Get the void policy for receivable return objects
            receivablesReturnVoidPolicy = wsDynamicsGP.GetPolicyByOperation(
            "VoidReceivablesReturn", context);

            // Void the specified receivables return
            wsDynamicsGP.VoidReceivablesReturn(receivablesReturnKey, context, receivablesReturnVoidPolicy);

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