GetTaxScheduleDetailList

Description

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

Parameters

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

Return Value:

Value	Type	Description
GetTaxScheduleDetailListResult	ArrayOfTaxScheduleDetail	The list of tax schedule detail objects that match the specified criteria.

Interfaces

• Dynamics GP
• Common

Examples

The following C# example retrieves the list of tax schedule detail objects with for the tax schedule Id "UKVAT-175". A message box displays the number of tax schedule 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;
            TaxScheduleDetail[] taxScheduleDetails;
            TaxScheduleDetailCriteria taxScheduleDetailCriteria;
            LikeRestrictionOfString taxScheduleIdRestriction;

            // 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 schedule detail objects to retrieve
            taxScheduleIdRestriction = new LikeRestrictionOfString();
            taxScheduleIdRestriction.EqualValue = "UKVAT-175";
            taxScheduleDetailCriteria = new TaxScheduleDetailCriteria();
            taxScheduleDetailCriteria.TaxScheduleKeyId = taxScheduleIdRestriction;

            // Retrieve the list of tax schedule detail objects
            taxScheduleDetails = wsDynamicsGP.GetTaxScheduleDetailList(taxScheduleDetailCriteria, context);

            // Display the number of tax schedule details found
            MessageBox.Show("Tax schedules for UKVAT-175: " + taxScheduleDetails.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;
            TaxScheduleDetail[] taxScheduleDetails;
            TaxScheduleDetailCriteria taxScheduleDetailCriteria;
            LikeRestrictionOfstring taxScheduleIdRestriction;

            // 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 schedule detail objects to retrieve
            taxScheduleIdRestriction = new LikeRestrictionOfstring();
            taxScheduleIdRestriction.EqualValue = "UKVAT-175";
            taxScheduleDetailCriteria = new TaxScheduleDetailCriteria();
            taxScheduleDetailCriteria.TaxScheduleKeyId = taxScheduleIdRestriction;

            // Retrieve the list of tax schedule detail objects
            taxScheduleDetails = wsDynamicsGP.GetTaxScheduleDetailList(taxScheduleDetailCriteria, context);

            // Display the number of tax schedules found
            MessageBox.Show("Tax schedules for UKVAT-175: " + taxScheduleDetails.Length.ToString());

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