GetReceivablesDocumentList

Description

Retrieves a list of receivables document summary objects that match the specified criteria.

Parameters

Parameter	Type	Description
criteria	ReceivablesDocumentCriteria	A receivables document criteria object that specifies which receivables document summary objects are returned.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetReceivablesDocumentListResult	ArrayOfReceivablesDocumentSummary	The list of receivables document summary objects that match the specified criteria.

Interfaces

• Dynamics GP
• Sales

Examples

The following C# example retrieves the list of receivables document summary objects where the customer Id is "AARONFIT0001" and the document type is a service repair. The Date and DocumentAmount property from each receivables document summary object are 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 customerIdRestriction;
            ListRestrictionOfNullableOfReceivablesDocumentType documentTypeRestriction;
            ReceivablesDocumentCriteria receivablesCriteria;
            ReceivablesDocumentSummary[] documentSummaries;

            // 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 objects
            // Retrieve all receivables documents with customer Id of 'AARONFIT0001'
            customerIdRestriction = new LikeRestrictionOfString();
            customerIdRestriction.EqualValue = "AARONFIT0001";

            // Retrieve only receivables documents with a type of service repair
            documentTypeRestriction = new ListRestrictionOfNullableOfReceivablesDocumentType();
            documentTypeRestriction.EqualValue = ReceivablesDocumentType.ServiceRepair;

            // Create the receivables document criteria object
            receivablesCriteria = new ReceivablesDocumentCriteria();
            receivablesCriteria.CustomerId = customerIdRestriction;
            receivablesCriteria.Type = documentTypeRestriction;

            // Retrieve the list of receivables document summary objects
            documentSummaries = wsDynamicsGP.GetReceivablesDocumentList(receivablesCriteria, context);

            // Display the ID and amount of each member of the summary object list
            StringBuilder summaryList = new StringBuilder();
            foreach (ReceivablesDocumentSummary a in documentSummaries)
            {
                summaryList.AppendLine("Service repair date: " + a.Date.Value.ToShortDateString()
                + "  Amount: " + a.DocumentAmount.Value.ToString("C"));
            }
            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;
            LikeRestrictionOfstring customerIdRestriction;
            ListRestrictionOfNullableOfReceivablesDocumentType documentTypeRestriction;
            ReceivablesDocumentCriteria receivablesCriteria;
            ReceivablesDocumentSummary[] documentSummaries;

            // 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 objects
            // Retrieve all receivables documents with customer Id of 'AARONFIT0001'
            customerIdRestriction = new LikeRestrictionOfstring();
            customerIdRestriction.EqualValue = "AARONFIT0001";

            // Retrieve only receivables documents with a type of service repair
            documentTypeRestriction = new ListRestrictionOfNullableOfReceivablesDocumentType();
            documentTypeRestriction.EqualValue = ReceivablesDocumentType.ServiceRepair;

            // Create the receivables document criteria object
            receivablesCriteria = new ReceivablesDocumentCriteria();
            receivablesCriteria.CustomerId = customerIdRestriction;
            receivablesCriteria.Type = documentTypeRestriction;

            // Retrieve the list of receivables document summary objects
            documentSummaries = wsDynamicsGP.GetReceivablesDocumentList(receivablesCriteria, context);

            // Display the ID and amount of each member of the summary object list
            StringBuilder summaryList = new StringBuilder();
            foreach (ReceivablesDocumentSummary a in documentSummaries)
            {
                summaryList.AppendLine("Service repair date: " + a.Date.Value.ToShortDateString()
                + "  Amount: " + a.DocumentAmount.Value.ToString("C"));
            }
            MessageBox.Show(summaryList.ToString());

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