GetPurchaseInvoiceList

Description

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

Parameters

Return Value:

Interfaces

• Dynamics GP
• Purchasing

Examples

The following C# example retrieves the list of purchase invoice summary objects with a batch key of “ENTER/MATCH“. The Vendor Id and Subtotal property from each purchase invoice 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 batchIdRestriction;
			PurchaseInvoiceCriteria purchaseInvoiceCriteria;
			PurchaseInvoiceSummary[] purchaseInvoiceSummaries;

			// 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 invoice summary object with a batch key of 'ENTER/MATCH'
			batchIdRestriction = new LikeRestrictionOfString();
			batchIdRestriction.EqualValue = "ENTER/MATCH";

			// Create a purchase invoice criteria object
			purchaseInvoiceCriteria = new PurchaseInvoiceCriteria();
			purchaseInvoiceCriteria.BatchId = batchIdRestriction;

			// Retrieve the list of purchase invoice summary objects
			purchaseInvoiceSummaries = wsDynamicsGP.GetPurchaseInvoiceList(purchaseInvoiceCriteria, context);

			// Display the vendor ID and amount of each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (PurchaseInvoiceSummary a in purchaseInvoiceSummaries)
			{
				summaryList.AppendLine("Vendor Id: " + a.VendorKey.Id + "  Purchase invoice amount: " +
				a.Subtotal.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 batchIdRestriction;
			PurchaseInvoiceCriteria purchaseInvoiceCriteria;
			PurchaseInvoiceSummary[] purchaseInvoiceSummaries;

			// 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 invoice summary object with a batch key of 'ENTER/MATCH'
			batchIdRestriction = new LikeRestrictionOfstring();
			batchIdRestriction.EqualValue = "ENTER/MATCH";

			// Create a purchase invoice criteria object
			purchaseInvoiceCriteria = new PurchaseInvoiceCriteria();
			purchaseInvoiceCriteria.BatchId = batchIdRestriction;

			// Retrieve the list of purchase invoice summary objects
			purchaseInvoiceSummaries = wsDynamicsGP.GetPurchaseInvoiceList(purchaseInvoiceCriteria, context);

			// Display the vendor ID and amount of each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (PurchaseInvoiceSummary a in purchaseInvoiceSummaries)
			{
				summaryList.AppendLine("Vendor Id: " + a.VendorKey.Id + "  Purchase invoice amount: " +
				a.Subtotal.Value.ToString("C"));
		}
			MessageBox.Show(summaryList.ToString());

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

Documentation Feedback

---