TaxScheduleDTO Object

Overview

The REST API makes extensive use of the TaxScheduleDTO object whenever working with a tax schedule.  This article will help you to know the various members of this object.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of REST and API’s
  • Understanding of C# and/or JavaScript

Getting Started

There are no tasks needed to get started with understanding this object. 

taxScheduleDTO

The TaxScheduleDTO object will contain all of the details of a single tax schedule for your Hotcakes Commerce store.

Members

The following table gives you details on the various members of the TaaxScheduleDTO object.  The descriptions are based upon default functionality and the default Viewset included with Hotcakes.

Member Default Description
DefaultRate 0 This is used only for VAT implementations to help calculate the correct taxes per VAT rules.
DefaultShippingRate 0 This is used only for VAT implementations to help calculate the correct taxes for shipping per VAT rules.
Id 0 The unique identifier or primary key of the tax schedule object
Name (empty string) The name of the tax schedule. This will be seen in the administration areas.
StoreId 0 The date/time stamp that the referral was made, used for auditing purposes only.

 

Example of CategoryDTO

{
   "Errors":[

   ],
   "Content":{
      "Id":1,
      "StoreId":1,
      "Name":"Holiday Tax Schedule",
      "DefaultRate":0,
      "DefaultShippingRate":0
   }
}
Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.