{
  "openapi": "3.0.1",
  "info": {
    "title": "Receipts",
    "description": "Create and administer a collection of 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"
          ]
        }
      }
    }
  ],
  "paths": {
    "/receipts": {
      "get": {
        "tags": [
          "receipts"
        ],
        "description": "Get a collection of receipts.",
        "operationId": "getReceipts",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The unique numeric ID for identifying the receipt.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "itemVersionSpecificationId",
            "in": "query",
            "description": "The unique numeric ID for identifying an item from the VERSIONSPC table.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "expectedInventoryDetailId",
            "in": "query",
            "description": "It is a foreign key to RADETAIL table if the receipt was created from expected inventory.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "storeId",
            "in": "query",
            "description": "The Store that owns the inventory.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "description": "Currency of the COST field, this is a currency code as per ISO 4217 standards.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fulfillmentCenterId",
            "in": "query",
            "description": "FulfillmentCenter where the inventory was received.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "vendorId",
            "in": "query",
            "description": "The vendor that supplied the inventory.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "receiptDate",
            "in": "query",
            "description": "Date the inventory was received.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "quantityReceived",
            "in": "query",
            "description": "The quantity received.The value must be a positive integer, a zero or negative value is invalid.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "quantityAllocated",
            "in": "query",
            "description": "The quantity allocated to customer orders but not yet released to fulfillment. The value must be a positive integer or zero. Negative values are invalid.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "quantityOnHand",
            "in": "query",
            "description": "The current quantity in inventory. The value must be a positive integer or zero. Negative values are invalid.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "quantityInKits",
            "in": "query",
            "description": "Reserved for IBM internal use.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "unitCost",
            "in": "query",
            "description": "Unit cost.",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "comment1",
            "in": "query",
            "description": "For additional comment.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "comment2",
            "in": "query",
            "description": "For additional comment.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "updatedDateTime",
            "in": "query",
            "description": "The last time this receipt was updated.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "createdDateTime",
            "in": "query",
            "description": "The date and time the receipt was created.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "receiptType",
            "in": "query",
            "description": "Indicates how this receipt was created. ADHC = AdHoc receipt, EIR = Expected Inventory Receipt, or RTN = returned receipt.",
            "schema": {
              "type": "string"
            }
          },
          {
            "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 receipts.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReceiptCollection"
                }
              }
            }
          },
          "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": [
          "receipts"
        ],
        "description": "Create a receipt.",
        "operationId": "createReceipt",
        "requestBody": {
          "description": "Information about each receipt of an item at a fuilfillment center.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Receipt_Body"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the receipt.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetReceiptsByReceiptsId": {
                "operationRef": "#/paths/~1receipts~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 /receipts/{id}`.\n"
              },
              "DeleteReceiptsByReceiptsId": {
                "operationRef": "#/paths/~1receipts~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 /receipts/{id}`.\n"
              },
              "UpdateReceiptsByReceiptsId": {
                "operationRef": "#/paths/~1receipts~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 /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": "Receipt"
      }
    },
    "/receipts/{id}": {
      "get": {
        "tags": [
          "receipts"
        ],
        "description": "Get a receipt.",
        "operationId": "getReceiptById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the receipt.",
            "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": "Information about each receipt of an item at a fuilfillment center.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Receipt"
                }
              }
            }
          },
          "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": [
          "receipts"
        ],
        "description": "Delete a receipt.",
        "operationId": "deleteReceiptById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the receipt.",
            "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": [
          "receipts"
        ],
        "description": "Update a receipt.",
        "operationId": "updateReceiptById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying the receipt.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "description": "Information about each receipt of an item at a fuilfillment center.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Receipt_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": "Receipt"
      }
    }
  },
  "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."
      },
      "Receipt": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "itemVersionSpecificationId": {
            "type": "integer"
          },
          "expectedInventoryDetailId": {
            "type": "string"
          },
          "storeId": {
            "type": "integer"
          },
          "currency": {
            "type": "string"
          },
          "fulfillmentCenterId": {
            "type": "integer"
          },
          "vendorId": {
            "type": "string"
          },
          "receiptDate": {
            "type": "string"
          },
          "quantityReceived": {
            "type": "integer"
          },
          "quantityAllocated": {
            "type": "integer"
          },
          "quantityOnHand": {
            "type": "integer"
          },
          "quantityInKits": {
            "type": "integer"
          },
          "unitCost": {
            "type": "string"
          },
          "comment1": {
            "type": "string"
          },
          "comment2": {
            "type": "string"
          },
          "updatedDateTime": {
            "type": "string"
          },
          "createdDateTime": {
            "type": "string"
          },
          "receiptType": {
            "type": "string"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                },
                "required": [
                  "href"
                ]
              }
            },
            "required": [
              "self"
            ]
          }
        },
        "required": [
          "id",
          "itemVersionSpecificationId",
          "expectedInventoryDetailId",
          "storeId",
          "currency",
          "fulfillmentCenterId",
          "vendorId",
          "receiptDate",
          "quantityReceived",
          "quantityAllocated",
          "quantityOnHand",
          "quantityInKits",
          "unitCost",
          "comment1",
          "comment2",
          "updatedDateTime",
          "createdDateTime",
          "receiptType",
          "links"
        ]
      },
      "Receipt_Body": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "itemVersionSpecificationId": {
            "type": "integer"
          },
          "expectedInventoryDetailId": {
            "type": "string"
          },
          "storeId": {
            "type": "integer"
          },
          "currency": {
            "type": "string"
          },
          "fulfillmentCenterId": {
            "type": "integer"
          },
          "vendorId": {
            "type": "string"
          },
          "receiptDate": {
            "type": "string"
          },
          "quantityReceived": {
            "type": "integer"
          },
          "quantityAllocated": {
            "type": "integer"
          },
          "quantityOnHand": {
            "type": "integer"
          },
          "quantityInKits": {
            "type": "integer"
          },
          "unitCost": {
            "type": "string"
          },
          "comment1": {
            "type": "string"
          },
          "comment2": {
            "type": "string"
          },
          "updatedDateTime": {
            "type": "string"
          },
          "createdDateTime": {
            "type": "string"
          },
          "receiptType": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "itemVersionSpecificationId",
          "storeId",
          "currency",
          "fulfillmentCenterId",
          "vendorId",
          "receiptDate",
          "quantityReceived",
          "quantityAllocated",
          "quantityOnHand",
          "quantityInKits",
          "unitCost",
          "comment1",
          "comment2",
          "updatedDateTime",
          "createdDateTime",
          "receiptType",
          "links"
        ]
      },
      "ReceiptCollection": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/Receipt"
            }
          }
        },
        "description": "A collection of receipts."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}