GetFeeByKey


Description

Retrieves a single fee object based on the item key value supplied.

Parameters

Parameter

Type

Description

key

ItemKey

The item key object that specifies the fee to retrieve.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetFeeByKeyResult

Fee

A fee object.


Interfaces

 

Examples

The following C# example retrieves the fee with the key value “5-CONTRACTS”. The description of the fee is displayed in a message box.

 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;
			ItemKey itemKey;
			Fee fee;

			// 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 an item key object to specify the fee
			itemKey = new ItemKey();
			itemKey.Id = "5-CONTRACTS";

			// Retrieve the fee object
			fee = wsDynamicsGP.GetFeeByKey(itemKey, context);

			// Display the description property of the fee object
			MessageBox.Show("Fee description: " + fee.Description);
	}
}
}

 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;
			ItemKey itemKey;
			Fee fee;

			// 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 an item key object to specify the fee
			itemKey = new ItemKey();
			itemKey.Id = "5-CONTRACTS";

			// Retrieve the fee object
			fee = wsDynamicsGP.GetFeeByKey(itemKey, context);

			// Display the description property of the fee object
			MessageBox.Show("Fee description: " + fee.Description);

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


Documentation Feedback