GetReceivablesServiceRepairList

Description

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

Parameters

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

Return Value:

Value	Type	Description
GetReceivablesServiceRepairListResult	ArrayOfReceivablesServiceRepairSummary	The list of receivables service repair summary objects that match the specified criteria.

Interfaces

• Dynamics GP
• Sales

Examples

The following C# example retrieves the list of receivables service repair summary objects where the salesperson Id is "Nancy B." and the transaction state is a "Open". The Date and DocumentAmount property from each receivables service repair 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 salespersonRestriction;
            ListRestrictionOfNullableOfReceivablesTransactionState transactionStateRestriction;
            ReceivablesServiceRepairCriteria serviceRepairCriteria;
            ReceivablesServiceRepairSummary[] repairSummaries;

            // 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 receivables repair documents with a transaction state of 'Open'
            transactionStateRestriction = new ListRestrictionOfNullableOfReceivablesTransactionState();
            transactionStateRestriction.EqualValue = ReceivablesTransactionState.Open;

            // Retrieve only receivables service repair document with a sales person Id like 'Nancy B.'
            salespersonRestriction = new LikeRestrictionOfString();
            salespersonRestriction.Like = "Nancy B.";

            // Create the receivables service repair criteria object and add the restriction objects
            serviceRepairCriteria = new ReceivablesServiceRepairCriteria();
            serviceRepairCriteria.SalespersonId = salespersonRestriction;
            serviceRepairCriteria.TransactionState = transactionStateRestriction;

            // Retrieve the list of receivables service repair summary objects
            repairSummaries = wsDynamicsGP.GetReceivablesServiceRepairList(serviceRepairCriteria, context);

            // Display the ID and amount of each member of the summary object list
            StringBuilder summaryList = new StringBuilder();
            foreach (ReceivablesServiceRepairSummary a in repairSummaries)
            {
                summaryList.AppendLine("Service 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 salespersonRestriction;
            ListRestrictionOfNullableOfReceivablesTransactionState transactionStateRestriction;
            ReceivablesServiceRepairCriteria serviceRepairCriteria;
            ReceivablesServiceRepairSummary[] repairSummaries;

            // 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 receivables repair documents with a transaction state of 'Open'
            transactionStateRestriction = new ListRestrictionOfNullableOfReceivablesTransactionState();
            transactionStateRestriction.EqualValue = ReceivablesTransactionState.Open;

            // Retrieve only receivables service repair document with a sales person Id like 'Nancy B.'
            salespersonRestriction = new LikeRestrictionOfstring();
            salespersonRestriction.Like = "Nancy B.";

            // Create the receivables service repair criteria object and add the restriction objects
            serviceRepairCriteria = new ReceivablesServiceRepairCriteria();
            serviceRepairCriteria.SalespersonId = salespersonRestriction;
            serviceRepairCriteria.TransactionState = transactionStateRestriction;

            // Retrieve the list of receivables service repair summary objects
            repairSummaries = wsDynamicsGP.GetReceivablesServiceRepairList(serviceRepairCriteria, context);

            // Display the ID and amount of each member of the summary object list
            StringBuilder summaryList = new StringBuilder();
            foreach (ReceivablesServiceRepairSummary a in repairSummaries)
            {
                summaryList.AppendLine("Service 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();
            }
        }
    }
}