GetTaxScheduleByKey

Description

Retrieves a single tax schedule object based on the key value supplied.

Parameters

Return Value:

Interfaces

• Dynamics GP
• Common

Examples

The following C# example retrieves the tax schedule object with the tax schedule Id value "UKVAT-175". The description 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;
            TaxSchedule taxSchedule;
            TaxScheduleKey taxScheduleKey;

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

            // Create a tax schedule key
            taxScheduleKey = new TaxScheduleKey();
            taxScheduleKey.Id = "UKVAT-175";

            // Get the tax schedule object
            taxSchedule = wsDynamicsGP.GetTaxScheduleByKey(taxScheduleKey, context);

            // Display the description for the tax detail
            MessageBox.Show("Description: " + taxSchedule.TaxScheduleDescription);
        }
    }
}

** 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 taxSchedule;
            TaxScheduleKey taxSchedulelKey;

            // 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 tax schedule key
            taxSchedulelKey = new TaxScheduleKey();
            taxSchedulelKey.Id = "UKVAT-175";

            // Get the tax schedule object
            taxSchedule = wsDynamicsGP.GetTaxScheduleByKey(taxSchedulelKey, context);

            // Display the description for the tax schedule
            MessageBox.Show("Description: " + taxSchedule.TaxScheduleDescription);

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