GetSalesQuoteList


Description

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

Parameters

Parameter

Type

Description

criteria

SalesQuoteCriteria

A sales quote criteria object that specifies which sales quote summary objects are returned.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetSalesQuoteListResult

ArrayOfSalesQuoteSummary

The list of sales quote summary objects that match the specified criteria.


Interfaces

 

Examples

The following C# example retrieves the list of sales quote summary objects where the Batch ID equals “SALES QUOTES”. The Id and amount property from each sales quote 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;
			LikeRestrictionOfString batchIdRestriction;
			SalesQuoteCriteria salesQuoteCriteria;
			SalesQuoteSummary[] salesQuoteSummaries;

			// 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 restriction object
			// Retrieve all sales quotes for a specified batch ID
			batchIdRestriction = new LikeRestrictionOfString();
			batchIdRestriction.EqualValue = "SALES QUOTES";

			// Create a sales quote criteria object
			salesQuoteCriteria = new SalesQuoteCriteria();
			salesQuoteCriteria.BatchId = batchIdRestriction;

			// Retrieve the list of sales quote summary objects
			salesQuoteSummaries = wsDynamicsGP.GetSalesQuoteList(salesQuoteCriteria, context);

			// Display the ID and amount of each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (SalesQuoteSummary a in salesQuoteSummaries)
			{
				summaryList.AppendLine("Sales quote: " + a.Key.Id + "  Quote 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.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			LikeRestrictionOfstring batchIdRestriction;
			SalesQuoteCriteria salesQuoteCriteria;
			SalesQuoteSummary[] salesQuoteSummaries;

			// 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 restriction object
			// Retrieve all sales quotes for a specified batch ID
			batchIdRestriction = new LikeRestrictionOfstring();
			batchIdRestriction.EqualValue = "SALES QUOTES";

			// Create a sales quote criteria object
			salesQuoteCriteria = new SalesQuoteCriteria();
			salesQuoteCriteria.BatchId = batchIdRestriction;

			// Retrieve the list of sales quote summary objects
			salesQuoteSummaries = wsDynamicsGP.GetSalesQuoteList(salesQuoteCriteria, context);

			// Display the ID and amount of each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (SalesQuoteSummary a in salesQuoteSummaries)
			{
				summaryList.AppendLine("Sales quote: " + a.Key.Id + "  Quote amount: " +
				a.TotalAmount.Value.ToString("C"));
		}
			MessageBox.Show(summaryList.ToString());

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


Documentation Feedback