GetSalesInvoiceList

Description

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

Parameters

Return Value:

Interfaces

• Dynamics GP
• Sales

Examples

The following C# example retrieves the list of sales invoice summary objects where the SalespersonId value is equal to “PAUL W.” and the TransactionState property is equal to “Work”. The Id and TotalAmount property from each sales invoice 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 salespersonIdRestriction;
			ListRestrictionOfNullableOfSalesTransactionState transactionStateRestriction;
			SalesInvoiceCriteria salesInvoiceCriteria;
			SalesInvoiceSummary[] salesInvoiceSummary;

			// 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 salesperson restriction object
			salespersonIdRestriction = new LikeRestrictionOfString();
			salespersonIdRestriction.EqualValue = "PAUL W.";

			// Create a transaction state restriction object
			// The SaleTransactionState enumeration specifies the transaction state
			transactionStateRestriction = new ListRestrictionOfNullableOfSalesTransactionState();
			transactionStateRestriction.EqualValue = SalesTransactionState.Work;

			// Create a sales invoice criteria object
			// Retrieve summary objects of unposted sales invoices for the specified salesperson
			salesInvoiceCriteria = new SalesInvoiceCriteria();
			salesInvoiceCriteria.TransactionState = transactionStateRestriction;
			salesInvoiceCriteria.SalespersonId = salespersonIdRestriction;

			// Retrieve the sales invoice summaries specified by the criteria object
			salesInvoiceSummary = wsDynamicsGP.GetSalesInvoiceList(salesInvoiceCriteria, context);

			// Display the ID and amount of each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (SalesInvoiceSummary a in salesInvoiceSummary)
			{
				summaryList.AppendLine("Invoice number: " + a.Key.Id + "  Invoice 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 salespersonIdRestriction;
			ListRestrictionOfNullableOfSalesTransactionState transactionStateRestriction;
			SalesInvoiceCriteria salesInvoiceCriteria;
			SalesInvoiceSummary[] salesInvoiceSummary;

			// 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 salesperson restriction object
			salespersonIdRestriction = new LikeRestrictionOfstring();
			salespersonIdRestriction.EqualValue = "PAUL W.";

			// Create a transaction state restriction object
			// The SaleTransactionState enumeration specifies the transaction state
			transactionStateRestriction = new ListRestrictionOfNullableOfSalesTransactionState();
			transactionStateRestriction.EqualValue = SalesTransactionState.Work;

			// Create a sales invoice criteria object
			// Retrieve summary objects of unposted sales invoices for the specified salesperson
			salesInvoiceCriteria = new SalesInvoiceCriteria();
			salesInvoiceCriteria.TransactionState = transactionStateRestriction;
			salesInvoiceCriteria.SalespersonId = salespersonIdRestriction;

			// Retrieve the sales invoice summaries specified by the criteria object
			salesInvoiceSummary = wsDynamicsGP.GetSalesInvoiceList(salesInvoiceCriteria, context);

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

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

Documentation Feedback

---