Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"mode",
"format"
],
"properties": {
"mode": {
"enum": [
"ingredients",
"known"
],
"type": "string",
"description": "ingredients: from each ingredient's pack price and the amount used. known: from a plate cost the owner already has."
},
"sold": {
"anyOf": [
{
"type": "integer",
"maximum": 1000000000,
"minimum": 0,
"description": "Optional: how many of this dish sold last month (POS item sales), for the figures a month."
},
{
"type": "null"
}
]
},
"extras": {
"anyOf": [
{
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "Optional, mode ingredients: small extras without a line of their own (salt, oil, garnish), % of the ingredients; often 5 to 10."
},
{
"type": "null"
}
]
},
"format": {
"enum": [
"quick_service",
"fast_casual",
"full_service",
"fine_dining",
"bar_lounge",
"cafe"
],
"type": "string",
"description": "The type of restaurant, which sets the food cost range and the starting target: quick_service = Quick service (Counter or kiosk, fast turnover); fast_casual = Fast casual (Order at the counter, food brought to the table); full_service = Full service / casual dining (Servers, moderate check); fine_dining = Fine dining (Chef-driven, higher check); bar_lounge = Bar, taproom or lounge (Drinks are about half of sales or more); cafe = Café or coffee shop (Drinks lead, with pastries and light food)."
},
"target": {
"anyOf": [
{
"type": "number",
"maximum": 99,
"minimum": 1,
"description": "Optional: the owner's target food cost, %. Left out, the middle of the format's range (32 for full service); none for a bar."
},
{
"type": "null"
}
]
},
"taxRate": {
"anyOf": [
{
"type": "number",
"maximum": 50,
"minimum": 0,
"description": "With taxIncluded, needed: the tax rate in this dish's price, %. Food and drinks can have different rates."
},
{
"type": "null"
}
]
},
"portions": {
"anyOf": [
{
"type": "number",
"maximum": 1000000000,
"description": "With mode ingredients, needed: how many plates the amounts make, 1 for a single plate.",
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
},
"menuPrice": {
"anyOf": [
{
"type": "number",
"maximum": 1000000000,
"description": "Optional: the dish's price on the menu. Left out, the result gives the prices to charge, as for a new dish.",
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
},
"plateCost": {
"anyOf": [
{
"type": "number",
"maximum": 1000000000,
"minimum": 0,
"description": "With mode known, needed: what the ingredients on one plate cost, from a recipe card or costing sheet, in the owner's own currency like every money figure here."
},
{
"type": "null"
}
]
},
"ingredients": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"required": [
"packUnit",
"usedUnit"
],
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 100,
"description": "Optional: what it is, as the owner calls it."
},
{
"type": "null"
}
]
},
"paid": {
"anyOf": [
{
"type": "number",
"maximum": 1000000000,
"minimum": 0,
"description": "What the owner paid for one pack, from their latest invoice, before any VAT or GST they claim back."
},
{
"type": "null"
}
]
},
"used": {
"anyOf": [
{
"type": "number",
"maximum": 1000000000,
"minimum": 0,
"description": "The amount that goes in the pot or on the plate, after trimming, for the plates in portions. Spoons or cups: weighed once."
},
{
"type": "null"
}
]
},
"usable": {
"anyOf": [
{
"type": "number",
"maximum": 100,
"minimum": 1,
"description": "Optional: of what's bought, the % left after trimming or cooking: 85 for 1 kg that trims to 850 g. Left out, 100."
},
{
"type": "null"
}
]
},
"packSize": {
"anyOf": [
{
"type": "number",
"maximum": 1000000000,
"description": "How much one pack holds, in packUnit: 5 for a 5 lb bag. A case of 6 cans is 6 each; a 4 × 5 lb case is 20 lb.",
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
},
"packUnit": {
"enum": [
"g",
"kg",
"oz",
"lb",
"ml",
"l",
"floz",
"gal",
"each"
],
"type": "string",
"description": "The pack's unit: floz and gal are US fluid ounces and gallons."
},
"usedUnit": {
"enum": [
"g",
"kg",
"oz",
"lb",
"ml",
"l",
"floz",
"gal",
"each"
],
"type": "string",
"description": "The amount's unit, of the pack's kind: weight, volume and count don't convert into each other."
}
},
"additionalProperties": false
},
"maxItems": 30,
"description": "With mode ingredients: each ingredient. A sauce or side already costed is one: its cost for a pack of 1 each, 1 each used."
},
{
"type": "null"
}
]
},
"taxIncluded": {
"anyOf": [
{
"type": "boolean",
"description": "true when menu prices include VAT or GST (UK, EU, Australia, New Zealand); left out when tax is added at the till (US, Canada)."
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}