GetPurchaseReceiptList

Description

Retrieves a list of purchase receipt summary objects that match the specified criteria.

Parameters

Return Value:

Interfaces

• Dynamics GP
• Purchasing

Examples

The following C# example retrieves the list of purchase receipt summary objects where the vendor ID is equal to “ADVANCED0001“. The Purchase Receipt Id and Transaction State property from each purchase receipt 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 vendorIdRestriction;
			PurchaseReceiptCriteria purchaseReceiptCriteria;
			PurchaseReceiptSummary[] purchaseReceiptSummaries;

			// 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 restriction object
			// Retrieve all purchase receipt summary object with a vendor Id of 'ADVANCED0001'
			vendorIdRestriction = new LikeRestrictionOfString();
			vendorIdRestriction.EqualValue = "ADVANCED0001";

			// Create the purchase receipt criteria object
			purchaseReceiptCriteria = new PurchaseReceiptCriteria();
			purchaseReceiptCriteria.VendorId = vendorIdRestriction;

			// Retrieve the list of purchase receipt summary objects
			purchaseReceiptSummaries = wsDynamicsGP.GetPurchaseReceiptList(purchaseReceiptCriteria, context);

			// Display the ID and transaction state of each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (PurchaseReceiptSummary a in purchaseReceiptSummaries)
			{
				summaryList.AppendLine("Purchase receipt: " + a.Key.Id + "  Transaction state: " +
				a.TransactionState.Value.ToString());
		}
			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 vendorIdRestriction;
			PurchaseReceiptCriteria purchaseReceiptCriteria;
			PurchaseReceiptSummary[] purchaseReceiptSummaries;

			// 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 restriction object
			// Retrieve all purchase receipt summary object with a vendor Id of 'ADVANCED0001'
			vendorIdRestriction = new LikeRestrictionOfstring();
			vendorIdRestriction.EqualValue = "ADVANCED0001";

			// Create the purchase receipt criteria object
			purchaseReceiptCriteria = new PurchaseReceiptCriteria();
			purchaseReceiptCriteria.VendorId = vendorIdRestriction;

			// Retrieve the list of purchase receipt summary objects
			purchaseReceiptSummaries = wsDynamicsGP.GetPurchaseReceiptList(purchaseReceiptCriteria, context);

			// Display the ID and transaction state of each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (PurchaseReceiptSummary a in purchaseReceiptSummaries)
			{
				summaryList.AppendLine("Purchase receipt: " + a.Key.Id + "  Transaction state: " +
				a.TransactionState.Value.ToString());
		}
			MessageBox.Show(summaryList.ToString());

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

Documentation Feedback

---