GetCustomerReceivablesSummaryByKey


Description

Retrieves receivables summary information for a specified customer. The value returned by this method can be affected by entity ID filtering.

Parameters

Parameter

Type

Description

key

CustomerKey

The customer key object that specifies the customer to retrieve.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetCustomerReceivablesSummaryByKeyResult

CustomerReceivablesSummary

A customer receivables summary object.


Interfaces

 

Examples

The following C# example retrieves the receivables summary object for the customer with the key value “AARONFIT0001”. A message box displays the customer’s last receivables payment date.

 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;
			CustomerKey customerKey;
			CustomerReceivablesSummary customerReceivablesSummary;

			// 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 customer key
			customerKey = new CustomerKey();
			customerKey.Id = "AARONFIT0001";

			// Retrieve the customer receivables summary object
			customerReceivablesSummary = wsDynamicsGP.GetCustomerReceivablesSummaryByKey(customerKey,
			context);

			// Display the last payment date from the customer receivables summary object
			MessageBox.Show("Last Payment Date: " + customerReceivablesSummary.LastPaymentDate.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;
			CustomerKey customerKey;
			CustomerReceivablesSummary customerReceivablesSummary;

			// 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 customer key
			customerKey = new CustomerKey();
			customerKey.Id = "AARONFIT0001";

			// Retrieve the customer receivables summary object
			customerReceivablesSummary = wsDynamicsGP.GetCustomerReceivablesSummaryByKey(customerKey,
			context);

			// Display the last payment date from the customer receivables summary object
			MessageBox.Show("Last Payment Date: " + customerReceivablesSummary.LastPaymentDate.ToString());

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


Documentation Feedback