GetPayablesFinanceChargeByKey


Description

Retrieves a single payables finance charge object based on the specified payables document key.

Parameters

Parameter

Type

Description

key

PayablesDocumentKey

The payables document key object that specifies the payables finance charge object to retrieve.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetPayablesFinanceChargeByKeyResult

PayablesFinanceCharge

A payables finance charge object.


Interfaces

 

Examples

The following C# example retrieves a payables finance charge object with the key value “00000000000000460”. 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;
			PayablesFinanceCharge payablesFinanceCharge;

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

			// Retrieve the payables finance charge object
			payablesFinanceCharge = wsDynamicsGP.GetPayablesFinanceChargeByKey(documentKey, context);

			// Display the vendor name property from the payables finance charge object
			MessageBox.Show("Vendor name: " + payablesFinanceCharge.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;
			PayablesFinanceCharge payablesFinanceCharge;

			// 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 to specify the finance charge object
			documentKey = new PayablesDocumentKey();
			documentKey.Id = "00000000000000460";

			// Retrieve the payables finance charge object
			payablesFinanceCharge = wsDynamicsGP.GetPayablesFinanceChargeByKey(documentKey, context);

			// Display the vendor name property from the payables finance charge object
			MessageBox.Show("Vendor name: " + payablesFinanceCharge.VendorName);

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


Documentation Feedback