GetItemCurrencyByKey


Description

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

Parameters

Parameter

Type

Description

key

ItemCurrencyKey

An item currency key object that specifies the item currency object to retrieve.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetItemCurrencyByKeyResult

ItemCurrency

An item currency object.


Interfaces

 

Examples

The following C# example retrieves the item currency with the item key value of “128 SDRAM”. The item currency ISO code 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;
			ItemCurrencyKey itemCurrencyKey;
			ItemCurrency itemCurrency;

			// 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 to specify the item
			itemKey = new ItemKey();
			itemKey.Id = "128 SDRAM";

			// Create a Currency object
			CurrencyKey currencyKey = new CurrencyKey();
			currencyKey.ISOCode = "USD";

			// Create a item currency key object to specify the item currency
			itemCurrencyKey = new ItemCurrencyKey();
			itemCurrencyKey.ItemKey = itemKey;
			itemCurrencyKey.CurrencyKey = currencyKey;

			// Retrieve the item currency object
			itemCurrency = wsDynamicsGP.GetItemCurrencyByKey(itemCurrencyKey, context);

			// Display the Currency ISO Code property for the item currency object
			MessageBox.Show("Currency ISO code: " + itemCurrency.Key.CurrencyKey.ISOCode.ToString());
	}
}
}

 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;
			ItemCurrencyKey itemCurrencyKey;
			ItemCurrency itemCurrency;

			// 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 to specify the item
			itemKey = new ItemKey();
			itemKey.Id = "128 SDRAM";

			// Create a Currency object
			CurrencyKey currencyKey = new CurrencyKey();
			currencyKey.ISOCode = "USD";

			// Create a item currency key object to specify the item currency
			itemCurrencyKey = new ItemCurrencyKey();
			itemCurrencyKey.ItemKey = itemKey;
			itemCurrencyKey.CurrencyKey = currencyKey;

			// Retrieve the item currency object
			itemCurrency = wsDynamicsGP.GetItemCurrencyByKey(itemCurrencyKey, context);

			// Display the Currency ISO Code property for the item currency object
			MessageBox.Show("Currency ISO code: " + itemCurrency.Key.CurrencyKey.ISOCode.ToString());

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


Documentation Feedback