GetReceivablesWarrantyList

Description

Retrieves a list of receivables warranty summary objects that match the specified criteria.

Parameters

Return Value:

Interfaces

• Dynamics GP
• Sales

Examples

The following C# example retrieves the list of receivables warranty summary objects where the customer Id is “ADAMPARK0001“. The Date and DocumentAmount property from each receivables warranty summary object are displayed in a message box.

 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;
			LikeRestrictionOfString customerIdRestriction;
			ReceivablesWarrantyCriteria receivablesWarrantyCriteria;
			ReceivablesWarrantySummary[] receivablesWarrantySummaries;

			// 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 restriction object
			// Retrieve all receivables warranty objects for the customer 'ADAMPARK0001'
			customerIdRestriction = new LikeRestrictionOfString();
			customerIdRestriction.EqualValue = "ADAMPARK0001";

			// Create the receivables warranty criteria object
			receivablesWarrantyCriteria = new ReceivablesWarrantyCriteria();
			receivablesWarrantyCriteria.CustomerId = customerIdRestriction;

			// Retrieve the list of receivables warranty summary objects
			receivablesWarrantySummaries = wsDynamicsGP.GetReceivablesWarrantyList(
			receivablesWarrantyCriteria, context);

			// Display the date and amount for each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (ReceivablesWarrantySummary a in receivablesWarrantySummaries)
			{
				summaryList.AppendLine("Warranty date: " + a.Date.Value.ToShortDateString()
				+ "  Warranty amount: " + a.DocumentAmount.Value.ToString("C"));
		}
			MessageBox.Show(summaryList.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;
			LikeRestrictionOfstring customerIdRestriction;
			ReceivablesWarrantyCriteria receivablesWarrantyCriteria;
			ReceivablesWarrantySummary[] receivablesWarrantySummaries;

			// 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 restriction object
			// Retrieve all receivables warranty objects for the customer 'ADAMPARK0001'
			customerIdRestriction = new LikeRestrictionOfstring();
			customerIdRestriction.EqualValue = "ADAMPARK0001";

			// Create the receivables warranty criteria object
			receivablesWarrantyCriteria = new ReceivablesWarrantyCriteria();
			receivablesWarrantyCriteria.CustomerId = customerIdRestriction;

			// Retrieve the list of receivables warranty summary objects
			receivablesWarrantySummaries = wsDynamicsGP.GetReceivablesWarrantyList(
			receivablesWarrantyCriteria, context);

			// Display the date and amount for each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (ReceivablesWarrantySummary a in receivablesWarrantySummaries)
			{
				summaryList.AppendLine("Warranty date: " + a.Date.Value.ToShortDateString()
				+ "  Warranty amount: " + a.DocumentAmount.Value.ToString("C"));
		}
			MessageBox.Show(summaryList.ToString());

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

Documentation Feedback

---