GetPostedPayablesVendorPaymentsByKey


Description

Retrieves a single posted payables vendor payment object based on the specified payables document key.

Parameters

Parameter

Type

Description

key

PayablesDocumentKey

The payables document key object that specifies the posted payables vendor payment object to retrieve.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetPostedPayablesVendorPaymentsByKeyResult

PostedPayablesVendorPayment

A posted payables vendor payment object.


Interfaces

 

Examples

The following C# example retrieves a posted payables vendor payment object with the payables document Id “00000000000000114“. A message box displays the vendor name property of the posted payables vendor payment object.

 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;
			PostedPayablesVendorPayment postedPayablesVendorPayment;
			PayablesDocumentKey payablesDocumentKey;

			// Create an instance of the service
			DynamicsGP wsDynamicsGP = new DynamicsGP();

			// Be sure that 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 payables document key
			payablesDocumentKey = new PayablesDocumentKey();
			payablesDocumentKey.Id = "00000000000000114";

			//Get the posted payables vendor payment object
			postedPayablesVendorPayment = wsDynamicsGP.GetPostedPayablesVendorPaymentsByKey(payablesDocumentKey, context);

			// Display the vendor name property of the specified posted payables vendor payment object
			MessageBox.Show("Vendor name: " + postedPayablesVendorPayment.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;
			PostedPayablesVendorPayment postedPayablesVendorPayment;
			PayablesDocumentKey payablesDocumentKey;

			// 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 payables document key
			payablesDocumentKey = new PayablesDocumentKey();
			payablesDocumentKey.Id = "00000000000000114";

			//Get the posted payables vendor payment object
			postedPayablesVendorPayment = wsDynamicsGP.GetPostedPayablesVendorPaymentsByKey(payablesDocumentKey, context);

			// Display the vendor name property of the specified posted payables vendor payment object
			MessageBox.Show("Vendor name: " + postedPayablesVendorPayment.VendorName);

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


Documentation Feedback