VoidReceivablesCreditMemo

Description

This method voids a receivables credit memo.

Parameters

Parameter	Type	Description
key	ReceivablesDocumentKey	A receivables document key object that specifies the receivables credit memo 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 receivables credit memo with the receivables document key "CM6500". This example uses the receivables credit memo created by the CreateReceivablesCreditMemo example. The VoidReceivableCreditMemo operation can only void the receivables credit memo after it has been posted. The VoidReceivablesCreditMemo removes the receivables credit memo 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 creditMemoKey;
            Policy receivablesCreditMemoVoidPolicy;

            // 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 the receivables document key to specify the receivables credit memo
            creditMemoKey = new ReceivablesDocumentKey();
            creditMemoKey.Id = "CM6500";

            // Get the void policy for receivables credit memo objects
            receivablesCreditMemoVoidPolicy = wsDynamicsGP.GetPolicyByOperation(
            "VoidReceivablesCreditMemo", context);

            // Void the receivables credit memo
            wsDynamicsGP.VoidReceivablesCreditMemo(creditMemoKey, context, receivablesCreditMemoVoidPolicy);
        }
    }
}

** 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 creditMemoKey;
            Policy receivablesCreditMemoVoidPolicy;

            // 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 the receivables document key to specify the receivables credit memo
            creditMemoKey = new ReceivablesDocumentKey();
            creditMemoKey.Id = "CM6500";

            // Get the void policy for receivables credit memo objects
            receivablesCreditMemoVoidPolicy = wsDynamicsGP.GetPolicyByOperation(
            "VoidReceivablesCreditMemo", context);

            // Void the receivables credit memo
            wsDynamicsGP.VoidReceivablesCreditMemo(creditMemoKey, context, receivablesCreditMemoVoidPolicy);

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