{
  "openapi": "3.0.1",
  "info": {
    "title": "Available Receipts",
    "description": "Create and administer a collection of available receipts.",
    "version": "9.1.20.0",
    "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"
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Available Receipts",
      "description": "Provide RESTful services to manage available receipts resources."
    }
  ],
  "paths": {
    "/available-receipts": {
      "get": {
        "tags": [
          "Available Receipts"
        ],
        "description": "Get a collection of available receipts.",
        "operationId": "getAvailableReceipts",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Unique identifier.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "precedence",
            "in": "query",
            "description": "An INTEGER that Represents the order in which inventory should be picked. Picking starts with the lowest number first.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "updatedDateTime",
            "in": "query",
            "description": "The last time this available-receipts was updated.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "receiptId",
            "in": "query",
            "description": "Indicates which receipt is available under the istribution arrangement.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "distributionArrangement",
            "in": "query",
            "description": "Indicates the distribution arrangement under which this receipt is available.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "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 available receipts.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AvailableReceiptCollection"
                }
              }
            }
          },
          "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": [
          "Available Receipts"
        ],
        "description": "Create an available receipt.",
        "operationId": "createAvailableReceipt",
        "requestBody": {
          "description": "The available receipt.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AvailableReceipt_Body"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the available receipt.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetAvailableReceiptsByAvailableReceiptsId": {
                "operationRef": "#/paths/~1available-receipts~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 /available-receipts/{id}`.\n"
              },
              "DeleteAvailableReceiptsByAvailableReceiptsId": {
                "operationRef": "#/paths/~1available-receipts~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 /available-receipts/{id}`.\n"
              },
              "UpdateAvailableReceiptsByAvailableReceiptsId": {
                "operationRef": "#/paths/~1available-receipts~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 /available-receipts/{id}`.\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": "AvailableReceipt"
      }
    },
    "/available-receipts/{id}": {
      "get": {
        "tags": [
          "Available Receipts"
        ],
        "description": "Get an available receipt.",
        "operationId": "getAvailableReceiptById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Unique identifier.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "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": "The available receipt.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AvailableReceipt"
                }
              }
            }
          },
          "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": [
          "Available Receipts"
        ],
        "description": "Delete an available receipt.",
        "operationId": "deleteAvailableReceiptById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Unique identifier.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "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": [
          "Available Receipts"
        ],
        "description": "Update an available receipt.",
        "operationId": "updateAvailableReceiptById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Unique identifier.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "description": "The available receipt.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AvailableReceipt_Body"
              }
            }
          },
          "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": "AvailableReceipt"
      }
    }
  },
  "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."
      },
      "AvailableReceipt": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "precedence": {
            "type": "string"
          },
          "updatedDateTime": {
            "type": "string"
          },
          "receiptId": {
            "type": "integer"
          },
          "distributionArrangement": {
            "type": "integer"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                },
                "required": [
                  "href"
                ]
              }
            },
            "required": [
              "self"
            ]
          }
        },
        "required": [
          "id",
          "precedence",
          "updatedDateTime",
          "receiptId",
          "distributionArrangement",
          "links"
        ]
      },
      "AvailableReceipt_Body": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "precedence": {
            "type": "string"
          },
          "updatedDateTime": {
            "type": "string"
          },
          "receiptId": {
            "type": "integer"
          },
          "distributionArrangement": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "precedence",
          "updatedDateTime",
          "receiptId",
          "distributionArrangement",
          "links"
        ]
      },
      "AvailableReceiptCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/AvailableReceipt"
            }
          }
        },
        "description": "A collection of available receipts."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}