TaxRateManager

The class manages commerce tax rates in the CMS.

Namespace

Ektron.Cms.Framework.Commerce.TaxRateManager

Constructors

  • TaxRateManager()
  • TaxRateManager(ApiAccessMode)

Properties

  • ApiMode. Gets or sets the current API access mode. If set to Admin, the API runs with the permissions of an administrator.
  • ApplicationPath. Gets the application path to the Workarea.
  • ContentLanguage. Gets or sets the current content language.
  • InPreviewMode. Gets or sets the preview mode and returns true if the site is in preview mode.
  • IsCommerceEnabled. Checks for a commerce license.
  • RequestInformation. Gets information about the current request.
  • SitePath. Gets the site path.
  • UserId. Gets or sets the ID of the currently logged-in user.

Methods

Add

Add(Ektron.Cms.Commerce.TaxRateData)

Adds a tax rate to the CMS. The Tax.Id property is populated with the new Tax's ID.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Rate
  • * Tax Class ID
  • * Type ID
  • * Type Item ID

Parameters

.aspx code snippet

<ol class="formFields">
<li class="clearfix">
    <ektronUI:Label ID="uxRateLabel" AssociatedControlID="uxRate" CssClass="span-4 last"
        runat="server" Text="* Rate:" />
    <ektronUI:TextField ID="uxRate" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
        Text="" />
</li>
<div class="ektronTopSpace"></div>
<li class="clearfix">
    <ektronUI:Label ID="uxTaxClassIdLabel" AssociatedControlID="uxTaxClassId" CssClass="span-4 last"
        runat="server" Text="* TaxClassId:" />
    <ektronUI:TextField ID="uxTaxClassId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
        Text="" />
</li>
<div class="ektronTopSpace"></div>
<li class="clearfix">
    <ektronUI:Label ID="uxTypeIdLabel" AssociatedControlID="uxTypeId" CssClass="span-4 last"
        runat="server" Text="* TypeId:" />
    <ektronUI:TextField ID="uxTypeId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
        Text="" />
</li>
<div class="ektronTopSpace"></div>
<li class="clearfix">
    <ektronUI:Label ID="uxTypeItemIdLabel" AssociatedControlID="uxTypeItemId" CssClass="span-4 last"
        runat="server" Text="* TypeItemId:" />
    <ektronUI:TextField ID="uxTypeItemId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
        Text="" />
