GetPaymentCardTypeByKey

Description

Retrieves a single payment card type object based on the specified payment card type key.

Parameters

Return Value:

Interfaces

• Dynamics GP
• Common
• Field Service
• Financials
• Human Resources/Payroll
• Inventory
• Manufacturing
• Project Accounting
• Purchasing
• Sales

Examples

The following C# example retrieves a payment card type object with the key value “AmericaCharge”. A message box displays the payable card type classification.

 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;
			PaymentCardTypeKey cardTypeKey;
			PaymentCardType cardType;

			// 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 payment card type key and specify the Id
			cardTypeKey = new PaymentCardTypeKey();
			cardTypeKey.Id = "AmericaCharge";

			// Retrieve the payment card type object
			cardType = wsDynamicsGP.GetPaymentCardTypeByKey(cardTypeKey, context);

			// Display the payable card type property from the payment card type object
			MessageBox.Show("Card Type: " + cardType.PayableCardType.Value.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;
			PaymentCardTypeKey cardTypeKey;
			PaymentCardType cardType;

			// 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 payment card type key and specify the Id
			cardTypeKey = new PaymentCardTypeKey();
			cardTypeKey.Id = "AmericaCharge";

			// Retrieve the payment card type object
			cardType = wsDynamicsGP.GetPaymentCardTypeByKey(cardTypeKey, context);

			// Display the payable card type property from the payment card type object
			MessageBox.Show("Card Type: " + cardType.PayableCardType.Value.ToString());

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

Documentation Feedback

---