Znode

GET taxrules

Gets a list of tax rules.

Request Information

» Expands

Name Description Usage
taxClass This will retrieve the related tax class. GET taxrules?expand=taxclass
taxRuleType This will retrieve the related tax rule type. GET taxrules?expand=taxruletype

» Filters

Name Description Usage
countryCode This will filter the request by country code. GET taxrules?filter=countrycode~{operator}~{value}
externalId This will filter the request by external ID. GET taxrules?filter=externalid~{operator}~{value}
portalId This will filter the request by portal ID. GET taxrules?filter=portalid~{operator}~{value}
stateCode This will filter the request by state code. GET taxrules?filter=statecode~{operator}~{value}
taxClassId This will filter the request by tax class ID. GET taxrules?filter=taxclassid~{operator}~{value}
taxRuleTypeId This will filter the request by tax rule type ID. GET taxrules?filter=taxruletypeid~{operator}~{value}

» Sorting

Name Description Usage
countryCode This will sort the response by country code. GET taxrules?sort=countrycode
gst This will sort the response by GST. GET taxrules?sort=gst
hst This will sort the response by HST. GET taxrules?sort=hst
precedence This will sort the response by precedence. GET taxrules?sort=precedence
pst This will sort the response by PST. GET taxrules?sort=pst
salesTax This will sort the response by sales tax. GET taxrules?sort=salestax
stateCode This will sort the response by state code. GET taxrules?sort=statecode
taxRuleId This will sort the response by tax rule ID. GET taxrules?sort=taxruleid
vat This will sort the response by VAT. GET taxrules?sort=vat

» Paging

Name Description Usage
index The index to retrieve when requesting paged results. GET taxrules?page=index~{value}
size The size of the page when retrieving paged results. GET taxrules?page=size~{value}

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

Sample:
	{
  "TaxRules": [
    {
      "CountryCode": "US",
      "CountyFips": "",
      "CountyName": null,
      "Custom1": "",
      "Custom2": "",
      "Custom3": null,
      "ExternalId": null,
      "Gst": 0.00,
      "Hst": 0.00,
      "IsInclusive": false,
      "PortalId": 1,
      "Precedence": 1,
      "Pst": 0.00,
      "SalesTax": 5.00,
      "StateCode": "OH",
      "TaxClass": null,
      "TaxClassId": 1,
      "TaxRuleId": 18,
      "TaxRuleType": null,
      "TaxRuleTypeId": 1,
      "TaxShipping": false,
      "Vat": 0.00
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false
}