GetSalesReturnByKey

Description

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

Parameters

Parameter	Type	Description
key	SalesDocumentKey	The sales return key object that specifies the sales return to retrieve.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetSalesReturnByKeyResult	SalesReturn	A sales return object.

Interfaces

• Dynamics GP
• Sales

Examples

The following C# example retrieves a sales return object with the key value "STDINV2257". A message box displays the customer name.

** 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;
            SalesDocumentKey salesReturnKey;
            SalesReturn salesReturn;

            // 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 Return key and specify the sales return
            salesReturnKey = new SalesDocumentKey();
            salesReturnKey.Id = "STDINV2257";

            // Retrieve the sales return object
            salesReturn = wsDynamicsGP.GetSalesReturnByKey(salesReturnKey, context);

            // Display the customer name
            MessageBox.Show("Customer name: " + salesReturn.CustomerName);
        }
    }
}

** 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;
            SalesDocumentKey salesReturnKey;
            SalesReturn salesReturn;

            // 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 Return key and specify the sales return
            salesReturnKey = new SalesDocumentKey();
            salesReturnKey.Id = "STDINV2257";

            // Retrieve the sales return object
            salesReturn = wsDynamicsGP.GetSalesReturnByKey(salesReturnKey, context);

            // Display the customer name
            MessageBox.Show("Customer name: " + salesReturn.CustomerName);

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