{
  "openapi": "3.0.1",
  "info": {
    "title": "Tax types",
    "version": "9.1.20.0",
    "description": "Create and administer a collection of tax types.",
    "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-types": {
      "get": {
        "tags": [
          "tax-types"
        ],
        "description": "Get a collection of tax type.",
        "operationId": "getTaxTypes",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The Tax Type ID.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "sequence",
            "in": "query",
            "description": "The OrderPrepare command uses CalculationUsage in ascending order of this Sequence attribute.",
            "schema": {
              "type": "number",
              "format": "double"
            }
          },
          {
            "name": "taxCodeSchemeId",
            "in": "query",
            "description": "The TaxScheme, if any, this TaxType is part of.",
            "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 type.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxTypeCollection"
                }
              }
            }
          },
          "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-types"
        ],
        "description": "Create a tax type.",
        "operationId": "createTaxType",
        "requestBody": {
          "description": "A tax type.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TaxType"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {}
          },
          "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": "TaxType"
      }
    },
    "/tax-types/{id}": {
      "get": {
        "tags": [
          "tax-types"
        ],
        "description": "Get a tax type.",
        "operationId": "getTaxTypeById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The Tax Type ID.",
            "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 type.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaxType"
                }
              }
            }
          },
          "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-types"
        ],
        "description": "Delete a tax type.",
        "operationId": "deleteTaxTypeById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The Tax Type ID.",
            "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-types"
        ],
        "description": "Update a tax type.",
        "operationId": "updateTaxTypeById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The Tax Type ID.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "description": "A tax type.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TaxType"
              }
            }
          },
          "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": "TaxType"
      }
    },
    "/tax-types/{id}/categories": {
      "get": {
        "tags": [
          "tax-types"
        ],
        "operationId": "getCategoriesOfTaxType",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The Tax Type ID.",
            "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.",
            "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"
                }
              }
            }
          }
        }
      }
    }
  },
  "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."
      },
      "TaxType": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The Tax Type ID.",
            "format": "int32"
          },
          "sequence": {
            "type": "number",
            "description": "The OrderPrepare command uses CalculationUsage in ascending order of this Sequence attribute.",
            "format": "double"
          },
          "taxCodeSchemeId": {
            "type": "integer",
            "description": "The TaxScheme, if any, this TaxType is part of.",
            "format": "int32"
          },
          "links": {
            "type": "object",
            "properties": {
              "categories": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                },
                "description": ""
              }
            },
            "description": "Links to related resources."
          }
        },
        "description": "A tax type."
      },
      "TaxTypeCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/TaxType"
            }
          }
        },
        "description": "A collection of tax type."
      },
      "TaxCategory": {
        "type": "object",
        "properties": {
          "taxCategoryId": {
            "type": "integer",
            "description": "The Tax Category ID.",
            "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 IBM 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"
          },
          "links": {
            "type": "object",
            "properties": {
              "descriptions": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string",
                    "description": "The URL of the link."
                  }
                },
                "description": ""
              }
            },
            "description": "Links to related resources."
          }
        },
        "description": "A tax category."
      },
      "TaxCategoryCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/TaxCategory"
            }
          }
        },
        "description": "A collection of tax category."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}