GetSalesBackorderList

Description

Retrieves a list of sales backorder summary objects that match the specified criteria.

Parameters

Return Value:

Interfaces

• Dynamics GP
• Sales

Examples

The following C# example retrieves the list of sales backorder summary objects where the TransactionState property is equal to "Work". The Id and TotalAmount property from each sales backorder 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;
            ListRestrictionOfNullableOfSalesTransactionState transactionStateRestriction;
            SalesBackorderCriteria salesBackorderCriteria;
            SalesBackorderSummary[] salesBackorderSummary;

            // 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 a transaction state restriction object
            transactionStateRestriction = new ListRestrictionOfNullableOfSalesTransactionState();
            transactionStateRestriction.EqualValue = SalesTransactionState.Work;

            // Create a sales backorder criteria object
            salesBackorderCriteria = new SalesBackorderCriteria();
            salesBackorderCriteria.TransactionState = transactionStateRestriction;

            // Retrieve the sales backorder summary objects specified by the criteria object
            salesBackorderSummary = wsDynamicsGP.GetSalesBackorderList(salesBackorderCriteria, context);

            // Display the ID and amount of each member of the summary object list
            StringBuilder summaryList = new StringBuilder();
            foreach (SalesBackorderSummary a in salesBackorderSummary)
            {
                summaryList.AppendLine("Backorder number: " + a.Key.Id + "  Backordered amount: " +
                a.TotalAmount.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;
            ListRestrictionOfNullableOfSalesTransactionState transactionStateRestriction;
            SalesBackorderCriteria salesBackorderCriteria;
            SalesBackorderSummary[] salesBackorderSummary;

            // 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 a transaction state restriction object
            transactionStateRestriction = new ListRestrictionOfNullableOfSalesTransactionState();
            transactionStateRestriction.EqualValue = SalesTransactionState.Work;

            // Create a sales backorder criteria object
            salesBackorderCriteria = new SalesBackorderCriteria();
            salesBackorderCriteria.TransactionState = transactionStateRestriction;

            // Retrieve the sales backorder summary objects specified by the criteria object
            salesBackorderSummary = wsDynamicsGP.GetSalesBackorderList(salesBackorderCriteria, context);

            // Display the ID and amount of each member of the summary object list
            StringBuilder summaryList = new StringBuilder();
            foreach (SalesBackorderSummary a in salesBackorderSummary)
            {
                summaryList.AppendLine("Backorder number: " + a.Key.Id + "  Backordered amount: " +
                a.TotalAmount.Value.ToString("C"));
            }
            MessageBox.Show(summaryList.ToString());

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