GetReceivablesInvoiceByKey

Description

Retrieves a single receivables invoice 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 invoice object with the key value “STDINV2185”. A message box displays the invoice 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 invoiceKey;
			ReceivablesInvoice receivablesInvoice;

			// 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 invoice key object to specify the receivables invoice
			invoiceKey = new ReceivablesDocumentKey();
			invoiceKey.Id = "STDINV2185";

			// Retrieve the receivables invoice object
			receivablesInvoice = wsDynamicsGP.GetReceivablesInvoiceByKey(invoiceKey, context);

			// Display the invoice amount
			MessageBox.Show("Invoice amount: " + receivablesInvoice.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 invoiceKey;
			ReceivablesInvoice receivablesInvoice;

			// 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 invoice key object to specify the receivables invoice
			invoiceKey = new ReceivablesDocumentKey();
			invoiceKey.Id = "STDINV2185";

			// Retrieve the receivables invoice object
			receivablesInvoice = wsDynamicsGP.GetReceivablesInvoiceByKey(invoiceKey, context);

			// Display the invoice amount
			MessageBox.Show("Invoice amount: " + receivablesInvoice.DocumentAmount.Value.ToString("C"));

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

Documentation Feedback

---