{
  "openapi": "3.0.1",
  "info": {
    "title": "Tax Categories",
    "version": "9.1.20.0",
    "description": "Create and administer tax categories.",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "paths": {
    "/tax-categories": {
      "get": {
        "tags": [
          "tax-categories"
        ],
        "description": "Get a collection of tax category.",
        "operationId": "getTaxCategories",
        "parameters": [
          {
            "name": "searchString",
            "in": "query",
            "description": "Limits search results to only include tax categories with a name that matches the value of this parameter. Searches are case-insensitive.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id",
            "in": "query",
            "description": "The unique numeric ID for identifying the tax category.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "calculationSequence",
            "in": "query",
            "description": "Tax amounts are calculated in ascending order of calculationSequence.",
            "schema": {
              "type": "number",
              "format": "double"
            }
          },
          {
            "name": "displaySequence",
            "in": "query",
            "description": "A user interface can use this field to control the sequence of tax amounts displayed for an Order.",
            "schema": {
              "type": "number",
              "format": "double"
            }
          },
          {
            "name": "displayUsage",
            "in": "query",
            "description": "Specifies that this tax category in relation to the PriceDataBean, 0 is not calculated, 1 is calculated.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "field1",
            "in": "query",
            "description": "Customizable.",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "field2",
            "in": "query",
            "description": "Customizable.",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "field3",
            "in": "query",
            "description": "Customizable.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "markForDelete",
            "in": "query",
            "description": "Reserved for HCL Internal use.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "name",
            "in": "query",
            "description": "A name that, along with the StoreEntity, uniquely identifies this Tax Category.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The StoreEntity of which this Tax Category is a part.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "taxTypeId",
            "in": "query",
            "description": "The TaxType of this Tax category.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of tax category.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxCategoryCollection"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "tax-categories"
        ],
        "description": "Create a tax category.",
        "operationId": "createTaxCategory",
        "requestBody": {
          "description": "A tax category.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TaxCategory"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the tax-category.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetTaxCategoryByTaxCategoryId": {
                "operationRef": "#/paths/~1tax-categories~1{id}/get",
                "parameters": {
                  "id": "request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /tax-categories/{id}`.\n"
              },
              "DeleteTaxCategoryByTaxCategoryId": {
                "operationRef": "#/paths/~1tax-categories~1{id}/delete",
                "parameters": {
                  "id": "request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `DELETE /tax-categories/{id}`.\n"
              },
              "UpdateTaxCategoryByTaxCategoryId": {
                "operationRef": "#/paths/~1tax-categories~1{id}/patch",
                "parameters": {
                  "id": "request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `PATCH /tax-categories/{id}`.\n"
              },
              "GetTaxCategoryByTaxCategoryIdanddescription": {
                "operationRef": "#/paths/~1tax-categories~1{id}~1descriptions/get",
                "parameters": {
                  "id": "request.body#/id"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /tax-categories/{id}/descriptions`.\n"
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "TaxCategory"
      }
    },
    "/tax-categories/{id}": {
      "get": {
        "tags": [
          "tax-categories"
        ],
        "description": "Get a tax category.",
        "operationId": "getTaxCategoryById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the tax category.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A tax category.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxCategory"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "tax-categories"
        ],
        "description": "Delete a tax category.",
        "operationId": "deleteTaxCategoryById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the tax category.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "tax-categories"
        ],
        "description": "Update a tax category.",
        "operationId": "updateTaxCategoryById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the tax category.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "A tax category.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TaxCategory"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "TaxCategory"
      }
    },
    "/tax-categories/{id}/descriptions": {
      "get": {
        "tags": [
          "tax-categories"
        ],
        "operationId": "getDescriptionsOfTaxCategory",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the tax category.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of tax category description.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxCategoryDescriptionCollection"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Link": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "The URL of the link.",
            "format": "uri"
          }
        },
        "description": "Links to related resources."
      },
      "Error": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string",
            "description": "The error message code."
          },
          "errorMessage": {
            "type": "string",
            "description": "The error message."
          },
          "errorKey": {
            "type": "string",
            "description": "The error message key."
          },
          "errorParameters": {
            "type": "array",
            "description": "The arguments used to construct the error message.",
            "items": {
              "type": "object",
              "properties": {}
            }
          },
          "errorLevel": {
            "type": "string",
            "description": "The error level."
          },
          "errorHref": {
            "type": "string",
            "description": "The error hypertext reference."
          }
        },
        "description": "The error message item model."
      },
      "ErrorResponseContainer": {
        "type": "object",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "The request identifier."
          },
          "errors": {
            "type": "array",
            "description": "The errors.",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        },
        "description": "The error message model."
      },
      "TaxCategory": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the tax category.",
            "format": "int32"
          },
          "calculationSequence": {
            "type": "number",
            "description": "Tax amounts are calculated in ascending order of calculationSequence.",
            "format": "double"
          },
          "displaySequence": {
            "type": "number",
            "description": "A user interface can use this field to control the sequence of tax amounts displayed for an Order.",
            "format": "double"
          },
          "displayUsage": {
            "type": "integer",
            "description": "Specifies that this tax category in relation to the PriceDataBean, 0 is not calculated, 1 is calculated.",
            "format": "int32"
          },
          "field1": {
            "type": "number",
            "description": "Customizable."
          },
          "field2": {
            "type": "number",
            "description": "Customizable."
          },
          "field3": {
            "type": "string",
            "description": "Customizable."
          },
          "markForDelete": {
            "type": "integer",
            "description": "Reserved for HCL Internal use.",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "description": "A name that, along with the StoreEntity, uniquely identifies this Tax Category."
          },
          "storeId": {
            "type": "integer",
            "description": "The StoreEntity of which this Tax Category is a part.",
            "format": "int32"
          },
          "taxTypeId": {
            "type": "integer",
            "description": "The TaxType of this Tax category.",
            "format": "int32"
          }
        },
        "description": "A tax category."
      },
      "TaxCategoryCollection": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/TaxCategory"
            }
          },
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int32"
          }
        },
        "description": "A collection of tax category."
      },
      "TaxCategoryDescription": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying the tax category.",
            "format": "int32"
          },
          "languageId": {
            "type": "integer",
            "description": "The Language ID.",
            "format": "int32"
          },
          "description": {
            "type": "string",
            "description": "A brief description of the tax category, suitable for display to a customer for selection. For example, Sales tax, Shipping tax."
          }
        },
        "description": "A tax category description."
      },
      "TaxCategoryDescriptionCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string"
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "taxCategoryId": {
                  "type": "integer"
                },
                "languageId": {
                  "type": "integer"
                },
                "description": {
                  "type": "string"
                },
                "links": {
                  "type": "object",
                  "properties": {
                    "self": {
                      "type": "object",
                      "properties": {
                        "href": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "href"
                      ]
                    }
                  },
                  "required": [
                    "self"
                  ]
                }
              },
              "required": [
                "taxCategoryId",
                "languageId",
                "description",
                "links"
              ]
            }
          },
          "count": {
            "type": "integer"
          }
        },
        "required": [
          "href",
          "items",
          "count"
        ]
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}