API reference

JSON over HTTPS. Every request has your key in Authorization: Bearer tbl_… — create it in Settings → Integrations (read only, or read & write). Amounts are in the restaurant’s currency, times in its time zone.

Base URLhttps://tablypos.com/api/v1/open
Rate limit120 requests / minute / key
ErrorsHTTP status + {"error": "…"}
Safe retriesexternalId: sent twice, made once

Restaurant

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.

Request
curl "https://tablypos.com/api/v1/open/restaurant" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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"
    }
  ]
}

Menu

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.

Request
curl "https://tablypos.com/api/v1/open/menu" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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.

ParameterInDescription
idrequiredpathThe dish id (from /menu)
Request
curl "https://tablypos.com/api/v1/open/dishes/pad-thai" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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}write · Menu

Change a dish

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.

ParameterInDescription
idrequiredpathThe dish id
Body fieldTypeDescription
availablebooleanfalse: off the menu (stop list)
pricenumberThe new price
namestringUp to 80 characters
descriptionstringUp to 300 characters
categorystringAnother category: its id or name (from /menu)
stationstringA cooking station from /menu (empty: none)
recipearrayWhat 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
Request
curl -X PATCH "https://tablypos.com/api/v1/open/dishes/pad-thai" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"recipe":[{"ingredient":"Rice noodles","quantity":120,"unit":"g"},{"ingredient":"Chicken","quantity":80,"unit":"g"},{"ingredient":"Egg","quantity":1}]}'
Response · 200
{
  "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/disheswrite · Menu

Add a dish

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 fieldTypeDescription
namerequiredstringUp to 80 characters
pricerequirednumber0 or more
categoryrequiredstringIts id or name (from /menu)
descriptionstringUp to 300 characters
availablebooleanfalse: added on the stop list (default true)
stationstringA cooking station from /menu
externalIdstringYour id: the same one is never added twice
recipearrayWhat 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
Request
curl -X POST "https://tablypos.com/api/v1/open/dishes" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"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"}]}'
Response · 200
{
  "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}write · Menu

Delete a dish

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.

ParameterInDescription
idrequiredpathThe dish id
Request
curl -X DELETE "https://tablypos.com/api/v1/open/dishes/9d2c…" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "id": "9d2c…",
  "name": "Mango smoothie",
  "deleted": true
}

POST/dishes/{id}/modifier-groupswrite · Menu

Add a modifier group to a dish

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.

ParameterInDescription
idrequiredpathThe dish id (from /menu)
Body fieldTypeDescription
namerequiredstringThe group, up to 60 characters (e.g. Extras)
modestringsingle (one of them, default) or multiple
minnumberAt least so many (0: optional, default)
maxnumberAt most so many (multiple only)
optionsarray[{name, price, ingredient?, quantity?}]
copyFromobject{dishId, groupId}: a copy of that dish’s group instead
Request
curl -X POST "https://tablypos.com/api/v1/open/dishes/pad-thai/modifier-groups" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"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}]}'
Response · 200
{
  "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}write · Menu

Change a modifier group

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.

ParameterInDescription
idrequiredpathThe dish id
grouprequiredpathThe group id (from /dishes/{id})
Body fieldTypeDescription
namestringUp to 60 characters
modestringsingle or multiple
minnumberAt least
maxnumberAt most
positionnumber0 = the first group
qrHiddenbooleantrue: not on the QR menu
Request
curl -X PATCH "https://tablypos.com/api/v1/open/dishes/pad-thai/modifier-groups/g1…" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"min":1}'
Response · 200
{
  "dishId": "pad-thai",
  "dish": "Pad Thai",
  "modifierGroups": []
}

DELETE/dishes/{id}/modifier-groups/{group}write · Menu

Delete a modifier group

Removes the group and its options from the dish (past receipts keep what was chosen). Webhook: menu.updated.

ParameterInDescription
idrequiredpathThe dish id
grouprequiredpathThe group id
Request
curl -X DELETE "https://tablypos.com/api/v1/open/dishes/pad-thai/modifier-groups/g1…" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "dishId": "pad-thai",
  "dish": "Pad Thai",
  "modifierGroups": []
}

POST/dishes/{id}/modifier-groups/{group}/optionswrite · Menu

Add an option to a modifier group

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.

