GetTaxDetailList

Description

Retrieves a list of tax detail objects that match the specified criteria.

Parameters

Parameter	Type	Description
criteria	TaxDetailCriteria	The tax detail criteria object that specifies which tax detail objects are returned.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetTaxDetailListResult	ArrayOfTaxDetail	The list of tax detail objects that match the specified criteria.

Interfaces

• Dynamics GP
• Common

Examples

The following C# example retrieves the list of tax detail objects with a tax detail Id that begins with "CAN", indicating they apply to Canadian taxes. A message box displays the number of tax detail objects found.

** 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;
            TaxDetail[] taxDetails;
            TaxDetailCriteria taxDetailCriteria;
            LikeRestrictionOfString taxDetailIdRestriction;

            // Create an instance of the service
            DynamicsGP wsDynamicsGP = new DynamicsGP();

            // Be sure that default credentials are being 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
            context.OrganizationKey = (OrganizationKey)companyKey;

            // Specify the criteria of the tax detail objects to retrieve
            taxDetailIdRestriction = new LikeRestrictionOfString();
            taxDetailIdRestriction.Like = "CAN%";
            taxDetailCriteria = new TaxDetailCriteria();
            taxDetailCriteria.TaxDetailKeyId = taxDetailIdRestriction;

            // Retrieve the list of tax detail objects
            taxDetails = wsDynamicsGP.GetTaxDetailList(taxDetailCriteria, context);

            // Display the number of tax details found
            MessageBox.Show("Tax details for Canada: " + taxDetails.Length.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;
            TaxDetail[] taxDetails;
            TaxDetailCriteria taxDetailCriteria;
            LikeRestrictionOfstring taxDetailIdRestriction;

            // 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;

            // Specify the criteria of the tax detail objects to retrieve
            taxDetailIdRestriction = new LikeRestrictionOfstring();
            taxDetailIdRestriction.Like = "CAN%";
            taxDetailCriteria = new TaxDetailCriteria();
            taxDetailCriteria.TaxDetailKeyId = taxDetailIdRestriction;

            // Retrieve the list of tax detail objects
            taxDetails = wsDynamicsGP.GetTaxDetailList(taxDetailCriteria, context);

            // Display the number of tax details found
            MessageBox.Show("Tax details for Canada: " + taxDetails.Length.ToString());

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