GetReceivablesWarrantyByKey

Description

Retrieves a single receivables warranty object based on the specified receivables document key. The value returned by this method can be affected by entity ID filtering.

Parameters

Parameter	Type	Description
key	ReceivablesDocumentKey	The receivables document key object that specifies the receivables warranty to retrieve.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetReceivablesWarrantyByKeyResult	ReceivablesWarranty	A receivables warranty object.

Interfaces

• Dynamics GP
• Sales

Examples

The following C# example retrieves a receivables warranty object with the Key value "WRN4003". A message box displays the customer ID and the warranty amount.

** Legacy endpoint**

using System;
using System.Collections.Generic;
using System.Text;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
    class Program
    {
        static void Main(string[] args)
        {
            CompanyKey companyKey;
            Context context;
            ReceivablesDocumentKey receivablesWarrantyKey;
            ReceivablesWarranty receivablesWarranty;

            // 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 warranty object
            receivablesWarrantyKey = new ReceivablesDocumentKey();
            receivablesWarrantyKey.Id = "WRN4003";

            // Retrieve the receivables warranty object
            receivablesWarranty = wsDynamicsGP.GetReceivablesWarrantyByKey(receivablesWarrantyKey, context);

            // Display the Customer ID and the warranty amount
            MessageBox.Show("Customer Id: " + receivablesWarranty.CustomerKey.Id + "  Warranty Amount: "
            + receivablesWarranty.DocumentAmount.Value.ToString("C"));
        }
    }
}

** Native endpoint **

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
    class Program
    {
        static void Main(string[] args)
        {
            CompanyKey companyKey;
            Context context;
            ReceivablesDocumentKey receivablesWarrantyKey;
            ReceivablesWarranty receivablesWarranty;

            // 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 warranty object
            receivablesWarrantyKey = new ReceivablesDocumentKey();
            receivablesWarrantyKey.Id = "WRN4003";

            // Retrieve the receivables warranty object
            receivablesWarranty = wsDynamicsGP.GetReceivablesWarrantyByKey(receivablesWarrantyKey, context);

            // Display the Customer ID and the warranty amount
            MessageBox.Show("Customer Id: " + receivablesWarranty.CustomerKey.Id + "  Warranty Amount: "
            + receivablesWarranty.DocumentAmount.Value.ToString("C"));

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