ParameterInDescription
idrequiredpathThe dish id
grouprequiredpathThe group id
Body fieldTypeDescription
namerequiredstringUp to 60 characters
pricenumberThe extra price (default 0)
ingredientstringAn ingredient taken from stock: its id or name
quantitynumberHow much of it, in its unit (default 1)
Request
curl -X POST "https://tablypos.com/api/v1/open/dishes/pad-thai/modifier-groups/g1…/options" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Extra shrimp","price":1.5,"ingredient":"Shrimp","quantity":0.05}'
Response · 200
{
  "dishId": "pad-thai",
  "dish": "Pad Thai",
  "modifierGroups": []
}

PATCH/dishes/{id}/modifier-groups/{group}/options/{option}write · Menu

Change a modifier option

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.

ParameterInDescription
idrequiredpathThe dish id
grouprequiredpathThe group id
optionrequiredpathThe option id
Body fieldTypeDescription
namestringUp to 60 characters
pricenumberThe extra price
ingredientstringIts id or name; "" for none
quantitynumberIn the ingredient’s unit
positionnumber0 = first
qrHiddenbooleantrue: not on the QR menu
Request
curl -X PATCH "https://tablypos.com/api/v1/open/dishes/pad-thai/modifier-groups/g1…/options/o1…" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"price":1}'
Response · 200
{
  "dishId": "pad-thai",
  "dish": "Pad Thai",
  "modifierGroups": []
}

DELETE/dishes/{id}/modifier-groups/{group}/options/{option}write · Menu

Delete a modifier option

Removes one choice from the group. Webhook: menu.updated.

ParameterInDescription
idrequiredpathThe dish id
grouprequiredpathThe group id
optionrequiredpathThe option id
Request
curl -X DELETE "https://tablypos.com/api/v1/open/dishes/pad-thai/modifier-groups/g1…/options/o1…" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "dishId": "pad-thai",
  "dish": "Pad Thai",
  "modifierGroups": []
}

POST/categorieswrite · Menu

Add a category

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 fieldTypeDescription
namerequiredstringUp to 40 characters
parentIdstringInside this category (id from /menu)
Request
curl -X POST "https://tablypos.com/api/v1/open/categories" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Smoothies","parentId":"drinks"}'
Response · 200
{
  "id": "4b7a…",
  "name": "Smoothies",
  "parentId": "drinks"
}

PATCH/categories/{id}write · Menu

Rename or move a category

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.

ParameterInDescription
idrequiredpathThe category id
Body fieldTypeDescription
namestringUp to 40 characters
parentIdstring | nullInside this category, or null: at the top
Request
curl -X PATCH "https://tablypos.com/api/v1/open/categories/4b7a…" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Fresh smoothies"}'
Response · 200
{
  "id": "4b7a…",
  "name": "Fresh smoothies",
  "parentId": "drinks"
}

DELETE/categories/{id}write · Menu

Delete a category

Only an empty one: refused (409) while it has dishes or subcategories, or a promotion uses it. The main screen cannot be deleted.

ParameterInDescription
idrequiredpathThe category id
Request
curl -X DELETE "https://tablypos.com/api/v1/open/categories/4b7a…" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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.

Request
curl "https://tablypos.com/api/v1/open/promotions" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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}write · Menu

Switch a promotion on or off

A promotion on (active: true) or paused; the tablets follow at once.

ParameterInDescription
idrequiredpathThe promotion id (from /promotions)
Body fieldTypeDescription
activerequiredbooleantrue: on, false: paused
Request
curl -X PATCH "https://tablypos.com/api/v1/open/promotions/happy-hour" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"active":false}'
Response · 200
{
  "id": "happy-hour",
  "name": "Happy hour",
  "active": false
}

Orders

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.

ParameterInDescription
fromqueryFirst day, YYYY-MM-DD (default: today)
toqueryLast day, YYYY-MM-DD (default: from)
statusqueryopen, paid or canceled · open | paid | canceled
limitqueryUp to 1000 (default 500)
Request
curl "https://tablypos.com/api/v1/open/orders?from=2026-10-01&to=2026-10-07" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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,
      "payments": [
        {
          "method": "Cash",
          "amount": 16,
          "tip": 1
        }
      ],
      "paid": 16
    }
  ]
}

GET/orders/open

Orders open now

What is on the tables right now, oldest first — for a live board or a delivery screen.

Request
curl "https://tablypos.com/api/v1/open/orders/open" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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.

ParameterInDescription
idrequiredpathThe order id
Request
curl "https://tablypos.com/api/v1/open/orders/API-MFX2K91" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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
    }
  ],
  "paid": 16
}

