# Tably > Tably is a point of sale and back office for restaurants, cafés and bars: waiters take orders on tablets, the kitchen gets tickets or a kitchen screen, and stock, cash, payroll and reports follow by themselves. It works offline, prints receipts, handles a second currency, has a QR menu for guests and an owner app (Tably Pulse) for phones. Free for 14 days with everything included, no card needed. Sign up: https://tablypos.com/register ## Plans (USD per month) - **Start — $14/month.** Sales, menu and stock for a small café or coffee shop. 50 dishes & tech cards, 2 tablets, 8 employees. Sales on waiter tablets, Counter service on the tablets, Menu with categories and photos, Dish modifiers, Stock & supplies, Customers. - **Standard — $34/month.** For restaurants that run the floor, the kitchen and the money. 150 dishes & tech cards, 5 tablets, 20 employees. Everything in Start, Tables & guest numbers, Tech cards, Finance, Reports. - **Pro — $54/month.** Automate the team and grow sales. 500 dishes & tech cards, 10 tablets, 40 employees. Everything in Standard, Kitchen display, 1 screen, Payroll, Promotions, Custom roles, API & integrations. ## Pages - [Tably — POS and back office for restaurants](https://tablypos.com/): What Tably does, from the waiter’s tablet to the books - [Pricing](https://tablypos.com/pricing): Plans, add-ons and the free trial - [Download](https://tablypos.com/download): The POS app for tablets and Tably Pulse for owners’ phones - [Coffee Shop POS](https://tablypos.com/coffee-shop-pos): A POS for coffee shops and cafés: tap the drinks, take the payment, next guest. Milk and syrup options, guest numbers, stock by the recipe. Works offline, 14 days free. - [Bar POS](https://tablypos.com/bar-pos): A POS for bars and pubs: tabs open till the last round, drinks to the bar printer, food to the kitchen, happy hours, bottles counted by the pour. Works offline, 14 days free. - [Restaurant POS](https://tablypos.com/restaurant-pos): A restaurant POS on tablets: tables on the floor plan, tickets or a kitchen screen for each station, food cost by the recipe, payroll and reports. Works offline, 14 days free. - [What’s new](https://tablypos.com/updates): New features and changes, newest first - [Developers](https://tablypos.com/developers): The Tably API, keys and examples - [API reference](https://tablypos.com/developers/api): Every endpoint of the open API - [Webhooks](https://tablypos.com/developers/webhooks): Events Tably sends to your server - [Tably with AI assistants](https://tablypos.com/developers/ai): Connecting Claude, ChatGPT and others to a restaurant ## Questions ### Is there a free trial? Yes: every new restaurant gets 14 days with everything included, without a card. After it, choose a plan in Settings → Tably billing. ### Can I change plans later? Yes, at any time. A new plan starts the same day, and the unused days of your current paid period are credited to it. ### How do I cancel? In Settings → Tably billing. Your plan stays active until the end of the paid period and then stops renewing. Your data is kept: you can come back to a plan later. ### Is there a money-back guarantee? Yes: ask within 14 days of any payment — monthly or yearly, a plan or an add-on — and you get it back in full. Read the refund policy for the details. ### Who takes the payment? Paddle.com, our online reseller and Merchant of Record: you pay by card or other methods on Paddle’s secure checkout, sales tax is included, and Paddle emails the receipt. ### What are add-ons? Extras for any plan, such as the kitchen display: orders on a screen in the kitchen instead of paper tickets. Turn one on in Settings → Add-ons — free for a trial the first time — and you pay only for the days it is on, together with your plan’s next payment. ### What do I need to start? A tablet or a computer with a browser — Android tablets, iPads and Windows computers all work — and, for printing, a receipt printer on your Wi‑Fi. ### What happens if the internet goes down? The tablets keep taking orders and printing; everything is sent to the server when the connection is back. Contact: support@tablypos.com ## Tably API Tably is a POS for restaurants (waiter tablets, kitchen display, back office). This API reads and changes one restaurant's data. Base URL: https://tablypos.com/api/v1/open Auth: header `Authorization: Bearer tbl_…` (Settings → Integrations; read-only or read & write keys — a write key changes only the areas chosen for it: orders, customers, menu, stock, money). Safe retries: creating calls take an `externalId` (your own id) — the same externalId gives back what was made the first time; suppliers and ingredients are matched by name. Errors: HTTP status + {"error": "…"}. Limit: 120 requests a minute. Amounts are in the restaurant's currency; times in its time zone. ## Endpoints ### GET /restaurant — The restaurant Name, currency, time zone, address and phone, the order types, and what the key may do (read or write, and for a write key the areas it may change). A good first call to check a key. Example answer: {"id":"5faf…","name":"Lotus Kitchen","currency":"USD","timezone":"America/New_York","address":"12 Riverside Street","phone":"+1 555 0100","access":"write","canChange":["orders","customers","menu"],"orderTypes":[{"id":"dine-in","name":"Dine in"},{"id":"takeaway","name":"Takeaway"}]} ### GET /menu — The whole menu Categories, cooking stations and dishes with prices, availability (the stop list), cooking stations and modifier groups with their options — everything needed to show the menu on a website or take an order. Example answer: {"categories":[{"id":"home","name":"Main screen"}],"stations":["Kitchen","Bar"],"dishes":[{"id":"iced-latte","name":"Iced latte","category":"Drinks","price":2.5,"available":true,"description":"Double espresso, cold milk, ice","station":"Bar","modifierGroups":[{"id":"milk","name":"Milk","min":0,"max":1,"options":[{"id":"oat","name":"Oat milk","price":0.5}]}]}]} ### GET /dishes/{id} — One dish A dish with its price, availability and modifier groups. - path `id` (required): The dish id (from /menu) Example answer: {"id":"pad-thai","name":"Pad Thai","category":"Mains","price":6.5,"available":true,"description":"Rice noodles, chicken, egg, tamarind, peanuts","station":"Kitchen","modifierGroups":[]} ### PATCH /dishes/{id} — Change a dish (write key: Menu) Take a dish off the menu (available: false) or back, change its price, name, description, category, cooking station or recipe — send only what changes (a recipe sent replaces the whole recipe). The tablets get it within seconds. The answer has the recipe, its food cost and the margin. Webhook: menu.updated. - path `id` (required): The dish id Body: `available` boolean — false: off the menu (stop list); `price` number — The new price; `name` string — Up to 80 characters; `description` string — Up to 300 characters; `category` string — Another category: its id or name (from /menu); `station` string — A cooking station from /menu (empty: none); `recipe` array — What one portion takes from stock: [{ ingredient | preparation (its id or name from /inventory), quantity, unit? }] — the quantity in the item's unit (kg, l, pcs), or unit "g" / "ml" for kg and l items (150 g of chicken: { ingredient: "Chicken", quantity: 150, unit: "g" }). Sales take it from stock, and the margin comes from it Example body: {"recipe":[{"ingredient":"Rice noodles","quantity":120,"unit":"g"},{"ingredient":"Chicken","quantity":80,"unit":"g"},{"ingredient":"Egg","quantity":1}]} Example answer: {"id":"pad-thai","name":"Pad Thai","category":"Mains","price":6.5,"available":true,"description":"Rice noodles, chicken, egg, tamarind, peanuts","station":"Kitchen","recipe":[{"ingredient":"rice-noodles","name":"Rice noodles","quantity":0.12,"unit":"kg"},{"ingredient":"chicken","name":"Chicken","quantity":0.08,"unit":"kg"},{"ingredient":"egg","name":"Egg","quantity":1,"unit":"pcs"}],"foodCost":1.12,"margin":82.8} ### POST /dishes — Add a dish (write key: Menu) A new dish in a category, on the tablets within seconds, with its recipe (what a portion takes from stock) if you send it; a picture is added on the website, modifier groups with POST /dishes/{id}/modifier-groups. With externalId it is made once: sending it again gives back the same dish. Counts towards the plan’s dishes. Webhook: menu.updated. Body: `name`* string — Up to 80 characters; `price`* number — 0 or more; `category`* string — Its id or name (from /menu); `description` string — Up to 300 characters; `available` boolean — false: added on the stop list (default true); `station` string — A cooking station from /menu; `externalId` string — Your id: the same one is never added twice; `recipe` array — What one portion takes from stock: [{ ingredient | preparation (its id or name from /inventory), quantity, unit? }] — the quantity in the item's unit (kg, l, pcs), or unit "g" / "ml" for kg and l items (150 g of chicken: { ingredient: "Chicken", quantity: 150, unit: "g" }). Sales take it from stock, and the margin comes from it Example body: {"name":"Mango smoothie","price":3.5,"category":"Drinks","description":"Mango, yogurt, ice","recipe":[{"ingredient":"Mango","quantity":150,"unit":"g"},{"ingredient":"Yogurt","quantity":100,"unit":"ml"}]} Example answer: {"id":"9d2c…","name":"Mango smoothie","category":"Drinks","price":3.5,"available":true,"description":"Mango, yogurt, ice","station":"Bar","recipe":[{"ingredient":"mango","name":"Mango","quantity":0.15,"unit":"kg"},{"ingredient":"yogurt","name":"Yogurt","quantity":0.1,"unit":"l"}],"foodCost":0.62,"margin":82.3} ### DELETE /dishes/{id} — Delete a dish (write key: Menu) Removes a dish from the menu; past receipts keep it. Refused (409) while a promotion or another dish’s modifier uses it — change that first. Its barcodes go with it. Webhook: menu.updated. - path `id` (required): The dish id Example answer: {"id":"9d2c…","name":"Mango smoothie","deleted":true} ### POST /dishes/{id}/modifier-groups — Add a modifier group to a dish (write key: Menu) A group of options on a dish — Extras, Size, Spice: the waiter (and the QR menu) asks it when the dish is added. mode single = one of them, multiple = up to max; min 0 = optional, 1+ = must choose. Each option has a name and an extra price, and may take an ingredient from stock (ingredient: its id or name from /inventory, quantity in its unit). Or copy a group of another dish with copyFrom. Needs Dish modifiers in the plan. Webhook: menu.updated. - path `id` (required): The dish id (from /menu) Body: `name`* string — The group, up to 60 characters (e.g. Extras); `mode` string — single (one of them, default) or multiple; `min` number — At least so many (0: optional, default); `max` number — At most so many (multiple only); `options` array — [{name, price, ingredient?, quantity?}]; `copyFrom` object — {dishId, groupId}: a copy of that dish’s group instead Example body: {"name":"Extras","mode":"multiple","min":0,"max":3,"options":[{"name":"Extra egg","price":0.5,"ingredient":"Eggs","quantity":1},{"name":"Extra cheese","price":0.75}]} Example answer: {"dishId":"pad-thai","dish":"Pad Thai","modifierGroups":[{"id":"g1…","name":"Extras","mode":"multiple","min":0,"max":3,"options":[{"id":"o1…","name":"Extra egg","price":0.5,"product":{"kind":"ingredient","id":"eggs","quantity":1}},{"id":"o2…","name":"Extra cheese","price":0.75}]}]} ### PATCH /dishes/{id}/modifier-groups/{group} — Change a modifier group (write key: Menu) Its name, mode, min, max, its place among the dish’s groups (position 0 = first), or qrHidden (left out of the QR menu). Send only what changes. Webhook: menu.updated. - path `id` (required): The dish id - path `group` (required): The group id (from /dishes/{id}) Body: `name` string — Up to 60 characters; `mode` string — single or multiple; `min` number — At least; `max` number — At most; `position` number — 0 = the first group; `qrHidden` boolean — true: not on the QR menu Example body: {"min":1} Example answer: {"dishId":"pad-thai","dish":"Pad Thai","modifierGroups":[]} ### DELETE /dishes/{id}/modifier-groups/{group} — Delete a modifier group (write key: Menu) Removes the group and its options from the dish (past receipts keep what was chosen). Webhook: menu.updated. - path `id` (required): The dish id - path `group` (required): The group id Example answer: {"dishId":"pad-thai","dish":"Pad Thai","modifierGroups":[]} ### POST /dishes/{id}/modifier-groups/{group}/options — Add an option to a modifier group (write key: Menu) A new choice in the group: a name, an extra price (0 for none), and optionally the ingredient it takes from stock (id or name from /inventory) with the quantity in its unit. Webhook: menu.updated. - path `id` (required): The dish id - path `group` (required): The group id Body: `name`* string — Up to 60 characters; `price` number — The extra price (default 0); `ingredient` string — An ingredient taken from stock: its id or name; `quantity` number — How much of it, in its unit (default 1) Example body: {"name":"Extra shrimp","price":1.5,"ingredient":"Shrimp","quantity":0.05} Example answer: {"dishId":"pad-thai","dish":"Pad Thai","modifierGroups":[]} ### PATCH /dishes/{id}/modifier-groups/{group}/options/{option} — Change a modifier option (write key: Menu) Its name, extra price, ingredient and quantity (ingredient "" = none), place in the group (position 0 = first) or qrHidden. Send only what changes. Webhook: menu.updated. - path `id` (required): The dish id - path `group` (required): The group id - path `option` (required): The option id Body: `name` string — Up to 60 characters; `price` number — The extra price; `ingredient` string — Its id or name; "" for none; `quantity` number — In the ingredient’s unit; `position` number — 0 = first; `qrHidden` boolean — true: not on the QR menu Example body: {"price":1} Example answer: {"dishId":"pad-thai","dish":"Pad Thai","modifierGroups":[]} ### DELETE /dishes/{id}/modifier-groups/{group}/options/{option} — Delete a modifier option (write key: Menu) Removes one choice from the group. Webhook: menu.updated. - path `id` (required): The dish id - path `group` (required): The group id - path `option` (required): The option id Example answer: {"dishId":"pad-thai","dish":"Pad Thai","modifierGroups":[]} ### POST /categories — Add a category (write key: Menu) A new menu category, at the top or inside another (parentId; up to 3 levels). The same name in the same place is not added twice. Body: `name`* string — Up to 40 characters; `parentId` string — Inside this category (id from /menu) Example body: {"name":"Smoothies","parentId":"drinks"} Example answer: {"id":"4b7a…","name":"Smoothies","parentId":"drinks"} ### PATCH /categories/{id} — Rename or move a category (write key: Menu) A new name (its dishes follow) and/or another place: parentId of a category, or null for the top. Never inside itself; up to 3 levels. - path `id` (required): The category id Body: `name` string — Up to 40 characters; `parentId` string | null — Inside this category, or null: at the top Example body: {"name":"Fresh smoothies"} Example answer: {"id":"4b7a…","name":"Fresh smoothies","parentId":"drinks"} ### DELETE /categories/{id} — Delete a category (write key: Menu) Only an empty one: refused (409) while it has dishes or subcategories, or a promotion uses it. The main screen cannot be deleted. - path `id` (required): The category id Example answer: {"id":"4b7a…","name":"Fresh smoothies","deleted":true} ### GET /promotions — Promotions Every promotion: what it gives (reward), on what (target), when (schedule, dates), its promo code, and whether it is on. Needs Promotions in the plan. Example answer: {"promotions":[{"id":"happy-hour","name":"Happy hour","description":"20% off drinks","kind":"happy_hour","active":true,"reward":{"type":"percent","value":20},"target":{"scope":"categories","ids":["drinks"]},"schedule":[{"days":[1,2,3,4,5],"from":"17:00","to":"19:00"}]}]} ### PATCH /promotions/{id} — Switch a promotion on or off (write key: Menu) A promotion on (active: true) or paused; the tablets follow at once. - path `id` (required): The promotion id (from /promotions) Body: `active`* boolean — true: on, false: paused Example body: {"active":false} Example answer: {"id":"happy-hour","name":"Happy hour","active":false} ### GET /orders — Orders by day Orders of those days (restaurant time, up to 31 days), newest first — a paid order on the day it was paid, the others on the day they were opened: every dish, payments, discounts, the waiter. - query `from`: First day, YYYY-MM-DD (default: today) - query `to`: Last day, YYYY-MM-DD (default: from) - query `status`: open, paid or canceled - query `limit`: Up to 1000 (default 500) Example answer: {"from":"2026-10-01","to":"2026-10-07","orders":[{"id":"API-MFX2K91","number":12,"status":"paid","service":"table","table":"4","guests":2,"waiter":"Dara","openedAt":"2026-10-07T12:00","closedAt":"2026-10-07T12:41","items":[{"id":"b3dc…","dishId":"pad-thai","name":"Pad Thai","quantity":2,"price":6.5,"guest":0,"note":"no peanuts","sentAt":"2026-10-07T12:01","readyQuantity":0,"removed":false},{"id":"7a01…","dishId":"iced-latte","name":"Iced latte · Oat milk","quantity":1,"price":3,"guest":0,"sentAt":"2026-10-07T12:01","readyQuantity":1,"removed":false}],"subtotal":16,"discount":0,"deliveryFee":0, ### GET /orders/open — Orders open now What is on the tables right now, oldest first — for a live board or a delivery screen. Example answer: {"orders":[{"id":"API-MFX2K91","number":12,"status":"open","service":"table","table":"4","guests":2,"waiter":"Dara","openedAt":"2026-10-07T12:00","closedAt":null,"items":[{"id":"b3dc…","dishId":"pad-thai","name":"Pad Thai","quantity":2,"price":6.5,"guest":0,"note":"no peanuts","sentAt":"2026-10-07T12:01","readyQuantity":0,"removed":false},{"id":"7a01…","dishId":"iced-latte","name":"Iced latte · Oat milk","quantity":1,"price":3,"guest":0,"sentAt":"2026-10-07T12:01","readyQuantity":1,"removed":false}],"subtotal":16,"discount":0,"deliveryFee":0,"payments":[],"paid":0}]} ### GET /orders/{id} — One order An order with its dishes (and how many portions the kitchen marked ready), payments and totals. - path `id` (required): The order id Example answer: {"id":"API-MFX2K91","number":12,"status":"paid","service":"table","table":"4","guests":2,"waiter":"Dara","openedAt":"2026-10-07T12:00","closedAt":"2026-10-07T12:41","items":[{"id":"b3dc…","dishId":"pad-thai","name":"Pad Thai","quantity":2,"price":6.5,"guest":0,"note":"no peanuts","sentAt":"2026-10-07T12:01","readyQuantity":0,"removed":false},{"id":"7a01…","dishId":"iced-latte","name":"Iced latte · Oat milk","quantity":1,"price":3,"guest":0,"sentAt":"2026-10-07T12:01","readyQuantity":1,"removed":false}],"subtotal":16,"discount":0,"deliveryFee":0,"payments":[{"method":"Cash","amount":16,"tip":1} ### POST /orders — Create an order (write key: Orders) An order from outside — your website, an app, a delivery service. Prices come from the menu; modifiers by group and option id. The dishes go to the kitchen display and the waiters' tablets at once (send: false keeps them unsent). Webhooks: order.opened, order.items_added, order.sent. Body: `service`* "table" | "guest_number" | "counter" — Where it is served; `table` string — The table number (service: table); `guestNumber` integer — The guest number (service: guest_number); `guests` integer — How many people; `type` string — The order type, by id or name (GET /restaurant): takeaway, delivery… — marked on the tablets, the kitchen display and the tickets; `customerId` string — A customer (their discount applies at payment); `items`* array — [{ dishId, quantity, note?, modifiers?: [{ groupId, optionId }] }]; `send` boolean — Send to the kitchen now (default true) Example body: {"service":"counter","type":"takeaway","items":[{"dishId":"pad-thai","quantity":2,"note":"no peanuts"},{"dishId":"iced-latte","modifiers":[{"groupId":"milk","optionId":"oat"}]}]} Example answer: {"id":"API-MFX2K91","number":12,"status":"open","service":"table","table":"4","guests":2,"waiter":"Dara","openedAt":"2026-10-07T12:00","closedAt":null,"items":[{"id":"b3dc…","dishId":"pad-thai","name":"Pad Thai","quantity":2,"price":6.5,"guest":0,"note":"no peanuts","sentAt":"2026-10-07T12:01","readyQuantity":0,"removed":false},{"id":"7a01…","dishId":"iced-latte","name":"Iced latte · Oat milk","quantity":1,"price":3,"guest":0,"sentAt":"2026-10-07T12:01","readyQuantity":1,"removed":false}],"subtotal":16,"discount":0,"deliveryFee":0,"payments":[],"paid":0} ### POST /orders/{id}/items — Add dishes (write key: Orders) More dishes for an open order; they go to the kitchen (send: false keeps them). Webhooks: order.items_added, order.sent. - path `id` (required): The order id Body: `items`* array — As in create_order; `send` boolean — Default true Example body: {"items":[{"dishId":"mango-rice","quantity":1}]} Example answer: {"id":"API-MFX2K91","number":12,"status":"open","service":"table","table":"4","guests":2,"waiter":"Dara","openedAt":"2026-10-07T12:00","closedAt":null,"items":[{"id":"b3dc…","dishId":"pad-thai","name":"Pad Thai","quantity":2,"price":6.5,"guest":0,"note":"no peanuts","sentAt":"2026-10-07T12:01","readyQuantity":0,"removed":false},{"id":"7a01…","dishId":"iced-latte","name":"Iced latte · Oat milk","quantity":1,"price":3,"guest":0,"sentAt":"2026-10-07T12:01","readyQuantity":1,"removed":false}],"subtotal":16,"discount":0,"deliveryFee":0,"payments":[],"paid":0} ### POST /orders/{id}/payments — Record a payment (write key: Orders) A payment taken outside Tably (online, a delivery app). Once the order is paid in full it closes: the receipt is in Tably, stock goes down. Webhooks: payment.added, order.paid. - path `id` (required): The order id Body: `amount`* number — How much was paid; `method` string — Payment method name (default "Online"); `tip` number — Tip on top Example body: {"method":"Online","amount":16} Example answer: {"id":"API-MFX2K91","number":12,"status":"paid","service":"table","table":"4","guests":2,"waiter":"Dara","openedAt":"2026-10-07T12:00","closedAt":"2026-10-07T12:41","items":[{"id":"b3dc…","dishId":"pad-thai","name":"Pad Thai","quantity":2,"price":6.5,"guest":0,"note":"no peanuts","sentAt":"2026-10-07T12:01","readyQuantity":0,"removed":false},{"id":"7a01…","dishId":"iced-latte","name":"Iced latte · Oat milk","quantity":1,"price":3,"guest":0,"sentAt":"2026-10-07T12:01","readyQuantity":1,"removed":false}],"subtotal":16,"discount":0,"deliveryFee":0,"payments":[{"method":"Cash","amount":16,"tip":1} ### POST /orders/{id}/close — Pay and close an order (write key: Orders) Pays what is left of an open order with one payment method (default Online) and closes it — for your website or a delivery app. Webhooks: payment.added, order.paid. - path `id` (required): The order id Body: `method` string — A payment method of the restaurant (default Online); `tip` number — A tip on top Example body: {"method":"Online"} Example answer: {"id":"API-…","status":"paid","subtotal":13,"payments":[{"method":"Online","amount":13,"tip":0}]} ### POST /orders/{id}/print — Print the bill (write key: Orders) The bill of an open order, or the receipt of a paid one, on the restaurant’s receipt printer. A device with the Tably app in the restaurant prints it within seconds. - path `id` (required): The order id Body: `kind` "bill" | "receipt" — Default: bill while open, receipt when paid; `printerId` string — A receipt printer (default: the first one) Example body: {"kind":"bill"} Example answer: {"queued":true,"jobId":"api-…","kind":"bill","printer":"Front counter"} ### POST /orders/{id}/cancel — Cancel an order (write key: Orders) Cancel an order with nothing paid. Webhook: order.canceled. - path `id` (required): The order id Body: `reason` string — Why (shown in Tably) Example body: {"reason":"Guest canceled online"} Example answer: {"id":"API-MFX2K91","number":12,"status":"canceled","service":"table","table":"4","guests":2,"waiter":"Dara","openedAt":"2026-10-07T12:00","closedAt":null,"items":[{"id":"b3dc…","dishId":"pad-thai","name":"Pad Thai","quantity":2,"price":6.5,"guest":0,"note":"no peanuts","sentAt":"2026-10-07T12:01","readyQuantity":0,"removed":false},{"id":"7a01…","dishId":"iced-latte","name":"Iced latte · Oat milk","quantity":1,"price":3,"guest":0,"sentAt":"2026-10-07T12:01","readyQuantity":1,"removed":false}],"subtotal":16,"discount":0,"deliveryFee":0,"payments":[],"paid":0} ### GET /customers — Customers Regular guests and business clients with their terms. Example answer: {"customers":[{"id":"176c…","kind":"person","name":"Mia Tran","phone":"+1 555 0100","email":"","discountPercent":10,"active":true,"createdAt":"2026-10-01T09:12:00Z"}]} ### GET /customers/{id} — One customer A customer by id. - path `id` (required): The customer id Example answer: {"id":"176c…","kind":"person","name":"Mia Tran","phone":"+1 555 0100","discountPercent":10,"active":true} ### POST /customers — Add a customer (write key: Customers) A new customer — from a loyalty app or a booking form. Webhook: customer.created. Body: `name`* string — Name; `phone` string — Phone; `email` string — Email; `address` string — Address; `notes` string — Notes; `discountPercent` number — 0–100, off every order; `kind` "person" | "business" — Default person Example body: {"name":"Mia Tran","phone":"+1 555 0100","discountPercent":10} Example answer: {"id":"176c…","kind":"person","name":"Mia Tran","phone":"+1 555 0100","discountPercent":10,"active":true} ### PATCH /customers/{id} — Change a customer (write key: Customers) Change any of the fields above, or active: false. Webhook: customer.updated. - path `id` (required): The customer id Body: `…` — Any field of create_customer, and active Example body: {"discountPercent":15} Example answer: {"id":"176c…","name":"Mia Tran","discountPercent":15,"active":true} ### GET /employees/on-shift — Who is at work now Who is working / on shift right now: the people clocked in and not out yet, with since when and the hours so far — by the Time clock add-on. timeClock: false (and nobody) while the add-on is off. Example answer: {"timeClock":true,"employees":[{"id":"dara","name":"Dara","role":"Waiter","since":"2026-10-11T08:58:12Z","hours":4.25}]} ### GET /schedule — Who works on a day By the schedule (Employees → Schedule): who should work that day and why (the usual week, a rotation, a day changed). With the Time clock add-on also who came and when, late by how many minutes against the shift, who left, and who is missing: status came, late, absent, not_in_yet, day_off or came_on_a_day_off. - query `date`: YYYY-MM-DD (default: today) Example answer: {"date":"2026-10-01","timeClock":true,"working":3,"employees":[{"id":"dara","name":"Dara","role":"Waiter","works":true,"why":"usual working day","came":"2026-10-01T08:12:40","atWork":true,"shift":"08:00","lateMinutes":12,"status":"late"},{"id":"vanna","name":"Vanna","role":"Waiter","works":true,"why":"rotation 2 on, 2 off","atWork":false,"status":"not_in_yet"}]} ### GET /schedule/days — Who works and who is off, day by day The schedule for several days (up to 31, from a date): for each day who should work and who has a day off and why (the usual week, a rotation, a day changed). For “who works this week”, “when is Dara off”, “who is off on Sunday”. - query `from`: YYYY-MM-DD (default: today) - query `days`: How many days, 1–31 (default 7) Example answer: {"from":"2026-10-05","days":[{"date":"2026-10-05","weekday":"Monday","working":[{"id":"dara","name":"Dara","role":"Waiter"}],"off":[{"id":"vanna","name":"Vanna","why":"rotation day off"}]}]} ### GET /timeclock — Hours worked Time clock marks for a period of days (up to 31): who came and left when and the hours, with each person’s days and hours in total. For pay, late comings or who worked when. timeClock: false while the add-on is off. - query `from`: YYYY-MM-DD (default: the day of to) - query `to`: YYYY-MM-DD (default: today) Example answer: {"timeClock":true,"from":"2026-10-07","to":"2026-10-01","people":[{"employeeId":"dara","name":"Dara","days":5,"hours":41.5}],"marks":[{"employeeId":"dara","name":"Dara","in":"2026-10-07T08:58:12","out":"2026-10-07T17:04:40","atWork":false,"hours":8.1}]} ### GET /kitchen — The kitchen now Dishes sent to the kitchen and still cooking — where, which station, how many minutes they wait (longest first) — and dishes ready on orders still open (ready how long ago). Example answer: {"at":"2026-10-01T13:20:00","cookingCount":2,"longestWaitMinutes":18,"cooking":[{"orderId":"…","place":"Table 4","dish":"Fish amok","station":"Kitchen","quantity":2,"sentAt":"2026-10-01T13:02","waitingMinutes":18}],"readyOnOpenOrders":[{"orderId":"…","place":"#12","dish":"Iced latte","station":"Bar","quantity":1,"readyAt":"2026-10-01T13:15","readyMinutesAgo":5}]} ### GET /employees — The team Names, roles, who is active (never PINs or pay) and each one’s schedule: the usual days off of the week (or a rotation: so many days on, so many off, from a date) and the single days changed from today on. active means employed, not at work now: who is at work now is GET /employees/on-shift; who works on a day is GET /schedule or /schedule/days. Example answer: {"employees":[{"id":"dara","name":"Dara","role":"Waiter","active":true,"schedule":{"usualDaysOff":["Sunday"],"extraWorkingDays":[],"changedDaysOff":["2026-10-08"]}},{"id":"vanna","name":"Vanna","role":"Cook","active":true,"schedule":{"rotation":{"daysOn":2,"daysOff":2,"from":"2026-10-01"},"extraWorkingDays":[],"changedDaysOff":[]}}]} ### GET /floors — Floors and tables Every floor with its tables, seats and whether the table is busy right now. Example answer: {"floors":[{"id":"main","name":"Main floor","tables":[{"number":"4","seats":6,"busy":true}]}]} ### GET /inventory — Stock Every ingredient with its stock, minimum, cost and category (when it has one); low: true when below the minimum. Webhook: stock.low. Example answer: {"ingredients":[{"id":"chicken","name":"Chicken","unit":"kg","stock":1.4,"minimum":2,"low":true,"cost":4.8,"category":"Meat"}]} ### POST /ingredients — Add an ingredient (write key: Stock & supplies) A new ingredient with no stock — stock comes with received supplies. One with the same name is given back as it is, so a retry never makes two. Webhook: ingredient.created. Body: `name`* string — Up to 80 characters; `unit`* "kg" | "l" | "pcs" — Cannot be changed later; `minimum` number — Below it, the ingredient is low (stock.low); `category` string — Groups the stock list (e.g. Sauces), up to 40 characters Example body: {"name":"Tamarind paste","unit":"kg","minimum":1,"category":"Sauces"} Example answer: {"id":"9c1e…","name":"Tamarind paste","unit":"kg","stock":0,"minimum":1} ### PATCH /ingredients/{id} — Change an ingredient (write key: Stock & supplies) A new name, minimum (the low-stock line) or category — send only what changes. The unit and stock do not change here: stock moves with supplies and sales. - path `id` (required): The ingredient id (from /inventory) Body: `name` string — Up to 80 characters; `minimum` number — Low-stock line, in its unit; `category` string — Up to 40 characters (empty: none) Example body: {"minimum":2} Example answer: {"id":"9c1e…","name":"Tamarind paste","unit":"kg","stock":3.5,"minimum":2} ### GET /ingredients/{id}/moves — An ingredient’s history What happened to one ingredient in a period (up to 31 days): deliveries in (supplier, price, storage), what sales took day by day (by today’s recipes), moves between storages; with its stock now. Needs Inventory in the plan. - path `id` (required): The ingredient id (from /inventory) - query `from`: YYYY-MM-DD - query `to`: YYYY-MM-DD (default: today) Example answer: {"id":"9c1e…","name":"Rice noodles","unit":"kg","stockNow":6.4,"averageCost":1.8,"from":"2026-10-01","to":"2026-10-07","delivered":10,"usedBySales":7.2,"moves":[{"date":"2026-10-02","type":"delivery","quantity":10,"price":1.8,"supplier":"Lucky Market","storage":"Main"},{"date":"2026-10-02","type":"sales","quantity":-1.2,"receipts":12},{"date":"2026-10-03","type":"move","quantity":2,"from":"Main","to":"Bar"}]} ### GET /suppliers — Suppliers Every supplier with their contacts. Example answer: {"suppliers":[{"id":"4b7a…","name":"Green Valley Farm","phone":"+1 555 0142","email":"orders@greenvalley.example","address":"","notes":"","active":true}]} ### POST /suppliers — Add a supplier (write key: Stock & supplies) A new supplier. One with the same name is given back as it is. Webhook: supplier.created. Body: `name`* string — Up to 80 characters; `phone` string — Phone; `email` string — Email; `address` string — Address; `notes` string — Notes Example body: {"name":"Green Valley Farm","phone":"+1 555 0142"} Example answer: {"id":"4b7a…","name":"Green Valley Farm","phone":"+1 555 0142","email":"","address":"","notes":"","active":true} ### GET /supplies — Supplies Deliveries by date, newest first: what came, at what price, the total, what is paid and what is still owed. - query `from`: YYYY-MM-DD (default: today) - query `to`: YYYY-MM-DD (up to 366 days) Example answer: {"from":"2026-10-01","to":"2026-10-07","supplies":[{"id":"e2f0…","date":"2026-10-07T09:30","supplier":"Green Valley Farm","storage":"Main storage","status":"draft","items":[{"ingredientId":"chicken","quantity":5,"price":4.8}],"deliveryFee":0,"commission":0,"total":24,"paid":24,"unpaid":0,"accountId":"cash","comment":"via API · Purchasing","externalId":"INV-2041"}]} ### POST /supplies — Add a supply (write key: Stock & supplies) A delivery from a supplier — from a purchasing app or the supplier's invoice. By default a draft: someone checks it on the website and receives it. status: "received" adds the stock at once; a received supply can then only be corrected on the website, never removed. Webhooks: supply.created (and supply.received). Body: `supplierId`* string — The supplier's id or name (GET /suppliers); `items`* array — [{ ingredientId, quantity, price }] — the price of one unit (kg, l or piece); 1–200; `status` "draft" | "received" — Default draft; `date` string — YYYY-MM-DD or YYYY-MM-DDTHH:MM, up to a year back (default: now); `storage` string — Where it goes (default: the first storage); `deliveryFee` number — Added to what is owed; `commission` number — Added to what is owed; `paid` number — Paid already (at most the total); needs accountId; `accountId` string — Paid from this account (GET /finance); `comment` string — Up to 300 characters; `externalId` string — Your id for it: sending it again gives back the same supply Example body: {"supplierId":"Green Valley Farm","items":[{"ingredientId":"chicken","quantity":5,"price":4.8}],"paid":24,"accountId":"cash","externalId":"INV-2041"} Example answer: {"id":"e2f0…","date":"2026-10-07T09:30","supplier":"Green Valley Farm","storage":"Main storage","status":"draft","items":[{"ingredientId":"chicken","quantity":5,"price":4.8}],"deliveryFee":0,"commission":0,"total":24,"paid":24,"unpaid":0,"accountId":"cash","comment":"via API · Purchasing","externalId":"INV-2041"} ### POST /supplies/{id}/receive — Receive a supply (write key: Stock & supplies) A draft supply received: its stock is added. Already received: given back as it is. Webhook: supply.received. - path `id` (required): The supply id Example answer: {"id":"e2f0…","date":"2026-10-07T09:30","supplier":"Green Valley Farm","storage":"Main storage","status":"received","items":[{"ingredientId":"chicken","quantity":5,"price":4.8}],"deliveryFee":0,"commission":0,"total":24,"paid":24,"unpaid":0,"accountId":"cash","comment":"via API · Purchasing","externalId":"INV-2041"} ### GET /write-offs — Write-offs Stock written off between two days, newest first: from which storage, why, what and how much, and what it cost (at the average cost then). - query `from`: YYYY-MM-DD (default: 7 days ago) - query `to`: YYYY-MM-DD (default: today) Example answer: {"from":"2026-10-01","to":"2026-10-07","writeOffs":[{"id":"7b1c…","date":"2026-10-07T22:10","storage":"Main storage","reason":"Spoiled","comment":"Fridge failed overnight","value":14.6,"items":[{"ingredientId":"chicken","quantity":1.2},{"dishId":"pad-thai","quantity":2}]}]} ### POST /write-offs — Write off stock (write key: Stock & supplies) Stock that left without being sold — spoiled, expired, broken, a staff meal. Products, preparations or dishes (a dish takes what its recipe uses) leave the storage; never below zero. Kept, never changed or removed. Webhook: stock.written_off. Body: `items`* array — [{ ingredientId | preparationId | dishId, quantity }] — a product in its unit, a preparation in its unit, a dish in portions; 1–200; `reason` string — Why: Spoiled, Expired, Damaged, Staff meal, Tasting, Lost or your own words (default: Other); `storage` string — Which storage it leaves (default: the first); `date` string — YYYY-MM-DD or YYYY-MM-DDTHH:MM, up to a year back (default: now); `comment` string — Up to 300 characters; `externalId` string — Your id for it: sending it again gives back the same write-off Example body: {"reason":"Spoiled","items":[{"ingredientId":"chicken","quantity":1.2},{"dishId":"pad-thai","quantity":2}],"comment":"Fridge failed overnight"} Example answer: {"id":"7b1c…","date":"2026-10-07T22:10","storage":"Main storage","reason":"Spoiled","comment":"Fridge failed overnight","value":14.6,"items":[{"ingredientId":"chicken","quantity":1.2},{"dishId":"pad-thai","quantity":2}]} ### GET /finance — Accounts and categories The money accounts (cash drawer, bank, safe…) with today's balance, and the income and expense categories — the ids and names a transaction needs. Example answer: {"accounts":[{"id":"cash","name":"Cash drawer","balance":412.5,"archived":false},{"id":"bank","name":"Bank account","balance":8240,"archived":false}],"categories":[{"id":"utilities","name":"Utilities","type":"expense"},{"id":"electricity","name":"Electricity","type":"expense","parentId":"utilities"},{"id":"salaries","name":"Salaries","type":"expense","parentId":"staff","needsEmployee":true}]} ### GET /transactions — Transactions Income, expenses and transfers by date, newest first (as in Finance → Transactions). - query `from`: YYYY-MM-DD (default: today) - query `to`: YYYY-MM-DD (up to 366 days) Example answer: {"from":"2026-10-01","to":"2026-10-07","transactions":[{"id":"tx-51d2…","date":"2026-10-07T10:15","type":"expense","category":"Electricity","amount":86.4,"accountId":"bank","comment":"September bill · via API · Accounting","externalId":"bank-7781"}]} ### POST /transactions — Add a transaction (write key: Money) Income, an expense or a transfer between accounts — from your accounting or bank. The category is one of the restaurant's (GET /finance); salaries and advances need the employee. It cannot be removed later, only seen in Finance → Transactions with the key's name. Webhook: transaction.created. Body: `type`* "income" | "expense" | "transfer" — What it is; `amount`* number — More than 0, 2 decimals at most; `accountId`* string — The account (GET /finance); for a transfer, where the money comes from; `toAccountId` string — Transfer: where the money goes; `category` string — Income or expense: the category's name or id; `employeeId` string — For staff categories (salaries, advances); `date` string — YYYY-MM-DD or YYYY-MM-DDTHH:MM, up to a year back (default: now); `comment` string — Up to 200 characters; `externalId` string — Your id for it: sending it again gives back the same transaction Example body: {"type":"expense","amount":86.4,"accountId":"bank","category":"Electricity","comment":"September bill","externalId":"bank-7781"} Example answer: {"id":"tx-51d2…","date":"2026-10-07T10:15","type":"expense","category":"Electricity","amount":86.4,"accountId":"bank","comment":"September bill · via API · Accounting","externalId":"bank-7781"} ### GET /cash-drawer — Cash in the drawer now What should be in the drawer now, as on the Dashboard: the cash account in the books (closed shifts, cash expenses and transfers) plus the paid receipts whose shift is not closed yet. One entry per account that takes cash; expected is all of them. Example answer: {"at":"2026-10-11T14:20:05","expected":512.4,"drawers":[{"accountId":"cash","account":"Cash","methods":["Cash"],"expected":512.4,"inBooks":300,"notInShift":212.4,"receiptsNotInShift":9}]} ### GET /reports/dishes — Margin by dish Each dish sold in a period (up to 31 days): how many, sales at its price (before order discounts), food cost by today’s recipes and the ingredients’ average cost, the margin and margin %. Most profitable first — what is best to sell. - query `from`: YYYY-MM-DD - query `to`: YYYY-MM-DD (default: today) Example answer: {"from":"2026-10-01","to":"2026-10-07","sales":2821,"foodCost":812.4,"margin":2008.6,"dishes":[{"dishId":"pad-thai","name":"Pad Thai","quantity":64,"sales":416,"foodCost":118.2,"margin":297.8,"marginPercent":71.6}]} ### GET /shifts — Closed shifts Cash shifts closed on the tablets: who, when, the cash counted and expected (not who is at work now: GET /employees/on-shift). - query `from`: YYYY-MM-DD - query `to`: YYYY-MM-DD Example answer: {"shifts":[{"id":"…","employeeName":"Dara","closedAt":"2026-10-07T23:02","counted":[{"method":"Cash","amount":412}],"expected":[{"method":"Cash","amount":412}]}]} ### GET /reports/sales — Sales report A period in numbers (paid orders): sales, receipts, the average bill, and sales by day, by hour, by dish, by waiter and by payment method. - query `from`: YYYY-MM-DD - query `to`: YYYY-MM-DD (up to 31 days) Example answer: {"from":"2026-10-01","to":"2026-10-07","sales":2821,"receipts":147,"averageBill":19.19,"byDay":[{"date":"2026-10-01","sales":388}],"byHour":[{"hour":"12","sales":610}],"dishes":[{"name":"Iced latte","quantity":96,"sales":240}],"waiters":[{"name":"Dara","receipts":76,"sales":1490}],"paymentMethods":[{"method":"Cash","amount":1702}]} ## Webhooks Tably POSTs {"id","event","createdAt","data"} to your https address, header `Tably-Signature: t=,v1=`. Answer 2xx within 10 s; retried after 1 and 10 minutes. - order.opened: An order is opened — on a tablet or through the API - order.items_added: Dishes are added to an order - order.sent: Dishes are sent to the kitchen - order.item_removed: A dish is removed (after sending, with a manager's approval) - order.moved: An order moves to another table or number - dish.ready: The kitchen display marks dishes ready (also one portion of several) - payment.added: A payment is taken - order.paid: An order is paid in full and closed - order.canceled: An order is canceled - shift.closed: A waiter closes their shift and counts the cash - menu.updated: The menu changes — on the website or through the API - customer.created: A customer is added through the API - customer.updated: A customer is changed through the API - transaction.created: A transaction is added through the API - supply.created: A supply is added through the API - supply.received: A supply added through the API is received (through the API or on the website) - stock.written_off: Stock is written off through the API - supplier.created: A supplier is added through the API - ingredient.created: An ingredient is added through the API - stock.low: After a sale, ingredients below their minimum