Aloha POS · Schema

ItemPrice

A price for a catalog item, tied to the item by its item code.

POSRestaurantHospitalityNCR

Properties

Name Type Description
version integer Optimistic-concurrency version; must increase on each update.
price number The price amount.
currency string Currency of the price.
effectiveDate string When the price becomes effective.
status string Price lifecycle status.
priceId object Identifier tying the price to its item.
View JSON Schema on GitHub

JSON Schema

ncr-voyix-platform-item-price-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aloha-pos/refs/heads/main/json-schema/ncr-voyix-platform-item-price-schema.json",
  "title": "ItemPrice",
  "description": "A price for a catalog item, tied to the item by its item code.",
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "description": "Optimistic-concurrency version; must increase on each update."
    },
    "price": {
      "type": "number",
      "format": "double",
      "description": "The price amount."
    },
    "currency": {
      "type": "string",
      "description": "Currency of the price.",
      "default": "US Dollar"
    },
    "effectiveDate": {
      "type": "string",
      "format": "date-time",
      "description": "When the price becomes effective."
    },
    "status": {
      "type": "string",
      "description": "Price lifecycle status.",
      "enum": ["ACTIVE", "INACTIVE"]
    },
    "priceId": {
      "type": "object",
      "description": "Identifier tying the price to its item.",
      "properties": {
        "itemCode": { "type": "string" }
      }
    }
  },
  "required": ["version", "price"]
}