GetTaxScheduleList

Dynamics

Description

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

Parameters

Parameter

Type

Description

criteria

TaxScheduleCriteria

The tax schedule criteria object that specifies which tax schedule objects are returned.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetTaxScheduleListResult

ArrayOfTaxSchedule

The list of tax schedule objects that match the specified criteria.


Interfaces

  • Dynamics GP
  • Common

Examples

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

Gg133637.LegacyEndpoint(en-us,MSDN.10).gif 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;
            TaxSchedule[] taxSchedules;
            TaxScheduleCriteria taxScheduleCriteria;
            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 objects to retrieve
            taxScheduleIdRestriction = new LikeRestrictionOfString();
            taxScheduleIdRestriction.Like = "CAN%";
            taxScheduleCriteria = new TaxScheduleCriteria();
            taxScheduleCriteria.TaxScheduleKeyId = taxScheduleIdRestriction;

            // Retrieve the list of tax schedule objects
            taxSchedules = wsDynamicsGP.GetTaxScheduleList(taxScheduleCriteria, context);

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

Gg133637.NativeEndpoint(en-us,MSDN.10).gif 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;
            TaxSchedule[] taxSchedules;
            TaxScheduleCriteria taxScheduleCriteria;
            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 objects to retrieve
            taxScheduleIdRestriction = new LikeRestrictionOfstring();
            taxScheduleIdRestriction.Like = "CAN%";
            taxScheduleCriteria = new TaxScheduleCriteria();
            taxScheduleCriteria.TaxScheduleKeyId = taxScheduleIdRestriction;

            // Retrieve the list of tax schedule objects
            taxSchedules = wsDynamicsGP.GetTaxScheduleList(taxScheduleCriteria, context);

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

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