GetReceivablesDebitMemoByKey


Description

Retrieves a single receivables debit memo 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 debit memo to retrieve.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetReceivablesDebitMemoByKeyResult

ReceivablesDebitMemo

A receivables debit memo object.


Interfaces

 

Examples

The following C# example retrieves a receivables debit memo object with the key value “DM18000”. A message box displays the customer ID and the amount from the receivables debit memo object.

 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 debitMemoKey;
			ReceivablesDebitMemo debitMemo;

			// 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 receivable document key to specify the receivables debit memo
			debitMemoKey = new ReceivablesDocumentKey();
			debitMemoKey.Id = "DM18000";

			// Retrieve the receivables debit memo object
			debitMemo = wsDynamicsGP.GetReceivablesDebitMemoByKey(debitMemoKey, context);

			// Display the debit memo’s customer ID and debit memo amount
			MessageBox.Show("Customer Id: " + debitMemo.CustomerKey.Id +
			"  Debit memo amount: " + debitMemo.SalesAmount.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 debitMemoKey;
			ReceivablesDebitMemo debitMemo;

			// 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 receivable document key to specify the receivables debit memo
			debitMemoKey = new ReceivablesDocumentKey();
			debitMemoKey.Id = "DM18000";

			// Retrieve the receivables debit memo object
			debitMemo = wsDynamicsGP.GetReceivablesDebitMemoByKey(debitMemoKey, context);

			// Display the debit memo’s customer ID and debit memo amount
			MessageBox.Show("Customer Id: " + debitMemo.CustomerKey.Id +
			"  Debit memo amount: " + debitMemo.SalesAmount.Value.ToString("C"));

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


Documentation Feedback