GetSalespersonCommissionsByKey


Description

Retrieves a single salesperson commissions object based on the specified salesperson commissions key. The value returned by this method can be affected by entity ID filtering.

Parameters

Parameter

Type

Description

key

SalespersonCommissionsKey

The salesperson commissions key object that specifies the salesperson commissions object to retrieve.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetSalespersonCommissionsByKeyResult

SalespersonCommissions

A salesperson commissions object.


Interfaces

 

Examples

The following C# example retrieves a salesperson commissions object with the document number β€œINV1016” and a sequence number of β€œ16384β€œ. A message box displays the sales invoice commission amount.

 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;
			SalespersonCommissionsKey commissionsKey;
			SalespersonCommissions salespersonCommissions;

			// 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 salesperson commission key object to specify the sales commissions
			commissionsKey = new SalespersonCommissionsKey();
			commissionsKey.DocumentNumber = "INV1016";
			commissionsKey.SequenceNumber = 16384;

			// Retrieve the salesperson commission object
			salespersonCommissions = wsDynamicsGP.GetSalespersonCommissionsByKey(commissionsKey, context);

			// Display the commission amount for the sales invoice
			MessageBox.Show("Commission amount: " + salespersonCommissions.Amount.Value.ToString("C"));
	}
}
}

 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;
			SalespersonCommissionsKey commissionsKey;
			SalespersonCommissions salespersonCommissions;

			// 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 salesperson commission key object to specify the sales commissions
			commissionsKey = new SalespersonCommissionsKey();
			commissionsKey.DocumentNumber = "INV1016";
			commissionsKey.SequenceNumber = 16384;

			// Retrieve the salesperson commission object
			salespersonCommissions = wsDynamicsGP.GetSalespersonCommissionsByKey(commissionsKey, context);

			// Display the commission amount for the sales invoice
			MessageBox.Show("Commission amount: " + salespersonCommissions.Amount.Value.ToString("C"));

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


Documentation Feedback