GetPayablesMiscellaneousChargeList

Description

Retrieves a list of payables miscellaneous charge summary objects that match the specified criteria.

Parameters

Return Value:

Interfaces

• Dynamics GP
• Purchasing

Examples

The following C# example retrieves the list of payables miscellaneous charge summary objects whose BatchId property equals “PAYABLES BATCH”. The document number and vendor name from each payables miscellaneous charge summary object is 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 batchRestriction;
			PayablesMiscellaneousChargeCriteria miscellaneousChargeCriteria;
			PayablesMiscellaneousChargeSummary[] payablesMiscellaneousChargeSummaries;

			// 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 records where the batch ID is 'PAYABLES BATCH'
			batchRestriction = new LikeRestrictionOfString();
			batchRestriction.EqualValue = "PAYABLES BATCH";

			// Create a payables miscellaneous credit criteria object
			miscellaneousChargeCriteria = new PayablesMiscellaneousChargeCriteria();
			miscellaneousChargeCriteria.BatchId = batchRestriction;

			// Retrieve the list of payables miscellaneous charge summary objects
			payablesMiscellaneousChargeSummaries = wsDynamicsGP.GetPayablesMiscellaneousChargeList(
			miscellaneousChargeCriteria, context);

			// Display the document number and vendor name property of each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (PayablesMiscellaneousChargeSummary a in payablesMiscellaneousChargeSummaries)
			{
				summaryList.AppendLine("Document number: " + a.Key.Id + "  Vendor name: " +
				a.VendorName);
		}
			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 batchRestriction;
			PayablesMiscellaneousChargeCriteria miscellaneousChargeCriteria;
			PayablesMiscellaneousChargeSummary[] payablesMiscellaneousChargeSummaries;

			// 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 records where the batch ID is 'PAYABLES BATCH'
			batchRestriction = new LikeRestrictionOfstring();
			batchRestriction.EqualValue = "PAYABLES BATCH";

			// Create a payables miscellaneous credit criteria object
			miscellaneousChargeCriteria = new PayablesMiscellaneousChargeCriteria();
			miscellaneousChargeCriteria.BatchId = batchRestriction;

			// Retrieve the list of payables miscellaneous charge summary objects
			payablesMiscellaneousChargeSummaries = wsDynamicsGP.GetPayablesMiscellaneousChargeList(
			miscellaneousChargeCriteria, context);

			// Display the document number and vendor name property of each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (PayablesMiscellaneousChargeSummary a in payablesMiscellaneousChargeSummaries)
			{
				summaryList.AppendLine("Document number: " + a.Key.Id + "  Vendor name: " +
				a.VendorName);
		}
			MessageBox.Show(summaryList.ToString());

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

Documentation Feedback

---