TaxRates

Returns a list of Tax Rates.

Table Specific Information

Select

The provider uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:

Id supports the = and IN comparisons.
TaxZoneId supports the = and IN comparisons.

The rest of the filter is executed client-side within the provider.

For example, the following queries are processed server-side:

SELECT * FROM TaxRates WHERE Id = 1

SELECT * FROM TaxRates WHERE TaxZoneId = 5

Insert

To insert a tax rate, specify the Name, TaxZoneId, and ClassRates columns. ClassRates must be a JSON-formatted array of tax-class rates. Note: For ClassRates fields, Default Tax Rate is must to include in the Array.

INSERT INTO TaxRates (Name, TaxZoneId, ClassRates) VALUES ('Standard Rate', 5, '[{"tax_class_id":1,"rate":7.5},{"tax_class_id":0,"rate":6.5}]')

Update

UPDATE TaxRates SET Enabled = false WHERE Id = 10

Delete

DELETE FROM TaxRates WHERE Id = 10

DELETE FROM TaxRates WHERE Id IN (10,11)

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	Internal identifier for the tax rate.
Name	String	False	Human-readable name for the tax rate.
Enabled	Boolean	False	Whether the tax rate is enabled. Defaults to true.
TaxZoneId	Integer	False	The Id of the tax zone this rate is associated with.
Priority	Integer	False	Determines the order rates are applied in and allows for compounding tax rates. Defaults to 1.
ClassRates	String	False	A JSON-formatted array of tax-class rates (tax_class_id, rate) for this tax rate. At least one entry is required to create a tax rate.