GetSalesInvoiceByKey


Description

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

Parameters

Parameter

Type

Description

key

SalesDocumentKey

The sales document key object that specifies the sales invoice to retrieve.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetSalesInvoiceByKeyResult

SalesInvoice

A sales invoice object.


Interfaces

 

Examples

The following C# example retrieves a sales invoice object with the key value “STDINV2255”. 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 salesInvoiceKey;
			SalesInvoice salesInvoice;

			// 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 document key
			salesInvoiceKey = new SalesDocumentKey();
			salesInvoiceKey.Id = "STDINV2255";

			// Retrieve the sales invoice
			salesInvoice = wsDynamicsGP.GetSalesInvoiceByKey(salesInvoiceKey, context);

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

 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;
			SalesDocumentKey salesInvoiceKey;
			SalesInvoice salesInvoice;

			// 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 document key
			salesInvoiceKey = new SalesDocumentKey();
			salesInvoiceKey.Id = "STDINV2255";

			// Retrieve the sales invoice
			salesInvoice = wsDynamicsGP.GetSalesInvoiceByKey(salesInvoiceKey, context);

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

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


Documentation Feedback