GetInventoryVarianceList


Description

Retrieves a list of inventory variance summary objects that meet the specified criteria.

Parameters

Parameter

Type

Description

criteria

InventoryVarianceCriteria

The inventory variance criteria object that specifies which inventory variance summary objects to retrieve.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetInventoryVarianceListResult

ArrayOfInventoryVarianceSummary

A list of the inventory variance summary objects that match the specified criteria.


Interfaces

 

Examples

The following C# example retrieves the list of inventory variance summary objects with a transaction state of “History”. A message box displays the variance document number and date for each inventory variance in the list.

 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;
			ListRestrictionOfNullableOfInventoryTransactionState transactionStateRestriction;
			InventoryVarianceCriteria inventoryVarianceCriteria;
			InventoryVarianceSummary[] inventoryVarianceSummaries;

			// 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 inventory variance summary objects with a transaction state of 'History'
			transactionStateRestriction = new ListRestrictionOfNullableOfInventoryTransactionState();
			transactionStateRestriction.EqualValue = InventoryTransactionState.History;

			// Create an inventory variance criteria object
			inventoryVarianceCriteria = new InventoryVarianceCriteria();
			inventoryVarianceCriteria.TransactionState = transactionStateRestriction;

			// Retrieve the list of inventory variance summary objects
			inventoryVarianceSummaries = wsDynamicsGP.GetInventoryVarianceList(
			inventoryVarianceCriteria, context);

			// Display the ID and amount of each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (InventoryVarianceSummary a in inventoryVarianceSummaries)
			{
				summaryList.AppendLine("Variance number: " + a.Key.Id + " Date: " +
				a.Date.Value.ToShortDateString());
		}
			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;
			ListRestrictionOfNullableOfInventoryTransactionState transactionStateRestriction;
			InventoryVarianceCriteria inventoryVarianceCriteria;
			InventoryVarianceSummary[] inventoryVarianceSummaries;

			// 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 inventory variance summary objects with a transaction state of 'History'
			transactionStateRestriction = new ListRestrictionOfNullableOfInventoryTransactionState();
			transactionStateRestriction.EqualValue = InventoryTransactionState.History;

			// Create an inventory variance criteria object
			inventoryVarianceCriteria = new InventoryVarianceCriteria();
			inventoryVarianceCriteria.TransactionState = transactionStateRestriction;

			// Retrieve the list of inventory variance summary objects
			inventoryVarianceSummaries = wsDynamicsGP.GetInventoryVarianceList(
			inventoryVarianceCriteria, context);

			// Display the ID and amount of each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (InventoryVarianceSummary a in inventoryVarianceSummaries)
			{
				summaryList.AppendLine("Variance number: " + a.Key.Id + " Date: " +
				a.Date.Value.ToShortDateString());
		}
			MessageBox.Show(summaryList.ToString());

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


Documentation Feedback