GetReceivablesReturnByKey

Description

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

Parameters

Return Value:

Interfaces

• Dynamics GP
• Sales

Examples

The following C# example retrieves a receivables return object with the key value “RTN18022”. A message box displays the customer ID and the return 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 receivablesReturnKey;
			ReceivablesReturn receivablesReturn;

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

			// Retrieve the receivables return object
			receivablesReturn = wsDynamicsGP.GetReceivablesReturnByKey(receivablesReturnKey, context);

			// Display the customer ID and return amount from the receivables return object
			MessageBox.Show("Customer Id: " + receivablesReturn.CustomerKey.Id + "  Returned amount: " 
			+ receivablesReturn.DocumentAmount.Value.ToString("C"));
	}
}
}

 Native endpoint

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

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			ReceivablesDocumentKey receivablesReturnKey;
			ReceivablesReturn receivablesReturn;

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

			// Retrieve the receivables return object
			receivablesReturn = wsDynamicsGP.GetReceivablesReturnByKey(receivablesReturnKey, context);

			// Display the customer ID and return amount from the receivables return object
			MessageBox.Show("Customer Id: " + receivablesReturn.CustomerKey.Id + "  Returned amount: " 
			+ receivablesReturn.DocumentAmount.Value.ToString("C"));

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

Documentation Feedback

---