</li>
<div class="ektronTopSpace"></div>
<li class="clearfix">
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</li>
</ol>        
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;
using Ektron.Cms;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {

            TaxRateManager taxRateManager = new TaxRateManager();
            TaxRateData taxRateData = new TaxRateData();
            taxRateData.Rate = decimal.Parse(uxRate.Text);
            taxRateData.TaxClassId = long.Parse(uxTaxClassId.Text);
            taxRateData.TypeId = long.Parse(uxTypeId.Text);
            taxRateData.TypeItemId = long.Parse(uxTypeItemId.Text);

            taxRateData = taxRateManager.Add(taxRateData);
            MessageUtilities.UpdateMessage(uxMessage, "TaxRateData is added with Id " + taxRateData.Id, Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Delete

Delete(System.Int64)

Deletes a tax rate from the CMS.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * ID

Parameters

  • taxRateId. ID of tax to delete.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxRateIdLabel" AssociatedControlID="uxTaxRateId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxTaxRateId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>        
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            TaxRateManager taxRateManager = new TaxRateManager();
            long ID = long.Parse(uxTaxRateId.Text);
            TaxRateData taxRateData = new TaxRateData();
            taxRateData = taxRateManager.GetItem(ID);
            if (ID > 0 && taxRateData != null)
            {
                taxRateManager.Delete(ID);
                MessageUtilities.UpdateMessage(uxMessage, "TaxRateData with Id " + uxTaxRateId.Text + " is deleted", Message.DisplayModes.Success);
            }
            else
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid TaxRate ID.", Message.DisplayModes.Error);

            uxPageMultiView.SetActiveView(uxViewMessage);
            
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

DeleteByCountry

DeleteByCountry(System.Int32)

Deletes all rates associated with a country.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * ID

Parameters

  • countryId. ID of country from which to delete rates.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCountryIdLabel" AssociatedControlID="uxCountryId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxCountryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="DeleteByCountry"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>        
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            TaxRateManager taxRateManager = new TaxRateManager();
            int ID = int.Parse(uxCountryId.Text);
            taxRateManager.DeleteByCountry(ID);
            MessageUtilities.UpdateMessage(uxMessage, "TaxRateData with countryId " + uxCountryId.Text + " is deleted", Message.DisplayModes.Success);

            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

DeleteByRegion

DeleteByRegion(System.Int64)

Deletes all rates associated with a region

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * ID

Parameters

  • regionId. ID of region from which to delete rates.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxRegionIdLabel" AssociatedControlID="uxRegionId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxRegionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="DeleteByRegion"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>        
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            TaxRateManager taxRateManager = new TaxRateManager();
            long ID = long.Parse(uxRegionId.Text);
            taxRateManager.DeleteByRegion(ID);
            MessageUtilities.UpdateMessage(uxMessage, "TaxRateData with regionId " + uxRegionId.Text + " is deleted", Message.DisplayModes.Success);

            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetApplicableTaxRate

GetApplicableTaxRate(Ektron.Cms.Commerce.AddressData,Ektron.Cms.Commerce.AddressData,System.Int64)

Returns the applicable tax rate for the supplied addresses and tax class.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Tax Class ID

Shipping From Address

  • * Shipping From Address Name
  • * Address Line 1
  • * City
  • * Region ID
  • * Postal Code
  • * Country ID

Shipping To Address

  • * Shipping To Address Name
  • * Address Line 1
  • * City
  • * Region ID
  • * Postal Code
  • * Country ID

Parameters

  • shipFromAddress. Address where the products are coming from.
  • shipToAddress. Address where products are going.
  • taxClassId. The taxClass for which to retrieve a rate.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxClassIdLabel" AssociatedControlID="uxTaxClass" CssClass="span-6 last" runat="server" Text="* TaxClassId: " />
        <ektronUI:TextField ID="uxTaxClass" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <b>Shipping From Address</b>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingFromAddressNameLabel" AssociatedControlID="uxShippingFromAddressName" CssClass="span-6 last"
            runat="server" Text="* Shipping From AddressName :" />
        <ektronUI:TextField ID="uxShippingFromAddressName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingFromAddressLine1Label" AssociatedControlID="uxShippingFromAddressLine1" CssClass="span-6 last"
            runat="server" Text="* AddressLine1 :" />
        <ektronUI:TextField ID="uxShippingFromAddressLine1" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingFromCityLabel" AssociatedControlID="uxShippingFromCity" CssClass="span-6 last"
            runat="server" Text="* City :" />
        <ektronUI:TextField ID="uxShippingFromCity" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingFromRegionIdLabel" AssociatedControlID="uxShippingFromRegionId" CssClass="span-6 last"
            runat="server" Text="* RegionId :" />
        <ektronUI:TextField ID="uxShippingFromRegionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingFromPostalCodeLabel" AssociatedControlID="uxShippingFromPostalCode" CssClass="span-6 last"
            runat="server" Text="* PostalCode :" />
        <ektronUI:TextField ID="uxShippingFromPostalCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingFromCountryIdLabel" AssociatedControlID="uxShippingFromCountryId" CssClass="span-6 last"
            runat="server" Text="* CountryId :" />
        <ektronUI:TextField ID="uxShippingFromCountryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>  
    <li class="clearfix">
        <b>Shipping To Address</b>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingToAddressNameLabel" AssociatedControlID="uxShippingToAddressName" CssClass="span-6 last"
            runat="server" Text="* Shipping To AddressName :" />
        <ektronUI:TextField ID="uxShippingToAddressName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingToAddressLine1Label" AssociatedControlID="uxShippingToAddressLine1" CssClass="span-6 last"
            runat="server" Text="* AddressLine1 :" />
        <ektronUI:TextField ID="uxShippingToAddressLine1" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingToCityLabel" AssociatedControlID="uxShippingToCity" CssClass="span-6 last"
            runat="server" Text="* City :" />
        <ektronUI:TextField ID="uxShippingToCity" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingToRegionIdLabel" AssociatedControlID="uxShippingToRegionId" CssClass="span-6 last"
            runat="server" Text="* RegionId :" />
        <ektronUI:TextField ID="uxShippingToRegionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingToPostalCodeLabel" AssociatedControlID="uxShippingToPostalCode" CssClass="span-6 last"
            runat="server" Text="* PostalCode :" />
        <ektronUI:TextField ID="uxShippingToPostalCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingToCountryIdLabel" AssociatedControlID="uxShippingToCountryId" CssClass="span-6 last"
            runat="server" Text="* CountryId :" />
        <ektronUI:TextField ID="uxShippingToCountryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>  
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetApplicableTaxRate"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Message ID="uxMessage" DisplayMode="Information" Visible="false" runat="server" />
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxRate" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxTaxClassId" runat="server"></asp:Literal>
    </li>
        <li class="clearfix">
        <asp:Literal ID="uxTypeId" runat="server"></asp:Literal>
    </li>
        <li class="clearfix">
        <asp:Literal ID="uxTypeItemId" runat="server"></asp:Literal>
    </li>
</ol>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            TaxRateManager taxRateManager = new TaxRateManager();
            TaxRateData taxRateData = new TaxRateData();
            long taxClassId = long.Parse(uxTaxClassId.Text);

            //ShippingFromAddress Information
            AddressData shippingFromAddress = new AddressData();
            shippingFromAddress.Name = uxShippingFromAddressName.Text;
            shippingFromAddress.AddressLine1 = uxShippingFromAddressLine1.Text;
            shippingFromAddress.City = uxShippingFromCity.Text;
            shippingFromAddress.Region = new RegionData { Id = long.Parse(uxShippingFromRegionId.Text) };
            shippingFromAddress.PostalCode = uxShippingFromPostalCode.Text;
            shippingFromAddress.Country = new CountryData { Id = int.Parse(uxShippingFromCountryId.Text) };

            //ShippingToAddress Information
            AddressData shippingToAddress = new AddressData();
            shippingToAddress.Name = uxShippingToAddressName.Text;
            shippingToAddress.AddressLine1 = uxShippingToAddressLine1.Text;
            shippingToAddress.City = uxShippingToCity.Text;
            shippingToAddress.Region = new RegionData { Id = long.Parse(uxShippingToRegionId.Text) };
            shippingToAddress.PostalCode = uxShippingToPostalCode.Text;
            shippingToAddress.Country = new CountryData { Id = int.Parse(uxShippingToCountryId.Text) };

            taxRateData = taxRateManager.GetApplicableTaxRate(shippingFromAddress, shippingToAddress,taxClassId);
            if (taxRateData != null)
            {

                MessageUtilities.UpdateMessage(uxMessage, "Details for Tax rate data Id " + taxRateData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxRate.Text = "Rate : " + taxRateData.Rate;
                uxTaxClassId.Text = "TaxClassId : " + taxRateData.TaxClassId;
                uxTypeId.Text = "TypeId : " + taxRateData.TypeId;
                uxTypeItemId.Text = "TypeItemId : " + taxRateData.TypeItemId;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Either Tax rate does not exist ", Message.DisplayModes.Error);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetApplicableTaxRateList

GetApplicableTaxRateList(Ektron.Cms.Commerce.AddressData,Ektron.Cms.Commerce.AddressData)

Returns a list of applicable tax rates for the supplied addresses. There is at most one rate for each available tax class for the specified addresses.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

Shipping From Address

  • * Shipping From Address Name
  • * Address Line 1
  • * City
  • * Region ID
  • * Postal Code
  • * Country ID

Shipping To Address

  • * Shipping To Address Name
  • * Address Line 1
  • * City
  • * Region ID
  • * Postal Code
  • * Country ID

Parameters

  • shipFromAddress. Address where the products are coming from.
  • shipToAddress. Address where products are going.

.aspx code snippet

<ol class="formFields">                   
    <li class="clearfix">
        <b>Shipping From Address</b>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingFromAddressNameLabel" AssociatedControlID="uxShippingFromAddressName" CssClass="span-5 last"
            runat="server" Text="* Shipping From AddressName :" />
        <ektronUI:TextField ID="uxShippingFromAddressName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingFromAddressLine1Label" AssociatedControlID="uxShippingFromAddressLine1" CssClass="span-5 last"
            runat="server" Text="* AddressLine1 :" />
        <ektronUI:TextField ID="uxShippingFromAddressLine1" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingFromCityLabel" AssociatedControlID="uxShippingFromCity" CssClass="span-5 last"
            runat="server" Text="* City :" />
        <ektronUI:TextField ID="uxShippingFromCity" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingFromRegionIdLabel" AssociatedControlID="uxShippingFromRegionId" CssClass="span-5 last"
            runat="server" Text="* RegionId :" />
        <ektronUI:TextField ID="uxShippingFromRegionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingFromPostalCodeLabel" AssociatedControlID="uxShippingFromPostalCode" CssClass="span-5 last"
            runat="server" Text="* PostalCode :" />
        <ektronUI:TextField ID="uxShippingFromPostalCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingFromCountryIdLabel" AssociatedControlID="uxShippingFromCountryId" CssClass="span-5 last"
            runat="server" Text="* CountryId :" />
        <ektronUI:TextField ID="uxShippingFromCountryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>  
    <li class="clearfix">
        <b>Shipping To Address</b>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingToAddressNameLabel" AssociatedControlID="uxShippingToAddressName" CssClass="span-5 last"
            runat="server" Text="* Shipping To AddressName :" />
        <ektronUI:TextField ID="uxShippingToAddressName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingToAddressLine1Label" AssociatedControlID="uxShippingToAddressLine1" CssClass="span-5 last"
            runat="server" Text="* AddressLine1 :" />
        <ektronUI:TextField ID="uxShippingToAddressLine1" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingToCityLabel" AssociatedControlID="uxShippingToCity" CssClass="span-5 last"
            runat="server" Text="* City :" />
        <ektronUI:TextField ID="uxShippingToCity" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingToRegionIdLabel" AssociatedControlID="uxShippingToRegionId" CssClass="span-5 last"
            runat="server" Text="* RegionId :" />
        <ektronUI:TextField ID="uxShippingToRegionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingToPostalCodeLabel" AssociatedControlID="uxShippingToPostalCode" CssClass="span-5 last"
            runat="server" Text="* PostalCode :" />
        <ektronUI:TextField ID="uxShippingToPostalCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingToCountryIdLabel" AssociatedControlID="uxShippingToCountryId" CssClass="span-5 last"
            runat="server" Text="* CountryId :" />
        <ektronUI:TextField ID="uxShippingToCountryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>  
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetApplicableTaxRateList"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-5" runat="server" Text="* - Required" /> 
    </li>
</ol>
<ektronUI:Message ID="uxMessage" DisplayMode="Information" Visible="false" runat="server" />
    <asp:ListView ID="uxtaxRateDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                <th>Id</th>
                <th>Rate</th>
                <th>TaxClassId</th>
                <th>TypeId</th>
                <th>TypeItemId</th>
                </tr>
            </thead>
            <tbody>
            <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Id")%>
            </td>
                <td class="devsite-method">
                <%# Eval("Rate")%>
            </td>
            <td class="devsite-method">
                <%# Eval("TaxClassId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("TypeId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("TypeItemId")%>
            </td>                        
        </tr>
    </ItemTemplate>
</asp:ListView>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Common;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            TaxRateManager taxRateManager = new TaxRateManager();
            TaxRateData taxRateData = new TaxRateData();
            
            //ShippingFromAddress Information
            AddressData shippingFromAddress = new AddressData();
            shippingFromAddress.Name = uxShippingFromAddressName.Text;
            shippingFromAddress.AddressLine1 = uxShippingFromAddressLine1.Text;
            shippingFromAddress.City = uxShippingFromCity.Text;
            shippingFromAddress.Region = new RegionData { Id = long.Parse(uxShippingFromRegionId.Text) };
            shippingFromAddress.PostalCode = uxShippingFromPostalCode.Text;
            shippingFromAddress.Country = new CountryData { Id = int.Parse(uxShippingFromCountryId.Text) };

            //ShippingToAddress Information
            AddressData shippingToAddress = new AddressData();
            shippingToAddress.Name = uxShippingToAddressName.Text;
            shippingToAddress.AddressLine1 = uxShippingToAddressLine1.Text;
            shippingToAddress.City = uxShippingToCity.Text;
            shippingToAddress.Region = new RegionData { Id = long.Parse(uxShippingToRegionId.Text) };
            shippingToAddress.PostalCode = uxShippingToPostalCode.Text;
            shippingToAddress.Country = new CountryData { Id = int.Parse(uxShippingToCountryId.Text) };

            List<TaxRateData> taxRateDataList = taxRateManager.GetApplicableTaxRateList(shippingFromAddress, shippingToAddress);

            uxtaxRateDataListView.Visible = true;
            uxtaxRateDataListView.DataSource = taxRateDataList;
            uxtaxRateDataListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(System.Int64)

Gets a Tax Rate based upon Tax Rate ID.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * ID

Parameters

  • taxRateId. ID of tax rate to retrieve.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxRateIdLabel" AssociatedControlID="uxTaxRateId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxTaxRateId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>  
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Item"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
    </ol>
   <ol class="formFields">
        <li class="clearfix">
            <ektronUI:Message ID="uxMessage" DisplayMode="Information" Visible="false" runat="server" />
        </li>
        <li class="clearfix">
            <asp:Literal ID="uxRate" runat="server"></asp:Literal>
        </li>
        <li class="clearfix">
            <asp:Literal ID="uxTaxClassId" runat="server"></asp:Literal>
        </li>
            <li class="clearfix">
            <asp:Literal ID="uxTypeId" runat="server"></asp:Literal>
        </li>
            <li class="clearfix">
            <asp:Literal ID="uxTypeItemId" runat="server"></asp:Literal>
        </li>
   </ol>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long taxRateId = long.Parse(uxTaxRateId.Text);

            TaxRateManager taxRateManager = new TaxRateManager();
            TaxRateData taxRateData = new TaxRateData();
            taxRateData = taxRateManager.GetItem(taxRateId);
            if (taxRateData != null)
            {

                MessageUtilities.UpdateMessage(uxMessage, "Details for Tax rate data Id " + taxRateData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxRate.Text = "Rate : " + taxRateData.Rate;
                uxTaxClassId.Text = "TaxClassId : " + taxRateData.TaxClassId;
                uxTypeId.Text = "TypeId : " + taxRateData.TypeId;
                uxTypeItemId.Text = "TypeItemId : " + taxRateData.TypeItemId;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Either Tax rate with Id " + taxRateId + " does not exist ", Message.DisplayModes.Error);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList

GetList(Ektron.Cms.Commerce.TaxRateCriteria)

Gets a list of rates based upon the supplied criteria.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Tax Rate Property
  • * Object Value

Parameters

  • criteria. Criteria by which to filter and sort tax rates.

Criteria use

The DataProperty enum works with its criteria class and defines the properties that the Manager class uses to filter and order. Specify zero (0) or more criteria to retrieve the objects you want. The criteria object also lets you set the number of items to return, define paging data, and modify sorting.

Criteria objects
  • Condition. The Logical operator to apply to the filters. The default value is "AND". The criteria condition controls the operator for the default filter group and the AND-ing\Or-ing the filter groups together.
    public Ektron.Cms.Common.LogicalOperation Condition { set; get; }
  • FilterGroups. Gets a list of filter groups. Filter groups can be created to do filter grouping (that is, parentheses in the where clause). The groups use the criteria's condition like other filters, but can use their own condition internally.
    public 
  System.Collections.Generic.List<CriteriaFilterGroup<ActivityCommentProperty>> 
  FilterGroups { get; }
  • Filters. Lists of filters defined in this criteria object. To add new Filters, you can add them here or use the AddFilter method (recommended).
    public 
  System.Collections.Generic.List<CriteriaFilter<ActivityCommentProperty>> 
  Filters { get; }
  • GroupByField. The group by field to apply to the results.
    public 
  Ektron.Cms.Activity.ActivityCommentProperty 
  GroupByField { set; get; }
  • OrderByDirection. Sets the order direction (ascending or descending).
    public EkEnumeration.OrderByDirection 
  OrderByDirection { set; get; }
  • OrderByField . Set the property used to order the results.
    public Ektron.Cms.Activity.ActivityCommentProperty 
  OrderByField { set; get; }
  • PagingInfo. By default, page size is 50 for improved performance. Example paging Info: 
    PagingInfo pageinfo = new PagingInfo();
pageinfo.CurrentPage=1;
pageinfo.RecordsPerPage = 100;
criteria.PagingInfo = pageinfo;
Constructor(property, orderbyDirection)

Sorts the results by a property in ascending or descending order.

AddFilter(property, operator, value)

Filters the results based on the conditions defined in this method.

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo, Objectvalue);
LogicalOperation Condition

Filters the array of items based on the logical condition set in the AddFilter properties. 

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo,Objectvalue);
List<CriteriaFilterGroup> FilterGroups

Binds data to a listview or gridview.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTaxRatePropertyLabel" AssociatedControlID="uxTaxRate" CssClass="span-5 last" runat="server" Text="* TaxRate Property:" />
        <asp:DropDownList ID="uxTaxRate" runat="server">
            <asp:ListItem>RateId</asp:ListItem>
            <asp:ListItem>Rate</asp:ListItem>
            <asp:ListItem>TaxClassId</asp:ListItem>
            <asp:ListItem>CountryId</asp:ListItem>
            <asp:ListItem>RegionId</asp:ListItem>
            <asp:ListItem>PostalCode</asp:ListItem>
            <asp:ListItem>TaxTypeId</asp:ListItem>
            <asp:ListItem>TaxTypeItemId</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-5 last" runat="server" Text="* ObjectValue:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-5" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<ektronUI:Message ID="uxMessage" DisplayMode="Information" Visible="false" runat="server" />       
<asp:View ID="uxViewMessage" runat="server">
<asp:ListView ID="uxtaxRateDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
<EmptyDataTemplate >Criteria didn't match the records.</EmptyDataTemplate>
<LayoutTemplate>
    <table class="devsite-api-method">
        <thead>
            <tr>
            <th>Id</th>
            <th>Rate</th>
            <th>TaxClassId</th>
            <th>TypeId</th>
            <th>TypeItemId</th>
            </tr>
        </thead>
        <tbody>
          <asp:PlaceHolder ID="aspItemPlaceholder" runat="server">
          </asp:PlaceHolder>
        </tbody>
    </table>
</LayoutTemplate>
<ItemTemplate>
    <tr>
        <td class="devsite-method">
            <%# Eval("Id")%>
        </td>
            <td class="devsite-method">
            <%# Eval("Rate")%>
        </td>
        <td class="devsite-method">
            <%# Eval("TaxClassId")%>
        </td>
        <td class="devsite-method">
            <%# Eval("TypeId")%>
        </td>
        <td class="devsite-method">
            <%# Eval("TypeItemId")%>
        </td>                        
    </tr>
</ItemTemplate>
</asp:ListView>
</asp:View>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Common;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            object Objectvalue;

            TaxRateManager taxRateManager = new TaxRateManager();
            TaxRateCriteria criteria = new TaxRateCriteria();

            if (uxTaxRate.SelectedItem.Text == "RateId")
            {
                Objectvalue = long.Parse(uxObjectValue.Text);
                criteria.AddFilter(TaxRateProperty.RateId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxTaxRate.SelectedItem.Text == "Rate")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(TaxRateProperty.Rate, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxTaxRate.SelectedItem.Text == "TaxClassId")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(TaxRateProperty.TaxClassId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxTaxRate.SelectedItem.Text == "CountryId")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(TaxRateProperty.CountryId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxTaxRate.SelectedItem.Text == "RegionId")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(TaxRateProperty.RegionId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxTaxRate.SelectedItem.Text == "PostalCode")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(TaxRateProperty.PostalCode, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxTaxRate.SelectedItem.Text == "TaxTypeId")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(TaxRateProperty.TaxTypeId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(TaxRateProperty.TaxTypeItemId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            List<TaxRateData> taxRateDataList = taxRateManager.GetList(criteria);

            uxtaxRateDataListView.Visible = true;
            uxtaxRateDataListView.DataSource = taxRateDataList;
            uxtaxRateDataListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Update

Update(Ektron.Cms.Commerce.TaxRateData)

Updates an existing tax rate in the CMS.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • ID
  • * Rate
  • * Tax Class ID
  • * Type ID
  • * Type Item ID

Parameters

.aspx code snippet

<ol class="formFields">
<li class="clearfix">
    <ektronUI:Label ID="uxTaxRateIdLabel" AssociatedControlID="uxTaxRateId" CssClass="span-4 last" runat="server" Text=" Id:" />
    <ektronUI:TextField ID="uxTaxRateId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxRateLabel" AssociatedControlID="uxRate" CssClass="span-4 last"
    runat="server" Text="* Rate:" />
<ektronUI:TextField ID="uxRate" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
    Text="" />
</li>
<div class="ektronTopSpace"></div>
<li class="clearfix">
<ektronUI:Label ID="uxTaxClassIdLabel" AssociatedControlID="uxTaxClassId" CssClass="span-4 last"
    runat="server" Text="* TaxClassId:" />
<ektronUI:TextField ID="uxTaxClassId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
    Text="" />
</li>
<div class="ektronTopSpace"></div>
<li class="clearfix">
<ektronUI:Label ID="uxTypeIdLabel" AssociatedControlID="uxTypeId" CssClass="span-4 last"
    runat="server" Text="* TypeId:" />
<ektronUI:TextField ID="uxTypeId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
    Text="" />
</li>
<div class="ektronTopSpace"></div>
<li class="clearfix">
<ektronUI:Label ID="uxTypeItemIdLabel" AssociatedControlID="uxTypeItemId" CssClass="span-4 last"
    runat="server" Text="* TypeItemId:" />
<ektronUI:TextField ID="uxTypeItemId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
    Text="" />
</li>
<div class="ektronTopSpace"></div>
<li class="clearfix">
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</li>
</ol>           
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.IO;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long taxRateId = long.Parse(uxTaxRateId.Text);
            TaxRateManager taxRateManager = new TaxRateManager();
            TaxRateData taxRateData = new TaxRateData();
            taxRateData = taxRateManager.GetItem(taxRateId);
            if (taxRateId > 0 && taxRateData != null)
            {
                taxRateData.Rate = decimal.Parse(uxRate.Text);
                taxRateData.TaxClassId = long.Parse(uxTaxClassId.Text);
                taxRateData.TypeId = long.Parse(uxTypeId.Text);
                taxRateData.TypeItemId = long.Parse(uxTypeItemId.Text);
                taxRateData = taxRateManager.Update(taxRateData);
                MessageUtilities.UpdateMessage(uxMessage, "TaxRateData Updated with Id " + taxRateData.Id, Message.DisplayModes.Success);
                
            }               
            else
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid TaxRate ID.", Message.DisplayModes.Error);
                
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Data Classes

TaxRateCriteria

Namespace

Ektron.Cms.Commerce

Constructors

  • TaxRateCriteria()
    public TaxRateCriteria()
  • TaxRateCriteria(Ektron.Cms.Commerce.TaxRateProperty, EkEnumeration.OrderByDirection)
    public TaxRateCriteria(Ektron.Cms.Commerce.TaxRateProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the TaxRateProperty are:

    • Country
    • CountryId
    • PostalCode
    • Rate
    • RateId
    • Region
    • RegionId
    • TaxClassId
    • TaxClassName
    • TaxTypeId
    • TaxTypeItemId
    • TaxTypeName
    • TaxTypePreference

TaxRateData

Namespace

Ektron.Cms.Commerce

Properties

  • Id. Gets or sets the ID of the TaxRate.
    public long Id { set; get; }
  • Rate. Gets or sets the actual rate for this TaxRate object. Should be entered in decimal format - i.e. .075 for 7.5%.
    public decimal Rate { set; get; }
  • TaxClassId. Gets or sets the ID of the tax class that this rate applies to.
    public long TaxClassId { set; get; }
  • TaxRateData()
    public TaxRateData()
  • TaxRateData(long, long, decimal)
    public TaxRateData(long typeId, long typeItemId,
  long taxClassId, decimal rate)
  • TaxRateData(long, long, decimal, long)
    public TaxRateData(long typeId, long typeItemId,
  long taxClassId, decimal rate, long id)
  • TypeId. Gets or sets the type of the Tax Rate.
    public long TypeId { set; get; }
  • TypeItemId. Gets or sets the ID of the tax type object this tax rate applies to. For instance, for a region sales tax, TypeItemId would be the ID of the corresponding region.
    public long TypeItemId { set; get; }