Tax\Rate represents single tax rate record associated with the Sales tax type.

GET
Retrieve tax rates by conditions

_cnd[limit]
array 
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array 
Sets sorting order field
default Success <XLite\Module\CDev\SalesTax\Model\Tax\Rate>[] array
Sample response
[{"id":53,"value":"example","type":"example","position":62,"tax":{"id":"integer","enabled":"boolean","rates":"<XLite\\Module\\CDev\\SalesTax\\Model\\Tax\\Rate>[] array"},"zone":{"zone_id":"integer","zone_name":"string","is_default":"boolean","zone_elements":"<XLite\\Model\\ZoneElement>[] array","shipping_markups":"<XLite\\Model\\Shipping\\Markup>[] array"},"taxClass":{"id":12,"position":54},"membership":{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"},"noTaxClass":false,"taxableBase":"example"}]

GET
Retrieve tax rate by id

id
integer Required
Id value of the Rate object
default Success <XLite\Module\CDev\SalesTax\Model\Tax\Rate>
Sample response
{"id":53,"value":"example","type":"example","position":62,"tax":{"id":"integer","enabled":"boolean","rates":"<XLite\\Module\\CDev\\SalesTax\\Model\\Tax\\Rate>[] array"},"zone":{"zone_id":"integer","zone_name":"string","is_default":"boolean","zone_elements":"<XLite\\Model\\ZoneElement>[] array","shipping_markups":"<XLite\\Model\\Shipping\\Markup>[] array"},"taxClass":{"id":12,"position":54},"membership":{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"},"noTaxClass":false,"taxableBase":"example"}
id
integer
Rate unique ID
value
string
Value
type
string
Type
position
integer
Position
tax
zone
taxClass
membership
noTaxClass
boolean
For product without tax class
taxableBase
string
Taxable base

PUT
Update tax rate by id

id
integer Required
Id value of the Rate object
<XLite\Module\CDev\SalesTax\Model\Tax\Rate>
id
integer
Rate unique ID
value
string
Value
type
string
Type
position
integer
Position
tax
zone
taxClass
membership
noTaxClass
boolean
For product without tax class
taxableBase
string
Taxable base
default Success <XLite\Module\CDev\SalesTax\Model\Tax\Rate>
Sample response
{"id":53,"value":"example","type":"example","position":62,"tax":{"id":"integer","enabled":"boolean","rates":"<XLite\\Module\\CDev\\SalesTax\\Model\\Tax\\Rate>[] array"},"zone":{"zone_id":"integer","zone_name":"string","is_default":"boolean","zone_elements":"<XLite\\Model\\ZoneElement>[] array","shipping_markups":"<XLite\\Model\\Shipping\\Markup>[] array"},"taxClass":{"id":12,"position":54},"membership":{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"},"noTaxClass":false,"taxableBase":"example"}
id
integer
Rate unique ID
value
string
Value
type
string
Type
position
integer
Position
tax
zone
taxClass
membership
noTaxClass
boolean
For product without tax class
taxableBase
string
Taxable base

DELETE
Delete tax rate by id

id
integer Required
Id value of the Rate object
default Success <XLite\Module\CDev\SalesTax\Model\Tax\Rate>
Sample response
{"id":53,"value":"example","type":"example","position":62,"tax":{"id":"integer","enabled":"boolean","rates":"<XLite\\Module\\CDev\\SalesTax\\Model\\Tax\\Rate>[] array"},"zone":{"zone_id":"integer","zone_name":"string","is_default":"boolean","zone_elements":"<XLite\\Model\\ZoneElement>[] array","shipping_markups":"<XLite\\Model\\Shipping\\Markup>[] array"},"taxClass":{"id":12,"position":54},"membership":{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"},"noTaxClass":false,"taxableBase":"example"}
id
integer
Rate unique ID
value
string
Value
type
string
Type
position
integer
Position
tax
zone
taxClass
membership
noTaxClass
boolean
For product without tax class
taxableBase
string
Taxable base

POST

<XLite\Module\CDev\SalesTax\Model\Tax\Rate>
id
integer
Rate unique ID
value
string
Value
type
string
Type
position
integer
Position
tax
zone
taxClass
membership
noTaxClass
boolean
For product without tax class
taxableBase
string
Taxable base
default Success <XLite\Module\CDev\SalesTax\Model\Tax\Rate>
Sample response
{"id":53,"value":"example","type":"example","position":62,"tax":{"id":"integer","enabled":"boolean","rates":"<XLite\\Module\\CDev\\SalesTax\\Model\\Tax\\Rate>[] array"},"zone":{"zone_id":"integer","zone_name":"string","is_default":"boolean","zone_elements":"<XLite\\Model\\ZoneElement>[] array","shipping_markups":"<XLite\\Model\\Shipping\\Markup>[] array"},"taxClass":{"id":12,"position":54},"membership":{"coupons":"<XLite\\Module\\CDev\\Coupons\\Model\\Coupon>[] array","membership_id":"integer","position":"integer","enabled":"boolean","quickData":"<XLite\\Model\\QuickData>[] array","categories":"<XLite\\Model\\Category>[] array","products":"<XLite\\Model\\Product>[] array"},"noTaxClass":false,"taxableBase":"example"}
id
integer
Rate unique ID
value
string
Value
type
string
Type
position
integer
Position
tax
zone
taxClass
membership
noTaxClass
boolean
For product without tax class
taxableBase
string
Taxable base