GetPayablesReturnList

Description

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

Parameters

Return Value:

Interfaces

• Dynamics GP
• Purchasing

Examples

The following C# example retrieves the list of payables return summary objects whose TransactionState property equals “Work”. The document number and vendor name from each payables return 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;
			ListRestrictionOfNullableOfPayablesTransactionState transactionStateRestriction;
			PayablesReturnCriteria payablesReturnCriteria;
			PayablesReturnSummary[] payablesReturnSummaries;

			// 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 restriction object
			transactionStateRestriction = new ListRestrictionOfNullableOfPayablesTransactionState();
			transactionStateRestriction.EqualValue = PayablesTransactionState.Work;

			// Create the payables return criteria object
			payablesReturnCriteria = new PayablesReturnCriteria();
			payablesReturnCriteria.TransactionState = transactionStateRestriction;

			// Retrieve the list of payables returns summary objects
			payablesReturnSummaries = wsDynamicsGP.GetPayablesReturnList(payablesReturnCriteria, context);

			// Display the document number and vendor name property of each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (PayablesReturnSummary a in payablesReturnSummaries)
			{
				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;
			ListRestrictionOfNullableOfPayablesTransactionState transactionStateRestriction;
			PayablesReturnCriteria payablesReturnCriteria;
			PayablesReturnSummary[] payablesReturnSummaries;

			// 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 restriction object
			transactionStateRestriction = new ListRestrictionOfNullableOfPayablesTransactionState();
			transactionStateRestriction.EqualValue = PayablesTransactionState.Work;

			// Create the payables return criteria object
			payablesReturnCriteria = new PayablesReturnCriteria();
			payablesReturnCriteria.TransactionState = transactionStateRestriction;

			// Retrieve the list of payables returns summary objects
			payablesReturnSummaries = wsDynamicsGP.GetPayablesReturnList(payablesReturnCriteria, context);

			// Display the document number and vendor name property of each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (PayablesReturnSummary a in payablesReturnSummaries)
			{
				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

---