POST/orderswrite · Orders

Create an order

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 fieldTypeDescription
servicerequired"table" | "guest_number" | "counter"Where it is served
tablestringThe table number (service: table)
guestNumberintegerThe guest number (service: guest_number)
guestsintegerHow many people
typestringThe order type, by id or name (GET /restaurant): takeaway, delivery… — marked on the tablets, the kitchen display and the tickets
customerIdstringA customer (their discount applies at payment)
itemsrequiredarray[{ dishId, quantity, note?, modifiers?: [{ groupId, optionId }] }]
sendbooleanSend to the kitchen now (default true)
Request
curl -X POST "https://tablypos.com/api/v1/open/orders" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"service":"counter","type":"takeaway","items":[{"dishId":"pad-thai","quantity":2,"note":"no peanuts"},{"dishId":"iced-latte","modifiers":[{"groupId":"milk","optionId":"oat"}]}]}'
Response · 200
{
  "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}/itemswrite · Orders

Add dishes

More dishes for an open order; they go to the kitchen (send: false keeps them). Webhooks: order.items_added, order.sent.

ParameterInDescription
idrequiredpathThe order id
Body fieldTypeDescription
itemsrequiredarrayAs in create_order
sendbooleanDefault true
Request
curl -X POST "https://tablypos.com/api/v1/open/orders/API-MFX2K91/items" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"items":[{"dishId":"mango-rice","quantity":1}]}'
Response · 200
{
  "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}/paymentswrite · Orders

Record a payment

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.

ParameterInDescription
idrequiredpathThe order id
Body fieldTypeDescription
amountrequirednumberHow much was paid
methodstringPayment method name (default "Online")
tipnumberTip on top
Request
curl -X POST "https://tablypos.com/api/v1/open/orders/API-MFX2K91/payments" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"method":"Online","amount":16}'
Response · 200
{
  "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
    }
  ],
  "paid": 16
}

POST/orders/{id}/closewrite · Orders

Pay and close an order

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.

ParameterInDescription
idrequiredpathThe order id
Body fieldTypeDescription
methodstringA payment method of the restaurant (default Online)
tipnumberA tip on top
Request
curl -X POST "https://tablypos.com/api/v1/open/orders/API-…/close" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"method":"Online"}'
Response · 200
{
  "id": "API-…",
  "status": "paid",
  "subtotal": 13,
  "payments": [
    {
      "method": "Online",
      "amount": 13,
      "tip": 0
    }
  ]
}

POST/orders/{id}/cancelwrite · Orders

Cancel an order

Cancel an order with nothing paid. Webhook: order.canceled.

ParameterInDescription
idrequiredpathThe order id
Body fieldTypeDescription
reasonstringWhy (shown in Tably)
Request
curl -X POST "https://tablypos.com/api/v1/open/orders/API-MFX2K91/cancel" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Guest canceled online"}'
Response · 200
{
  "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/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).

Request
curl "https://tablypos.com/api/v1/open/kitchen" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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
    }
  ]
}

Customers

GET/customers

Customers

Regular guests and business clients with their terms.

Request
curl "https://tablypos.com/api/v1/open/customers" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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.

ParameterInDescription
idrequiredpathThe customer id
Request
curl "https://tablypos.com/api/v1/open/customers/id" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "id": "176c…",
  "kind": "person",
  "name": "Mia Tran",
  "phone": "+1 555 0100",
  "discountPercent": 10,
  "active": true
}

POST/customerswrite · Customers

Add a customer

A new customer — from a loyalty app or a booking form. Webhook: customer.created.

Body fieldTypeDescription
namerequiredstringName
phonestringPhone
emailstringEmail
addressstringAddress
notesstringNotes
discountPercentnumber0–100, off every order
kind"person" | "business"Default person
Request
curl -X POST "https://tablypos.com/api/v1/open/customers" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Mia Tran","phone":"+1 555 0100","discountPercent":10}'
Response · 200
{
  "id": "176c…",
  "kind": "person",
  "name": "Mia Tran",
  "phone": "+1 555 0100",
  "discountPercent": 10,
  "active": true
}

PATCH/customers/{id}write · Customers

Change a customer

Change any of the fields above, or active: false. Webhook: customer.updated.

