Gets a list of tax rule types.
Name | Description | Usage |
---|---|---|
className | This will filter the request by class name. | GET taxruletypes?filter=classname~{operator}~{value} |
isActive | This will filter the request by the is active flag. | GET taxruletypes?filter=isactive~{operator}~{value} |
name | This will filter the request by name. | GET taxruletypes?filter=name~{operator}~{value} |
portalId | This will filter the request by portal ID. | GET taxruletypes?filter=portalid~{operator}~{value} |
Name | Description | Usage |
---|---|---|
className | This will sort the response by class name. | GET taxruletypes?sort=classname |
name | This will sort the response by name. | GET taxruletypes?sort=name |
taxRuleTypeId | This will sort the response by tax rule type ID. | GET taxruletypes?sort=taxruletypeid |
Name | Description | Usage |
---|---|---|
index | The index to retrieve when requesting paged results. | GET taxruletypes?page=index~{value} |
size | The size of the page when retrieving paged results. | GET taxruletypes?page=size~{value} |
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.
{
"TaxRuleTypes": [
{
"ClassName": "ZnodeTaxSalesTax",
"Description": "Applies sales tax to the shopping cart.",
"IsActive": true,
"Name": "Sales Tax",
"PortalId": null,
"TaxRuleTypeId": 1
}
],
"PageIndex": null,
"PageSize": null,
"TotalPages": null,
"TotalResults": null,
"ErrorCode": null,
"ErrorMessage": null,
"StackTrace": null,
"AllowHtmlResponse": false,
"HasError": false,
"StringResponse": null
}