GetReceivablesServiceRepairByKey


Description

Retrieves a single receivables service repair object based on the specified receivables document key. The value returned by this method can be affected by entity ID filtering.

Parameters

Parameter

Type

Description

key

ReceivablesDocumentKey

The receivables document key object that specifies the receivables service repair to retrieve.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetReceivablesServiceRepairByKeyResult

ReceivablesServiceRepair

A receivables service repair object.


Interfaces

 

Examples

The following C# example retrieves a receivables service repair object with the key value “SVC11020”. A message box displays the service repair 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;
			ReceivablesDocumentKey serviceRepairKey;
			ReceivablesServiceRepair receivablesServiceRepair;

			// 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 the receivables service repair key object to specify the service repair
			serviceRepairKey = new ReceivablesDocumentKey();
			serviceRepairKey.Id = "SVC11020";

			// Retrieve the receivables service repair object
			receivablesServiceRepair = wsDynamicsGP.GetReceivablesServiceRepairByKey(
			serviceRepairKey, context);

			// Display the service repair amount
			MessageBox.Show("Service repair amount: " +
			receivablesServiceRepair.DocumentAmount.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;
			ReceivablesDocumentKey serviceRepairKey;
			ReceivablesServiceRepair receivablesServiceRepair;

			// 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 the receivables service repair key object to specify the service repair
			serviceRepairKey = new ReceivablesDocumentKey();
			serviceRepairKey.Id = "SVC11020";

			// Retrieve the receivables service repair object
			receivablesServiceRepair = wsDynamicsGP.GetReceivablesServiceRepairByKey(
			serviceRepairKey, context);

			// Display the service repair amount
			MessageBox.Show("Service repair amount: " +
			receivablesServiceRepair.DocumentAmount.Value.ToString("C"));

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


Documentation Feedback