ParameterInDescription
idrequiredpathThe customer id
Body fieldTypeDescription
…Any field of create_customer, and active
Request
curl -X PATCH "https://tablypos.com/api/v1/open/customers/id" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"discountPercent":15}'
Response · 200
{
  "id": "176c…",
  "name": "Mia Tran",
  "discountPercent": 15,
  "active": true
}

Team & floor

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.

Request
curl "https://tablypos.com/api/v1/open/employees/on-shift" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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.

ParameterInDescription
datequeryYYYY-MM-DD (default: today)
Request
curl "https://tablypos.com/api/v1/open/schedule?date=2026-10-01" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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”.

ParameterInDescription
fromqueryYYYY-MM-DD (default: today)
daysqueryHow many days, 1–31 (default 7)
Request
curl "https://tablypos.com/api/v1/open/schedule/days?from=2026-10-05&days=7" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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.

ParameterInDescription
fromqueryYYYY-MM-DD (default: the day of to)
toqueryYYYY-MM-DD (default: today)
Request
curl "https://tablypos.com/api/v1/open/timeclock?from=2026-10-07&to=2026-10-01" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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/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.

Request
curl "https://tablypos.com/api/v1/open/employees" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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.

Request
curl "https://tablypos.com/api/v1/open/floors" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "floors": [
    {
      "id": "main",
      "name": "Main floor",
      "tables": [
        {
          "number": "4",
          "seats": 6,
          "busy": true
        }
      ]
    }
  ]
}

Stock

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.

Request
curl "https://tablypos.com/api/v1/open/inventory" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "ingredients": [
    {
      "id": "chicken",
      "name": "Chicken",
      "unit": "kg",
      "stock": 1.4,
      "minimum": 2,
      "low": true,
      "cost": 4.8,
      "category": "Meat"
    }
  ]
}

POST/ingredientswrite · Stock & supplies

Add an ingredient

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 fieldTypeDescription
namerequiredstringUp to 80 characters
unitrequired"kg" | "l" | "pcs"Cannot be changed later
minimumnumberBelow it, the ingredient is low (stock.low)
categorystringGroups the stock list (e.g. Sauces), up to 40 characters
Request
curl -X POST "https://tablypos.com/api/v1/open/ingredients" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Tamarind paste","unit":"kg","minimum":1,"category":"Sauces"}'
Response · 200
{
  "id": "9c1e…",
  "name": "Tamarind paste",
  "unit": "kg",
  "stock": 0,
  "minimum": 1
}

PATCH/ingredients/{id}write · Stock & supplies

Change an ingredient

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.

ParameterInDescription
idrequiredpathThe ingredient id (from /inventory)
Body fieldTypeDescription
namestringUp to 80 characters
minimumnumberLow-stock line, in its unit
categorystringUp to 40 characters (empty: none)
Request
curl -X PATCH "https://tablypos.com/api/v1/open/ingredients/9c1e…" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"minimum":2}'
Response · 200
{
  "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.

ParameterInDescription
idrequiredpathThe ingredient id (from /inventory)
fromqueryYYYY-MM-DD
toqueryYYYY-MM-DD (default: today)
Request
curl "https://tablypos.com/api/v1/open/ingredients/9c1e…/moves?from=2026-10-01&to=2026-10-07" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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.

Request
curl "https://tablypos.com/api/v1/open/suppliers" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "suppliers": [
    {
      "id": "4b7a…",
      "name": "Green Valley Farm",
      "phone": "+1 555 0142",
      "email": "orders@greenvalley.example",
      "address": "",
      "notes": "",
      "active": true
    }
  ]
}

POST/supplierswrite · Stock & supplies

Add a supplier

A new supplier. One with the same name is given back as it is. Webhook: supplier.created.

