GetPayablesCreditMemoList

Description

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

Parameters

Parameter	Type	Description
criteria	PayablesCreditMemoCriteria	A payables credit memo criteria object that specifies which payables credit memo summary objects are returned.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetPayablesCreditMemoListResult	ArrayOfPayablesCreditMemoSummary	The list of payables credit memo summary objects that match the specified criteria.

Interfaces

• Dynamics GP
• Purchasing

Examples

The following C# example retrieves the list of payables credit memo summary objects whose TransactionState property equals "Open". The document number and vendor name from each payables credit memo 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;
            PayablesCreditMemoCriteria creditMemoCriteria;
            PayablesCreditMemoSummary[] payablesCreditMemoSummaries;

            // 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 payables credit memo objects with a status of 'Open'
            transactionStateRestriction = new ListRestrictionOfNullableOfPayablesTransactionState();
            transactionStateRestriction.EqualValue = PayablesTransactionState.Open;

            // Create the payables credit memo criteria object
            creditMemoCriteria = new PayablesCreditMemoCriteria();
            creditMemoCriteria.TransactionState = transactionStateRestriction;

            // Retrieve the payables credit memo summary objects
            payablesCreditMemoSummaries = wsDynamicsGP.GetPayablesCreditMemoList(
            creditMemoCriteria, context);

            // Display the document number and vendor name of each member of the summary object list
            StringBuilder summaryList = new StringBuilder();
            foreach (PayablesCreditMemoSummary a in payablesCreditMemoSummaries)
            {
                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.ServiceModel;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
    class Program
    {
        static void Main(string[] args)
        {
            CompanyKey companyKey;
            Context context;
            ListRestrictionOfNullableOfPayablesTransactionState transactionStateRestriction;
            PayablesCreditMemoCriteria creditMemoCriteria;
            PayablesCreditMemoSummary[] payablesCreditMemoSummaries;

            // 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 payables credit memo objects with a status of 'Open'
            transactionStateRestriction = new ListRestrictionOfNullableOfPayablesTransactionState();
            transactionStateRestriction.EqualValue = PayablesTransactionState.Open;

            // Create the payables credit memo criteria object
            creditMemoCriteria = new PayablesCreditMemoCriteria();
            creditMemoCriteria.TransactionState = transactionStateRestriction;

            // Retrieve the payables credit memo summary objects
            payablesCreditMemoSummaries = wsDynamicsGP.GetPayablesCreditMemoList(
            creditMemoCriteria, context);

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