GetPayablesCreditMemoByKey


Description

Retrieves a single payables credit memo object based on the specified payables document key.

Parameters

Parameter

Type

Description

key

PayablesDocumentKey

The payables document key object that specifies the payables credit memo to retrieve.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetPayablesCreditMemoByKeyResult

PayablesCreditMemo

A payables credit memo object.


Interfaces

 

Examples

The following C# example retrieves a payables credit memo object with the key value “00000000000000459”. A message box displays the vendor 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;
			PayablesDocumentKey documentKey;
			PayablesCreditMemo payablesCreditMemo;

			// 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 the payables document key object
			documentKey = new PayablesDocumentKey();
			documentKey.Id = "00000000000000459";

			// Retrieve the payable credit memo object
			payablesCreditMemo = wsDynamicsGP.GetPayablesCreditMemoByKey(documentKey, context);

			// Display the vendor name property from the payables credit memo object
			MessageBox.Show("Vendor name: " + payablesCreditMemo.VendorName);
	}
}
}

 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;
			PayablesDocumentKey documentKey;
			PayablesCreditMemo payablesCreditMemo;

			// 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 the payables document key object
			documentKey = new PayablesDocumentKey();
			documentKey.Id = "00000000000000459";

			// Retrieve the payable credit memo object
			payablesCreditMemo = wsDynamicsGP.GetPayablesCreditMemoByKey(documentKey, context);

			// Display the vendor name property from the payables credit memo object
			MessageBox.Show("Vendor name: " + payablesCreditMemo.VendorName);

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


Documentation Feedback