Body fieldTypeDescription
namerequiredstringUp to 80 characters
phonestringPhone
emailstringEmail
addressstringAddress
notesstringNotes
Request
curl -X POST "https://tablypos.com/api/v1/open/suppliers" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Green Valley Farm","phone":"+1 555 0142"}'
Response · 200
{
  "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.

ParameterInDescription
fromqueryYYYY-MM-DD (default: today)
toqueryYYYY-MM-DD (up to 366 days)
Request
curl "https://tablypos.com/api/v1/open/supplies?from=2026-10-01&to=2026-10-07" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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/supplieswrite · Stock & supplies

Add a supply

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 fieldTypeDescription
supplierIdrequiredstringThe supplier's id or name (GET /suppliers)
itemsrequiredarray[{ ingredientId, quantity, price }] — the price of one unit (kg, l or piece); 1–200
status"draft" | "received"Default draft
datestringYYYY-MM-DD or YYYY-MM-DDTHH:MM, up to a year back (default: now)
storagestringWhere it goes (default: the first storage)
deliveryFeenumberAdded to what is owed
commissionnumberAdded to what is owed
paidnumberPaid already (at most the total); needs accountId
accountIdstringPaid from this account (GET /finance)
commentstringUp to 300 characters
externalIdstringYour id for it: sending it again gives back the same supply
Request
curl -X POST "https://tablypos.com/api/v1/open/supplies" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"supplierId":"Green Valley Farm","items":[{"ingredientId":"chicken","quantity":5,"price":4.8}],"paid":24,"accountId":"cash","externalId":"INV-2041"}'
Response · 200
{
  "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}/receivewrite · Stock & supplies

Receive a supply

A draft supply received: its stock is added. Already received: given back as it is. Webhook: supply.received.

ParameterInDescription
idrequiredpathThe supply id
Request
curl -X POST "https://tablypos.com/api/v1/open/supplies/id/receive" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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).

ParameterInDescription
fromqueryYYYY-MM-DD (default: 7 days ago)
toqueryYYYY-MM-DD (default: today)
Request
curl "https://tablypos.com/api/v1/open/write-offs" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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-offswrite · Stock & supplies

Write off stock

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 fieldTypeDescription
itemsrequiredarray[{ ingredientId | preparationId | dishId, quantity }] — a product in its unit, a preparation in its unit, a dish in portions; 1–200
reasonstringWhy: Spoiled, Expired, Damaged, Staff meal, Tasting, Lost or your own words (default: Other)
storagestringWhich storage it leaves (default: the first)
datestringYYYY-MM-DD or YYYY-MM-DDTHH:MM, up to a year back (default: now)
commentstringUp to 300 characters
externalIdstringYour id for it: sending it again gives back the same write-off
Request
curl -X POST "https://tablypos.com/api/v1/open/write-offs" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Spoiled","items":[{"ingredientId":"chicken","quantity":1.2},{"dishId":"pad-thai","quantity":2}],"comment":"Fridge failed overnight"}'
Response · 200
{
  "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
    }
  ]
}

Money

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.

Request
curl "https://tablypos.com/api/v1/open/finance" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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).

ParameterInDescription
fromqueryYYYY-MM-DD (default: today)
toqueryYYYY-MM-DD (up to 366 days)
Request
curl "https://tablypos.com/api/v1/open/transactions?from=2026-10-01&to=2026-10-07" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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/transactionswrite · Money

Add a transaction

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 fieldTypeDescription
typerequired"income" | "expense" | "transfer"What it is
amountrequirednumberMore than 0, 2 decimals at most
accountIdrequiredstringThe account (GET /finance); for a transfer, where the money comes from
toAccountIdstringTransfer: where the money goes
categorystringIncome or expense: the category's name or id
employeeIdstringFor staff categories (salaries, advances)
datestringYYYY-MM-DD or YYYY-MM-DDTHH:MM, up to a year back (default: now)
commentstringUp to 200 characters
externalIdstringYour id for it: sending it again gives back the same transaction
Request
curl -X POST "https://tablypos.com/api/v1/open/transactions" \
  -H "Authorization: Bearer $TABLY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"expense","amount":86.4,"accountId":"bank","category":"Electricity","comment":"September bill","externalId":"bank-7781"}'
Response · 200
{
  "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.

Request
curl "https://tablypos.com/api/v1/open/cash-drawer" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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
    }
  ]
}

Reports

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.

ParameterInDescription
fromqueryYYYY-MM-DD
toqueryYYYY-MM-DD (default: today)
Request
curl "https://tablypos.com/api/v1/open/reports/dishes?from=2026-10-01&to=2026-10-07" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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).

ParameterInDescription
fromqueryYYYY-MM-DD
toqueryYYYY-MM-DD
Request
curl "https://tablypos.com/api/v1/open/shifts" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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.

ParameterInDescription
fromqueryYYYY-MM-DD
toqueryYYYY-MM-DD (up to 31 days)
Request
curl "https://tablypos.com/api/v1/open/reports/sales?from=2026-10-01&to=2026-10-07" \
  -H "Authorization: Bearer $TABLY_KEY"
Response · 200
{
  "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
    }
  ]
}