developer / api

20Tabs API

Connect your application to 20Tabs. Manage products, submit orders, register payment methods and read receipts, closings and revenue. All over a simple REST API.

Base URL https://api.20tabs.app
v1 OpenAPI 3.0 ↓ openapi.yaml

Authentication

The 20Tabs API uses OAuth 2.0 with the Authorization Code Flow. Each 20Tabs account authorizes your app, which gives you an access token scoped to that organization's subscription.

Apps can be registered directly in the 20Tabs backoffice under Developer. Your client ID and client secret are available as soon as the app is created. Your app can also receive webhooks and extend 20Tabs with fields and actions.

If you do not have a 20Tabs account yet, you can create one on our website. Developers building an integration for others can sign up the same way and contact us at … afterwards; we are happy to provide a free account for development purposes.

  1. Create your app in the backoffice under Developer and copy your client ID and client secret.
  2. Your app shows up in the App Store of your own organization right away. Contact us when you want to make it available to other organizations.
  3. When the organization installs your app we will redirect them to your authentication URL with the organization domain as a query parameter:
  4. https://your-app.example.com/install?customer_domain=example.20tabs.app
  5. You request access for this organization and the scopes you need via the Authorization Code Flow.
  6. Exchange the authorization code for an access token. Authorization tokens are valid for 5 minutes.
  7. Send the access token on every request in the Authorization header:
  8. Authorization: Bearer <access token>
  9. Access tokens are valid for 1 hour. Use the refresh token to get a new access token when the old one expires.

OAuth endpoints

Authorization https://{organization_domain}.20tabs.app/oauth/authorize
Token https://api.20tabs.app/oauth/token
Refresh https://api.20tabs.app/oauth/refresh

Scopes

cash_register:read

Read cash registers, their mutations and counts

cash_register:write

Create cash registers, book cash mutations and count the cash

category_of_revenue:read

Read categories of revenue

category_of_revenue:write

Create categories of revenue

closure:read

Read the periods in which online reservations and shops are closed

closure:write

Close online reservations and shops for a period, for example for holidays

compensation_reason:read

Read compensation reasons

compensation_reason:write

Create, update and archive compensation reasons

customer:read

Read customers and customer groups

customer:write

Create and update customers and customer groups

daily_closing:read

Read daily closings

device:read

Read devices

device:write

Create, update and link devices

discount_rule:read

Read discount rules

discount_rule:write

Create, update and delete discount rules

email_template:read

Read the subject and text of the mails to guests

email_template:write

Change the subject and text of the mails to guests

employee:read

Read employees and their roles

employee:write

Create and update employees and their roles

floorplan:read

Read areas and tables

floorplan:write

Create and update areas and tables

ledger_account:read

Read ledger accounts and their bookings

ledger_account:write

Set the numbers and codes of ledger accounts

monthly_closing:read

Read monthly closings

order:read

Read orders

order:write

Create orders

organization:read

Read the organization and its settings

organization:write

Update the organization's settings and sender address

payment:read

Read payments

payment:write

Create payments

payment_method:read

Read payment methods

payment_method:write

Manage your app's payment methods

preparation:read

Read preparation locations and states

preparation:write

Manage preparation locations and states

product:read

Read products, allergens, markers and fees

product:write

Create and update products, allergens, markers and fees

receipt:read

Read receipts

receipt:write

Update receipts

report:read

Read sales, tax, payment and trend reports

reservation:read

Read reservations, availability and the reservation program

reservation:write

Create, update, confirm, cancel and check in reservations, and set up reservation windows, kinds and the reservation program

shop:read

Read shops, their opening hours and pick-up times

shop:write

Set up shops and their opening hours

task:read

Read tasks in the organization's task list

task:write

Create and complete tasks

tax_rate:read

Read tax rates

voucher:read

Read vouchers, gift cards and their balances

Webhooks, fields and actions

Besides the API, an app can receive webhooks, add its own fields to forms in 20Tabs and place buttons in the register and backoffice. All of this is configured on your app under Developer. The webhook URL, installation URL, launch URLs and field sources must be on a domain that has been verified for your app; you can request verification there as well.

Webhooks

Choose the events your app should receive and we send a POST request to your webhook URL whenever one occurs. Each event requires the matching read permission. Available events: guests, daily closings, monthly closings, orders, products, receipts, reservations, tasks and voucher cards.

{
  "subscription_id": "0b6f1c2e-…",
  "resource_type": "reservation",
  "resource_id": 42,
  "action": "create",
  "options": {}
}

The subscription_id identifies the organization that installed your app. Use the resource_id to fetch the current state of the object through the API. The action is create, update or destroy. Requests also carry an Accept-Language header and, when available, 20Tabs-Session, 20Tabs-Device and 20Tabs-Employee headers. Respond with a 2xx status code.

Fields

Fields let the organization store settings for your app on its own records, for example an external account number on a payment method. They appear in the form of the record they belong to. Fields can be added to products, vouchers, revenue categories, payment methods, loyalty settings and reservation settings.

  • Text field: a free text input.
  • Select field: a fixed list of values, or values loaded from a source URL on your side.

Use a source URL when the choices depend on data in your app, for example the ledger accounts of the organization in your accounting software. Every time the form is shown, we request the choices from that URL with a GET, sending the X-Subscription-Id header so you know which organization is asking. Respond within 3 seconds with a JSON list of label and value pairs:

[["Main account", "1000"], ["Savings", "1100"]]

When a record with values for your app is saved, we send a webhook with the action app_fields_filled. The options contain the values your app's fields hold on that record.

Actions

Actions add a button for your app to 20Tabs. Each action has a label, an identifier and a place where it is shown:

  • Receipt: in the receipt options or on the payment screen of the register.
  • Payment methods: in the menu on the payment methods page of the backoffice.
  • Reports: on the reports page of the backoffice.

Without a launch URL, pressing the button sends a webhook with the action's identifier as action. For receipt actions the resource_id is the receipt.

With a launch URL, the user is sent to your app instead. This is only available to users with backoffice access. We add a code, the subscription_id and the user's locale to the URL; exchange the code at the token endpoint, just like in the authorization flow, to sign the user in.

https://your-app.example.com/reports?code=…&subscription_id=…&locale=en

Allergens

GET /v1/allergens product:read

Returns the allergens products can be marked with, in display order. Guests see them in shops and on the kiosk; assign them with `allergen_ids` on `PATCH /v1/products/{id}`.

Parameters

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Allergen List allergens
Response attributes

The items on this page.

id integer

Unique identifier of the allergen.

name string

Name in the organization's language.

name_translations object

Name per language code, for example `{ "nl": "Noten", "en": "Nuts" }`.

icon string

Icon shown next to the name, for example `wheat` or `milk`.

position integer

Display order, starting at 1.

created_at datetime

Time the allergen was created.

updated_at datetime

Time the allergen was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "name_translations": {},
      "icon": "string",
      "position": 1,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/allergens product:write

Adds an allergen, for example `{ "name_translations": { "nl": "Selderij", "en": "Celery" }, "icon": "celery" }`. Give `name` or `name_translations`.

Request body

name string

Name in the organization's language, for example `Noten`

name_translations object

Name per language code, for example `{ "nl": "Noten", "en": "Nuts", "de": "Schalenfrüchte" }`; replaces all translations

position integer

Display order, starting at 1; other allergens shift to make room

icon enum req

Icon shown next to the name

bank_notesbell_alertboltcameracardchat_bubblecheck_circlecheckclipboardclockclosecredit_cardcross_circlecrosseuroexclamation_circleforwardgeargrouphouseitemkeyleaflockmailmapmergeminus_circleminusnewspaperpencilpersonsplus_circleplusprinterquestion_mark_circleremoverounded_arrowssearchshopping_cartsmartphonestoretagtaskthumb_downthumb_uptrashtrucktvuputensilswheatcelerycrustaceanseggsfishlupinmilkmolluscsmustardnutspeanutssesamesoybeanssulphites

{
  "name_translations": {
    "nl": "Selderij",
    "en": "Celery"
  },
  "icon": "celery"
}

Responses

201 Allergen Create an allergen
Response attributes
id integer

Unique identifier of the allergen.

name string

Name in the organization's language.

name_translations object

Name per language code, for example `{ "nl": "Noten", "en": "Nuts" }`.

icon string

Icon shown next to the name, for example `wheat` or `milk`.

position integer

Display order, starting at 1.

created_at datetime

Time the allergen was created.

updated_at datetime

Time the allergen was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "name_translations": {},
  "icon": "string",
  "position": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/allergens/{id} product:read

Retrieve an allergen

Parameters

id path · integer req

Unique identifier of the allergen

Responses

200 Allergen Retrieve an allergen
Response attributes
id integer

Unique identifier of the allergen.

name string

Name in the organization's language.

name_translations object

Name per language code, for example `{ "nl": "Noten", "en": "Nuts" }`.

icon string

Icon shown next to the name, for example `wheat` or `milk`.

position integer

Display order, starting at 1.

created_at datetime

Time the allergen was created.

updated_at datetime

Time the allergen was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "name_translations": {},
  "icon": "string",
  "position": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/allergens/{id} product:write

Updates the given attributes; attributes that are not included keep their current value. `name` changes only the organization's language.

Parameters

id path · integer req

Unique identifier of the allergen

Request body

name string

Name in the organization's language, for example `Noten`

name_translations object

Name per language code, for example `{ "nl": "Noten", "en": "Nuts", "de": "Schalenfrüchte" }`; replaces all translations

position integer

Display order, starting at 1; other allergens shift to make room

icon enum

Icon shown next to the name

bank_notesbell_alertboltcameracardchat_bubblecheck_circlecheckclipboardclockclosecredit_cardcross_circlecrosseuroexclamation_circleforwardgeargrouphouseitemkeyleaflockmailmapmergeminus_circleminusnewspaperpencilpersonsplus_circleplusprinterquestion_mark_circleremoverounded_arrowssearchshopping_cartsmartphonestoretagtaskthumb_downthumb_uptrashtrucktvuputensilswheatcelerycrustaceanseggsfishlupinmilkmolluscsmustardnutspeanutssesamesoybeanssulphites

{
  "name_translations": {
    "nl": "Selderij",
    "en": "Celery"
  }
}

Responses

200 Allergen Update an allergen
Response attributes
id integer

Unique identifier of the allergen.

name string

Name in the organization's language.

name_translations object

Name per language code, for example `{ "nl": "Noten", "en": "Nuts" }`.

icon string

Icon shown next to the name, for example `wheat` or `milk`.

position integer

Display order, starting at 1.

created_at datetime

Time the allergen was created.

updated_at datetime

Time the allergen was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "name_translations": {},
  "icon": "string",
  "position": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/allergens/{id} product:write

Deletes the allergen and removes it from all products.

Parameters

id path · integer req

Unique identifier of the allergen

Responses

204 Delete an allergen

Areas

Returns the areas of the floor plan in display order, for example `Restaurant`, `Terrace` and `Bar`. Each area holds tables; list them with `GET /v1/tables?area_id=`.

Parameters

include_archived query · boolean

Include archived areas

default false

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Area List areas
Response attributes

The items on this page.

id integer

Unique identifier of the area.

name string

Name of the area, for example `Terrace`.

position integer

Display order within the floor plan, starting at 1.

table_combination_mode string

How online reservations may join tables for larger parties: `automatic` combines any tables in the area, `explicit` only combines tables linked to each other (see the table's `links`).

hidden boolean

Whether the area is temporarily hidden, for example a terrace in winter. Hidden areas are left out of the floor plan at the register and out of online reservations.

archived boolean

Whether the area is archived.

tables_count integer

Number of unarchived tables in the area.

created_at datetime

Time the area was created.

updated_at datetime

Time the area was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "position": 1,
      "table_combination_mode": "string",
      "hidden": true,
      "archived": true,
      "tables_count": 1,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}

Adds an area at the end of the floor plan, for example `{ "name": "Terrace" }`. Add its tables with `POST /v1/tables`.

Request body

name string req

Name of the area, for example `Terrace` or `Bar`

table_combination_mode enum

How online reservations may join tables for parties no single table seats: `automatic` (default) combines any tables in the area, `explicit` only combines tables that are linked to each other with the table's `links`, for example because a step or fixed bench separates the others

automaticexplicit

{
  "name": "Terrace"
}

Responses

201 Area Create an area
Response attributes
id integer

Unique identifier of the area.

name string

Name of the area, for example `Terrace`.

position integer

Display order within the floor plan, starting at 1.

table_combination_mode string

How online reservations may join tables for larger parties: `automatic` combines any tables in the area, `explicit` only combines tables linked to each other (see the table's `links`).

hidden boolean

Whether the area is temporarily hidden, for example a terrace in winter. Hidden areas are left out of the floor plan at the register and out of online reservations.

archived boolean

Whether the area is archived.

tables_count integer

Number of unarchived tables in the area.

created_at datetime

Time the area was created.

updated_at datetime

Time the area was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "position": 1,
  "table_combination_mode": "string",
  "hidden": true,
  "archived": true,
  "tables_count": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/areas/{id} floorplan:read

Retrieve an area

Parameters

id path · integer req

Unique identifier of the area

Responses

200 Area Retrieve an area
Response attributes
id integer

Unique identifier of the area.

name string

Name of the area, for example `Terrace`.

position integer

Display order within the floor plan, starting at 1.

table_combination_mode string

How online reservations may join tables for larger parties: `automatic` combines any tables in the area, `explicit` only combines tables linked to each other (see the table's `links`).

hidden boolean

Whether the area is temporarily hidden, for example a terrace in winter. Hidden areas are left out of the floor plan at the register and out of online reservations.

archived boolean

Whether the area is archived.

tables_count integer

Number of unarchived tables in the area.

created_at datetime

Time the area was created.

updated_at datetime

Time the area was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "position": 1,
  "table_combination_mode": "string",
  "hidden": true,
  "archived": true,
  "tables_count": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/areas/{id} floorplan:write

Updates the given attributes; attributes that are not included keep their current value. Set `hidden` to take an area out of use for a while, for example a terrace in winter. Set `archived` to `false` to restore an archived area; its tables stay archived until restored themselves.

Parameters

id path · integer req

Unique identifier of the area

Request body

name string

Name of the area, for example `Terrace` or `Bar`

table_combination_mode enum

How online reservations may join tables for parties no single table seats: `automatic` (default) combines any tables in the area, `explicit` only combines tables that are linked to each other with the table's `links`, for example because a step or fixed bench separates the others

automaticexplicit

position integer

1-based position in the floor plan; other areas shift to make room

hidden boolean

Hide the area from the register's floor plan and from online reservations

archived boolean

`true` archives the area and its tables, `false` restores the area

{
  "hidden": true
}

Responses

200 Area Update an area
Response attributes
id integer

Unique identifier of the area.

name string

Name of the area, for example `Terrace`.

position integer

Display order within the floor plan, starting at 1.

table_combination_mode string

How online reservations may join tables for larger parties: `automatic` combines any tables in the area, `explicit` only combines tables linked to each other (see the table's `links`).

hidden boolean

Whether the area is temporarily hidden, for example a terrace in winter. Hidden areas are left out of the floor plan at the register and out of online reservations.

archived boolean

Whether the area is archived.

tables_count integer

Number of unarchived tables in the area.

created_at datetime

Time the area was created.

updated_at datetime

Time the area was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "position": 1,
  "table_combination_mode": "string",
  "hidden": true,
  "archived": true,
  "tables_count": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/areas/{id} floorplan:write

Archives the area together with its tables. Refused while one of its tables has open receipts, upcoming reservations, is in a guest group or is placed on a map.

Parameters

id path · integer req

Unique identifier of the area

Responses

200 Area Archive an area
Response attributes
id integer

Unique identifier of the area.

name string

Name of the area, for example `Terrace`.

position integer

Display order within the floor plan, starting at 1.

table_combination_mode string

How online reservations may join tables for larger parties: `automatic` combines any tables in the area, `explicit` only combines tables linked to each other (see the table's `links`).

hidden boolean

Whether the area is temporarily hidden, for example a terrace in winter. Hidden areas are left out of the floor plan at the register and out of online reservations.

archived boolean

Whether the area is archived.

tables_count integer

Number of unarchived tables in the area.

created_at datetime

Time the area was created.

updated_at datetime

Time the area was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "position": 1,
  "table_combination_mode": "string",
  "hidden": true,
  "archived": true,
  "tables_count": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Cash registers

GET /v1/cash_registers cash_register:read

Returns the cash drawers with the cash expected in each.

Parameters

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of CashRegister List cash registers
Response attributes

The items on this page.

id integer

Unique identifier of the cash register.

name string

Name of the cash register, for example `Bar`.

location string

Where the cash register is, for example `Behind the bar`.

current_balance Money

Cash expected in the drawer.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

device_id integer

Printer that opens the drawer; null for none.

created_at datetime

Time the cash register was created.

updated_at datetime

Time the cash register was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "location": "string",
      "current_balance": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "device_id": 1,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/cash_registers cash_register:write

Adds a cash drawer with the cash it holds now, for example `{ "name": "Bar", "opening_balance": { "value": 15000, "currency": "EUR" } }`. Link it to payment methods in the back office.

Request body

name string req

Name of the cash register, for example `Bar`

location string

Where the cash register is, for example `Behind the bar`

device_id integer

Printer that opens the drawer; null for none

opening_balance object req

Cash in the drawer now

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

{
  "name": "Bar",
  "opening_balance": {
    "value": 15000,
    "currency": "EUR"
  }
}

Responses

201 CashRegister Create a cash register
Response attributes
id integer

Unique identifier of the cash register.

name string

Name of the cash register, for example `Bar`.

location string

Where the cash register is, for example `Behind the bar`.

current_balance Money

Cash expected in the drawer.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

device_id integer

Printer that opens the drawer; null for none.

created_at datetime

Time the cash register was created.

updated_at datetime

Time the cash register was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "location": "string",
  "current_balance": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "device_id": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/cash_registers/{id} cash_register:read

Retrieve a cash register

Parameters

id path · integer req

Unique identifier of the cash register

Responses

200 CashRegister Retrieve a cash register
Response attributes
id integer

Unique identifier of the cash register.

name string

Name of the cash register, for example `Bar`.

location string

Where the cash register is, for example `Behind the bar`.

current_balance Money

Cash expected in the drawer.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

device_id integer

Printer that opens the drawer; null for none.

created_at datetime

Time the cash register was created.

updated_at datetime

Time the cash register was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "location": "string",
  "current_balance": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "device_id": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/cash_registers/{id} cash_register:write

Updates the given attributes; attributes that are not included keep their current value. The balance only changes through mutations and counts.

Parameters

id path · integer req

Unique identifier of the cash register

Request body

name string

Name of the cash register, for example `Bar`

location string

Where the cash register is, for example `Behind the bar`

device_id integer

Printer that opens the drawer; null for none

{
  "location": "Behind the bar",
  "device_id": 3
}

Responses

200 CashRegister Update a cash register
Response attributes
id integer

Unique identifier of the cash register.

name string

Name of the cash register, for example `Bar`.

location string

Where the cash register is, for example `Behind the bar`.

current_balance Money

Cash expected in the drawer.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

device_id integer

Printer that opens the drawer; null for none.

created_at datetime

Time the cash register was created.

updated_at datetime

Time the cash register was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "location": "string",
  "current_balance": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "device_id": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/cash_registers/{id}/counts cash_register:read

Returns the counts of the drawer, most recent first.

Parameters

id path · integer req

Unique identifier of the cash register

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of CashRegisterCount List cash counts
Response attributes

The items on this page.

id integer

Unique identifier of the count.

expected_balance Money

Cash expected before the count.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

counted_total Money

Cash counted.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

difference Money

Counted minus expected; booked as a correction.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

quantities array of object

Pieces counted per coin or note.

denomination Money

The coin or note.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

quantity integer

Number of pieces.

employee_id integer

Employee who counted; null when counted in the back office or through the API.

note string

Note with the count.

created_at datetime

Time of the count.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "expected_balance": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "counted_total": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "difference": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "quantities": [
        {
          "denomination": {
            "value": 1,
            "currency": "string",
            "minor_units": 1,
            "formatted": "string"
          },
          "quantity": 1
        }
      ],
      "employee_id": 1,
      "note": "string",
      "created_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/cash_registers/{id}/counts cash_register:write

Records the pieces counted per coin and note, for example `{ "quantities": [{ "denomination": { "value": 1000, "currency": "EUR" }, "quantity": 3 }] }`. Only the coins and notes set up for cash counts in the back office can be counted. A difference with the expected balance is booked as a correction.

Parameters

id path · integer req

Unique identifier of the cash register

Request body

quantities array of object req

Pieces counted per coin or note

denomination object req

Coin or note, as money

value integer req

Value of the coin or note in the precision of `minor_units`

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Decimal places in `value`

quantity integer req

Number of pieces

note string

Note with the count

{
  "quantities": [
    {
      "denomination": {
        "value": 1000,
        "currency": "EUR"
      },
      "quantity": 3
    }
  ]
}

Responses

201 CashRegisterCount Count the cash
Response attributes
id integer

Unique identifier of the count.

expected_balance Money

Cash expected before the count.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

counted_total Money

Cash counted.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

difference Money

Counted minus expected; booked as a correction.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

quantities array of object

Pieces counted per coin or note.

denomination Money

The coin or note.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

quantity integer

Number of pieces.

employee_id integer

Employee who counted; null when counted in the back office or through the API.

note string

Note with the count.

created_at datetime

Time of the count.

Example response
{
  "id": 1,
  "expected_balance": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "counted_total": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "difference": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "quantities": [
    {
      "denomination": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "quantity": 1
    }
  ],
  "employee_id": 1,
  "note": "string",
  "created_at": "2026-01-15T12:30:00Z"
}
GET /v1/cash_registers/{id}/mutations cash_register:read

Returns the changes of the cash in the drawer, most recent first.

Parameters

id path · integer req

Unique identifier of the cash register

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of CashRegisterMutation List cash mutations
Response attributes

The items on this page.

id integer

Unique identifier of the mutation.

mutation_type enum

`payment`, `deposit`, `withdrawal` or `correction`.

paymentwithdrawaldepositcorrection

amount Money

Change of the balance; negative for a withdrawal.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

note string

Note with the mutation.

created_at datetime

Time of the mutation.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "mutation_type": "payment",
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "note": "string",
      "created_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/cash_registers/{id}/mutations cash_register:write

Puts cash in or takes cash out of the drawer, for example `{ "mutation_type": "withdrawal", "amount": { "value": -5000, "currency": "EUR" }, "note": "To the safe" }`. The amount is added to the balance, so take cash out with a negative amount.

Parameters

id path · integer req

Unique identifier of the cash register

Request body

mutation_type enum req

`deposit`, `withdrawal` or `correction`; cash payments are booked by the register itself

depositwithdrawalcorrection

amount object req

Change of the balance; negative to take cash out

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

note string

Note with the mutation

{
  "mutation_type": "withdrawal",
  "amount": {
    "value": -5000,
    "currency": "EUR"
  },
  "note": "To the safe"
}

Responses

201 CashRegisterMutation Book a cash mutation
Response attributes
id integer

Unique identifier of the mutation.

mutation_type enum

`payment`, `deposit`, `withdrawal` or `correction`.

paymentwithdrawaldepositcorrection

amount Money

Change of the balance; negative for a withdrawal.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

note string

Note with the mutation.

created_at datetime

Time of the mutation.

Example response
{
  "id": 1,
  "mutation_type": "payment",
  "amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "note": "string",
  "created_at": "2026-01-15T12:30:00Z"
}

Categories of revenue

GET /v1/categories_of_revenue category_of_revenue:read

Returns all categories of revenue configured for the organization, including archived ones, so that past revenue can always be mapped.

Parameters

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of CategoryOfRevenue List categories of revenue
Response attributes

The items on this page.

id integer

Unique identifier of the category of revenue.

name string

Name of the category of revenue.

archived boolean

Whether the category of revenue has been archived.

created_at datetime

Time the category of revenue was created.

updated_at datetime

Time the category of revenue was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "archived": true,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/categories_of_revenue category_of_revenue:write

Creates a category of revenue owned by your app. Assign products and payments to it to break down revenue in closings and reports.

Request body

name string req

Name of the category of revenue

{
  "name": "Merchandise"
}

Responses

201 CategoryOfRevenue Create a category of revenue
Response attributes
id integer

Unique identifier of the category of revenue.

name string

Name of the category of revenue.

archived boolean

Whether the category of revenue has been archived.

created_at datetime

Time the category of revenue was created.

updated_at datetime

Time the category of revenue was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/categories_of_revenue/{id} category_of_revenue:read

Retrieve a category of revenue

Parameters

id path · integer req

Unique identifier of the category of revenue

Responses

200 CategoryOfRevenue Retrieve a category of revenue
Response attributes
id integer

Unique identifier of the category of revenue.

name string

Name of the category of revenue.

archived boolean

Whether the category of revenue has been archived.

created_at datetime

Time the category of revenue was created.

updated_at datetime

Time the category of revenue was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/categories_of_revenue/{id} category_of_revenue:write

Updates the given attributes; attributes that are not included keep their current value. Set `archived` to `false` to restore an archived category.

Parameters

id path · integer req

Unique identifier of the category of revenue

Request body

name string

Name of the category of revenue

archived boolean

`true` archives the category, `false` restores it

{
  "name": "Merchandise and gifts"
}

Responses

200 CategoryOfRevenue Update a category of revenue
Response attributes
id integer

Unique identifier of the category of revenue.

name string

Name of the category of revenue.

archived boolean

Whether the category of revenue has been archived.

created_at datetime

Time the category of revenue was created.

updated_at datetime

Time the category of revenue was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/categories_of_revenue/{id} category_of_revenue:write

Archives the category. Refused while products, payment methods or other settings still use it.

Parameters

id path · integer req

Unique identifier of the category of revenue

Responses

200 CategoryOfRevenue Archive a category of revenue
Response attributes
id integer

Unique identifier of the category of revenue.

name string

Name of the category of revenue.

archived boolean

Whether the category of revenue has been archived.

created_at datetime

Time the category of revenue was created.

updated_at datetime

Time the category of revenue was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Closures

GET /v1/closures closure:read

Returns the periods in which the organization is closed for online reservations, shops or both. Closed periods are left out of reservation availability and shop pick-up times.

Parameters

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Closure List closures
Response attributes

The items on this page.

id integer

Unique identifier of the closure.

name string

Name of the closure, for example `Christmas`.

starts_at datetime

Start of the closure.

ends_at datetime

End of the closure, inclusive; null when it has no end.

schedule string

The closure's schedule in words, also for recurring closures set up in the back office.

reservations boolean

Whether online reservations are closed.

all_shops boolean

Whether all shops are closed, including shops added later.

shop_ids array of integer

Shops that are closed when `all_shops` is false.

created_at datetime

Time the closure was created.

updated_at datetime

Time the closure was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "starts_at": "2026-01-15T12:30:00Z",
      "ends_at": "2026-01-15T12:30:00Z",
      "schedule": "string",
      "reservations": true,
      "all_shops": true,
      "shop_ids": [
        1
      ],
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/closures closure:write

Closes online reservations, shops or both for a period. Use `starts_on` and `ends_on` for whole days (`2026-12-25` to `2026-12-26` closes both Christmas days) or `starts_at` and `ends_at` for part of a day.

Request body

name string req

Name of the closure, for example `Christmas` or `Private party`

starts_on date

First whole day of the closure

ends_on date

Last whole day of the closure; defaults to `starts_on` on create and keeps the current end on update

starts_at datetime

Start of a closure that doesn't cover whole days, for example from 18:00

ends_at datetime

End of a closure that doesn't cover whole days, inclusive

reservations boolean

Close online reservations; defaults to true

all_shops boolean

Close all shops, including shops added later

shop_ids array of integer

Close only these shops

{
  "name": "Christmas",
  "starts_on": "2026-12-25",
  "ends_on": "2026-12-26",
  "reservations": true,
  "all_shops": true
}

Responses

201 Closure Create a closure
Response attributes
id integer

Unique identifier of the closure.

name string

Name of the closure, for example `Christmas`.

starts_at datetime

Start of the closure.

ends_at datetime

End of the closure, inclusive; null when it has no end.

schedule string

The closure's schedule in words, also for recurring closures set up in the back office.

reservations boolean

Whether online reservations are closed.

all_shops boolean

Whether all shops are closed, including shops added later.

shop_ids array of integer

Shops that are closed when `all_shops` is false.

created_at datetime

Time the closure was created.

updated_at datetime

Time the closure was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "schedule": "string",
  "reservations": true,
  "all_shops": true,
  "shop_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/closures/{id} closure:read

Retrieve a closure

Parameters

id path · integer req

Unique identifier of the closure

Responses

200 Closure Retrieve a closure
Response attributes
id integer

Unique identifier of the closure.

name string

Name of the closure, for example `Christmas`.

starts_at datetime

Start of the closure.

ends_at datetime

End of the closure, inclusive; null when it has no end.

schedule string

The closure's schedule in words, also for recurring closures set up in the back office.

reservations boolean

Whether online reservations are closed.

all_shops boolean

Whether all shops are closed, including shops added later.

shop_ids array of integer

Shops that are closed when `all_shops` is false.

created_at datetime

Time the closure was created.

updated_at datetime

Time the closure was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "schedule": "string",
  "reservations": true,
  "all_shops": true,
  "shop_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/closures/{id} closure:write

Updates the given attributes; attributes that are not included keep their current value. A new period replaces the old one.

Parameters

id path · integer req

Unique identifier of the closure

Request body

name string

Name of the closure, for example `Christmas` or `Private party`

starts_on date

First whole day of the closure

ends_on date

Last whole day of the closure; defaults to `starts_on` on create and keeps the current end on update

starts_at datetime

Start of a closure that doesn't cover whole days, for example from 18:00

ends_at datetime

End of a closure that doesn't cover whole days, inclusive

reservations boolean

Close online reservations; defaults to true

all_shops boolean

Close all shops, including shops added later

shop_ids array of integer

Close only these shops

{
  "ends_on": "2026-12-27"
}

Responses

200 Closure Update a closure
Response attributes
id integer

Unique identifier of the closure.

name string

Name of the closure, for example `Christmas`.

starts_at datetime

Start of the closure.

ends_at datetime

End of the closure, inclusive; null when it has no end.

schedule string

The closure's schedule in words, also for recurring closures set up in the back office.

reservations boolean

Whether online reservations are closed.

all_shops boolean

Whether all shops are closed, including shops added later.

shop_ids array of integer

Shops that are closed when `all_shops` is false.

created_at datetime

Time the closure was created.

updated_at datetime

Time the closure was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "schedule": "string",
  "reservations": true,
  "all_shops": true,
  "shop_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/closures/{id} closure:write

Reopens the period the closure covered.

Parameters

id path · integer req

Unique identifier of the closure

Responses

204 Delete a closure

Compensation reasons

GET /v1/compensation_reasons compensation_reason:read

Returns the reasons staff pick when they compensate an item on the register, for example a dish that came out cold.

Parameters

include_archived query · boolean

Include archived reasons

default false

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of CompensationReason List compensation reasons
Response attributes

The items on this page.

id integer

Unique identifier of the compensation reason.

name string

Name of the reason, for example `Cold dish`.

archived boolean

Whether the reason has been archived.

created_at datetime

Time the reason was created.

updated_at datetime

Time the reason was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "archived": true,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/compensation_reasons compensation_reason:write

Adds a reason, for example `{ "name": "Cold dish" }`.

Request body

name string req

Name of the reason

{
  "name": "Cold dish"
}

Responses

201 CompensationReason Create a compensation reason
Response attributes
id integer

Unique identifier of the compensation reason.

name string

Name of the reason, for example `Cold dish`.

archived boolean

Whether the reason has been archived.

created_at datetime

Time the reason was created.

updated_at datetime

Time the reason was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/compensation_reasons/{id} compensation_reason:read

Retrieve a compensation reason

Parameters

id path · integer req

Unique identifier of the compensation reason

Responses

200 CompensationReason Retrieve a compensation reason
Response attributes
id integer

Unique identifier of the compensation reason.

name string

Name of the reason, for example `Cold dish`.

archived boolean

Whether the reason has been archived.

created_at datetime

Time the reason was created.

updated_at datetime

Time the reason was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/compensation_reasons/{id} compensation_reason:write

Updates the given attributes; attributes that are not included keep their current value. Set `archived` to `false` to restore an archived reason.

Parameters

id path · integer req

Unique identifier of the compensation reason

Request body

name string

Name of the reason

archived boolean

`true` archives the reason, `false` restores it

{
  "name": "Dish came out cold"
}

Responses

200 CompensationReason Update a compensation reason
Response attributes
id integer

Unique identifier of the compensation reason.

name string

Name of the reason, for example `Cold dish`.

archived boolean

Whether the reason has been archived.

created_at datetime

Time the reason was created.

updated_at datetime

Time the reason was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/compensation_reasons/{id} compensation_reason:write

Archives the reason so staff can no longer pick it.

Parameters

id path · integer req

Unique identifier of the compensation reason

Responses

200 CompensationReason Archive a compensation reason
Response attributes
id integer

Unique identifier of the compensation reason.

name string

Name of the reason, for example `Cold dish`.

archived boolean

Whether the reason has been archived.

created_at datetime

Time the reason was created.

updated_at datetime

Time the reason was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Customers

GET /v1/customers customer:read

Returns the customers of the organization, ordered by name. Archived customers, customers merged into another customer and temporary customers (created for an "op naam" order) are left out unless asked for.

Parameters

query query · string

Only customers whose name, email address or phone number contains this text (for example `jansen`), or whose loyalty card has this code

group_id query · integer

Only members of this customer group

include_archived query · boolean

Include archived customers

default false

include_temporary query · boolean

Include temporary customers that still have an open receipt

default false

sort query · enum

`name`, `recent` for the customers with the latest receipts first, or `pinned` for pinned customers first

namerecentpinned default name

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Customer List customers
Response attributes

The items on this page.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "email": "string",
      "phone": "string",
      "address": "string",
      "note": "string",
      "locale": "string",
      "pinned": true,
      "balance": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "temporary": true,
      "archived": true,
      "merged_into_id": 1,
      "group_ids": [
        1
      ],
      "last_receipt_at": "2026-01-15T12:30:00Z",
      "identifier": "string",
      "app_data": {},
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/customers customer:write

Creates a customer owned by your app. When an active customer with the same email address already exists, no customer is created: the existing customer is returned unchanged with status `303 See Other` and a `Location` header pointing to it, so you can safely call this for every incoming order.

Request body

name string req

Full name of the customer, for example `Jan de Vries`

email string

Email address, for example `jan@example.com`

phone string

Phone number, for example `+31612345678`

address string

Postal address, for example `Dorpsstraat 1, 7511 AB Enschede`

note string

Internal note for staff, for example `Allergic to nuts`

locale enum

Preferred language for mails

nlende

pinned boolean

Pin the customer: pinned customers always have an open receipt and are shown first on the register

group_ids array of integer

Customer groups the customer belongs to (`GET /v1/groups`). The list replaces the current memberships, so `[]` removes them all

app_data object

Arbitrary data your app wants to store on the customer, for example `{ "loyalty_number": "A123" }`

{
  "name": "Jan de Vries",
  "email": "jan@example.com",
  "phone": "+31612345678",
  "locale": "nl",
  "group_ids": [
    2
  ]
}

Responses

201 Customer Create a customer
Response attributes
id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "note": "string",
  "locale": "string",
  "pinned": true,
  "balance": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "temporary": true,
  "archived": true,
  "merged_into_id": 1,
  "group_ids": [
    1
  ],
  "last_receipt_at": "2026-01-15T12:30:00Z",
  "identifier": "string",
  "app_data": {},
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/customers/{id} customer:read

Retrieve a customer

Parameters

id path · integer req

Unique identifier of the customer

Responses

200 Customer Retrieve a customer
Response attributes
id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "note": "string",
  "locale": "string",
  "pinned": true,
  "balance": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "temporary": true,
  "archived": true,
  "merged_into_id": 1,
  "group_ids": [
    1
  ],
  "last_receipt_at": "2026-01-15T12:30:00Z",
  "identifier": "string",
  "app_data": {},
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/customers/{id} customer:write

Updates the given attributes; attributes that are not included keep their current value. Passing `group_ids` replaces the group memberships, so `[]` removes the customer from all groups.

Parameters

id path · integer req

Unique identifier of the customer

Request body

name string

Full name of the customer, for example `Jan de Vries`

email string

Email address, for example `jan@example.com`

phone string

Phone number, for example `+31612345678`

address string

Postal address, for example `Dorpsstraat 1, 7511 AB Enschede`

note string

Internal note for staff, for example `Allergic to nuts`

locale enum

Preferred language for mails

nlende

pinned boolean

Pin the customer: pinned customers always have an open receipt and are shown first on the register

group_ids array of integer

Customer groups the customer belongs to (`GET /v1/groups`). The list replaces the current memberships, so `[]` removes them all

app_data object

Arbitrary data your app wants to store on the customer, for example `{ "loyalty_number": "A123" }`

{
  "note": "Allergic to nuts"
}

Responses

200 Customer Update a customer
Response attributes
id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "note": "string",
  "locale": "string",
  "pinned": true,
  "balance": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "temporary": true,
  "archived": true,
  "merged_into_id": 1,
  "group_ids": [
    1
  ],
  "last_receipt_at": "2026-01-15T12:30:00Z",
  "identifier": "string",
  "app_data": {},
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/customers/{id} customer:write

Archives the customer: it no longer shows up in lists and searches on the register. Its receipts, reservations and balance are kept.

Parameters

id path · integer req

Unique identifier of the customer

Responses

200 Customer Archive a customer
Response attributes
id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "note": "string",
  "locale": "string",
  "pinned": true,
  "balance": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "temporary": true,
  "archived": true,
  "merged_into_id": 1,
  "group_ids": [
    1
  ],
  "last_receipt_at": "2026-01-15T12:30:00Z",
  "identifier": "string",
  "app_data": {},
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
POST /v1/customers/{id}/merge customer:write

Merges a duplicate customer into `into_customer_id`: cards, discounts, group memberships, open receipts, receipt history, payments and loyalty balance move to that customer, and this customer is marked as merged. This can't be undone. Returns the customer that was merged into.

Parameters

id path · integer req

Unique identifier of the customer

Request body

into_customer_id integer req

Customer that remains, for example the one with the most complete details

{
  "into_customer_id": 12
}

Responses

201 Customer Merge a customer into another
Response attributes
id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "note": "string",
  "locale": "string",
  "pinned": true,
  "balance": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "temporary": true,
  "archived": true,
  "merged_into_id": 1,
  "group_ids": [
    1
  ],
  "last_receipt_at": "2026-01-15T12:30:00Z",
  "identifier": "string",
  "app_data": {},
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Daily closings

GET /v1/daily_closings/{id} daily_closing:read

Returns a daily closing, including the cashflow per payment method, the revenue broken down per category of revenue, employee, device and voucher, and any voucher redemptions.

Parameters

id path · integer req

Unique identifier of the daily closing

Responses

200 DailyClosing Retrieve a daily closing
Response attributes
id integer

Unique identifier of the daily closing.

cashflow object

Cashflow generated during the day, per payment method.

amounts object

Amount received per payment method, keyed by payment method ID, each in the money shape (`value`, `currency`, `minor_units`, `formatted`).

revenue object

Revenue generated during the day, broken down per dimension.

per_category_of_revenue array of Revenue

Revenue per category of revenue.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_employee array of Revenue

Revenue per employee.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_device array of Revenue

Revenue per device.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_voucher array of Revenue

Revenue per voucher.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_loyalty_topup array of Revenue

Revenue per loyalty top-up.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_reservation_deposit array of Revenue

Reservation deposits received.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher_redemptions array of object

Vouchers redeemed during the day.

voucher Reference

Voucher that was redeemed.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount redeemed.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

loyalty_redemption LoyaltyRedemption

Customer balance redeemed during the day.

loyalty Reference

Loyalty program the redemption belongs to.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount redeemed.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

reservation_deposit_redemption object

Reservation deposits settled during the day.

reservation Reference

Reservation program the redemption belongs to.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Deposit amount applied to receipts.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

forfeited Money

Part of the applied deposits kept as forfeit revenue.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

created_at datetime

Time the daily closing was created.

for_date date

Trading date the daily closing covers.

updated_at datetime

Time the daily closing was last updated.

Example response
{
  "id": 1,
  "cashflow": {
    "amounts": {}
  },
  "revenue": {
    "per_category_of_revenue": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_employee": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_device": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_voucher": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_loyalty_topup": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_reservation_deposit": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ]
  },
  "voucher_redemptions": [
    {
      "voucher": {
        "id": 1,
        "name": "string"
      },
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      }
    }
  ],
  "loyalty_redemption": {
    "loyalty": {
      "id": 1,
      "name": "string"
    },
    "amount": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    }
  },
  "reservation_deposit_redemption": {
    "reservation": {
      "id": 1,
      "name": "string"
    },
    "amount": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "forfeited": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    }
  },
  "created_at": "2026-01-15T12:30:00Z",
  "for_date": "2026-01-15",
  "updated_at": "2026-01-15T12:30:00Z"
}

Devices

GET /v1/devices device:read

Returns the registers, displays, kiosks and printers of the organization, sorted by name. Filter by `kind`. Devices are set up in the back office.

Parameters

kind query · enum

Only devices of this kind

registercustomer_facing_displaypreparation_displaykioskbackoffice_displaynetwork_printerbluetooth_printer

include_archived query · boolean

Include archived devices

default false

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Device List devices
Response attributes

The items on this page.

id integer

Unique identifier of the device.

name string

Name of the device.

kind string

Device type: register, customer_facing_display, preparation_display, kiosk, backoffice_display, network_printer, or bluetooth_printer.

subtype string

Secondary classification within a kind (e.g. register or handheld for registers; preparation or runner for preparation displays).

quickselect_page_id integer

Unique identifier of the quickselect page shown on the device.

preparation_location_ids array of string

Unique identifiers of the preparation locations the device prepares.

linked_device_ids array of string

Unique identifiers of the devices linked to this device, such as its printers and customer-facing display.

archived boolean

Whether the device has been archived.

created_at datetime

Time the device was created.

updated_at datetime

Time the device was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "kind": "string",
      "subtype": "string",
      "quickselect_page_id": 1,
      "preparation_location_ids": [
        "string"
      ],
      "linked_device_ids": [
        "string"
      ],
      "archived": true,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
GET /v1/devices/{id} device:read

Retrieve a device

Parameters

id path · integer req

Unique identifier of the device

Responses

200 Device Retrieve a device
Response attributes
id integer

Unique identifier of the device.

name string

Name of the device.

kind string

Device type: register, customer_facing_display, preparation_display, kiosk, backoffice_display, network_printer, or bluetooth_printer.

subtype string

Secondary classification within a kind (e.g. register or handheld for registers; preparation or runner for preparation displays).

quickselect_page_id integer

Unique identifier of the quickselect page shown on the device.

preparation_location_ids array of string

Unique identifiers of the preparation locations the device prepares.

linked_device_ids array of string

Unique identifiers of the devices linked to this device, such as its printers and customer-facing display.

archived boolean

Whether the device has been archived.

created_at datetime

Time the device was created.

updated_at datetime

Time the device was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "kind": "string",
  "subtype": "string",
  "quickselect_page_id": 1,
  "preparation_location_ids": [
    "string"
  ],
  "linked_device_ids": [
    "string"
  ],
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Discount rules

GET /v1/discount_rules discount_rule:read

Returns all discount rules: general rules that apply to every receipt and rules tied to a customer, customer group or employee. When several rules match an item, the item gets the highest discount; a discount set by hand on the receipt wins when it is higher.

Parameters

customer_id query · integer

Only rules of this customer

group_id query · integer

Only rules of this customer group

employee_id query · integer

Only rules of this employee

general query · boolean

`true` for only rules that apply to every receipt, `false` for only rules tied to a customer, group or employee

enabled query · boolean

Only enabled (`true`) or disabled (`false`) rules

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of DiscountRule List discount rules
Response attributes

The items on this page.

id integer

Unique identifier of the discount rule.

name string

Name of the discount rule, for example `Happy hour`.

kind string

How the discount is calculated: `percentage` (a percentage off each item), `volume` (a percentage that grows with the number of items, see `tiers`), `buy_x_pay_y` (buy `buy_quantity`, pay `pay_quantity`) or `flat_rate` (a fixed amount off each item).

enabled boolean

Whether the rule is applied; disabled rules are kept but never applied.

discount_percentage number

Percentage off each item for `percentage` rules, for example 20.0; null for other kinds.

flat_amount Money

Amount off each item for `flat_rate` rules; null for other kinds.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

buy_quantity integer

Items to buy for `buy_x_pay_y` rules, for example 3 in 'buy 3, pay 2'; null for other kinds.

pay_quantity integer

Items to pay for `buy_x_pay_y` rules, for example 2 in 'buy 3, pay 2'; null for other kinds.

tiers array of object

Steps of a `volume` rule, ordered by `min_quantity`; empty for other kinds.

min_quantity integer

Number of items from which the tier applies, for example 6.

discount_percentage number

Discount percentage for this tier, for example 20.0.

product_category_ids array of integer

Product categories the rule applies to (`GET /v1/product_categories`); empty when it applies to all products.

customer_id integer

Customer whose receipts get the discount; null when the rule isn't tied to a customer.

group_id integer

Customer group whose receipts get the discount; null when the rule isn't tied to a group.

employee_id integer

Employee whose own receipts get the discount, for example a staff discount; null when the rule isn't tied to an employee.

cascade boolean

For group rules: whether the discount also applies to receipts of the group's customers.

always boolean

Whether the rule applies at all times; when false, the schedule fields below say when.

weekdays array of integer

Weekdays a weekly rule applies on, 0 is Sunday; null when the rule isn't weekly.

from_time string

Time of day a weekly rule starts applying, HH:MM, for example `16:00`; null when the rule isn't weekly.

till_time string

Time of day a weekly rule stops applying, HH:MM, for example `18:00`. A time before `from_time` ends the next day.

starts_at datetime

Start of a one-off period the rule applies in; null for weekly rules and rules that always apply.

ends_at datetime

End of that one-off period, inclusive.

schedule string

When the rule applies, in words; also describes monthly or yearly schedules set up in the back office, which have no weekly or period fields.

created_at datetime

Time the rule was created.

updated_at datetime

Time the rule was last changed.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "kind": "string",
      "enabled": true,
      "discount_percentage": 9.99,
      "flat_amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "buy_quantity": 1,
      "pay_quantity": 1,
      "tiers": [
        {
          "min_quantity": 1,
          "discount_percentage": 9.99
        }
      ],
      "product_category_ids": [
        1
      ],
      "customer_id": 1,
      "group_id": 1,
      "employee_id": 1,
      "cascade": true,
      "always": true,
      "weekdays": [
        1
      ],
      "from_time": "string",
      "till_time": "string",
      "starts_at": "2026-01-15T12:30:00Z",
      "ends_at": "2026-01-15T12:30:00Z",
      "schedule": "string",
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/discount_rules discount_rule:write

Creates a rule that lowers prices automatically. Examples: happy hour is `kind: percentage`, `discount_percentage: 20`, `product_category_ids: []`, `weekdays: [1, 2, 3, 4, 5]`, `from_time: "16:00"`, `till_time: "18:00"`; a volume discount is `kind: volume` with `tiers: [{ min_quantity: 3, discount_percentage: 10 }, { min_quantity: 6, discount_percentage: 20 }]`; 'buy 3, pay 2' is `kind: buy_x_pay_y`, `buy_quantity: 3`, `pay_quantity: 2`; a staff discount is `kind: percentage` with an `employee_id`. Without `customer_id`, `group_id` or `employee_id` the rule applies to every receipt. Without schedule fields it applies at all times. Rules are created disabled unless `enabled` is true.

Request body

name string req

Name of the rule, for example `Happy hour` or `Staff discount`

kind enum req

How the discount is calculated: `percentage` needs `discount_percentage`; `volume` (volume discount) needs `tiers`; `buy_x_pay_y` needs `buy_quantity` and `pay_quantity`; `flat_rate` needs `flat_amount`

percentagevolumebuy_x_pay_yflat_rate

enabled boolean

Whether the rule is applied; defaults to false, so pass `true` to switch it on

discount_percentage number

Percentage off each item for `percentage` rules, above 0 and at most 100

flat_amount object

Amount off each item for `flat_rate` rules, for example `{ "value": 150, "currency": "EUR" }` for €1.50 off

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

buy_quantity integer

For `buy_x_pay_y` rules: items to buy, for example 3 in 'buy 3, pay 2'

pay_quantity integer

For `buy_x_pay_y` rules: items to pay, lower than `buy_quantity`

tiers array of object

Steps of a `volume` rule. The list replaces the current steps. For example 10% from 3 items and 20% from 6 items

min_quantity integer req

Number of items from which the step applies

discount_percentage number req

Percentage off each item from that number on

product_category_ids array of integer

Only discount products in these categories; `[]` discounts all products

customer_id integer

Only discount receipts of this customer

group_id integer

Only discount receipts of this customer group

employee_id integer

Only discount receipts this employee orders for themselves, for example a staff discount

cascade boolean

For group rules: also discount receipts of the group's customers

always boolean

Apply at all times, removing the schedule. This is the default for new rules without schedule fields

true

weekdays array of integer

Weekdays a weekly rule applies on, 0 is Sunday and 6 is Saturday. Use with `from_time` and `till_time`, for example happy hour on weekdays [1, 2, 3, 4, 5] from 16:00 to 18:00

from_time string

Time of day a weekly rule starts applying, HH:MM

till_time string

Time of day a weekly rule stops applying, HH:MM. A time before `from_time` ends the next day

starts_at datetime

Start of a one-off period the rule applies in, for example a weekend promotion

ends_at datetime

End of that one-off period, inclusive

{
  "name": "Happy hour",
  "kind": "percentage",
  "discount_percentage": 25.0,
  "product_category_ids": [
    4
  ],
  "weekdays": [
    5,
    6
  ],
  "from_time": "16:00",
  "till_time": "18:00"
}

Responses

201 DiscountRule Create a discount rule
Response attributes
id integer

Unique identifier of the discount rule.

name string

Name of the discount rule, for example `Happy hour`.

kind string

How the discount is calculated: `percentage` (a percentage off each item), `volume` (a percentage that grows with the number of items, see `tiers`), `buy_x_pay_y` (buy `buy_quantity`, pay `pay_quantity`) or `flat_rate` (a fixed amount off each item).

enabled boolean

Whether the rule is applied; disabled rules are kept but never applied.

discount_percentage number

Percentage off each item for `percentage` rules, for example 20.0; null for other kinds.

flat_amount Money

Amount off each item for `flat_rate` rules; null for other kinds.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

buy_quantity integer

Items to buy for `buy_x_pay_y` rules, for example 3 in 'buy 3, pay 2'; null for other kinds.

pay_quantity integer

Items to pay for `buy_x_pay_y` rules, for example 2 in 'buy 3, pay 2'; null for other kinds.

tiers array of object

Steps of a `volume` rule, ordered by `min_quantity`; empty for other kinds.

min_quantity integer

Number of items from which the tier applies, for example 6.

discount_percentage number

Discount percentage for this tier, for example 20.0.

product_category_ids array of integer

Product categories the rule applies to (`GET /v1/product_categories`); empty when it applies to all products.

customer_id integer

Customer whose receipts get the discount; null when the rule isn't tied to a customer.

group_id integer

Customer group whose receipts get the discount; null when the rule isn't tied to a group.

employee_id integer

Employee whose own receipts get the discount, for example a staff discount; null when the rule isn't tied to an employee.

cascade boolean

For group rules: whether the discount also applies to receipts of the group's customers.

always boolean

Whether the rule applies at all times; when false, the schedule fields below say when.

weekdays array of integer

Weekdays a weekly rule applies on, 0 is Sunday; null when the rule isn't weekly.

from_time string

Time of day a weekly rule starts applying, HH:MM, for example `16:00`; null when the rule isn't weekly.

till_time string

Time of day a weekly rule stops applying, HH:MM, for example `18:00`. A time before `from_time` ends the next day.

starts_at datetime

Start of a one-off period the rule applies in; null for weekly rules and rules that always apply.

ends_at datetime

End of that one-off period, inclusive.

schedule string

When the rule applies, in words; also describes monthly or yearly schedules set up in the back office, which have no weekly or period fields.

created_at datetime

Time the rule was created.

updated_at datetime

Time the rule was last changed.

Example response
{
  "id": 1,
  "name": "string",
  "kind": "string",
  "enabled": true,
  "discount_percentage": 9.99,
  "flat_amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "buy_quantity": 1,
  "pay_quantity": 1,
  "tiers": [
    {
      "min_quantity": 1,
      "discount_percentage": 9.99
    }
  ],
  "product_category_ids": [
    1
  ],
  "customer_id": 1,
  "group_id": 1,
  "employee_id": 1,
  "cascade": true,
  "always": true,
  "weekdays": [
    1
  ],
  "from_time": "string",
  "till_time": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "schedule": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/discount_rules/{id} discount_rule:read

Retrieve a discount rule

Parameters

id path · integer req

Unique identifier of the discount rule

Responses

200 DiscountRule Retrieve a discount rule
Response attributes
id integer

Unique identifier of the discount rule.

name string

Name of the discount rule, for example `Happy hour`.

kind string

How the discount is calculated: `percentage` (a percentage off each item), `volume` (a percentage that grows with the number of items, see `tiers`), `buy_x_pay_y` (buy `buy_quantity`, pay `pay_quantity`) or `flat_rate` (a fixed amount off each item).

enabled boolean

Whether the rule is applied; disabled rules are kept but never applied.

discount_percentage number

Percentage off each item for `percentage` rules, for example 20.0; null for other kinds.

flat_amount Money

Amount off each item for `flat_rate` rules; null for other kinds.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

buy_quantity integer

Items to buy for `buy_x_pay_y` rules, for example 3 in 'buy 3, pay 2'; null for other kinds.

pay_quantity integer

Items to pay for `buy_x_pay_y` rules, for example 2 in 'buy 3, pay 2'; null for other kinds.

tiers array of object

Steps of a `volume` rule, ordered by `min_quantity`; empty for other kinds.

min_quantity integer

Number of items from which the tier applies, for example 6.

discount_percentage number

Discount percentage for this tier, for example 20.0.

product_category_ids array of integer

Product categories the rule applies to (`GET /v1/product_categories`); empty when it applies to all products.

customer_id integer

Customer whose receipts get the discount; null when the rule isn't tied to a customer.

group_id integer

Customer group whose receipts get the discount; null when the rule isn't tied to a group.

employee_id integer

Employee whose own receipts get the discount, for example a staff discount; null when the rule isn't tied to an employee.

cascade boolean

For group rules: whether the discount also applies to receipts of the group's customers.

always boolean

Whether the rule applies at all times; when false, the schedule fields below say when.

weekdays array of integer

Weekdays a weekly rule applies on, 0 is Sunday; null when the rule isn't weekly.

from_time string

Time of day a weekly rule starts applying, HH:MM, for example `16:00`; null when the rule isn't weekly.

till_time string

Time of day a weekly rule stops applying, HH:MM, for example `18:00`. A time before `from_time` ends the next day.

starts_at datetime

Start of a one-off period the rule applies in; null for weekly rules and rules that always apply.

ends_at datetime

End of that one-off period, inclusive.

schedule string

When the rule applies, in words; also describes monthly or yearly schedules set up in the back office, which have no weekly or period fields.

created_at datetime

Time the rule was created.

updated_at datetime

Time the rule was last changed.

Example response
{
  "id": 1,
  "name": "string",
  "kind": "string",
  "enabled": true,
  "discount_percentage": 9.99,
  "flat_amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "buy_quantity": 1,
  "pay_quantity": 1,
  "tiers": [
    {
      "min_quantity": 1,
      "discount_percentage": 9.99
    }
  ],
  "product_category_ids": [
    1
  ],
  "customer_id": 1,
  "group_id": 1,
  "employee_id": 1,
  "cascade": true,
  "always": true,
  "weekdays": [
    1
  ],
  "from_time": "string",
  "till_time": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "schedule": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/discount_rules/{id} discount_rule:write

Updates the given attributes; attributes that are not included keep their current value. `tiers` and `product_category_ids` replace the current ones. Sending only `till_time` moves the end time on the same weekdays; `always: true` removes the schedule. Pass `customer_id`, `group_id` or `employee_id` as null to make the rule apply to every receipt.

Parameters

id path · integer req

Unique identifier of the discount rule

Request body

name string

Name of the rule, for example `Happy hour` or `Staff discount`

kind enum

How the discount is calculated: `percentage` needs `discount_percentage`; `volume` (volume discount) needs `tiers`; `buy_x_pay_y` needs `buy_quantity` and `pay_quantity`; `flat_rate` needs `flat_amount`

percentagevolumebuy_x_pay_yflat_rate

enabled boolean

Whether the rule is applied; defaults to false, so pass `true` to switch it on

discount_percentage number

Percentage off each item for `percentage` rules, above 0 and at most 100

flat_amount object

Amount off each item for `flat_rate` rules, for example `{ "value": 150, "currency": "EUR" }` for €1.50 off

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

buy_quantity integer

For `buy_x_pay_y` rules: items to buy, for example 3 in 'buy 3, pay 2'

pay_quantity integer

For `buy_x_pay_y` rules: items to pay, lower than `buy_quantity`

tiers array of object

Steps of a `volume` rule. The list replaces the current steps. For example 10% from 3 items and 20% from 6 items

min_quantity integer req

Number of items from which the step applies

discount_percentage number req

Percentage off each item from that number on

product_category_ids array of integer

Only discount products in these categories; `[]` discounts all products

customer_id integer

Only discount receipts of this customer

group_id integer

Only discount receipts of this customer group

employee_id integer

Only discount receipts this employee orders for themselves, for example a staff discount

cascade boolean

For group rules: also discount receipts of the group's customers

always boolean

Apply at all times, removing the schedule. This is the default for new rules without schedule fields

true

weekdays array of integer

Weekdays a weekly rule applies on, 0 is Sunday and 6 is Saturday. Use with `from_time` and `till_time`, for example happy hour on weekdays [1, 2, 3, 4, 5] from 16:00 to 18:00

from_time string

Time of day a weekly rule starts applying, HH:MM

till_time string

Time of day a weekly rule stops applying, HH:MM. A time before `from_time` ends the next day

starts_at datetime

Start of a one-off period the rule applies in, for example a weekend promotion

ends_at datetime

End of that one-off period, inclusive

{
  "enabled": false
}

Responses

200 DiscountRule Update a discount rule
Response attributes
id integer

Unique identifier of the discount rule.

name string

Name of the discount rule, for example `Happy hour`.

kind string

How the discount is calculated: `percentage` (a percentage off each item), `volume` (a percentage that grows with the number of items, see `tiers`), `buy_x_pay_y` (buy `buy_quantity`, pay `pay_quantity`) or `flat_rate` (a fixed amount off each item).

enabled boolean

Whether the rule is applied; disabled rules are kept but never applied.

discount_percentage number

Percentage off each item for `percentage` rules, for example 20.0; null for other kinds.

flat_amount Money

Amount off each item for `flat_rate` rules; null for other kinds.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

buy_quantity integer

Items to buy for `buy_x_pay_y` rules, for example 3 in 'buy 3, pay 2'; null for other kinds.

pay_quantity integer

Items to pay for `buy_x_pay_y` rules, for example 2 in 'buy 3, pay 2'; null for other kinds.

tiers array of object

Steps of a `volume` rule, ordered by `min_quantity`; empty for other kinds.

min_quantity integer

Number of items from which the tier applies, for example 6.

discount_percentage number

Discount percentage for this tier, for example 20.0.

product_category_ids array of integer

Product categories the rule applies to (`GET /v1/product_categories`); empty when it applies to all products.

customer_id integer

Customer whose receipts get the discount; null when the rule isn't tied to a customer.

group_id integer

Customer group whose receipts get the discount; null when the rule isn't tied to a group.

employee_id integer

Employee whose own receipts get the discount, for example a staff discount; null when the rule isn't tied to an employee.

cascade boolean

For group rules: whether the discount also applies to receipts of the group's customers.

always boolean

Whether the rule applies at all times; when false, the schedule fields below say when.

weekdays array of integer

Weekdays a weekly rule applies on, 0 is Sunday; null when the rule isn't weekly.

from_time string

Time of day a weekly rule starts applying, HH:MM, for example `16:00`; null when the rule isn't weekly.

till_time string

Time of day a weekly rule stops applying, HH:MM, for example `18:00`. A time before `from_time` ends the next day.

starts_at datetime

Start of a one-off period the rule applies in; null for weekly rules and rules that always apply.

ends_at datetime

End of that one-off period, inclusive.

schedule string

When the rule applies, in words; also describes monthly or yearly schedules set up in the back office, which have no weekly or period fields.

created_at datetime

Time the rule was created.

updated_at datetime

Time the rule was last changed.

Example response
{
  "id": 1,
  "name": "string",
  "kind": "string",
  "enabled": true,
  "discount_percentage": 9.99,
  "flat_amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "buy_quantity": 1,
  "pay_quantity": 1,
  "tiers": [
    {
      "min_quantity": 1,
      "discount_percentage": 9.99
    }
  ],
  "product_category_ids": [
    1
  ],
  "customer_id": 1,
  "group_id": 1,
  "employee_id": 1,
  "cascade": true,
  "always": true,
  "weekdays": [
    1
  ],
  "from_time": "string",
  "till_time": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "schedule": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/discount_rules/{id} discount_rule:write

Deletes the rule; new items no longer get its discount. To pause a rule instead, set `enabled` to false.

Parameters

id path · integer req

Unique identifier of the discount rule

Responses

204 Delete a discount rule

Email setting

GET /v1/email_setting organization:read

Returns the address mails to guests are sent from and the DNS records that verify its domain. Responds with 404 while mails are sent from 20Tabs' own address.

Responses

200 EmailSetting Retrieve the sender address
Response attributes
email string

Sender address, for example `info@bistro.nl`.

status string

Whether the domain itself is verified through its DKIM records: `pending`, `verified` or `failed`. Mails are only sent from this address once it is `verified`.

mail_from_status string

Whether the bounce domain (MX and SPF records on a subdomain) is set up: `pending`, `verified` or `failed`. Not needed for sending, but without it strict receivers more often mark the mails as spam.

verified_at datetime

Time the domain was verified.

dns_records array of object

DNS records to add at the domain: the DKIM records for `status` and the MX and SPF records of the bounce domain for `mail_from_status`.

type string

Record type: `CNAME`, `MX` or `TXT`.

name string

Name of the record.

value string

Value of the record.

status string

Whether the record was found: `pending`, `verified` or `failed`.

created_at datetime

Time the sender address was created.

updated_at datetime

Time the sender address was last updated.

Example response
{
  "email": "string",
  "status": "string",
  "mail_from_status": "string",
  "verified_at": "2026-01-15T12:30:00Z",
  "dns_records": [
    {
      "type": "string",
      "name": "string",
      "value": "string",
      "status": "string"
    }
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
POST /v1/email_setting organization:write

Sends mails to guests from an address on the organization's own domain, for example `{ "email": "info@bistro.nl" }`. Add the returned `dns_records` at the domain; mails use the address once `status` is `verified`. To change the address, delete it first.

Request body

email string req

Sender address

{
  "email": "info@bistro.nl"
}

Responses

201 EmailSetting Set up the sender address
Response attributes
email string

Sender address, for example `info@bistro.nl`.

status string

Whether the domain itself is verified through its DKIM records: `pending`, `verified` or `failed`. Mails are only sent from this address once it is `verified`.

mail_from_status string

Whether the bounce domain (MX and SPF records on a subdomain) is set up: `pending`, `verified` or `failed`. Not needed for sending, but without it strict receivers more often mark the mails as spam.

verified_at datetime

Time the domain was verified.

dns_records array of object

DNS records to add at the domain: the DKIM records for `status` and the MX and SPF records of the bounce domain for `mail_from_status`.

type string

Record type: `CNAME`, `MX` or `TXT`.

name string

Name of the record.

value string

Value of the record.

status string

Whether the record was found: `pending`, `verified` or `failed`.

created_at datetime

Time the sender address was created.

updated_at datetime

Time the sender address was last updated.

Example response
{
  "email": "string",
  "status": "string",
  "mail_from_status": "string",
  "verified_at": "2026-01-15T12:30:00Z",
  "dns_records": [
    {
      "type": "string",
      "name": "string",
      "value": "string",
      "status": "string"
    }
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/email_setting organization:write

Mails to guests are sent from 20Tabs' own address again.

Responses

204 Remove the sender address

Email templates

GET /v1/email_templates email_template:read

Returns the subject and text of every mail to guests, per language. Null fields use the 20Tabs default.

Parameters

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of EmailTemplate List mail templates
Response attributes

The items on this page.

kind enum

Which mail: receipt, order confirmation, voucher card, loyalty card or a reservation mail.

receipt_pdforder_confirmationvoucher_card_pdfloyaltyreservation_requestedreservation_confirmedreservation_declinedreservation_cancelledreservation_reminderreservation_deposit_requestedreservation_deposit_expired

locale string

Language of the mail, for example `nl` or `en`.

subject string

Subject; null for the default.

body string

Text; null for the default.

created_at datetime

Time the template was created.

updated_at datetime

Time the template was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "kind": "receipt_pdf",
      "locale": "string",
      "subject": "string",
      "body": "string",
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
GET /v1/email_templates/{kind}/{locale} email_template:read

Returns the subject and text of one mail in one language. Null fields use the 20Tabs default.

Parameters

kind path · enum req

Which mail

receipt_pdforder_confirmationvoucher_card_pdfloyaltyreservation_requestedreservation_confirmedreservation_declinedreservation_cancelledreservation_reminderreservation_deposit_requestedreservation_deposit_expired

locale path · enum req

Language of the mail

nlende

Responses

200 EmailTemplate Retrieve a mail template
Response attributes
kind enum

Which mail: receipt, order confirmation, voucher card, loyalty card or a reservation mail.

receipt_pdforder_confirmationvoucher_card_pdfloyaltyreservation_requestedreservation_confirmedreservation_declinedreservation_cancelledreservation_reminderreservation_deposit_requestedreservation_deposit_expired

locale string

Language of the mail, for example `nl` or `en`.

subject string

Subject; null for the default.

body string

Text; null for the default.

created_at datetime

Time the template was created.

updated_at datetime

Time the template was last updated.

Example response
{
  "kind": "receipt_pdf",
  "locale": "string",
  "subject": "string",
  "body": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PUT /v1/email_templates/{kind}/{locale} email_template:write

Sets the subject and text of a mail in one language; send null to go back to the 20Tabs default.

Parameters

kind path · enum req

Which mail

receipt_pdforder_confirmationvoucher_card_pdfloyaltyreservation_requestedreservation_confirmedreservation_declinedreservation_cancelledreservation_reminderreservation_deposit_requestedreservation_deposit_expired

locale path · enum req

Language of the mail

nlende

Request body

subject string

Subject; null for the default

body string

Text; null for the default

{
  "subject": "Your receipt from Bistro De Hoek",
  "body": "Thank you for your visit! Your receipt is attached."
}

Responses

200 EmailTemplate Update a mail template
Response attributes
kind enum

Which mail: receipt, order confirmation, voucher card, loyalty card or a reservation mail.

receipt_pdforder_confirmationvoucher_card_pdfloyaltyreservation_requestedreservation_confirmedreservation_declinedreservation_cancelledreservation_reminderreservation_deposit_requestedreservation_deposit_expired

locale string

Language of the mail, for example `nl` or `en`.

subject string

Subject; null for the default.

body string

Text; null for the default.

created_at datetime

Time the template was created.

updated_at datetime

Time the template was last updated.

Example response
{
  "kind": "receipt_pdf",
  "locale": "string",
  "subject": "string",
  "body": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Employees

GET /v1/employees employee:read

Returns the employees of the organization, ordered by name. PIN codes and login cards are never included.

Parameters

include_archived query · boolean

Include archived employees

default false

role_id query · integer

Only employees with this role

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Employee List employees
Response attributes

The items on this page.

id integer

Unique identifier of the employee.

name string

Name of the employee, for example `Sanne`.

role_id integer

Role that limits what the employee may do on the register; null means the employee may do everything.

locale string

Language of the register for this employee, `nl` or `en`.

access_backoffice boolean

Whether the employee can open the back office from a register. Read-only; managed in the back office.

note string

Internal note about the employee. Only included by the employee endpoints.

archived boolean

Whether the employee is archived and can no longer log in.

created_at datetime

Time the employee was added to the organization.

updated_at datetime

Time the employee was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "role_id": 1,
      "locale": "string",
      "access_backoffice": true,
      "note": "string",
      "archived": true,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/employees employee:write

Adds an employee who can log in on the registers. A PIN code, login card and back office access can only be set in the back office.

Request body

name string req

Name of the employee as shown on the register, for example `Sanne`

role_id integer

Role that limits what the employee may do on the register; null lets the employee do everything

locale enum

Language of the register for this employee; defaults to `nl`

nlende

note string

Internal note about the employee

{
  "name": "Sanne",
  "role_id": 2,
  "locale": "nl"
}

Responses

201 Employee Create an employee
Response attributes
id integer

Unique identifier of the employee.

name string

Name of the employee, for example `Sanne`.

role_id integer

Role that limits what the employee may do on the register; null means the employee may do everything.

locale string

Language of the register for this employee, `nl` or `en`.

access_backoffice boolean

Whether the employee can open the back office from a register. Read-only; managed in the back office.

note string

Internal note about the employee. Only included by the employee endpoints.

archived boolean

Whether the employee is archived and can no longer log in.

created_at datetime

Time the employee was added to the organization.

updated_at datetime

Time the employee was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "role_id": 1,
  "locale": "string",
  "access_backoffice": true,
  "note": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/employees/{id} employee:read

Retrieve an employee

Parameters

id path · integer req

Unique identifier of the employee

Responses

200 Employee Retrieve an employee
Response attributes
id integer

Unique identifier of the employee.

name string

Name of the employee, for example `Sanne`.

role_id integer

Role that limits what the employee may do on the register; null means the employee may do everything.

locale string

Language of the register for this employee, `nl` or `en`.

access_backoffice boolean

Whether the employee can open the back office from a register. Read-only; managed in the back office.

note string

Internal note about the employee. Only included by the employee endpoints.

archived boolean

Whether the employee is archived and can no longer log in.

created_at datetime

Time the employee was added to the organization.

updated_at datetime

Time the employee was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "role_id": 1,
  "locale": "string",
  "access_backoffice": true,
  "note": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/employees/{id} employee:write

Updates the given attributes; attributes that are not included keep their current value. Send `role_id: null` to remove the role.

Parameters

id path · integer req

Unique identifier of the employee

Request body

name string

Name of the employee as shown on the register, for example `Sanne`

role_id integer

Role that limits what the employee may do on the register; null lets the employee do everything

locale enum

Language of the register for this employee; defaults to `nl`

nlende

note string

Internal note about the employee

{
  "role_id": 3
}

Responses

200 Employee Update an employee
Response attributes
id integer

Unique identifier of the employee.

name string

Name of the employee, for example `Sanne`.

role_id integer

Role that limits what the employee may do on the register; null means the employee may do everything.

locale string

Language of the register for this employee, `nl` or `en`.

access_backoffice boolean

Whether the employee can open the back office from a register. Read-only; managed in the back office.

note string

Internal note about the employee. Only included by the employee endpoints.

archived boolean

Whether the employee is archived and can no longer log in.

created_at datetime

Time the employee was added to the organization.

updated_at datetime

Time the employee was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "role_id": 1,
  "locale": "string",
  "access_backoffice": true,
  "note": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/employees/{id} employee:write

Archives the employee: they can no longer log in and their open orders are discarded. The last active employee can't be archived.

Parameters

id path · integer req

Unique identifier of the employee

Responses

200 Employee Archive an employee
Response attributes
id integer

Unique identifier of the employee.

name string

Name of the employee, for example `Sanne`.

role_id integer

Role that limits what the employee may do on the register; null means the employee may do everything.

locale string

Language of the register for this employee, `nl` or `en`.

access_backoffice boolean

Whether the employee can open the back office from a register. Read-only; managed in the back office.

note string

Internal note about the employee. Only included by the employee endpoints.

archived boolean

Whether the employee is archived and can no longer log in.

created_at datetime

Time the employee was added to the organization.

updated_at datetime

Time the employee was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "role_id": 1,
  "locale": "string",
  "access_backoffice": true,
  "note": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Employee roles

GET /v1/employee_roles employee:read

Returns the roles of the organization. A role limits which register actions its employees may perform; employees without a role may do everything.

Parameters

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of EmployeeRole List employee roles
Response attributes

The items on this page.

id integer

Unique identifier of the role.

name string

Name of the role, for example `Bar staff` or `Manager`.

permissions array of enum

Register actions the role allows, for example `["payments", "discounts"]`. `representation` and `own_use` settle a receipt as business entertainment or own use, `email` sends receipts and balances to guests, `revert_course` undoes calling a course and `loyalty_balance` tops up or corrects customer balances.

move_receiptspaymentsvoid_receiptsremove_itemsrepresentationown_usediscountsrefundsopen_cash_draweremailrevert_courseloyalty_balancereservations

employee_ids array of integer

Identifiers of the active employees with this role.

created_at datetime

Time the role was created.

updated_at datetime

Time the role was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "permissions": [
        "move_receipts"
      ],
      "employee_ids": [
        1
      ],
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/employee_roles employee:write

Creates a role with the given permissions, for example bar staff that may take payments but not give discounts or void receipts. Assign it with `role_id` on the employee.

Request body

name string req

Name of the role, for example `Bar staff`

permissions array of enum

Register actions the role allows. The list replaces the current permissions. For example `["payments", "discounts"]`

move_receiptspaymentsvoid_receiptsremove_itemsrepresentationown_usediscountsrefundsopen_cash_draweremailrevert_courseloyalty_balancereservations

{
  "name": "Bar staff",
  "permissions": [
    "payments",
    "open_cash_drawer"
  ]
}

Responses

201 EmployeeRole Create an employee role
Response attributes
id integer

Unique identifier of the role.

name string

Name of the role, for example `Bar staff` or `Manager`.

permissions array of enum

Register actions the role allows, for example `["payments", "discounts"]`. `representation` and `own_use` settle a receipt as business entertainment or own use, `email` sends receipts and balances to guests, `revert_course` undoes calling a course and `loyalty_balance` tops up or corrects customer balances.

move_receiptspaymentsvoid_receiptsremove_itemsrepresentationown_usediscountsrefundsopen_cash_draweremailrevert_courseloyalty_balancereservations

employee_ids array of integer

Identifiers of the active employees with this role.

created_at datetime

Time the role was created.

updated_at datetime

Time the role was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "permissions": [
    "move_receipts"
  ],
  "employee_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/employee_roles/{id} employee:read

Retrieve an employee role

Parameters

id path · integer req

Unique identifier of the role

Responses

200 EmployeeRole Retrieve an employee role
Response attributes
id integer

Unique identifier of the role.

name string

Name of the role, for example `Bar staff` or `Manager`.

permissions array of enum

Register actions the role allows, for example `["payments", "discounts"]`. `representation` and `own_use` settle a receipt as business entertainment or own use, `email` sends receipts and balances to guests, `revert_course` undoes calling a course and `loyalty_balance` tops up or corrects customer balances.

move_receiptspaymentsvoid_receiptsremove_itemsrepresentationown_usediscountsrefundsopen_cash_draweremailrevert_courseloyalty_balancereservations

employee_ids array of integer

Identifiers of the active employees with this role.

created_at datetime

Time the role was created.

updated_at datetime

Time the role was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "permissions": [
    "move_receipts"
  ],
  "employee_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/employee_roles/{id} employee:write

Updates the given attributes; attributes that are not included keep their current value. `permissions` replaces the full list.

Parameters

id path · integer req

Unique identifier of the role

Request body

name string

Name of the role, for example `Bar staff`

permissions array of enum

Register actions the role allows. The list replaces the current permissions. For example `["payments", "discounts"]`

move_receiptspaymentsvoid_receiptsremove_itemsrepresentationown_usediscountsrefundsopen_cash_draweremailrevert_courseloyalty_balancereservations

{
  "permissions": [
    "payments",
    "open_cash_drawer",
    "discounts"
  ]
}

Responses

200 EmployeeRole Update an employee role
Response attributes
id integer

Unique identifier of the role.

name string

Name of the role, for example `Bar staff` or `Manager`.

permissions array of enum

Register actions the role allows, for example `["payments", "discounts"]`. `representation` and `own_use` settle a receipt as business entertainment or own use, `email` sends receipts and balances to guests, `revert_course` undoes calling a course and `loyalty_balance` tops up or corrects customer balances.

move_receiptspaymentsvoid_receiptsremove_itemsrepresentationown_usediscountsrefundsopen_cash_draweremailrevert_courseloyalty_balancereservations

employee_ids array of integer

Identifiers of the active employees with this role.

created_at datetime

Time the role was created.

updated_at datetime

Time the role was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "permissions": [
    "move_receipts"
  ],
  "employee_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/employee_roles/{id} employee:write

Deletes a role that no employee has. Give its employees another role (or none) first, because employees without a role may do everything.

Parameters

id path · integer req

Unique identifier of the role

Responses

204 Delete an employee role

Fees

Returns the fees: extra charges added to the receipt with a product (for example a bottle deposit, via `fee_ids` on `PATCH /v1/products/{id}`) or with every order in a shop (for example a delivery fee, via `fee_ids` on `PATCH /v1/shops/{id}`).

Parameters

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Fee List fees
Response attributes
items array of Fee

The items on this page.

id integer

Unique identifier of the fee.

name string

Name of the fee as shown on the receipt.

price Money

Amount charged including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate_id integer

Unique identifier of the tax rate applied to the fee.

category_of_revenue_id integer

Unique identifier of the category of revenue the fee is booked on.

enabled boolean

Whether the fee is charged. Disabled fees stay assigned but aren't added to receipts.

created_at datetime

Time the fee was created.

updated_at datetime

Time the fee was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "tax_rate_id": 1,
      "category_of_revenue_id": 1,
      "enabled": true,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}

Adds a fee, for example `{ "name": "Statiegeld", "price": { "value": 15, "currency": "EUR" }, "tax_rate_id": 3, "category_of_revenue_id": 4 }`. Assign it to products or shops with their `fee_ids`.

Request body

name string req

Name shown on the receipt, for example `Statiegeld`

price object req

Amount including VAT, for example `{ "value": 15, "currency": "EUR" }` for €0.15

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

tax_rate_id integer req

Tax rate to apply (`GET /v1/tax_rates`)

category_of_revenue_id integer req

Category of revenue the fee is booked on (`GET /v1/categories_of_revenue`)

enabled boolean

Whether the fee is charged; disable it to stop charging without unassigning it

{
  "name": "Statiegeld",
  "price": {
    "value": 15,
    "currency": "EUR"
  },
  "tax_rate_id": 3,
  "category_of_revenue_id": 4
}

Responses

201 Fee Create a fee
Response attributes
id integer

Unique identifier of the fee.

name string

Name of the fee as shown on the receipt.

price Money

Amount charged including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate_id integer

Unique identifier of the tax rate applied to the fee.

category_of_revenue_id integer

Unique identifier of the category of revenue the fee is booked on.

enabled boolean

Whether the fee is charged. Disabled fees stay assigned but aren't added to receipts.

created_at datetime

Time the fee was created.

updated_at datetime

Time the fee was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "tax_rate_id": 1,
  "category_of_revenue_id": 1,
  "enabled": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/fees/{id} product:read

Retrieve a fee

Parameters

id path · integer req

Unique identifier of the fee

Responses

200 Fee Retrieve a fee
Response attributes
id integer

Unique identifier of the fee.

name string

Name of the fee as shown on the receipt.

price Money

Amount charged including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate_id integer

Unique identifier of the tax rate applied to the fee.

category_of_revenue_id integer

Unique identifier of the category of revenue the fee is booked on.

enabled boolean

Whether the fee is charged. Disabled fees stay assigned but aren't added to receipts.

created_at datetime

Time the fee was created.

updated_at datetime

Time the fee was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "tax_rate_id": 1,
  "category_of_revenue_id": 1,
  "enabled": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/fees/{id} product:write

Updates the given attributes; attributes that are not included keep their current value.

Parameters

id path · integer req

Unique identifier of the fee

Request body

name string

Name shown on the receipt, for example `Statiegeld`

price object

Amount including VAT, for example `{ "value": 15, "currency": "EUR" }` for €0.15

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

tax_rate_id integer

Tax rate to apply (`GET /v1/tax_rates`)

category_of_revenue_id integer

Category of revenue the fee is booked on (`GET /v1/categories_of_revenue`)

enabled boolean

Whether the fee is charged; disable it to stop charging without unassigning it

{
  "price": {
    "value": 25,
    "currency": "EUR"
  }
}

Responses

200 Fee Update a fee
Response attributes
id integer

Unique identifier of the fee.

name string

Name of the fee as shown on the receipt.

price Money

Amount charged including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate_id integer

Unique identifier of the tax rate applied to the fee.

category_of_revenue_id integer

Unique identifier of the category of revenue the fee is booked on.

enabled boolean

Whether the fee is charged. Disabled fees stay assigned but aren't added to receipts.

created_at datetime

Time the fee was created.

updated_at datetime

Time the fee was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "tax_rate_id": 1,
  "category_of_revenue_id": 1,
  "enabled": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/fees/{id} product:write

Deletes the fee and removes it from all products and shops. Receipts it was charged on keep the charge.

Parameters

id path · integer req

Unique identifier of the fee

Responses

204 Delete a fee

Groups

Returns the customer groups of the organization, ordered by name. Discounts for members are discount rules linked to the group.

Parameters

include_archived query · boolean

Include archived groups

default false

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Group List customer groups
Response attributes

The items on this page.

id integer

Unique identifier of the group.

name string

Name of the group, for example `Tennisclub De Lob`.

email string

Email address of the group, for example for invoices.

phone string

Phone number of the group.

address string

Postal address of the group.

combined_receipt boolean

Whether members order on one shared receipt of the group instead of on their own receipts.

archived boolean

Whether the group is archived.

customer_ids array of integer

Identifiers of the customers that are members of the group.

table_ids array of integer

Identifiers of the tables linked to the group.

created_at datetime

Time the group was created.

updated_at datetime

Time the group was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "email": "string",
      "phone": "string",
      "address": "string",
      "combined_receipt": true,
      "archived": true,
      "customer_ids": [
        1
      ],
      "table_ids": [
        1
      ],
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}

Creates a group, for example a company whose employees order on one combined receipt. Add members with `customer_ids` or one by one with `PUT /v1/groups/{id}/customers/{customer_id}`.

Request body

name string req

Name of the group, for example `Tennisclub De Lob`

email string

Email address of the group, for example `penningmeester@delob.nl`

phone string

Phone number of the group

address string

Postal address of the group

combined_receipt boolean

Let members order on one shared receipt of the group; defaults to true

customer_ids array of integer

Customers that are members of the group. The list replaces the current members, so `[]` removes them all

{
  "name": "Tennisclub De Lob",
  "email": "penningmeester@delob.nl",
  "combined_receipt": true,
  "customer_ids": [
    12,
    15
  ]
}

Responses

201 Group Create a customer group
Response attributes
id integer

Unique identifier of the group.

name string

Name of the group, for example `Tennisclub De Lob`.

email string

Email address of the group, for example for invoices.

phone string

Phone number of the group.

address string

Postal address of the group.

combined_receipt boolean

Whether members order on one shared receipt of the group instead of on their own receipts.

archived boolean

Whether the group is archived.

customer_ids array of integer

Identifiers of the customers that are members of the group.

table_ids array of integer

Identifiers of the tables linked to the group.

created_at datetime

Time the group was created.

updated_at datetime

Time the group was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "combined_receipt": true,
  "archived": true,
  "customer_ids": [
    1
  ],
  "table_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/groups/{id} customer:read

Retrieve a customer group

Parameters

id path · integer req

Unique identifier of the group

Responses

200 Group Retrieve a customer group
Response attributes
id integer

Unique identifier of the group.

name string

Name of the group, for example `Tennisclub De Lob`.

email string

Email address of the group, for example for invoices.

phone string

Phone number of the group.

address string

Postal address of the group.

combined_receipt boolean

Whether members order on one shared receipt of the group instead of on their own receipts.

archived boolean

Whether the group is archived.

customer_ids array of integer

Identifiers of the customers that are members of the group.

table_ids array of integer

Identifiers of the tables linked to the group.

created_at datetime

Time the group was created.

updated_at datetime

Time the group was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "combined_receipt": true,
  "archived": true,
  "customer_ids": [
    1
  ],
  "table_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/groups/{id} customer:write

Updates the given attributes; attributes that are not included keep their current value. Passing `customer_ids` replaces all members, so `[]` removes everyone.

Parameters

id path · integer req

Unique identifier of the group

Request body

name string

Name of the group, for example `Tennisclub De Lob`

email string

Email address of the group, for example `penningmeester@delob.nl`

phone string

Phone number of the group

address string

Postal address of the group

combined_receipt boolean

Let members order on one shared receipt of the group; defaults to true

customer_ids array of integer

Customers that are members of the group. The list replaces the current members, so `[]` removes them all

{
  "customer_ids": [
    12,
    15,
    18
  ]
}

Responses

200 Group Update a customer group
Response attributes
id integer

Unique identifier of the group.

name string

Name of the group, for example `Tennisclub De Lob`.

email string

Email address of the group, for example for invoices.

phone string

Phone number of the group.

address string

Postal address of the group.

combined_receipt boolean

Whether members order on one shared receipt of the group instead of on their own receipts.

archived boolean

Whether the group is archived.

customer_ids array of integer

Identifiers of the customers that are members of the group.

table_ids array of integer

Identifiers of the tables linked to the group.

created_at datetime

Time the group was created.

updated_at datetime

Time the group was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "combined_receipt": true,
  "archived": true,
  "customer_ids": [
    1
  ],
  "table_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/groups/{id} customer:write

Archives the group. Only possible once it has no members or tables left; remove them first.

Parameters

id path · integer req

Unique identifier of the group

Responses

200 Group Archive a customer group
Response attributes
id integer

Unique identifier of the group.

name string

Name of the group, for example `Tennisclub De Lob`.

email string

Email address of the group, for example for invoices.

phone string

Phone number of the group.

address string

Postal address of the group.

combined_receipt boolean

Whether members order on one shared receipt of the group instead of on their own receipts.

archived boolean

Whether the group is archived.

customer_ids array of integer

Identifiers of the customers that are members of the group.

table_ids array of integer

Identifiers of the tables linked to the group.

created_at datetime

Time the group was created.

updated_at datetime

Time the group was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "combined_receipt": true,
  "archived": true,
  "customer_ids": [
    1
  ],
  "table_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PUT /v1/groups/{id}/customers/{customer_id} customer:write

Makes the customer a member of the group. Adding an existing member changes nothing.

Parameters

id path · integer req

Unique identifier of the group

customer_id path · integer req

Unique identifier of the customer

Responses

200 Group Add a customer to a group
Response attributes
id integer

Unique identifier of the group.

name string

Name of the group, for example `Tennisclub De Lob`.

email string

Email address of the group, for example for invoices.

phone string

Phone number of the group.

address string

Postal address of the group.

combined_receipt boolean

Whether members order on one shared receipt of the group instead of on their own receipts.

archived boolean

Whether the group is archived.

customer_ids array of integer

Identifiers of the customers that are members of the group.

table_ids array of integer

Identifiers of the tables linked to the group.

created_at datetime

Time the group was created.

updated_at datetime

Time the group was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "combined_receipt": true,
  "archived": true,
  "customer_ids": [
    1
  ],
  "table_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/groups/{id}/customers/{customer_id} customer:write

Ends the customer's membership of the group. The customer itself is kept.

Parameters

id path · integer req

Unique identifier of the group

customer_id path · integer req

Unique identifier of the customer

Responses

200 Group Remove a customer from a group
Response attributes
id integer

Unique identifier of the group.

name string

Name of the group, for example `Tennisclub De Lob`.

email string

Email address of the group, for example for invoices.

phone string

Phone number of the group.

address string

Postal address of the group.

combined_receipt boolean

Whether members order on one shared receipt of the group instead of on their own receipts.

archived boolean

Whether the group is archived.

customer_ids array of integer

Identifiers of the customers that are members of the group.

table_ids array of integer

Identifiers of the tables linked to the group.

created_at datetime

Time the group was created.

updated_at datetime

Time the group was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "combined_receipt": true,
  "archived": true,
  "customer_ids": [
    1
  ],
  "table_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Ledger accounts

GET /v1/ledger_accounts ledger_account:read

Returns the accounts the register books on: revenue per category, payments per method, VAT, tips and liabilities such as vouchers, loyalty balances and deposits. Set `number` and `code` to match your own bookkeeping.

Parameters

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of LedgerAccount List ledger accounts
Response attributes

The items on this page.

id integer

Unique identifier of the ledger account.

name string

Name of the account.

kind string

Kind of account, for example `revenue`, `payments`, `tax` or `vouchers`.

number integer

Account number in your bookkeeping.

code string

Code in your bookkeeping, for example a VAT code.

parent_id integer

Account this one is part of; null for a main account.

created_at datetime

Time the ledger account was created.

updated_at datetime

Time the ledger account was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "kind": "string",
      "number": 1,
      "code": "string",
      "parent_id": 1,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
GET /v1/ledger_accounts/{id} ledger_account:read

Retrieve a ledger account

Parameters

id path · integer req

Unique identifier of the ledger account

Responses

200 LedgerAccount Retrieve a ledger account
Response attributes
id integer

Unique identifier of the ledger account.

name string

Name of the account.

kind string

Kind of account, for example `revenue`, `payments`, `tax` or `vouchers`.

number integer

Account number in your bookkeeping.

code string

Code in your bookkeeping, for example a VAT code.

parent_id integer

Account this one is part of; null for a main account.

created_at datetime

Time the ledger account was created.

updated_at datetime

Time the ledger account was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "kind": "string",
  "number": 1,
  "code": "string",
  "parent_id": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/ledger_accounts/{id} ledger_account:write

Sets the account number and code used in your own bookkeeping.

Parameters

id path · integer req

Unique identifier of the ledger account

Request body

number integer

Account number, for example `8000`

code string

Code, for example a VAT code

{
  "number": 8000,
  "code": "V21"
}

Responses

200 LedgerAccount Update a ledger account
Response attributes
id integer

Unique identifier of the ledger account.

name string

Name of the account.

kind string

Kind of account, for example `revenue`, `payments`, `tax` or `vouchers`.

number integer

Account number in your bookkeeping.

code string

Code in your bookkeeping, for example a VAT code.

parent_id integer

Account this one is part of; null for a main account.

created_at datetime

Time the ledger account was created.

updated_at datetime

Time the ledger account was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "kind": "string",
  "number": 1,
  "code": "string",
  "parent_id": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/ledger_accounts/{id}/mutations ledger_account:read

Returns the bookings on the account in the daily closings of a period (at most 366 days), most recent first.

Parameters

id path · integer req

Unique identifier of the ledger account

from query · date req

First day of the period

to query · date

Last day of the period; defaults to `from`

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of LedgerMutation List ledger mutations
Response attributes

The items on this page.

id integer

Unique identifier of the mutation.

amount Money

Amount booked; positive is credit.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

daily_closing_id integer

Daily closing the booking belongs to.

source_type string

What caused the booking, for example `receipt` or `payment`.

source_id integer

Unique identifier of what caused the booking.

created_at datetime

Time of the booking.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "daily_closing_id": 1,
      "source_type": "string",
      "source_id": 1,
      "created_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}

Loyalty setting

GET /v1/loyalty_setting organization:read

Retrieve the loyalty program

Responses

200 LoyaltySetting Retrieve the loyalty program
Response attributes
enabled boolean

Whether customers get a loyalty card in their wallet.

balance_enabled boolean

Whether customers can top up a balance and pay with it.

self_registration_enabled boolean

Whether guests can sign up for a card themselves.

show_discounts boolean

Whether the wallet pass shows the customer's discounts.

loyalty_pass_name string

Name on the wallet pass.

wallet_pass_color string

Color of the wallet pass as #rrggbb.

prefer_barcode_over_qr boolean

Whether the pass shows a barcode instead of a QR code.

created_at datetime

Time the loyalty program was created.

updated_at datetime

Time the loyalty program was last updated.

Example response
{
  "enabled": true,
  "balance_enabled": true,
  "self_registration_enabled": true,
  "show_discounts": true,
  "loyalty_pass_name": "string",
  "wallet_pass_color": "string",
  "prefer_barcode_over_qr": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/loyalty_setting organization:write

Updates the given settings; settings that are not included keep their current value.

Request body

enabled boolean

Give customers a loyalty card in their wallet

balance_enabled boolean

Let customers top up a balance and pay with it

self_registration_enabled boolean

Let guests sign up for a card themselves

show_discounts boolean

Show the customer's discounts on the wallet pass

loyalty_pass_name string

Name on the wallet pass

wallet_pass_color string

Color of the wallet pass as #rrggbb

prefer_barcode_over_qr boolean

Show a barcode instead of a QR code on the pass

{
  "enabled": true,
  "loyalty_pass_name": "Stamkaart",
  "wallet_pass_color": "#1f2937"
}

Responses

200 LoyaltySetting Update the loyalty program
Response attributes
enabled boolean

Whether customers get a loyalty card in their wallet.

balance_enabled boolean

Whether customers can top up a balance and pay with it.

self_registration_enabled boolean

Whether guests can sign up for a card themselves.

show_discounts boolean

Whether the wallet pass shows the customer's discounts.

loyalty_pass_name string

Name on the wallet pass.

wallet_pass_color string

Color of the wallet pass as #rrggbb.

prefer_barcode_over_qr boolean

Whether the pass shows a barcode instead of a QR code.

created_at datetime

Time the loyalty program was created.

updated_at datetime

Time the loyalty program was last updated.

Example response
{
  "enabled": true,
  "balance_enabled": true,
  "self_registration_enabled": true,
  "show_discounts": true,
  "loyalty_pass_name": "string",
  "wallet_pass_color": "string",
  "prefer_barcode_over_qr": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Markers

GET /v1/markers product:read

Returns the markers, ordered by name. Markers are colored labels such as `Vegan` or `Birthday`, shown on products, receipts and reservations. Assign them to products with `marker_ids` on `PATCH /v1/products/{id}`; receipts with such a product get the marker too.

Parameters

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Marker List markers
Response attributes

The items on this page.

id integer

Unique identifier of the marker.

name string

Name of the marker.

icon string

Icon shown on the marker, for example `leaf`.

color string

Color of the marker, for example `green`.

created_at datetime

Time the marker was created.

updated_at datetime

Time the marker was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "icon": "string",
      "color": "string",
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/markers product:write

Adds a marker, for example `{ "name": "Vegan", "icon": "leaf", "color": "green" }`.

Request body

name string req

Name of the marker, for example `Vegan`

icon enum req

Icon shown on the marker

bank_notesbell_alertboltcameracardchat_bubblecheck_circlecheckclipboardclockclosecredit_cardcross_circlecrosseuroexclamation_circleforwardgeargrouphouseitemkeyleaflockmailmapmergeminus_circleminusnewspaperpencilpersonsplus_circleplusprinterquestion_mark_circleremoverounded_arrowssearchshopping_cartsmartphonestoretagtaskthumb_downthumb_uptrashtrucktvuputensilswheatcelerycrustaceanseggsfishlupinmilkmolluscsmustardnutspeanutssesamesoybeanssulphites

color enum req

Color of the marker

slategrayzincneutralstoneredorangeamberyellowlimegreenemeraldtealcyanskyblueindigovioletpurplefuchsiapinkrose

{
  "name": "Vegan",
  "icon": "leaf",
  "color": "green"
}

Responses

201 Marker Create a marker
Response attributes
id integer

Unique identifier of the marker.

name string

Name of the marker.

icon string

Icon shown on the marker, for example `leaf`.

color string

Color of the marker, for example `green`.

created_at datetime

Time the marker was created.

updated_at datetime

Time the marker was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "icon": "string",
  "color": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/markers/{id} product:read

Retrieve a marker

Parameters

id path · integer req

Unique identifier of the marker

Responses

200 Marker Retrieve a marker
Response attributes
id integer

Unique identifier of the marker.

name string

Name of the marker.

icon string

Icon shown on the marker, for example `leaf`.

color string

Color of the marker, for example `green`.

created_at datetime

Time the marker was created.

updated_at datetime

Time the marker was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "icon": "string",
  "color": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/markers/{id} product:write

Updates the given attributes; attributes that are not included keep their current value.

Parameters

id path · integer req

Unique identifier of the marker

Request body

name string

Name of the marker, for example `Vegan`

icon enum

Icon shown on the marker

bank_notesbell_alertboltcameracardchat_bubblecheck_circlecheckclipboardclockclosecredit_cardcross_circlecrosseuroexclamation_circleforwardgeargrouphouseitemkeyleaflockmailmapmergeminus_circleminusnewspaperpencilpersonsplus_circleplusprinterquestion_mark_circleremoverounded_arrowssearchshopping_cartsmartphonestoretagtaskthumb_downthumb_uptrashtrucktvuputensilswheatcelerycrustaceanseggsfishlupinmilkmolluscsmustardnutspeanutssesamesoybeanssulphites

color enum

Color of the marker

slategrayzincneutralstoneredorangeamberyellowlimegreenemeraldtealcyanskyblueindigovioletpurplefuchsiapinkrose

{
  "color": "green"
}

Responses

200 Marker Update a marker
Response attributes
id integer

Unique identifier of the marker.

name string

Name of the marker.

icon string

Icon shown on the marker, for example `leaf`.

color string

Color of the marker, for example `green`.

created_at datetime

Time the marker was created.

updated_at datetime

Time the marker was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "icon": "string",
  "color": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Modals

POST /v1/modals

Displays a modal in the user's session on the register, for example to confirm a payment your app is processing.

Request body

session_id integer req

Unique identifier of the user session to show the modal in

title string req

Title of the modal

text string req

Body text of the modal

type string

Leave empty for a plain text modal, or use `confirm_payment` for a payment confirmation modal

metadata object

For `confirm_payment` modals: the `reference`, `amount` (as money, for example `{ "value": 1250, "currency": "EUR" }`) and `payment_method_id` of the payment to confirm

{
  "session_id": 4821,
  "title": "Card declined",
  "text": "The payment was declined. Ask the guest for another card."
}

Responses

201 Show a modal

Monthly closings

GET /v1/monthly_closings/{id} monthly_closing:read

Returns a monthly closing with the combined cashflow and revenue of all daily closings in the month, together with the individual daily closings it covers.

Parameters

id path · integer req

Unique identifier of the monthly closing

Responses

200 MonthlyClosing Retrieve a monthly closing
Response attributes
id integer

Unique identifier of the monthly closing.

cashflow object

Combined cashflow of all daily closings in the month, per payment method.

amounts object

Amount received per payment method, keyed by payment method ID, each in the money shape (`value`, `currency`, `minor_units`, `formatted`).

revenue object

Combined revenue of all daily closings in the month, broken down per dimension.

per_category_of_revenue array of Revenue

Revenue per category of revenue.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_employee array of Revenue

Revenue per employee.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_device array of Revenue

Revenue per device.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_voucher array of Revenue

Revenue per voucher.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_loyalty_topup array of Revenue

Revenue per loyalty top-up.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_reservation_deposit array of Revenue

Reservation deposits received.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher_redemptions array of object

Vouchers redeemed during the month.

voucher Reference

Voucher that was redeemed.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount redeemed.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

loyalty_redemption LoyaltyRedemption

Customer balance redeemed during the month.

loyalty Reference

Loyalty program the redemption belongs to.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount redeemed.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

reservation_deposit_redemption object

Reservation deposits settled during the month.

reservation Reference

Reservation program the redemption belongs to.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Deposit amount applied to receipts.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

forfeited Money

Part of the applied deposits kept as forfeit revenue.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

daily_closings array of DailyClosing

Daily closings the monthly closing covers.

id integer

Unique identifier of the daily closing.

cashflow object

Cashflow generated during the day, per payment method.

amounts object

Amount received per payment method, keyed by payment method ID, each in the money shape (`value`, `currency`, `minor_units`, `formatted`).

revenue object

Revenue generated during the day, broken down per dimension.

per_category_of_revenue array of Revenue

Revenue per category of revenue.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_employee array of Revenue

Revenue per employee.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_device array of Revenue

Revenue per device.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_voucher array of Revenue

Revenue per voucher.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_loyalty_topup array of Revenue

Revenue per loyalty top-up.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_reservation_deposit array of Revenue

Reservation deposits received.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher_redemptions array of object

Vouchers redeemed during the day.

voucher Reference

Voucher that was redeemed.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount redeemed.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

loyalty_redemption LoyaltyRedemption

Customer balance redeemed during the day.

loyalty Reference

Loyalty program the redemption belongs to.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount redeemed.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

reservation_deposit_redemption object

Reservation deposits settled during the day.

reservation Reference

Reservation program the redemption belongs to.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Deposit amount applied to receipts.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

forfeited Money

Part of the applied deposits kept as forfeit revenue.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

created_at datetime

Time the daily closing was created.

for_date date

Trading date the daily closing covers.

updated_at datetime

Time the daily closing was last updated.

created_at datetime

Time the monthly closing was created.

updated_at datetime

Time the monthly closing was last updated.

Example response
{
  "id": 1,
  "cashflow": {
    "amounts": {}
  },
  "revenue": {
    "per_category_of_revenue": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_employee": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_device": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_voucher": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_loyalty_topup": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_reservation_deposit": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ]
  },
  "voucher_redemptions": [
    {
      "voucher": {
        "id": 1,
        "name": "string"
      },
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      }
    }
  ],
  "loyalty_redemption": {
    "loyalty": {
      "id": 1,
      "name": "string"
    },
    "amount": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    }
  },
  "reservation_deposit_redemption": {
    "reservation": {
      "id": 1,
      "name": "string"
    },
    "amount": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "forfeited": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    }
  },
  "daily_closings": [
    {
      "id": 1,
      "cashflow": {
        "amounts": {}
      },
      "revenue": {
        "per_category_of_revenue": [
          {
            "amount": {
              "value": 1,
              "currency": "string",
              "minor_units": 1,
              "formatted": "string"
            },
            "tax_rate": {
              "id": 1,
              "name": "string",
              "percentage": 9.99,
              "kind": "string",
              "archived": true,
              "label": "string",
              "created_at": "2026-01-15T12:30:00Z",
              "updated_at": "2026-01-15T12:30:00Z"
            },
            "category_of_revenue": {
              "id": 1,
              "name": "string"
            },
            "employee": {
              "id": 1,
              "name": "string"
            },
            "device": {
              "id": 1,
              "name": "string"
            },
            "voucher": {
              "id": 1,
              "name": "string"
            },
            "loyalty": {
              "id": 1,
              "name": "string"
            },
            "reservation": {
              "id": 1,
              "name": "string"
            }
          }
        ],
        "per_employee": [
          {
            "amount": {
              "value": 1,
              "currency": "string",
              "minor_units": 1,
              "formatted": "string"
            },
            "tax_rate": {
              "id": 1,
              "name": "string",
              "percentage": 9.99,
              "kind": "string",
              "archived": true,
              "label": "string",
              "created_at": "2026-01-15T12:30:00Z",
              "updated_at": "2026-01-15T12:30:00Z"
            },
            "category_of_revenue": {
              "id": 1,
              "name": "string"
            },
            "employee": {
              "id": 1,
              "name": "string"
            },
            "device": {
              "id": 1,
              "name": "string"
            },
            "voucher": {
              "id": 1,
              "name": "string"
            },
            "loyalty": {
              "id": 1,
              "name": "string"
            },
            "reservation": {
              "id": 1,
              "name": "string"
            }
          }
        ],
        "per_device": [
          {
            "amount": {
              "value": 1,
              "currency": "string",
              "minor_units": 1,
              "formatted": "string"
            },
            "tax_rate": {
              "id": 1,
              "name": "string",
              "percentage": 9.99,
              "kind": "string",
              "archived": true,
              "label": "string",
              "created_at": "2026-01-15T12:30:00Z",
              "updated_at": "2026-01-15T12:30:00Z"
            },
            "category_of_revenue": {
              "id": 1,
              "name": "string"
            },
            "employee": {
              "id": 1,
              "name": "string"
            },
            "device": {
              "id": 1,
              "name": "string"
            },
            "voucher": {
              "id": 1,
              "name": "string"
            },
            "loyalty": {
              "id": 1,
              "name": "string"
            },
            "reservation": {
              "id": 1,
              "name": "string"
            }
          }
        ],
        "per_voucher": [
          {
            "amount": {
              "value": 1,
              "currency": "string",
              "minor_units": 1,
              "formatted": "string"
            },
            "tax_rate": {
              "id": 1,
              "name": "string",
              "percentage": 9.99,
              "kind": "string",
              "archived": true,
              "label": "string",
              "created_at": "2026-01-15T12:30:00Z",
              "updated_at": "2026-01-15T12:30:00Z"
            },
            "category_of_revenue": {
              "id": 1,
              "name": "string"
            },
            "employee": {
              "id": 1,
              "name": "string"
            },
            "device": {
              "id": 1,
              "name": "string"
            },
            "voucher": {
              "id": 1,
              "name": "string"
            },
            "loyalty": {
              "id": 1,
              "name": "string"
            },
            "reservation": {
              "id": 1,
              "name": "string"
            }
          }
        ],
        "per_loyalty_topup": [
          {
            "amount": {
              "value": 1,
              "currency": "string",
              "minor_units": 1,
              "formatted": "string"
            },
            "tax_rate": {
              "id": 1,
              "name": "string",
              "percentage": 9.99,
              "kind": "string",
              "archived": true,
              "label": "string",
              "created_at": "2026-01-15T12:30:00Z",
              "updated_at": "2026-01-15T12:30:00Z"
            },
            "category_of_revenue": {
              "id": 1,
              "name": "string"
            },
            "employee": {
              "id": 1,
              "name": "string"
            },
            "device": {
              "id": 1,
              "name": "string"
            },
            "voucher": {
              "id": 1,
              "name": "string"
            },
            "loyalty": {
              "id": 1,
              "name": "string"
            },
            "reservation": {
              "id": 1,
              "name": "string"
            }
          }
        ],
        "per_reservation_deposit": [
          {
            "amount": {
              "value": 1,
              "currency": "string",
              "minor_units": 1,
              "formatted": "string"
            },
            "tax_rate": {
              "id": 1,
              "name": "string",
              "percentage": 9.99,
              "kind": "string",
              "archived": true,
              "label": "string",
              "created_at": "2026-01-15T12:30:00Z",
              "updated_at": "2026-01-15T12:30:00Z"
            },
            "category_of_revenue": {
              "id": 1,
              "name": "string"
            },
            "employee": {
              "id": 1,
              "name": "string"
            },
            "device": {
              "id": 1,
              "name": "string"
            },
            "voucher": {
              "id": 1,
              "name": "string"
            },
            "loyalty": {
              "id": 1,
              "name": "string"
            },
            "reservation": {
              "id": 1,
              "name": "string"
            }
          }
        ]
      },
      "voucher_redemptions": [
        {
          "voucher": {
            "id": 1,
            "name": "string"
          },
          "amount": {
            "value": 1,
            "currency": "string",
            "minor_units": 1,
            "formatted": "string"
          }
        }
      ],
      "loyalty_redemption": {
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        }
      },
      "reservation_deposit_redemption": {
        "reservation": {
          "id": 1,
          "name": "string"
        },
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "forfeited": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        }
      },
      "created_at": "2026-01-15T12:30:00Z",
      "for_date": "2026-01-15",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Oauth

GET https://{organization}.20tabs.app/oauth/authorize

Starts the authorization code flow. Renders a consent page in the user's browser on the organization's domain; after the user approves, the browser is redirected to `redirect_uri` with `code`, `state` and `subscription_id` query parameters.

Parameters

client_id query · string req

Client id of the registered app

redirect_uri query · string req

Callback URL; must be allowed by the registered app

state query · string

Opaque value echoed back on the redirect

read_only query · boolean

Request only the read scopes of the app, if the app supports read-only installs

Responses

200 Consent page (HTML)
302 Redirect to `redirect_uri` with `code`, `state` and `subscription_id`
422 Unknown client id or redirect URI not allowed
POST https://api.20tabs.app/oauth/refresh

Exchanges a refresh token for a new access and refresh token pair.

Responses

200 OauthToken Access token refreshed
Response attributes
token_type string
access_token string
refresh_token string
expires_in integer

Access token lifetime in seconds

scopes array of string

Scopes granted to the subscription

subscription_id string
Example response
{
  "token_type": "string",
  "access_token": "string",
  "refresh_token": "string",
  "expires_in": 1,
  "scopes": [
    "string"
  ],
  "subscription_id": "string"
}
401 OauthError Invalid refresh token
Response attributes
error string
error_description string
Example response
{
  "error": "string",
  "error_description": "string"
}
POST https://api.20tabs.app/oauth/token

Exchanges the authorization `code` for an access token.

Responses

200 OauthToken Access token issued
Response attributes
token_type string
access_token string
refresh_token string
expires_in integer

Access token lifetime in seconds

scopes array of string

Scopes granted to the subscription

subscription_id string
Example response
{
  "token_type": "string",
  "access_token": "string",
  "refresh_token": "string",
  "expires_in": 1,
  "scopes": [
    "string"
  ],
  "subscription_id": "string"
}
401 OauthError Invalid code, code verifier or client credentials
Response attributes
error string
error_description string
Example response
{
  "error": "string",
  "error_description": "string"
}
422 OauthError Redirect URI mismatch
Response attributes
error string
error_description string
Example response
{
  "error": "string",
  "error_description": "string"
}

Orders

GET /v1/orders order:read

Returns the orders submitted between `from` and `to` (inclusive, at most 31 days), most recent first. Filter by `shop_id` to get the orders placed in a shop.

Parameters

from query · date

First day of the range; defaults to today

to query · date

Last day of the range; defaults to `from`

shop_id query · integer

Only orders placed in this shop

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Order List orders
Response attributes

The items on this page.

id integer

Unique identifier of the order.

receipt_id integer

Unique identifier of the receipt the order was placed on.

shop_id integer

Unique identifier of the shop the order was placed in; null for orders from the register or the API.

receiptable_type string

What the order was placed on: `table`, `customer`, `group` or `employee`.

receiptable_id integer

Unique identifier of the table, customer, group or employee the order was placed on.

pick_up_at datetime

Pick-up moment for takeout orders; null otherwise.

items array of object

Items that were ordered.

id integer

Unique identifier of the item.

product_id integer

Unique identifier of the ordered product; null for free-form items.

parent_id integer

Unique identifier of the item this item belongs to, for example a product option or a fee; null for top-level items.

description string

Description of the item as shown on the receipt.

note string

Note shown on the preparation receipt.

price Money

Unit price after discounts and compensation; this is what the guest pays.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

original_price Money

Unit price before discounts and compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

discount_percentage number

Discount percentage applied to the item, from a discount rule or the receipt discount; 0 without discount.

compensation Money

Amount taken off the item as compensation, for example for a cold dish; 0 without compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

compensation_reason_id integer

Unique identifier of the compensation reason; null without compensation.

compensation_reason string

Reason for the compensation, as set up in the back office; null without compensation.

compensation_note string

Note the employee added to the compensation.

tax_rate TaxRate

Tax rate applied to the item.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the item counts towards.

id integer

Unique identifier of the resource.

name string

Name of the resource.

cost_price Money

Cost price of the item.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

unit_quantity integer

Quantity sold of `unit_name`, for example 250 for 250 gram; null for items sold per piece.

unit_name string

Unit the item is sold per, for example `gram`; null for items sold per piece.

course integer

Course the item is served in, 0 for no course.

preparation_state string

Where the item is in preparation: `unrequested`, `requested`, `ready_to_prepare`, `preparing`, `prepared`, `ready_to_deliver` or `delivered`.

representation_by Reference

Employee the item was booked on as representation (on the house), if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

own_use boolean

Whether the item was booked as own use (consumed by staff or the business) instead of sold.

payment_status string

Payment status of the item: `open`, `pending` or `paid`.

refunded_item_id integer

On a return receipt: the item that was refunded; null otherwise.

voucher_card_id integer

Voucher card sold or topped up with the item (`GET /v1/voucher_cards/{id}`); null otherwise.

kind enum

`sale` for products and other items, `voucher` for a sold voucher card, `loyalty_topup` for balance topped up on a customer and `reservation_deposit` for a deposit paid on a reservation.

salevoucherloyalty_topupreservation_deposit

voucher Reference

Voucher sold with the item, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for top-up items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

created_at datetime

Time the item was added to the receipt.

updated_at datetime

Time the receipt item was last updated.

submitted_at datetime

Time the order was submitted for preparation; null while the order is still a cart.

created_at datetime

Time the order was created.

updated_at datetime

Time the order was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "receipt_id": 1,
      "shop_id": 1,
      "receiptable_type": "string",
      "receiptable_id": 1,
      "pick_up_at": "2026-01-15T12:30:00Z",
      "items": [
        {
          "id": 1,
          "product_id": 1,
          "parent_id": 1,
          "description": "string",
          "note": "string",
          "price": {
            "value": 1,
            "currency": "string",
            "minor_units": 1,
            "formatted": "string"
          },
          "original_price": {
            "value": 1,
            "currency": "string",
            "minor_units": 1,
            "formatted": "string"
          },
          "discount_percentage": 9.99,
          "compensation": {
            "value": 1,
            "currency": "string",
            "minor_units": 1,
            "formatted": "string"
          },
          "compensation_reason_id": 1,
          "compensation_reason": "string",
          "compensation_note": "string",
          "tax_rate": {
            "id": 1,
            "name": "string",
            "percentage": 9.99,
            "kind": "string",
            "archived": true,
            "label": "string",
            "created_at": "2026-01-15T12:30:00Z",
            "updated_at": "2026-01-15T12:30:00Z"
          },
          "category_of_revenue": {
            "id": 1,
            "name": "string"
          },
          "cost_price": {
            "value": 1,
            "currency": "string",
            "minor_units": 1,
            "formatted": "string"
          },
          "unit_quantity": 1,
          "unit_name": "string",
          "course": 1,
          "preparation_state": "string",
          "representation_by": {
            "id": 1,
            "name": "string"
          },
          "own_use": true,
          "payment_status": "string",
          "refunded_item_id": 1,
          "voucher_card_id": 1,
          "kind": "sale",
          "voucher": {
            "id": 1,
            "name": "string"
          },
          "loyalty": {
            "id": 1,
            "name": "string"
          },
          "reservation": {
            "id": 1,
            "name": "string"
          },
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        }
      ],
      "submitted_at": "2026-01-15T12:30:00Z",
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/orders order:write

Creates an order and submits it for preparation. Provide exactly one of `receipt_id`, `card`, `customer_id`, `table_id`, `group_id` or `employee_id` to determine the receipt the order is placed on. With `receipt_id` the order is added to that receipt; with `card` it is added to the open receipt of the card holder; otherwise a new receipt is opened for the customer, table, group or employee. Each item either references a product by `product_id` or `plu`, inheriting its price, tax rate and preparation settings, or describes a free-form item with `description` and `price`. Items can carry nested sub-items, for example product options.

Request body

card string

Code of a card; the order is placed on the open receipt of its holder

customer_id integer

Unique identifier of the customer to place the order for

table_id integer

Unique identifier of the table to place the order on

group_id integer

Unique identifier of the group to place the order for

employee_id integer

Unique identifier of the employee to place the order for

receipt_id integer

Unique identifier of an open receipt to add the order to

note string

Note added to the receipt

pick_up_at datetime

Pick-up moment for a takeout order; makes the order a takeout

items array of object req

Items to order

product_id integer

Unique identifier of the product to order

plu string

PLU or barcode of the product to order

description string

Item description; defaults to the product name

note string

Note shown on the preparation receipt

price object

Unit price including VAT, for example `{ "value": 320, "currency": "EUR" }`; defaults to the product price

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

discount_percentage number

Discount percentage on a 0-100 scale for the item, for example 10.0; defaults to the product discount

no_discount boolean

Whether the item is excluded from receipt-wide discounts

tax_rate_id integer

Unique identifier of the tax rate; defaults to the product tax rate

product_category_ids array of integer

Unique identifiers of the product categories the item belongs to

category_of_revenue_id integer

Unique identifier of the category of revenue; defaults to the product category of revenue

preparation_location_id integer

Unique identifier of the preparation location the item is sent to

course integer

Course the item is served in; defaults to the product default course

unit_name string

Unit the item is sold in, for example kg

unit_quantity integer

Quantity in the given unit

unit_default_quantity integer

Default quantity in the given unit

items array of object

Nested sub-items, for example product options

{
  "table_id": 12,
  "items": [
    {
      "product_id": 101
    },
    {
      "product_id": 101
    },
    {
      "plu": "1001",
      "note": "No ice",
      "items": [
        {
          "product_id": 210
        }
      ]
    }
  ]
}

Responses

201 Order Create and submit an order
Response attributes
id integer

Unique identifier of the order.

receipt_id integer

Unique identifier of the receipt the order was placed on.

shop_id integer

Unique identifier of the shop the order was placed in; null for orders from the register or the API.

receiptable_type string

What the order was placed on: `table`, `customer`, `group` or `employee`.

receiptable_id integer

Unique identifier of the table, customer, group or employee the order was placed on.

pick_up_at datetime

Pick-up moment for takeout orders; null otherwise.

items array of object

Items that were ordered.

id integer

Unique identifier of the item.

product_id integer

Unique identifier of the ordered product; null for free-form items.

parent_id integer

Unique identifier of the item this item belongs to, for example a product option or a fee; null for top-level items.

description string

Description of the item as shown on the receipt.

note string

Note shown on the preparation receipt.

price Money

Unit price after discounts and compensation; this is what the guest pays.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

original_price Money

Unit price before discounts and compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

discount_percentage number

Discount percentage applied to the item, from a discount rule or the receipt discount; 0 without discount.

compensation Money

Amount taken off the item as compensation, for example for a cold dish; 0 without compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

compensation_reason_id integer

Unique identifier of the compensation reason; null without compensation.

compensation_reason string

Reason for the compensation, as set up in the back office; null without compensation.

compensation_note string

Note the employee added to the compensation.

tax_rate TaxRate

Tax rate applied to the item.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the item counts towards.

id integer

Unique identifier of the resource.

name string

Name of the resource.

cost_price Money

Cost price of the item.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

unit_quantity integer

Quantity sold of `unit_name`, for example 250 for 250 gram; null for items sold per piece.

unit_name string

Unit the item is sold per, for example `gram`; null for items sold per piece.

course integer

Course the item is served in, 0 for no course.

preparation_state string

Where the item is in preparation: `unrequested`, `requested`, `ready_to_prepare`, `preparing`, `prepared`, `ready_to_deliver` or `delivered`.

representation_by Reference

Employee the item was booked on as representation (on the house), if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

own_use boolean

Whether the item was booked as own use (consumed by staff or the business) instead of sold.

payment_status string

Payment status of the item: `open`, `pending` or `paid`.

refunded_item_id integer

On a return receipt: the item that was refunded; null otherwise.

voucher_card_id integer

Voucher card sold or topped up with the item (`GET /v1/voucher_cards/{id}`); null otherwise.

kind enum

`sale` for products and other items, `voucher` for a sold voucher card, `loyalty_topup` for balance topped up on a customer and `reservation_deposit` for a deposit paid on a reservation.

salevoucherloyalty_topupreservation_deposit

voucher Reference

Voucher sold with the item, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for top-up items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

created_at datetime

Time the item was added to the receipt.

updated_at datetime

Time the receipt item was last updated.

submitted_at datetime

Time the order was submitted for preparation; null while the order is still a cart.

created_at datetime

Time the order was created.

updated_at datetime

Time the order was last updated.

Example response
{
  "id": 1,
  "receipt_id": 1,
  "shop_id": 1,
  "receiptable_type": "string",
  "receiptable_id": 1,
  "pick_up_at": "2026-01-15T12:30:00Z",
  "items": [
    {
      "id": 1,
      "product_id": 1,
      "parent_id": 1,
      "description": "string",
      "note": "string",
      "price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "original_price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "discount_percentage": 9.99,
      "compensation": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "compensation_reason_id": 1,
      "compensation_reason": "string",
      "compensation_note": "string",
      "tax_rate": {
        "id": 1,
        "name": "string",
        "percentage": 9.99,
        "kind": "string",
        "archived": true,
        "label": "string",
        "created_at": "2026-01-15T12:30:00Z",
        "updated_at": "2026-01-15T12:30:00Z"
      },
      "category_of_revenue": {
        "id": 1,
        "name": "string"
      },
      "cost_price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "unit_quantity": 1,
      "unit_name": "string",
      "course": 1,
      "preparation_state": "string",
      "representation_by": {
        "id": 1,
        "name": "string"
      },
      "own_use": true,
      "payment_status": "string",
      "refunded_item_id": 1,
      "voucher_card_id": 1,
      "kind": "sale",
      "voucher": {
        "id": 1,
        "name": "string"
      },
      "loyalty": {
        "id": 1,
        "name": "string"
      },
      "reservation": {
        "id": 1,
        "name": "string"
      },
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "submitted_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
POST /v1/orders/submissions order:write

Submits an order and triggers all configured callbacks in the organization. With `receipt_id` the order is added to that receipt. Otherwise it stays on the receipt it already belongs to, or a new receipt is opened for it.

Request body

order_id integer req

Unique identifier of the order to submit

receipt_id integer

Unique identifier of an open receipt to add the order to

{
  "order_id": 812
}

Responses

201 Order Submit an order
Response attributes
id integer

Unique identifier of the order.

receipt_id integer

Unique identifier of the receipt the order was placed on.

shop_id integer

Unique identifier of the shop the order was placed in; null for orders from the register or the API.

receiptable_type string

What the order was placed on: `table`, `customer`, `group` or `employee`.

receiptable_id integer

Unique identifier of the table, customer, group or employee the order was placed on.

pick_up_at datetime

Pick-up moment for takeout orders; null otherwise.

items array of object

Items that were ordered.

id integer

Unique identifier of the item.

product_id integer

Unique identifier of the ordered product; null for free-form items.

parent_id integer

Unique identifier of the item this item belongs to, for example a product option or a fee; null for top-level items.

description string

Description of the item as shown on the receipt.

note string

Note shown on the preparation receipt.

price Money

Unit price after discounts and compensation; this is what the guest pays.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

original_price Money

Unit price before discounts and compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

discount_percentage number

Discount percentage applied to the item, from a discount rule or the receipt discount; 0 without discount.

compensation Money

Amount taken off the item as compensation, for example for a cold dish; 0 without compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

compensation_reason_id integer

Unique identifier of the compensation reason; null without compensation.

compensation_reason string

Reason for the compensation, as set up in the back office; null without compensation.

compensation_note string

Note the employee added to the compensation.

tax_rate TaxRate

Tax rate applied to the item.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the item counts towards.

id integer

Unique identifier of the resource.

name string

Name of the resource.

cost_price Money

Cost price of the item.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

unit_quantity integer

Quantity sold of `unit_name`, for example 250 for 250 gram; null for items sold per piece.

unit_name string

Unit the item is sold per, for example `gram`; null for items sold per piece.

course integer

Course the item is served in, 0 for no course.

preparation_state string

Where the item is in preparation: `unrequested`, `requested`, `ready_to_prepare`, `preparing`, `prepared`, `ready_to_deliver` or `delivered`.

representation_by Reference

Employee the item was booked on as representation (on the house), if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

own_use boolean

Whether the item was booked as own use (consumed by staff or the business) instead of sold.

payment_status string

Payment status of the item: `open`, `pending` or `paid`.

refunded_item_id integer

On a return receipt: the item that was refunded; null otherwise.

voucher_card_id integer

Voucher card sold or topped up with the item (`GET /v1/voucher_cards/{id}`); null otherwise.

kind enum

`sale` for products and other items, `voucher` for a sold voucher card, `loyalty_topup` for balance topped up on a customer and `reservation_deposit` for a deposit paid on a reservation.

salevoucherloyalty_topupreservation_deposit

voucher Reference

Voucher sold with the item, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for top-up items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

created_at datetime

Time the item was added to the receipt.

updated_at datetime

Time the receipt item was last updated.

submitted_at datetime

Time the order was submitted for preparation; null while the order is still a cart.

created_at datetime

Time the order was created.

updated_at datetime

Time the order was last updated.

Example response
{
  "id": 1,
  "receipt_id": 1,
  "shop_id": 1,
  "receiptable_type": "string",
  "receiptable_id": 1,
  "pick_up_at": "2026-01-15T12:30:00Z",
  "items": [
    {
      "id": 1,
      "product_id": 1,
      "parent_id": 1,
      "description": "string",
      "note": "string",
      "price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "original_price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "discount_percentage": 9.99,
      "compensation": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "compensation_reason_id": 1,
      "compensation_reason": "string",
      "compensation_note": "string",
      "tax_rate": {
        "id": 1,
        "name": "string",
        "percentage": 9.99,
        "kind": "string",
        "archived": true,
        "label": "string",
        "created_at": "2026-01-15T12:30:00Z",
        "updated_at": "2026-01-15T12:30:00Z"
      },
      "category_of_revenue": {
        "id": 1,
        "name": "string"
      },
      "cost_price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "unit_quantity": 1,
      "unit_name": "string",
      "course": 1,
      "preparation_state": "string",
      "representation_by": {
        "id": 1,
        "name": "string"
      },
      "own_use": true,
      "payment_status": "string",
      "refunded_item_id": 1,
      "voucher_card_id": 1,
      "kind": "sale",
      "voucher": {
        "id": 1,
        "name": "string"
      },
      "loyalty": {
        "id": 1,
        "name": "string"
      },
      "reservation": {
        "id": 1,
        "name": "string"
      },
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "submitted_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/orders/{id} order:read

Retrieve an order

Parameters

id path · integer req

Unique identifier of the order

Responses

200 Order Retrieve an order
Response attributes
id integer

Unique identifier of the order.

receipt_id integer

Unique identifier of the receipt the order was placed on.

shop_id integer

Unique identifier of the shop the order was placed in; null for orders from the register or the API.

receiptable_type string

What the order was placed on: `table`, `customer`, `group` or `employee`.

receiptable_id integer

Unique identifier of the table, customer, group or employee the order was placed on.

pick_up_at datetime

Pick-up moment for takeout orders; null otherwise.

items array of object

Items that were ordered.

id integer

Unique identifier of the item.

product_id integer

Unique identifier of the ordered product; null for free-form items.

parent_id integer

Unique identifier of the item this item belongs to, for example a product option or a fee; null for top-level items.

description string

Description of the item as shown on the receipt.

note string

Note shown on the preparation receipt.

price Money

Unit price after discounts and compensation; this is what the guest pays.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

original_price Money

Unit price before discounts and compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

discount_percentage number

Discount percentage applied to the item, from a discount rule or the receipt discount; 0 without discount.

compensation Money

Amount taken off the item as compensation, for example for a cold dish; 0 without compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

compensation_reason_id integer

Unique identifier of the compensation reason; null without compensation.

compensation_reason string

Reason for the compensation, as set up in the back office; null without compensation.

compensation_note string

Note the employee added to the compensation.

tax_rate TaxRate

Tax rate applied to the item.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the item counts towards.

id integer

Unique identifier of the resource.

name string

Name of the resource.

cost_price Money

Cost price of the item.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

unit_quantity integer

Quantity sold of `unit_name`, for example 250 for 250 gram; null for items sold per piece.

unit_name string

Unit the item is sold per, for example `gram`; null for items sold per piece.

course integer

Course the item is served in, 0 for no course.

preparation_state string

Where the item is in preparation: `unrequested`, `requested`, `ready_to_prepare`, `preparing`, `prepared`, `ready_to_deliver` or `delivered`.

representation_by Reference

Employee the item was booked on as representation (on the house), if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

own_use boolean

Whether the item was booked as own use (consumed by staff or the business) instead of sold.

payment_status string

Payment status of the item: `open`, `pending` or `paid`.

refunded_item_id integer

On a return receipt: the item that was refunded; null otherwise.

voucher_card_id integer

Voucher card sold or topped up with the item (`GET /v1/voucher_cards/{id}`); null otherwise.

kind enum

`sale` for products and other items, `voucher` for a sold voucher card, `loyalty_topup` for balance topped up on a customer and `reservation_deposit` for a deposit paid on a reservation.

salevoucherloyalty_topupreservation_deposit

voucher Reference

Voucher sold with the item, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for top-up items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

created_at datetime

Time the item was added to the receipt.

updated_at datetime

Time the receipt item was last updated.

submitted_at datetime

Time the order was submitted for preparation; null while the order is still a cart.

created_at datetime

Time the order was created.

updated_at datetime

Time the order was last updated.

Example response
{
  "id": 1,
  "receipt_id": 1,
  "shop_id": 1,
  "receiptable_type": "string",
  "receiptable_id": 1,
  "pick_up_at": "2026-01-15T12:30:00Z",
  "items": [
    {
      "id": 1,
      "product_id": 1,
      "parent_id": 1,
      "description": "string",
      "note": "string",
      "price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "original_price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "discount_percentage": 9.99,
      "compensation": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "compensation_reason_id": 1,
      "compensation_reason": "string",
      "compensation_note": "string",
      "tax_rate": {
        "id": 1,
        "name": "string",
        "percentage": 9.99,
        "kind": "string",
        "archived": true,
        "label": "string",
        "created_at": "2026-01-15T12:30:00Z",
        "updated_at": "2026-01-15T12:30:00Z"
      },
      "category_of_revenue": {
        "id": 1,
        "name": "string"
      },
      "cost_price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "unit_quantity": 1,
      "unit_name": "string",
      "course": 1,
      "preparation_state": "string",
      "representation_by": {
        "id": 1,
        "name": "string"
      },
      "own_use": true,
      "payment_status": "string",
      "refunded_item_id": 1,
      "voucher_card_id": 1,
      "kind": "sale",
      "voucher": {
        "id": 1,
        "name": "string"
      },
      "loyalty": {
        "id": 1,
        "name": "string"
      },
      "reservation": {
        "id": 1,
        "name": "string"
      },
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "submitted_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Organization

GET /v1/organization organization:read

Returns the organization this subscription is authorized for, including its business profile and contact details.

Responses

200 Organization Retrieve the organization
Response attributes
id integer

Unique identifier of the organization.

name string

Name of the organization.

display_name string

Trading name shown on receipts and customer-facing screens.

email string

Contact email address of the organization.

phone string

Contact phone number of the organization.

first_name string

First name of the contact person.

last_name string

Last name of the contact person.

coc string

Chamber of Commerce (KvK) registration number.

vat string

VAT identification number.

street string

Street of the business address.

building string

Name of the building of the business address.

building_number string

Building number of the business address.

postal_code string

Postal code of the business address.

city string

City of the business address.

country_code string

ISO 3166-1 alpha-2 country code of the business address.

latitude number

Latitude of the business address in decimal degrees.

longitude number

Longitude of the business address in decimal degrees.

locale string

Default locale of the organization, for example `nl` or `en`.

time_zone string

Time zone the organization works in, as a Rails time zone name, for example `Amsterdam`.

day_end_time string

Time of night the business day ends, HH:MM, for example `04:00` when sales after midnight count towards the previous day; null when the day ends at midnight.

domain string

Domain the organization's 20Tabs environment runs on, for example `bistro.20tabs.app`.

logo_url string

URL of the organization's logo; null without logo.

created_at datetime

Time the organization joined 20Tabs.

updated_at datetime

Time the organization was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "display_name": "string",
  "email": "string",
  "phone": "string",
  "first_name": "string",
  "last_name": "string",
  "coc": "string",
  "vat": "string",
  "street": "string",
  "building": "string",
  "building_number": "string",
  "postal_code": "string",
  "city": "string",
  "country_code": "string",
  "latitude": 9.99,
  "longitude": 9.99,
  "locale": "string",
  "time_zone": "string",
  "day_end_time": "string",
  "domain": "string",
  "logo_url": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Payments

GET /v1/payments payment:read

Returns the payments made between `from` and `to` (inclusive, at most 366 days), most recent first. Filter by payment method, receipt, customer or amount to track down a payment.

Parameters

from query · date

First day of the range; defaults to today

to query · date

Last day of the range; defaults to `from`

payment_method_id query · integer

Only payments with this payment method

receipt_id query · integer

Only payments on this receipt

customer_id query · integer

Only payments on receipts of this customer

amount_min[value] query · integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

amount_min[currency] query · enum req

ISO 4217 currency code

EUR

amount_min[minor_units] query · integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

amount_max[value] query · integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

amount_max[currency] query · enum req

ISO 4217 currency code

EUR

amount_max[minor_units] query · integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Payment List payments
Response attributes

The items on this page.

id integer

Unique identifier of the payment.

receipt_id integer

Unique identifier of the receipt the payment settles.

payment_method_id integer

Unique identifier of the payment method that was used.

voucher_card_id integer

Unique identifier of the voucher card the payment was made with; null for other payments.

category_of_revenue Reference

Category of revenue the payment counts towards, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

kind enum

`payment` for cash, card and other payment methods, `voucher` for a payment with a voucher card, `loyalty_balance` for a payment from a customer's balance and `reservation_deposit` for a paid deposit settled on the receipt.

paymentvoucherloyalty_balancereservation_deposit

voucher Reference

Voucher the payment was made with, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for balance payments.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit settlements.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount paid.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

created_at datetime

Time the payment was created.

updated_at datetime

Time the payment was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "receipt_id": 1,
      "payment_method_id": 1,
      "voucher_card_id": 1,
      "category_of_revenue": {
        "id": 1,
        "name": "string"
      },
      "kind": "payment",
      "voucher": {
        "id": 1,
        "name": "string"
      },
      "loyalty": {
        "id": 1,
        "name": "string"
      },
      "reservation": {
        "id": 1,
        "name": "string"
      },
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/payments payment:write

Records a payment on a receipt, for example after your app has processed a transaction through one of its registered payment methods. All pending items on the receipt are marked as paid.

Request body

receipt_id integer req

Unique identifier of the receipt the payment settles

amount object req

Amount paid, for example `{ "value": 1250, "currency": "EUR" }` for €12.50; negative for a refund

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

payment_method_id integer req

Unique identifier of the payment method that was used

metadata object

Additional provider-specific details to store alongside the payment

{
  "receipt_id": 1107,
  "amount": {
    "value": 1250,
    "currency": "EUR"
  },
  "payment_method_id": 6
}

Responses

201 Payment Create a payment
Response attributes
id integer

Unique identifier of the payment.

receipt_id integer

Unique identifier of the receipt the payment settles.

payment_method_id integer

Unique identifier of the payment method that was used.

voucher_card_id integer

Unique identifier of the voucher card the payment was made with; null for other payments.

category_of_revenue Reference

Category of revenue the payment counts towards, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

kind enum

`payment` for cash, card and other payment methods, `voucher` for a payment with a voucher card, `loyalty_balance` for a payment from a customer's balance and `reservation_deposit` for a paid deposit settled on the receipt.

paymentvoucherloyalty_balancereservation_deposit

voucher Reference

Voucher the payment was made with, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for balance payments.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit settlements.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount paid.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

created_at datetime

Time the payment was created.

updated_at datetime

Time the payment was last updated.

Example response
{
  "id": 1,
  "receipt_id": 1,
  "payment_method_id": 1,
  "voucher_card_id": 1,
  "category_of_revenue": {
    "id": 1,
    "name": "string"
  },
  "kind": "payment",
  "voucher": {
    "id": 1,
    "name": "string"
  },
  "loyalty": {
    "id": 1,
    "name": "string"
  },
  "reservation": {
    "id": 1,
    "name": "string"
  },
  "amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/payments/{id} payment:read

Retrieve a payment

Parameters

id path · integer req

Unique identifier of the payment

Responses

200 Payment Retrieve a payment
Response attributes
id integer

Unique identifier of the payment.

receipt_id integer

Unique identifier of the receipt the payment settles.

payment_method_id integer

Unique identifier of the payment method that was used.

voucher_card_id integer

Unique identifier of the voucher card the payment was made with; null for other payments.

category_of_revenue Reference

Category of revenue the payment counts towards, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

kind enum

`payment` for cash, card and other payment methods, `voucher` for a payment with a voucher card, `loyalty_balance` for a payment from a customer's balance and `reservation_deposit` for a paid deposit settled on the receipt.

paymentvoucherloyalty_balancereservation_deposit

voucher Reference

Voucher the payment was made with, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for balance payments.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit settlements.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount paid.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

created_at datetime

Time the payment was created.

updated_at datetime

Time the payment was last updated.

Example response
{
  "id": 1,
  "receipt_id": 1,
  "payment_method_id": 1,
  "voucher_card_id": 1,
  "category_of_revenue": {
    "id": 1,
    "name": "string"
  },
  "kind": "payment",
  "voucher": {
    "id": 1,
    "name": "string"
  },
  "loyalty": {
    "id": 1,
    "name": "string"
  },
  "reservation": {
    "id": 1,
    "name": "string"
  },
  "amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Payment methods

GET /v1/payment_methods payment_method:read

Returns the payment methods registered by your app. Set `all` to get every payment method of the organization, such as cash and card.

Parameters

all query · boolean

Every payment method of the organization, not only your app's

default false

include_archived query · boolean

Include archived payment methods

default false

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of PaymentMethod List payment methods
Response attributes

The items on this page.

id integer

Unique identifier of the payment method.

name string

Display name shown to users on the register.

kind enum

`external` for a method registered by an app, `internal` for one set up in the back office such as cash or card, `system` for vouchers, balance and deposits, `representation` or `own_use`.

representationown_useexternalsysteminternal

cash_register_id integer

Cash register that payments with this method go into; null when they don't touch a cash drawer.

online boolean

Whether the payment is processed online (`true`) or in store (`false`).

tap_to_pay boolean

Whether the payment method uses Tap to Pay.

operator_reference string

Reference that helps 20Tabs users identify the payment method in your system.

required_data object

Fields the user must fill in when paying with this method.

archived boolean

Whether the payment method is archived.

created_at datetime

Time the payment method was registered.

updated_at datetime

Time the payment method was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "kind": "representation",
      "cash_register_id": 1,
      "online": true,
      "tap_to_pay": true,
      "operator_reference": "string",
      "required_data": {},
      "archived": true,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/payment_methods payment_method:write

Registers a payment method that becomes available on the organization's registers. When a user pays with it, 20Tabs calls your app's webhook with the `receipt_id` and `payment_method_id`; your app processes the transaction and records the result by creating a payment.

Request body

name string req

Display name shown to users on the register

online boolean req

Whether the payment is processed online (`true`) or in store (`false`)

tap_to_pay boolean

Whether the payment method uses Tap to Pay

operator_reference string

Reference that helps 20Tabs users identify the payment method in your system

required_data array of string

Fields the user must fill in when paying with this method, for example the barcode and pincode of a voucher. The collected values are sent to your payment webhook. Example: [{ name: 'card_number', type: 'string', translated_name: { nl: 'Kaartnummer', en: 'Card number' } }]

{
  "name": "Pin terminal bar",
  "online": false
}

Responses

201 PaymentMethod Register a payment method
Response attributes
id integer

Unique identifier of the payment method.

name string

Display name shown to users on the register.

kind enum

`external` for a method registered by an app, `internal` for one set up in the back office such as cash or card, `system` for vouchers, balance and deposits, `representation` or `own_use`.

representationown_useexternalsysteminternal

cash_register_id integer

Cash register that payments with this method go into; null when they don't touch a cash drawer.

online boolean

Whether the payment is processed online (`true`) or in store (`false`).

tap_to_pay boolean

Whether the payment method uses Tap to Pay.

operator_reference string

Reference that helps 20Tabs users identify the payment method in your system.

required_data object

Fields the user must fill in when paying with this method.

archived boolean

Whether the payment method is archived.

created_at datetime

Time the payment method was registered.

updated_at datetime

Time the payment method was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "kind": "representation",
  "cash_register_id": 1,
  "online": true,
  "tap_to_pay": true,
  "operator_reference": "string",
  "required_data": {},
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/payment_methods/{id} payment_method:read

Returns any payment method of the organization, also the ones not registered by your app.

Parameters

id path · integer req

Unique identifier of the payment method

Responses

200 PaymentMethod Retrieve a payment method
Response attributes
id integer

Unique identifier of the payment method.

name string

Display name shown to users on the register.

kind enum

`external` for a method registered by an app, `internal` for one set up in the back office such as cash or card, `system` for vouchers, balance and deposits, `representation` or `own_use`.

representationown_useexternalsysteminternal

cash_register_id integer

Cash register that payments with this method go into; null when they don't touch a cash drawer.

online boolean

Whether the payment is processed online (`true`) or in store (`false`).

tap_to_pay boolean

Whether the payment method uses Tap to Pay.

operator_reference string

Reference that helps 20Tabs users identify the payment method in your system.

required_data object

Fields the user must fill in when paying with this method.

archived boolean

Whether the payment method is archived.

created_at datetime

Time the payment method was registered.

updated_at datetime

Time the payment method was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "kind": "representation",
  "cash_register_id": 1,
  "online": true,
  "tap_to_pay": true,
  "operator_reference": "string",
  "required_data": {},
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/payment_methods/{id} payment_method:write

Updates a payment method registered by your app.

Parameters

id path · integer req

Unique identifier of the payment method

Request body

name string

Display name shown to users on the register

{
  "name": "Pin terminal terrace"
}

Responses

200 PaymentMethod Update a payment method
Response attributes
id integer

Unique identifier of the payment method.

name string

Display name shown to users on the register.

kind enum

`external` for a method registered by an app, `internal` for one set up in the back office such as cash or card, `system` for vouchers, balance and deposits, `representation` or `own_use`.

representationown_useexternalsysteminternal

cash_register_id integer

Cash register that payments with this method go into; null when they don't touch a cash drawer.

online boolean

Whether the payment is processed online (`true`) or in store (`false`).

tap_to_pay boolean

Whether the payment method uses Tap to Pay.

operator_reference string

Reference that helps 20Tabs users identify the payment method in your system.

required_data object

Fields the user must fill in when paying with this method.

archived boolean

Whether the payment method is archived.

created_at datetime

Time the payment method was registered.

updated_at datetime

Time the payment method was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "kind": "representation",
  "cash_register_id": 1,
  "online": true,
  "tap_to_pay": true,
  "operator_reference": "string",
  "required_data": {},
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/payment_methods/{id} payment_method:write

Archives a payment method registered by your app, removing it from the organization's registers. Existing payments keep referring to it.

Parameters

id path · integer req

Unique identifier of the payment method

Responses

204 Archive a payment method

Preparation locations

GET /v1/preparation_locations preparation:read

Returns the places where items are prepared, such as the kitchen or bar, sorted by name. Products are routed to a location with their `preparation_location_id`.

Parameters

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of PreparationLocation List preparation locations
Response attributes

The items on this page.

id integer
name string
preparation_states string

Subset of canonical states this location tracks.

print_preparation_states string

States whose transitions trigger printing at this location.

print_movings boolean

Whether a slip is printed when items are moved between receipts.

created_at datetime

Time the preparation location was created.

updated_at datetime

Time the preparation location was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "preparation_states": "string",
      "print_preparation_states": "string",
      "print_movings": true,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/preparation_locations preparation:write

Adds a location, for example `{ "name": "Bar" }`.

Request body

name string req

Name of the location, for example `Kitchen` or `Bar`

preparation_states array of enum

States items go through at this location; must include `unrequested`, `requested` and `delivered`. Defaults to the standard kitchen flow

unrequestedrequestedready_to_preparepreparingpreparedready_to_deliverdelivered

print_preparation_states array of enum

States in which a slip is printed for this location

unrequestedrequestedready_to_preparepreparingpreparedready_to_deliverdelivered

print_movings boolean

Print a slip when items are moved to another receipt

{
  "name": "Bar"
}

Responses

201 PreparationLocation Create a preparation location
Response attributes
id integer
name string
preparation_states string

Subset of canonical states this location tracks.

print_preparation_states string

States whose transitions trigger printing at this location.

print_movings boolean

Whether a slip is printed when items are moved between receipts.

created_at datetime

Time the preparation location was created.

updated_at datetime

Time the preparation location was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "preparation_states": "string",
  "print_preparation_states": "string",
  "print_movings": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/preparation_locations/{id} preparation:read

Retrieve a preparation location

Parameters

id path · integer req

Unique identifier of the preparation location

Responses

200 PreparationLocation Retrieve a preparation location
Response attributes
id integer
name string
preparation_states string

Subset of canonical states this location tracks.

print_preparation_states string

States whose transitions trigger printing at this location.

print_movings boolean

Whether a slip is printed when items are moved between receipts.

created_at datetime

Time the preparation location was created.

updated_at datetime

Time the preparation location was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "preparation_states": "string",
  "print_preparation_states": "string",
  "print_movings": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/preparation_locations/{id} preparation:write

Updates the given attributes; attributes that are not included keep their current value.

Parameters

id path · integer req

Unique identifier of the preparation location

Request body

name string

Name of the location, for example `Kitchen` or `Bar`

preparation_states array of enum

States items go through at this location; must include `unrequested`, `requested` and `delivered`. Defaults to the standard kitchen flow

unrequestedrequestedready_to_preparepreparingpreparedready_to_deliverdelivered

print_preparation_states array of enum

States in which a slip is printed for this location

unrequestedrequestedready_to_preparepreparingpreparedready_to_deliverdelivered

print_movings boolean

Print a slip when items are moved to another receipt

{
  "print_preparation_states": [
    "requested"
  ]
}

Responses

200 PreparationLocation Update a preparation location
Response attributes
id integer
name string
preparation_states string

Subset of canonical states this location tracks.

print_preparation_states string

States whose transitions trigger printing at this location.

print_movings boolean

Whether a slip is printed when items are moved between receipts.

created_at datetime

Time the preparation location was created.

updated_at datetime

Time the preparation location was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "preparation_states": "string",
  "print_preparation_states": "string",
  "print_movings": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/preparation_locations/{id} preparation:write

Deletes the location. Refused while products are routed to it or devices prepare or print for it.

Parameters

id path · integer req

Unique identifier of the preparation location

Responses

204 Delete a preparation location

Preparation states

GET /v1/preparation_states preparation:read

Returns the organization's labels and colors for each step items go through, from `unrequested` to `delivered`. The steps themselves are fixed; a preparation location picks which of them it uses.

Parameters

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of PreparationState List preparation states
Response attributes

The items on this page.

id integer
state string

Canonical state key: unrequested, requested, ready_to_prepare, preparing, prepared, ready_to_deliver, or delivered.

label string

Display label shown on kitchen displays.

next_state_button_label string

Label on the button that advances to the next state.

color string

Tailwind color name (e.g. amber, fuchsia, blue, green).

show_in_summary boolean

Whether items in this state appear in the receipt summary.

created_at datetime

Time the preparation state was created.

updated_at datetime

Time the preparation state was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "state": "string",
      "label": "string",
      "next_state_button_label": "string",
      "color": "string",
      "show_in_summary": true,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
PATCH /v1/preparation_states/{id} preparation:write

Updates how the state is shown on preparation displays; attributes that are not included keep their current value.

Parameters

id path · integer req

Unique identifier of the preparation state

Request body

label string

Name shown on preparation displays

next_state_button_label string

Text on the button that moves items to the next state; required for every state but the last

color string

Color name, for example `amber`, `blue` or `green`; null for none

show_in_summary boolean

Show items in this state in the receipt summary

{
  "label": "In the pan",
  "color": "amber"
}

Responses

200 PreparationState Update a preparation state
Response attributes
id integer
state string

Canonical state key: unrequested, requested, ready_to_prepare, preparing, prepared, ready_to_deliver, or delivered.

label string

Display label shown on kitchen displays.

next_state_button_label string

Label on the button that advances to the next state.

color string

Tailwind color name (e.g. amber, fuchsia, blue, green).

show_in_summary boolean

Whether items in this state appear in the receipt summary.

created_at datetime

Time the preparation state was created.

updated_at datetime

Time the preparation state was last updated.

Example response
{
  "id": 1,
  "state": "string",
  "label": "string",
  "next_state_button_label": "string",
  "color": "string",
  "show_in_summary": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Products

GET /v1/products product:read

Returns the products in the organization's catalog, ordered by name. Search with `query` or filter by product category or category of revenue. Archived products are left out unless `include_archived` is true.

Parameters

query query · string

Only products whose name contains this text or whose PLU is exactly this text

product_category_id query · integer

Only products in this product category

category_of_revenue_id query · integer

Only products in this category of revenue

include_archived query · boolean

Include archived products

default false

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Product List products
Response attributes

The items on this page.

id integer

Unique identifier of the product.

name string

Name of the product.

description string

Description shown to guests in shops and on the kiosk.

plu string

PLU or barcode identifying the product.

price Money

Selling price including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

cost_price Money

Purchase price excluding VAT; null when unknown.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate_id integer

Unique identifier of the tax rate applied to the product.

category_of_revenue_id integer

Unique identifier of the category of revenue the product belongs to.

product_category_ids array of integer

Product categories the product is assigned to.

default_course integer

Course the product is served in by default (0 for no course).

preparation_location_id integer

Unique identifier of the preparation location the product is prepared at, for example the kitchen; null when it needs no preparation.

no_discount boolean

Whether discounts are never applied to the product.

unit_name string

Unit the product is sold per, for example `gram`; null when sold per piece.

unit_default_quantity integer

Quantity of `unit_name` the price applies to, for example 100 for a price per 100 gram.

sold_out boolean

Whether the product is sold out right now.

sold_out_remaining integer

How many can still be sold until `sold_out_until`; null when the stock isn't counted.

sold_out_until datetime

Until when `sold_out_remaining` counts; null when the stock isn't counted.

allergen_ids array of integer

Allergens the product contains (`GET /v1/allergens`).

marker_ids array of integer

Markers shown on the product and copied to receipts it is ordered on (`GET /v1/markers`).

fee_ids array of integer

Fees added to a receipt with each product, for example a bottle deposit (`GET /v1/fees`).

sale_times array of object

Weekly periods the product can be sold in; empty when it can always be sold.

weekdays array of integer

Weekdays the product is sold on, 0 is Sunday.

from_time string

Time of day sales start, HH:MM.

till_time string

Time of day sales end, HH:MM. A time before `from_time` ends the next day.

image_url string

URL of the product image; null without image.

archived boolean

Whether the product is archived and no longer sold.

created_at datetime

Time the product was created.

updated_at datetime

Time the product was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "description": "string",
      "plu": "string",
      "price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "cost_price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "tax_rate_id": 1,
      "category_of_revenue_id": 1,
      "product_category_ids": [
        1
      ],
      "default_course": 1,
      "preparation_location_id": 1,
      "no_discount": true,
      "unit_name": "string",
      "unit_default_quantity": 1,
      "sold_out": true,
      "sold_out_remaining": 1,
      "sold_out_until": "2026-01-15T12:30:00Z",
      "allergen_ids": [
        1
      ],
      "marker_ids": [
        1
      ],
      "fee_ids": [
        1
      ],
      "sale_times": [
        {
          "weekdays": [
            1
          ],
          "from_time": "string",
          "till_time": "string"
        }
      ],
      "image_url": "string",
      "archived": true,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/products product:write

Creates a product owned by your app, for example `{ "name": "Cappuccino", "plu": "1001", "price": { "value": 320, "currency": "EUR" }, "tax_rate_id": 1, "category_of_revenue_id": 2, "allergen_ids": [7] }`. If a product with the given PLU already exists, no product is created; the existing product is returned with a `303 See Other` status and a `Location` header pointing to it.

Request body

plu string req

PLU or barcode identifying the product; unique within the organization

name string req

Name of the product, for example `Cappuccino`

price object req

Selling price including VAT, for example `{ "value": 320, "currency": "EUR" }` for €3.20

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

tax_rate_id integer req

Tax rate to apply (`GET /v1/tax_rates`)

category_of_revenue_id integer req

Category of revenue the product is booked on (`GET /v1/categories_of_revenue`)

description string

Description shown to guests in shops and on the kiosk

cost_price object

Purchase price excluding VAT; null to clear

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

default_course integer

Course the product is served in by default (0 for no course)

no_discount boolean

Never apply discounts to the product

preparation_location_id integer

Preparation location the product is prepared at, for example the kitchen; null when it needs no preparation

product_category_ids array of integer

Product categories of the product (`GET /v1/product_categories`). The list replaces the current categories, so `[]` removes them all

allergen_ids array of integer

Allergens the product contains (`GET /v1/allergens`). The list replaces the current allergens, so `[]` removes them all

marker_ids array of integer

Markers shown on the product (`GET /v1/markers`). The list replaces the current markers, so `[]` removes them all

fee_ids array of integer

Fees charged with the product, for example a bottle deposit (`GET /v1/fees`). The list replaces the current fees, so `[]` removes them all

unit_name string

Sell per unit instead of per piece, for example `gram`; null to sell per piece

unit_default_quantity integer

Quantity of `unit_name` the price applies to, for example `100` for a price per 100 gram; required with `unit_name`

sold_out_remaining integer

How many can still be sold today; `0` marks the product sold out until the end of the day, null stops counting

sold_out_until datetime

Until when `sold_out_remaining` counts; defaults to the end of today

sale_times array of object

Weekly periods the product can be sold in, for example only lunch on weekdays. The list replaces the current periods, so `[]` makes the product always available

weekdays array of integer req

Weekdays, 0 is Sunday and 6 is Saturday

from_time string req

Time sales start, HH:MM

till_time string req

Time sales end, HH:MM; a time before `from_time` ends the next day

{
  "name": "Cappuccino",
  "plu": "1001",
  "price": {
    "value": 320,
    "currency": "EUR"
  },
  "tax_rate_id": 1,
  "category_of_revenue_id": 2,
  "allergen_ids": [
    7
  ]
}

Responses

201 Product Create a product
Response attributes
id integer

Unique identifier of the product.

name string

Name of the product.

description string

Description shown to guests in shops and on the kiosk.

plu string

PLU or barcode identifying the product.

price Money

Selling price including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

cost_price Money

Purchase price excluding VAT; null when unknown.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate_id integer

Unique identifier of the tax rate applied to the product.

category_of_revenue_id integer

Unique identifier of the category of revenue the product belongs to.

product_category_ids array of integer

Product categories the product is assigned to.

default_course integer

Course the product is served in by default (0 for no course).

preparation_location_id integer

Unique identifier of the preparation location the product is prepared at, for example the kitchen; null when it needs no preparation.

no_discount boolean

Whether discounts are never applied to the product.

unit_name string

Unit the product is sold per, for example `gram`; null when sold per piece.

unit_default_quantity integer

Quantity of `unit_name` the price applies to, for example 100 for a price per 100 gram.

sold_out boolean

Whether the product is sold out right now.

sold_out_remaining integer

How many can still be sold until `sold_out_until`; null when the stock isn't counted.

sold_out_until datetime

Until when `sold_out_remaining` counts; null when the stock isn't counted.

allergen_ids array of integer

Allergens the product contains (`GET /v1/allergens`).

marker_ids array of integer

Markers shown on the product and copied to receipts it is ordered on (`GET /v1/markers`).

fee_ids array of integer

Fees added to a receipt with each product, for example a bottle deposit (`GET /v1/fees`).

sale_times array of object

Weekly periods the product can be sold in; empty when it can always be sold.

weekdays array of integer

Weekdays the product is sold on, 0 is Sunday.

from_time string

Time of day sales start, HH:MM.

till_time string

Time of day sales end, HH:MM. A time before `from_time` ends the next day.

image_url string

URL of the product image; null without image.

archived boolean

Whether the product is archived and no longer sold.

created_at datetime

Time the product was created.

updated_at datetime

Time the product was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "description": "string",
  "plu": "string",
  "price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "cost_price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "tax_rate_id": 1,
  "category_of_revenue_id": 1,
  "product_category_ids": [
    1
  ],
  "default_course": 1,
  "preparation_location_id": 1,
  "no_discount": true,
  "unit_name": "string",
  "unit_default_quantity": 1,
  "sold_out": true,
  "sold_out_remaining": 1,
  "sold_out_until": "2026-01-15T12:30:00Z",
  "allergen_ids": [
    1
  ],
  "marker_ids": [
    1
  ],
  "fee_ids": [
    1
  ],
  "sale_times": [
    {
      "weekdays": [
        1
      ],
      "from_time": "string",
      "till_time": "string"
    }
  ],
  "image_url": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/products/find product:read

Looks up a single product by its PLU or barcode.

Parameters

plu query · string req

PLU or barcode of the product

Responses

200 Product Find a product by PLU
Response attributes
id integer

Unique identifier of the product.

name string

Name of the product.

description string

Description shown to guests in shops and on the kiosk.

plu string

PLU or barcode identifying the product.

price Money

Selling price including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

cost_price Money

Purchase price excluding VAT; null when unknown.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate_id integer

Unique identifier of the tax rate applied to the product.

category_of_revenue_id integer

Unique identifier of the category of revenue the product belongs to.

product_category_ids array of integer

Product categories the product is assigned to.

default_course integer

Course the product is served in by default (0 for no course).

preparation_location_id integer

Unique identifier of the preparation location the product is prepared at, for example the kitchen; null when it needs no preparation.

no_discount boolean

Whether discounts are never applied to the product.

unit_name string

Unit the product is sold per, for example `gram`; null when sold per piece.

unit_default_quantity integer

Quantity of `unit_name` the price applies to, for example 100 for a price per 100 gram.

sold_out boolean

Whether the product is sold out right now.

sold_out_remaining integer

How many can still be sold until `sold_out_until`; null when the stock isn't counted.

sold_out_until datetime

Until when `sold_out_remaining` counts; null when the stock isn't counted.

allergen_ids array of integer

Allergens the product contains (`GET /v1/allergens`).

marker_ids array of integer

Markers shown on the product and copied to receipts it is ordered on (`GET /v1/markers`).

fee_ids array of integer

Fees added to a receipt with each product, for example a bottle deposit (`GET /v1/fees`).

sale_times array of object

Weekly periods the product can be sold in; empty when it can always be sold.

weekdays array of integer

Weekdays the product is sold on, 0 is Sunday.

from_time string

Time of day sales start, HH:MM.

till_time string

Time of day sales end, HH:MM. A time before `from_time` ends the next day.

image_url string

URL of the product image; null without image.

archived boolean

Whether the product is archived and no longer sold.

created_at datetime

Time the product was created.

updated_at datetime

Time the product was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "description": "string",
  "plu": "string",
  "price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "cost_price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "tax_rate_id": 1,
  "category_of_revenue_id": 1,
  "product_category_ids": [
    1
  ],
  "default_course": 1,
  "preparation_location_id": 1,
  "no_discount": true,
  "unit_name": "string",
  "unit_default_quantity": 1,
  "sold_out": true,
  "sold_out_remaining": 1,
  "sold_out_until": "2026-01-15T12:30:00Z",
  "allergen_ids": [
    1
  ],
  "marker_ids": [
    1
  ],
  "fee_ids": [
    1
  ],
  "sale_times": [
    {
      "weekdays": [
        1
      ],
      "from_time": "string",
      "till_time": "string"
    }
  ],
  "image_url": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/products/{id} product:read

Retrieve a product

Parameters

id path · integer req

Unique identifier of the product

Responses

200 Product Retrieve a product
Response attributes
id integer

Unique identifier of the product.

name string

Name of the product.

description string

Description shown to guests in shops and on the kiosk.

plu string

PLU or barcode identifying the product.

price Money

Selling price including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

cost_price Money

Purchase price excluding VAT; null when unknown.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate_id integer

Unique identifier of the tax rate applied to the product.

category_of_revenue_id integer

Unique identifier of the category of revenue the product belongs to.

product_category_ids array of integer

Product categories the product is assigned to.

default_course integer

Course the product is served in by default (0 for no course).

preparation_location_id integer

Unique identifier of the preparation location the product is prepared at, for example the kitchen; null when it needs no preparation.

no_discount boolean

Whether discounts are never applied to the product.

unit_name string

Unit the product is sold per, for example `gram`; null when sold per piece.

unit_default_quantity integer

Quantity of `unit_name` the price applies to, for example 100 for a price per 100 gram.

sold_out boolean

Whether the product is sold out right now.

sold_out_remaining integer

How many can still be sold until `sold_out_until`; null when the stock isn't counted.

sold_out_until datetime

Until when `sold_out_remaining` counts; null when the stock isn't counted.

allergen_ids array of integer

Allergens the product contains (`GET /v1/allergens`).

marker_ids array of integer

Markers shown on the product and copied to receipts it is ordered on (`GET /v1/markers`).

fee_ids array of integer

Fees added to a receipt with each product, for example a bottle deposit (`GET /v1/fees`).

sale_times array of object

Weekly periods the product can be sold in; empty when it can always be sold.

weekdays array of integer

Weekdays the product is sold on, 0 is Sunday.

from_time string

Time of day sales start, HH:MM.

till_time string

Time of day sales end, HH:MM. A time before `from_time` ends the next day.

image_url string

URL of the product image; null without image.

archived boolean

Whether the product is archived and no longer sold.

created_at datetime

Time the product was created.

updated_at datetime

Time the product was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "description": "string",
  "plu": "string",
  "price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "cost_price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "tax_rate_id": 1,
  "category_of_revenue_id": 1,
  "product_category_ids": [
    1
  ],
  "default_course": 1,
  "preparation_location_id": 1,
  "no_discount": true,
  "unit_name": "string",
  "unit_default_quantity": 1,
  "sold_out": true,
  "sold_out_remaining": 1,
  "sold_out_until": "2026-01-15T12:30:00Z",
  "allergen_ids": [
    1
  ],
  "marker_ids": [
    1
  ],
  "fee_ids": [
    1
  ],
  "sale_times": [
    {
      "weekdays": [
        1
      ],
      "from_time": "string",
      "till_time": "string"
    }
  ],
  "image_url": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/products/{id} product:write

Updates the given attributes; attributes that are not included keep their current value. Lists such as `allergen_ids` replace the current assignment, so `{ "allergen_ids": [] }` removes all allergens. Send `archived: false` to restore an archived product.

Parameters

id path · integer req

Unique identifier of the product

Request body

plu string

PLU or barcode identifying the product; unique within the organization

name string

Name of the product, for example `Cappuccino`

price object

Selling price including VAT, for example `{ "value": 320, "currency": "EUR" }` for €3.20

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

tax_rate_id integer

Tax rate to apply (`GET /v1/tax_rates`)

category_of_revenue_id integer

Category of revenue the product is booked on (`GET /v1/categories_of_revenue`)

description string

Description shown to guests in shops and on the kiosk

cost_price object

Purchase price excluding VAT; null to clear

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

default_course integer

Course the product is served in by default (0 for no course)

no_discount boolean

Never apply discounts to the product

preparation_location_id integer

Preparation location the product is prepared at, for example the kitchen; null when it needs no preparation

product_category_ids array of integer

Product categories of the product (`GET /v1/product_categories`). The list replaces the current categories, so `[]` removes them all

allergen_ids array of integer

Allergens the product contains (`GET /v1/allergens`). The list replaces the current allergens, so `[]` removes them all

marker_ids array of integer

Markers shown on the product (`GET /v1/markers`). The list replaces the current markers, so `[]` removes them all

fee_ids array of integer

Fees charged with the product, for example a bottle deposit (`GET /v1/fees`). The list replaces the current fees, so `[]` removes them all

unit_name string

Sell per unit instead of per piece, for example `gram`; null to sell per piece

unit_default_quantity integer

Quantity of `unit_name` the price applies to, for example `100` for a price per 100 gram; required with `unit_name`

sold_out_remaining integer

How many can still be sold today; `0` marks the product sold out until the end of the day, null stops counting

sold_out_until datetime

Until when `sold_out_remaining` counts; defaults to the end of today

sale_times array of object

Weekly periods the product can be sold in, for example only lunch on weekdays. The list replaces the current periods, so `[]` makes the product always available

weekdays array of integer req

Weekdays, 0 is Sunday and 6 is Saturday

from_time string req

Time sales start, HH:MM

till_time string req

Time sales end, HH:MM; a time before `from_time` ends the next day

archived boolean

Archive (true) or restore (false) the product

{
  "allergen_ids": []
}

Responses

200 Product Update a product
Response attributes
id integer

Unique identifier of the product.

name string

Name of the product.

description string

Description shown to guests in shops and on the kiosk.

plu string

PLU or barcode identifying the product.

price Money

Selling price including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

cost_price Money

Purchase price excluding VAT; null when unknown.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate_id integer

Unique identifier of the tax rate applied to the product.

category_of_revenue_id integer

Unique identifier of the category of revenue the product belongs to.

product_category_ids array of integer

Product categories the product is assigned to.

default_course integer

Course the product is served in by default (0 for no course).

preparation_location_id integer

Unique identifier of the preparation location the product is prepared at, for example the kitchen; null when it needs no preparation.

no_discount boolean

Whether discounts are never applied to the product.

unit_name string

Unit the product is sold per, for example `gram`; null when sold per piece.

unit_default_quantity integer

Quantity of `unit_name` the price applies to, for example 100 for a price per 100 gram.

sold_out boolean

Whether the product is sold out right now.

sold_out_remaining integer

How many can still be sold until `sold_out_until`; null when the stock isn't counted.

sold_out_until datetime

Until when `sold_out_remaining` counts; null when the stock isn't counted.

allergen_ids array of integer

Allergens the product contains (`GET /v1/allergens`).

marker_ids array of integer

Markers shown on the product and copied to receipts it is ordered on (`GET /v1/markers`).

fee_ids array of integer

Fees added to a receipt with each product, for example a bottle deposit (`GET /v1/fees`).

sale_times array of object

Weekly periods the product can be sold in; empty when it can always be sold.

weekdays array of integer

Weekdays the product is sold on, 0 is Sunday.

from_time string

Time of day sales start, HH:MM.

till_time string

Time of day sales end, HH:MM. A time before `from_time` ends the next day.

image_url string

URL of the product image; null without image.

archived boolean

Whether the product is archived and no longer sold.

created_at datetime

Time the product was created.

updated_at datetime

Time the product was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "description": "string",
  "plu": "string",
  "price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "cost_price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "tax_rate_id": 1,
  "category_of_revenue_id": 1,
  "product_category_ids": [
    1
  ],
  "default_course": 1,
  "preparation_location_id": 1,
  "no_discount": true,
  "unit_name": "string",
  "unit_default_quantity": 1,
  "sold_out": true,
  "sold_out_remaining": 1,
  "sold_out_until": "2026-01-15T12:30:00Z",
  "allergen_ids": [
    1
  ],
  "marker_ids": [
    1
  ],
  "fee_ids": [
    1
  ],
  "sale_times": [
    {
      "weekdays": [
        1
      ],
      "from_time": "string",
      "till_time": "string"
    }
  ],
  "image_url": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/products/{id} product:write

Removes the product from the catalog, menus and shops. Sales history is kept; restore it with `PATCH` and `archived: false`.

Parameters

id path · integer req

Unique identifier of the product

Responses

204 Archive a product
GET /v1/products/{id}/option_groups product:read

Returns the option groups attached to the product, in the order the register shows them.

Parameters

id path · integer req

Unique identifier of the product

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of ProductsOptionGroup List a product's option groups
Response attributes

The items on this page.

id integer
product_id integer
product_option_group_id integer
position integer

Display order of this group on the product.

created_at datetime

Time the attachment was created.

updated_at datetime

Time the attachment was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "product_id": 1,
      "product_option_group_id": 1,
      "position": 1,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/products/{id}/option_groups product:write

Attaches the group to the product at the end, for example `{ "product_option_group_id": 3 }`. Attaching a group that is already attached returns the existing attachment.

Parameters

id path · integer req

Unique identifier of the product

Request body

product_option_group_id integer req

Unique identifier of the option group

{
  "product_option_group_id": 3
}

Responses

201 ProductsOptionGroup Attach an option group
Response attributes
id integer
product_id integer
product_option_group_id integer
position integer

Display order of this group on the product.

created_at datetime

Time the attachment was created.

updated_at datetime

Time the attachment was last updated.

Example response
{
  "id": 1,
  "product_id": 1,
  "product_option_group_id": 1,
  "position": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/products/{id}/option_groups/{product_option_group_id} product:write

Move an option group

Parameters

id path · integer req

Unique identifier of the product

product_option_group_id path · integer req

Unique identifier of the option group

Request body

position integer req

1-based position on the product; other groups shift to make room

{
  "position": 1
}

Responses

200 ProductsOptionGroup Move an option group
Response attributes
id integer
product_id integer
product_option_group_id integer
position integer

Display order of this group on the product.

created_at datetime

Time the attachment was created.

updated_at datetime

Time the attachment was last updated.

Example response
{
  "id": 1,
  "product_id": 1,
  "product_option_group_id": 1,
  "position": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/products/{id}/option_groups/{product_option_group_id} product:write

Detaches the group from the product; the group itself remains.

Parameters

id path · integer req

Unique identifier of the product

product_option_group_id path · integer req

Unique identifier of the option group

Responses

204 Detach an option group

Product categories

GET /v1/product_categories product:read

Returns the categories that group products for filtering, discount rules and reports, sorted by name. Assign them to products with `product_category_ids`.

Parameters

query query · string

Only categories whose name contains this text

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of ProductCategory List product categories
Response attributes

The items on this page.

id integer

Unique identifier of the product category.

name string

Name of the product category.

created_at datetime

Time the product category was created.

updated_at datetime

Time the product category was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/product_categories product:write

Adds a category, for example `{ "name": "Beers" }`.

Request body

name string req

Name of the category

{
  "name": "Beers"
}

Responses

201 ProductCategory Create a product category
Response attributes
id integer

Unique identifier of the product category.

name string

Name of the product category.

created_at datetime

Time the product category was created.

updated_at datetime

Time the product category was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/product_categories/{id} product:read

Retrieve a product category

Parameters

id path · integer req

Unique identifier of the product category

Responses

200 ProductCategory Retrieve a product category
Response attributes
id integer

Unique identifier of the product category.

name string

Name of the product category.

created_at datetime

Time the product category was created.

updated_at datetime

Time the product category was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/product_categories/{id} product:write

Updates the given attributes; attributes that are not included keep their current value.

Parameters

id path · integer req

Unique identifier of the product category

Request body

name string

Name of the category

{
  "name": "Special beers"
}

Responses

200 ProductCategory Update a product category
Response attributes
id integer

Unique identifier of the product category.

name string

Name of the product category.

created_at datetime

Time the product category was created.

updated_at datetime

Time the product category was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Product options

GET /v1/product_options product:read

Returns the options of a group in display order.

Parameters

product_option_group_id query · integer req

Group whose options to list

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of ProductOption List product options
Response attributes

The items on this page.

id integer
kind string

Option type: custom (free-form name and price) or product (backed by an existing product).

name string
description string
price Money

Price of the option. Null for product-backed options that inherit the product price.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate_id integer

Tax rate of a custom option; null for product-backed options.

category_of_revenue_id integer

Category of revenue of a custom option; null for product-backed options.

product_id integer

Backing product sequence. Only set for kind=product.

max_choices integer

Maximum number of times this option can be selected. Null means no limit of its own, so only the group total and the stock apply.

no_discount boolean

Whether discounts are excluded from this option.

position integer

Display order within the group.

created_at datetime

Time the product option was created.

updated_at datetime

Time the product option was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "kind": "string",
      "name": "string",
      "description": "string",
      "price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "tax_rate_id": 1,
      "category_of_revenue_id": 1,
      "product_id": 1,
      "max_choices": 1,
      "no_discount": true,
      "position": 1,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/product_options product:write

Adds an option to a group at the end, for example `{ "product_option_group_id": 3, "kind": "custom", "name": "Extra cheese", "price": { "value": 50, "currency": "EUR" }, "tax_rate_id": 1, "category_of_revenue_id": 2 }`.

Request body

product_option_group_id integer req

Group to add the option to

kind enum req

`custom` for an option with its own name and price, `product` for an existing product. Cannot be changed afterwards

customproduct

name string

Name of a `custom` option, for example `Extra cheese`; a `product` option takes the product's name

description string

Description shown with the option

price object

Price including VAT; required for a `custom` option, overrides the product's price for a `product` option

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

tax_rate_id integer

Tax rate of a `custom` option

category_of_revenue_id integer

Category of revenue of a `custom` option

product_id integer

Product offered as this option; required for a `product` option

max_choices integer

Most times this option can be chosen; null for no limit of its own

no_discount boolean

Exclude the option from discounts

{
  "product_option_group_id": 3,
  "kind": "custom",
  "name": "Extra cheese",
  "price": {
    "value": 50,
    "currency": "EUR"
  },
  "tax_rate_id": 1,
  "category_of_revenue_id": 2
}

Responses

201 ProductOption Create a product option
Response attributes
id integer
kind string

Option type: custom (free-form name and price) or product (backed by an existing product).

name string
description string
price Money

Price of the option. Null for product-backed options that inherit the product price.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate_id integer

Tax rate of a custom option; null for product-backed options.

category_of_revenue_id integer

Category of revenue of a custom option; null for product-backed options.

product_id integer

Backing product sequence. Only set for kind=product.

max_choices integer

Maximum number of times this option can be selected. Null means no limit of its own, so only the group total and the stock apply.

no_discount boolean

Whether discounts are excluded from this option.

position integer

Display order within the group.

created_at datetime

Time the product option was created.

updated_at datetime

Time the product option was last updated.

Example response
{
  "id": 1,
  "kind": "string",
  "name": "string",
  "description": "string",
  "price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "tax_rate_id": 1,
  "category_of_revenue_id": 1,
  "product_id": 1,
  "max_choices": 1,
  "no_discount": true,
  "position": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/product_options/{id} product:read

Retrieve a product option

Parameters

id path · integer req

Unique identifier of the product option

Responses

200 ProductOption Retrieve a product option
Response attributes
id integer
kind string

Option type: custom (free-form name and price) or product (backed by an existing product).

name string
description string
price Money

Price of the option. Null for product-backed options that inherit the product price.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate_id integer

Tax rate of a custom option; null for product-backed options.

category_of_revenue_id integer

Category of revenue of a custom option; null for product-backed options.

product_id integer

Backing product sequence. Only set for kind=product.

max_choices integer

Maximum number of times this option can be selected. Null means no limit of its own, so only the group total and the stock apply.

no_discount boolean

Whether discounts are excluded from this option.

position integer

Display order within the group.

created_at datetime

Time the product option was created.

updated_at datetime

Time the product option was last updated.

Example response
{
  "id": 1,
  "kind": "string",
  "name": "string",
  "description": "string",
  "price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "tax_rate_id": 1,
  "category_of_revenue_id": 1,
  "product_id": 1,
  "max_choices": 1,
  "no_discount": true,
  "position": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/product_options/{id} product:write

Updates the given attributes; attributes that are not included keep their current value.

Parameters

id path · integer req

Unique identifier of the product option

Request body

name string

Name of a `custom` option, for example `Extra cheese`; a `product` option takes the product's name

description string

Description shown with the option

price object

Price including VAT; required for a `custom` option, overrides the product's price for a `product` option

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

tax_rate_id integer

Tax rate of a `custom` option

category_of_revenue_id integer

Category of revenue of a `custom` option

product_id integer

Product offered as this option; required for a `product` option

max_choices integer

Most times this option can be chosen; null for no limit of its own

no_discount boolean

Exclude the option from discounts

position integer

1-based position in the group; other options shift to make room

{
  "price": {
    "value": 75,
    "currency": "EUR"
  }
}

Responses

200 ProductOption Update a product option
Response attributes
id integer
kind string

Option type: custom (free-form name and price) or product (backed by an existing product).

name string
description string
price Money

Price of the option. Null for product-backed options that inherit the product price.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate_id integer

Tax rate of a custom option; null for product-backed options.

category_of_revenue_id integer

Category of revenue of a custom option; null for product-backed options.

product_id integer

Backing product sequence. Only set for kind=product.

max_choices integer

Maximum number of times this option can be selected. Null means no limit of its own, so only the group total and the stock apply.

no_discount boolean

Whether discounts are excluded from this option.

position integer

Display order within the group.

created_at datetime

Time the product option was created.

updated_at datetime

Time the product option was last updated.

Example response
{
  "id": 1,
  "kind": "string",
  "name": "string",
  "description": "string",
  "price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "tax_rate_id": 1,
  "category_of_revenue_id": 1,
  "product_id": 1,
  "max_choices": 1,
  "no_discount": true,
  "position": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/product_options/{id} product:write

Deletes the option from its group. Receipts keep the options already sold.

Parameters

id path · integer req

Unique identifier of the product option

Responses

204 Delete a product option

Product option groups

GET /v1/product_option_groups product:read

Returns the groups of options products can offer, such as sizes, toppings or side dishes, sorted by name. Attach a group to a product with `POST /v1/products/{id}/option_groups`.

Parameters

kind query · enum

Only groups of this kind

add_onproduct_add_onoptionproduct_option

include_archived query · boolean

Include archived groups

default false

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of ProductOptionGroup List product option groups
Response attributes

The items on this page.

id integer
name string
kind string

Group type: add_on or product_add_on appends items to the receipt; option or product_option substitutes or modifies the parent product.

required boolean

Whether the customer must choose at least one option.

substitutable boolean

Whether choosing an option substitutes the parent product.

hide_on_receipt boolean

Whether selected options are hidden on the printed receipt.

hide_parent boolean

Whether the parent product line is hidden when an option is selected.

total_choices integer

Maximum number of choices across the whole group, counting duplicates. Null means no total limit.

combine_on_receipt boolean

Whether the chosen options are stored as one comma separated receipt line instead of a line per choice.

archived string
created_at datetime

Time the product option group was created.

updated_at datetime

Time the product option group was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "kind": "string",
      "required": true,
      "substitutable": true,
      "hide_on_receipt": true,
      "hide_parent": true,
      "total_choices": 1,
      "combine_on_receipt": true,
      "archived": "string",
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/product_option_groups product:write

Adds a group, for example `{ "name": "Toppings", "kind": "add_on" }`. Add its options with `POST /v1/product_options`.

Request body

kind enum req

`add_on` and `product_add_on` add items to the receipt; `option` and `product_option` change or replace the product. The `product_` kinds offer existing products as options. Cannot be changed afterwards

add_onproduct_add_onoptionproduct_option

name string req

Name of the group, for example `Size` or `Toppings`

required boolean

The guest must choose at least one option

substitutable boolean

Choosing an option replaces the product

hide_on_receipt boolean

Leave the chosen options off the printed receipt

hide_parent boolean

Leave the product line off the receipt when an option is chosen

total_choices integer

Most choices in the whole group, counting repeats; null for no limit. Only for `add_on` and `product_add_on` groups

combine_on_receipt boolean

Put the chosen options on one comma separated receipt line. Only for `product_add_on` groups

{
  "name": "Toppings",
  "kind": "add_on"
}

Responses

201 ProductOptionGroup Create a product option group
Response attributes
id integer
name string
kind string

Group type: add_on or product_add_on appends items to the receipt; option or product_option substitutes or modifies the parent product.

required boolean

Whether the customer must choose at least one option.

substitutable boolean

Whether choosing an option substitutes the parent product.

hide_on_receipt boolean

Whether selected options are hidden on the printed receipt.

hide_parent boolean

Whether the parent product line is hidden when an option is selected.

total_choices integer

Maximum number of choices across the whole group, counting duplicates. Null means no total limit.

combine_on_receipt boolean

Whether the chosen options are stored as one comma separated receipt line instead of a line per choice.

archived string
created_at datetime

Time the product option group was created.

updated_at datetime

Time the product option group was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "kind": "string",
  "required": true,
  "substitutable": true,
  "hide_on_receipt": true,
  "hide_parent": true,
  "total_choices": 1,
  "combine_on_receipt": true,
  "archived": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/product_option_groups/{id} product:read

Retrieve a product option group

Parameters

id path · integer req

Unique identifier of the product option group

Responses

200 ProductOptionGroup Retrieve a product option group
Response attributes
id integer
name string
kind string

Group type: add_on or product_add_on appends items to the receipt; option or product_option substitutes or modifies the parent product.

required boolean

Whether the customer must choose at least one option.

substitutable boolean

Whether choosing an option substitutes the parent product.

hide_on_receipt boolean

Whether selected options are hidden on the printed receipt.

hide_parent boolean

Whether the parent product line is hidden when an option is selected.

total_choices integer

Maximum number of choices across the whole group, counting duplicates. Null means no total limit.

combine_on_receipt boolean

Whether the chosen options are stored as one comma separated receipt line instead of a line per choice.

archived string
created_at datetime

Time the product option group was created.

updated_at datetime

Time the product option group was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "kind": "string",
  "required": true,
  "substitutable": true,
  "hide_on_receipt": true,
  "hide_parent": true,
  "total_choices": 1,
  "combine_on_receipt": true,
  "archived": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/product_option_groups/{id} product:write

Updates the given attributes; attributes that are not included keep their current value. Set `archived` to `false` to restore an archived group.

Parameters

id path · integer req

Unique identifier of the product option group

Request body

name string

Name of the group, for example `Size` or `Toppings`

required boolean

The guest must choose at least one option

substitutable boolean

Choosing an option replaces the product

hide_on_receipt boolean

Leave the chosen options off the printed receipt

hide_parent boolean

Leave the product line off the receipt when an option is chosen

total_choices integer

Most choices in the whole group, counting repeats; null for no limit. Only for `add_on` and `product_add_on` groups

combine_on_receipt boolean

Put the chosen options on one comma separated receipt line. Only for `product_add_on` groups

archived boolean

`true` archives the group, `false` restores it

{
  "required": true
}

Responses

200 ProductOptionGroup Update a product option group
Response attributes
id integer
name string
kind string

Group type: add_on or product_add_on appends items to the receipt; option or product_option substitutes or modifies the parent product.

required boolean

Whether the customer must choose at least one option.

substitutable boolean

Whether choosing an option substitutes the parent product.

hide_on_receipt boolean

Whether selected options are hidden on the printed receipt.

hide_parent boolean

Whether the parent product line is hidden when an option is selected.

total_choices integer

Maximum number of choices across the whole group, counting duplicates. Null means no total limit.

combine_on_receipt boolean

Whether the chosen options are stored as one comma separated receipt line instead of a line per choice.

archived string
created_at datetime

Time the product option group was created.

updated_at datetime

Time the product option group was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "kind": "string",
  "required": true,
  "substitutable": true,
  "hide_on_receipt": true,
  "hide_parent": true,
  "total_choices": 1,
  "combine_on_receipt": true,
  "archived": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/product_option_groups/{id} product:write

Archives the group. Refused while it is attached to a product.

Parameters

id path · integer req

Unique identifier of the product option group

Responses

200 ProductOptionGroup Archive a product option group
Response attributes
id integer
name string
kind string

Group type: add_on or product_add_on appends items to the receipt; option or product_option substitutes or modifies the parent product.

required boolean

Whether the customer must choose at least one option.

substitutable boolean

Whether choosing an option substitutes the parent product.

hide_on_receipt boolean

Whether selected options are hidden on the printed receipt.

hide_parent boolean

Whether the parent product line is hidden when an option is selected.

total_choices integer

Maximum number of choices across the whole group, counting duplicates. Null means no total limit.

combine_on_receipt boolean

Whether the chosen options are stored as one comma separated receipt line instead of a line per choice.

archived string
created_at datetime

Time the product option group was created.

updated_at datetime

Time the product option group was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "kind": "string",
  "required": true,
  "substitutable": true,
  "hide_on_receipt": true,
  "hide_parent": true,
  "total_choices": 1,
  "combine_on_receipt": true,
  "archived": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Quickselects

GET /v1/quickselects product:read

Returns the buttons of a quickselect category in display order.

Parameters

quickselect_category_id query · integer req

Category whose buttons to list

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Quickselect List quickselects
Response attributes

The items on this page.

id integer
kind string

Button type: product, voucher, manual, scan, search, or takeout.

label string

Custom display label. Falls back to the product or voucher name when blank.

color string

Tailwind color name for the button background.

position integer

Display order within the category.

quickselectable_id integer

Sequence of the backing record (product or voucher).

settings object

Settings of a `manual` button; null for other kinds.

default_name string

Name the free item gets; staff can change it.

default_price Money

Price the free item gets; staff can change it.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

category_of_revenue_ids array of integer

Ones staff may pick for the item; empty for all.

tax_rate_ids array of integer

Ones staff may pick for the item; empty for all.

preparation_location_ids array of integer

Ones staff may pick for the item; empty for all.

product_category_ids array of integer

Ones staff may pick for the item; empty for all.

created_at datetime

Time the quickselect was created.

updated_at datetime

Time the quickselect was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "kind": "string",
      "label": "string",
      "color": "string",
      "position": 1,
      "quickselectable_id": 1,
      "settings": {
        "default_name": "string",
        "default_price": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "category_of_revenue_ids": [
          1
        ],
        "tax_rate_ids": [
          1
        ],
        "preparation_location_ids": [
          1
        ],
        "product_category_ids": [
          1
        ]
      },
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/quickselects product:write

Adds a button at the end of a category, for example `{ "quickselect_category_id": 4, "kind": "product", "product_id": 12 }`.

Request body

quickselect_category_id integer req

Category to add the button to

kind enum req

`product` rings up a product, `voucher` sells a voucher, `manual` enters a free item, `scan` scans a barcode, `search` searches products, `takeout` starts a takeout order. Cannot be changed afterwards

productvouchermanualscansearchtakeout

product_id integer

Product of a `product` button

voucher_id integer

Voucher of a `voucher` button

label string

Text on the button; defaults to the product or voucher name

color string

Color name of the button, for example `amber` or `blue`; null for the default

settings object

Settings of a `manual` button; settings that are not included keep their current value

default_name string

Name the free item gets; staff can change it

default_price object

Price the free item gets; staff can change it

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

category_of_revenue_ids array of integer

Categories of revenue staff may pick; `[]` for all

tax_rate_ids array of integer

Tax rates staff may pick; `[]` for all

preparation_location_ids array of integer

Preparation locations staff may pick; `[]` for all

product_category_ids array of integer

Product categories staff may pick; `[]` for all

{
  "quickselect_category_id": 4,
  "kind": "product",
  "product_id": 12
}

Responses

201 Quickselect Create a quickselect
Response attributes
id integer
kind string

Button type: product, voucher, manual, scan, search, or takeout.

label string

Custom display label. Falls back to the product or voucher name when blank.

color string

Tailwind color name for the button background.

position integer

Display order within the category.

quickselectable_id integer

Sequence of the backing record (product or voucher).

settings object

Settings of a `manual` button; null for other kinds.

default_name string

Name the free item gets; staff can change it.

default_price Money

Price the free item gets; staff can change it.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

category_of_revenue_ids array of integer

Ones staff may pick for the item; empty for all.

tax_rate_ids array of integer

Ones staff may pick for the item; empty for all.

preparation_location_ids array of integer

Ones staff may pick for the item; empty for all.

product_category_ids array of integer

Ones staff may pick for the item; empty for all.

created_at datetime

Time the quickselect was created.

updated_at datetime

Time the quickselect was last updated.

Example response
{
  "id": 1,
  "kind": "string",
  "label": "string",
  "color": "string",
  "position": 1,
  "quickselectable_id": 1,
  "settings": {
    "default_name": "string",
    "default_price": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "category_of_revenue_ids": [
      1
    ],
    "tax_rate_ids": [
      1
    ],
    "preparation_location_ids": [
      1
    ],
    "product_category_ids": [
      1
    ]
  },
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/quickselects/{id} product:read

Retrieve a quickselect

Parameters

id path · integer req

Unique identifier of the quickselect

Responses

200 Quickselect Retrieve a quickselect
Response attributes
id integer
kind string

Button type: product, voucher, manual, scan, search, or takeout.

label string

Custom display label. Falls back to the product or voucher name when blank.

color string

Tailwind color name for the button background.

position integer

Display order within the category.

quickselectable_id integer

Sequence of the backing record (product or voucher).

settings object

Settings of a `manual` button; null for other kinds.

default_name string

Name the free item gets; staff can change it.

default_price Money

Price the free item gets; staff can change it.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

category_of_revenue_ids array of integer

Ones staff may pick for the item; empty for all.

tax_rate_ids array of integer

Ones staff may pick for the item; empty for all.

preparation_location_ids array of integer

Ones staff may pick for the item; empty for all.

product_category_ids array of integer

Ones staff may pick for the item; empty for all.

created_at datetime

Time the quickselect was created.

updated_at datetime

Time the quickselect was last updated.

Example response
{
  "id": 1,
  "kind": "string",
  "label": "string",
  "color": "string",
  "position": 1,
  "quickselectable_id": 1,
  "settings": {
    "default_name": "string",
    "default_price": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "category_of_revenue_ids": [
      1
    ],
    "tax_rate_ids": [
      1
    ],
    "preparation_location_ids": [
      1
    ],
    "product_category_ids": [
      1
    ]
  },
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/quickselects/{id} product:write

Updates the given attributes; attributes that are not included keep their current value. To change what a button rings up, delete it and add a new one.

Parameters

id path · integer req

Unique identifier of the quickselect

Request body

label string

Text on the button; defaults to the product or voucher name

color string

Color name of the button, for example `amber` or `blue`; null for the default

settings object

Settings of a `manual` button; settings that are not included keep their current value

default_name string

Name the free item gets; staff can change it

default_price object

Price the free item gets; staff can change it

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

category_of_revenue_ids array of integer

Categories of revenue staff may pick; `[]` for all

tax_rate_ids array of integer

Tax rates staff may pick; `[]` for all

preparation_location_ids array of integer

Preparation locations staff may pick; `[]` for all

product_category_ids array of integer

Product categories staff may pick; `[]` for all

position integer

1-based position in the category; other buttons shift to make room

{
  "label": "Pint",
  "color": "amber"
}

Responses

200 Quickselect Update a quickselect
Response attributes
id integer
kind string

Button type: product, voucher, manual, scan, search, or takeout.

label string

Custom display label. Falls back to the product or voucher name when blank.

color string

Tailwind color name for the button background.

position integer

Display order within the category.

quickselectable_id integer

Sequence of the backing record (product or voucher).

settings object

Settings of a `manual` button; null for other kinds.

default_name string

Name the free item gets; staff can change it.

default_price Money

Price the free item gets; staff can change it.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

category_of_revenue_ids array of integer

Ones staff may pick for the item; empty for all.

tax_rate_ids array of integer

Ones staff may pick for the item; empty for all.

preparation_location_ids array of integer

Ones staff may pick for the item; empty for all.

product_category_ids array of integer

Ones staff may pick for the item; empty for all.

created_at datetime

Time the quickselect was created.

updated_at datetime

Time the quickselect was last updated.

Example response
{
  "id": 1,
  "kind": "string",
  "label": "string",
  "color": "string",
  "position": 1,
  "quickselectable_id": 1,
  "settings": {
    "default_name": "string",
    "default_price": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "category_of_revenue_ids": [
      1
    ],
    "tax_rate_ids": [
      1
    ],
    "preparation_location_ids": [
      1
    ],
    "product_category_ids": [
      1
    ]
  },
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/quickselects/{id} product:write

Deletes the button; the product or voucher remains.

Parameters

id path · integer req

Unique identifier of the quickselect

Responses

204 Delete a quickselect

Quickselect categories

GET /v1/quickselect_categories product:read

Returns the categories (tabs) of a quickselect page in display order. Each holds buttons; list them with `GET /v1/quickselects?quickselect_category_id=`.

Parameters

quickselect_page_id query · integer req

Page whose categories to list

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of QuickselectCategory List quickselect categories
Response attributes

The items on this page.

id integer
quickselect_page_id integer

Unique identifier of the page this category belongs to.

name string
position integer

Display order within the page.

created_at datetime

Time the quickselect category was created.

updated_at datetime

Time the quickselect category was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "quickselect_page_id": 1,
      "name": "string",
      "position": 1,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/quickselect_categories product:write

Adds a category at the end of a page, for example `{ "quickselect_page_id": 1, "name": "Beers" }`.

Request body

quickselect_page_id integer req

Page to add the category to

name string req

Name of the category

{
  "quickselect_page_id": 1,
  "name": "Beers"
}

Responses

201 QuickselectCategory Create a quickselect category
Response attributes
id integer
quickselect_page_id integer

Unique identifier of the page this category belongs to.

name string
position integer

Display order within the page.

created_at datetime

Time the quickselect category was created.

updated_at datetime

Time the quickselect category was last updated.

Example response
{
  "id": 1,
  "quickselect_page_id": 1,
  "name": "string",
  "position": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/quickselect_categories/{id} product:read

Retrieve a quickselect category

Parameters

id path · integer req

Unique identifier of the quickselect category

Responses

200 QuickselectCategory Retrieve a quickselect category
Response attributes
id integer
quickselect_page_id integer

Unique identifier of the page this category belongs to.

name string
position integer

Display order within the page.

created_at datetime

Time the quickselect category was created.

updated_at datetime

Time the quickselect category was last updated.

Example response
{
  "id": 1,
  "quickselect_page_id": 1,
  "name": "string",
  "position": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/quickselect_categories/{id} product:write

Updates the given attributes; attributes that are not included keep their current value.

Parameters

id path · integer req

Unique identifier of the quickselect category

Request body

name string

Name of the category

position integer

1-based position on the page; other categories shift to make room

{
  "name": "Wines",
  "position": 2
}

Responses

200 QuickselectCategory Update a quickselect category
Response attributes
id integer
quickselect_page_id integer

Unique identifier of the page this category belongs to.

name string
position integer

Display order within the page.

created_at datetime

Time the quickselect category was created.

updated_at datetime

Time the quickselect category was last updated.

Example response
{
  "id": 1,
  "quickselect_page_id": 1,
  "name": "string",
  "position": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/quickselect_categories/{id} product:write

Deletes the category with its buttons.

Parameters

id path · integer req

Unique identifier of the quickselect category

Responses

204 Delete a quickselect category

Quickselect pages

GET /v1/quickselect_pages product:read

Returns the screens of buttons registers show to ring up products, in display order. A register shows the page set as its `quickselect_page_id`; a page holds categories (`GET /v1/quickselect_categories`), which hold the buttons (`GET /v1/quickselects`).

Parameters

switchable query · boolean

Only pages registers can switch to from the page picker

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of QuickselectPage List quickselect pages
Response attributes

The items on this page.

id integer
name string
position integer

Display order of this page.

show_product_images boolean

Whether buttons on this page display product images.

switchable boolean

Whether registers can switch to this page from a page picker.

created_at datetime

Time the quickselect page was created.

updated_at datetime

Time the quickselect page was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "position": 1,
      "show_product_images": true,
      "switchable": true,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/quickselect_pages product:write

Adds a page at the end, for example `{ "name": "Terrace" }`.

Request body

name string req

Name of the page, for example `Bar` or `Terrace`

show_product_images boolean

Show product images on the buttons

switchable boolean

Registers can switch to this page from the page picker

{
  "name": "Terrace"
}

Responses

201 QuickselectPage Create a quickselect page
Response attributes
id integer
name string
position integer

Display order of this page.

show_product_images boolean

Whether buttons on this page display product images.

switchable boolean

Whether registers can switch to this page from a page picker.

created_at datetime

Time the quickselect page was created.

updated_at datetime

Time the quickselect page was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "position": 1,
  "show_product_images": true,
  "switchable": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/quickselect_pages/{id} product:read

Retrieve a quickselect page

Parameters

id path · integer req

Unique identifier of the quickselect page

Responses

200 QuickselectPage Retrieve a quickselect page
Response attributes
id integer
name string
position integer

Display order of this page.

show_product_images boolean

Whether buttons on this page display product images.

switchable boolean

Whether registers can switch to this page from a page picker.

created_at datetime

Time the quickselect page was created.

updated_at datetime

Time the quickselect page was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "position": 1,
  "show_product_images": true,
  "switchable": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/quickselect_pages/{id} product:write

Updates the given attributes; attributes that are not included keep their current value.

Parameters

id path · integer req

Unique identifier of the quickselect page

Request body

name string

Name of the page, for example `Bar` or `Terrace`

show_product_images boolean

Show product images on the buttons

switchable boolean

Registers can switch to this page from the page picker

position integer

1-based position among the pages; other pages shift to make room

{
  "show_product_images": true
}

Responses

200 QuickselectPage Update a quickselect page
Response attributes
id integer
name string
position integer

Display order of this page.

show_product_images boolean

Whether buttons on this page display product images.

switchable boolean

Whether registers can switch to this page from a page picker.

created_at datetime

Time the quickselect page was created.

updated_at datetime

Time the quickselect page was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "position": 1,
  "show_product_images": true,
  "switchable": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/quickselect_pages/{id} product:write

Deletes the page with its categories and buttons. Registers that showed it no longer have a page.

Parameters

id path · integer req

Unique identifier of the quickselect page

Responses

204 Delete a quickselect page

Receipts

GET /v1/receipts receipt:read

Returns the receipts settled in a daily closing (`daily_closing_id`), or the receipts opened in a period (`from` and `to`, at most 366 days), most recent first. Filter by customer, for example for a purchase history, or by status.

Parameters

daily_closing_id query · integer

Only receipts settled in this daily closing

from query · date

First day of the period the receipts were opened in

to query · date

Last day of the period; defaults to `from`

customer_id query · integer

Only receipts of this customer

status query · enum

Only open, paid or voided receipts

openpaidvoided

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Receipt List receipts
Response attributes

The items on this page.

id integer

Unique identifier of the receipt.

label string

Name of the receipt as shown on the register, for example the table, customer or a name typed in; prefixed with the pick-up time for takeout.

receiptable_type string

What the receipt is opened on: `table`, `customer`, `group`, `employee` (an employee ordering for themselves), `kiosk` or `app`.

receiptable_id integer

Unique identifier of the table, customer, group or employee the receipt is opened on.

items array of object

Line items on the receipt.

id integer

Unique identifier of the item.

product_id integer

Unique identifier of the ordered product; null for free-form items.

parent_id integer

Unique identifier of the item this item belongs to, for example a product option or a fee; null for top-level items.

description string

Description of the item as shown on the receipt.

note string

Note shown on the preparation receipt.

price Money

Unit price after discounts and compensation; this is what the guest pays.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

original_price Money

Unit price before discounts and compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

discount_percentage number

Discount percentage applied to the item, from a discount rule or the receipt discount; 0 without discount.

compensation Money

Amount taken off the item as compensation, for example for a cold dish; 0 without compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

compensation_reason_id integer

Unique identifier of the compensation reason; null without compensation.

compensation_reason string

Reason for the compensation, as set up in the back office; null without compensation.

compensation_note string

Note the employee added to the compensation.

tax_rate TaxRate

Tax rate applied to the item.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the item counts towards.

id integer

Unique identifier of the resource.

name string

Name of the resource.

cost_price Money

Cost price of the item.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

unit_quantity integer

Quantity sold of `unit_name`, for example 250 for 250 gram; null for items sold per piece.

unit_name string

Unit the item is sold per, for example `gram`; null for items sold per piece.

course integer

Course the item is served in, 0 for no course.

preparation_state string

Where the item is in preparation: `unrequested`, `requested`, `ready_to_prepare`, `preparing`, `prepared`, `ready_to_deliver` or `delivered`.

representation_by Reference

Employee the item was booked on as representation (on the house), if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

own_use boolean

Whether the item was booked as own use (consumed by staff or the business) instead of sold.

payment_status string

Payment status of the item: `open`, `pending` or `paid`.

refunded_item_id integer

On a return receipt: the item that was refunded; null otherwise.

voucher_card_id integer

Voucher card sold or topped up with the item (`GET /v1/voucher_cards/{id}`); null otherwise.

kind enum

`sale` for products and other items, `voucher` for a sold voucher card, `loyalty_topup` for balance topped up on a customer and `reservation_deposit` for a deposit paid on a reservation.

salevoucherloyalty_topupreservation_deposit

voucher Reference

Voucher sold with the item, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for top-up items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

created_at datetime

Time the item was added to the receipt.

updated_at datetime

Time the receipt item was last updated.

customer Customer

Customer the receipt belongs to, if any.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

payments array of Payment

Payments recorded on the receipt.

id integer

Unique identifier of the payment.

receipt_id integer

Unique identifier of the receipt the payment settles.

payment_method_id integer

Unique identifier of the payment method that was used.

voucher_card_id integer

Unique identifier of the voucher card the payment was made with; null for other payments.

category_of_revenue Reference

Category of revenue the payment counts towards, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

kind enum

`payment` for cash, card and other payment methods, `voucher` for a payment with a voucher card, `loyalty_balance` for a payment from a customer's balance and `reservation_deposit` for a paid deposit settled on the receipt.

paymentvoucherloyalty_balancereservation_deposit

voucher Reference

Voucher the payment was made with, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for balance payments.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit settlements.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount paid.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

created_at datetime

Time the payment was created.

updated_at datetime

Time the payment was last updated.

total_amount Money

Total of the items after discounts and compensations, excluding items booked as representation or own use.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

open_amount Money

Amount still to be paid.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

discount_type string

How a discount given on the whole receipt is expressed: `percentage` (see `discount_percentage`) or `absolute` (see `absolute_discount`).

discount_percentage number

Percentage discount given on the whole receipt, for example 10.0; 0 without one. Items get this or their own discount rule, whichever is higher.

absolute_discount Money

Amount taken off the whole receipt when `discount_type` is `absolute`, spread over the items.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

guests_count integer

Number of guests on the receipt; null when not registered.

note string

Note on the receipt, shown on the register.

marker_ids array of integer

Markers on the receipt, for example allergies or VIP (`GET /v1/markers`).

paid_at datetime

Time the receipt was paid in full; null while the receipt is open.

voided_at datetime

Time the receipt was voided; null unless voided. A voided receipt was cancelled and counts towards no revenue.

voided_reason string

Reason the employee gave for voiding the receipt.

refunded_receipt_id integer

For a return: the receipt whose items were refunded; null for regular receipts.

daily_closing_id integer

Daily closing the receipt was settled in; null until the day is closed.

pick_up_at datetime

Pick-up moment for takeout receipts; null otherwise.

reservation_id integer

Unique identifier of the reservation checked in on this receipt.

opened_at datetime

Time the receipt was opened.

created_at datetime

Time the receipt was created.

updated_at datetime

Time the receipt was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "label": "string",
      "receiptable_type": "string",
      "receiptable_id": 1,
      "items": [
        {
          "id": 1,
          "product_id": 1,
          "parent_id": 1,
          "description": "string",
          "note": "string",
          "price": {
            "value": 1,
            "currency": "string",
            "minor_units": 1,
            "formatted": "string"
          },
          "original_price": {
            "value": 1,
            "currency": "string",
            "minor_units": 1,
            "formatted": "string"
          },
          "discount_percentage": 9.99,
          "compensation": {
            "value": 1,
            "currency": "string",
            "minor_units": 1,
            "formatted": "string"
          },
          "compensation_reason_id": 1,
          "compensation_reason": "string",
          "compensation_note": "string",
          "tax_rate": {
            "id": 1,
            "name": "string",
            "percentage": 9.99,
            "kind": "string",
            "archived": true,
            "label": "string",
            "created_at": "2026-01-15T12:30:00Z",
            "updated_at": "2026-01-15T12:30:00Z"
          },
          "category_of_revenue": {
            "id": 1,
            "name": "string"
          },
          "cost_price": {
            "value": 1,
            "currency": "string",
            "minor_units": 1,
            "formatted": "string"
          },
          "unit_quantity": 1,
          "unit_name": "string",
          "course": 1,
          "preparation_state": "string",
          "representation_by": {
            "id": 1,
            "name": "string"
          },
          "own_use": true,
          "payment_status": "string",
          "refunded_item_id": 1,
          "voucher_card_id": 1,
          "kind": "sale",
          "voucher": {
            "id": 1,
            "name": "string"
          },
          "loyalty": {
            "id": 1,
            "name": "string"
          },
          "reservation": {
            "id": 1,
            "name": "string"
          },
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        }
      ],
      "customer": {
        "id": 1,
        "name": "string",
        "email": "string",
        "phone": "string",
        "address": "string",
        "note": "string",
        "locale": "string",
        "pinned": true,
        "balance": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "temporary": true,
        "archived": true,
        "merged_into_id": 1,
        "group_ids": [
          1
        ],
        "last_receipt_at": "2026-01-15T12:30:00Z",
        "identifier": "string",
        "app_data": {},
        "created_at": "2026-01-15T12:30:00Z",
        "updated_at": "2026-01-15T12:30:00Z"
      },
      "payments": [
        {
          "id": 1,
          "receipt_id": 1,
          "payment_method_id": 1,
          "voucher_card_id": 1,
          "category_of_revenue": {
            "id": 1,
            "name": "string"
          },
          "kind": "payment",
          "voucher": {
            "id": 1,
            "name": "string"
          },
          "loyalty": {
            "id": 1,
            "name": "string"
          },
          "reservation": {
            "id": 1,
            "name": "string"
          },
          "amount": {
            "value": 1,
            "currency": "string",
            "minor_units": 1,
            "formatted": "string"
          },
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        }
      ],
      "total_amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "open_amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "discount_type": "string",
      "discount_percentage": 9.99,
      "absolute_discount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "guests_count": 1,
      "note": "string",
      "marker_ids": [
        1
      ],
      "paid_at": "2026-01-15T12:30:00Z",
      "voided_at": "2026-01-15T12:30:00Z",
      "voided_reason": "string",
      "refunded_receipt_id": 1,
      "daily_closing_id": 1,
      "pick_up_at": "2026-01-15T12:30:00Z",
      "reservation_id": 1,
      "opened_at": "2026-01-15T12:30:00Z",
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
GET /v1/receipts/{id} receipt:read

Returns a receipt with its items, payments, customer and outstanding amount.

Parameters

id path · integer req

Unique identifier of the receipt

Responses

200 Receipt Retrieve a receipt
Response attributes
id integer

Unique identifier of the receipt.

label string

Name of the receipt as shown on the register, for example the table, customer or a name typed in; prefixed with the pick-up time for takeout.

receiptable_type string

What the receipt is opened on: `table`, `customer`, `group`, `employee` (an employee ordering for themselves), `kiosk` or `app`.

receiptable_id integer

Unique identifier of the table, customer, group or employee the receipt is opened on.

items array of object

Line items on the receipt.

id integer

Unique identifier of the item.

product_id integer

Unique identifier of the ordered product; null for free-form items.

parent_id integer

Unique identifier of the item this item belongs to, for example a product option or a fee; null for top-level items.

description string

Description of the item as shown on the receipt.

note string

Note shown on the preparation receipt.

price Money

Unit price after discounts and compensation; this is what the guest pays.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

original_price Money

Unit price before discounts and compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

discount_percentage number

Discount percentage applied to the item, from a discount rule or the receipt discount; 0 without discount.

compensation Money

Amount taken off the item as compensation, for example for a cold dish; 0 without compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

compensation_reason_id integer

Unique identifier of the compensation reason; null without compensation.

compensation_reason string

Reason for the compensation, as set up in the back office; null without compensation.

compensation_note string

Note the employee added to the compensation.

tax_rate TaxRate

Tax rate applied to the item.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the item counts towards.

id integer

Unique identifier of the resource.

name string

Name of the resource.

cost_price Money

Cost price of the item.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

unit_quantity integer

Quantity sold of `unit_name`, for example 250 for 250 gram; null for items sold per piece.

unit_name string

Unit the item is sold per, for example `gram`; null for items sold per piece.

course integer

Course the item is served in, 0 for no course.

preparation_state string

Where the item is in preparation: `unrequested`, `requested`, `ready_to_prepare`, `preparing`, `prepared`, `ready_to_deliver` or `delivered`.

representation_by Reference

Employee the item was booked on as representation (on the house), if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

own_use boolean

Whether the item was booked as own use (consumed by staff or the business) instead of sold.

payment_status string

Payment status of the item: `open`, `pending` or `paid`.

refunded_item_id integer

On a return receipt: the item that was refunded; null otherwise.

voucher_card_id integer

Voucher card sold or topped up with the item (`GET /v1/voucher_cards/{id}`); null otherwise.

kind enum

`sale` for products and other items, `voucher` for a sold voucher card, `loyalty_topup` for balance topped up on a customer and `reservation_deposit` for a deposit paid on a reservation.

salevoucherloyalty_topupreservation_deposit

voucher Reference

Voucher sold with the item, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for top-up items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

created_at datetime

Time the item was added to the receipt.

updated_at datetime

Time the receipt item was last updated.

customer Customer

Customer the receipt belongs to, if any.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

payments array of Payment

Payments recorded on the receipt.

id integer

Unique identifier of the payment.

receipt_id integer

Unique identifier of the receipt the payment settles.

payment_method_id integer

Unique identifier of the payment method that was used.

voucher_card_id integer

Unique identifier of the voucher card the payment was made with; null for other payments.

category_of_revenue Reference

Category of revenue the payment counts towards, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

kind enum

`payment` for cash, card and other payment methods, `voucher` for a payment with a voucher card, `loyalty_balance` for a payment from a customer's balance and `reservation_deposit` for a paid deposit settled on the receipt.

paymentvoucherloyalty_balancereservation_deposit

voucher Reference

Voucher the payment was made with, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for balance payments.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit settlements.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount paid.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

created_at datetime

Time the payment was created.

updated_at datetime

Time the payment was last updated.

total_amount Money

Total of the items after discounts and compensations, excluding items booked as representation or own use.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

open_amount Money

Amount still to be paid.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

discount_type string

How a discount given on the whole receipt is expressed: `percentage` (see `discount_percentage`) or `absolute` (see `absolute_discount`).

discount_percentage number

Percentage discount given on the whole receipt, for example 10.0; 0 without one. Items get this or their own discount rule, whichever is higher.

absolute_discount Money

Amount taken off the whole receipt when `discount_type` is `absolute`, spread over the items.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

guests_count integer

Number of guests on the receipt; null when not registered.

note string

Note on the receipt, shown on the register.

marker_ids array of integer

Markers on the receipt, for example allergies or VIP (`GET /v1/markers`).

paid_at datetime

Time the receipt was paid in full; null while the receipt is open.

voided_at datetime

Time the receipt was voided; null unless voided. A voided receipt was cancelled and counts towards no revenue.

voided_reason string

Reason the employee gave for voiding the receipt.

refunded_receipt_id integer

For a return: the receipt whose items were refunded; null for regular receipts.

daily_closing_id integer

Daily closing the receipt was settled in; null until the day is closed.

pick_up_at datetime

Pick-up moment for takeout receipts; null otherwise.

reservation_id integer

Unique identifier of the reservation checked in on this receipt.

opened_at datetime

Time the receipt was opened.

created_at datetime

Time the receipt was created.

updated_at datetime

Time the receipt was last updated.

Example response
{
  "id": 1,
  "label": "string",
  "receiptable_type": "string",
  "receiptable_id": 1,
  "items": [
    {
      "id": 1,
      "product_id": 1,
      "parent_id": 1,
      "description": "string",
      "note": "string",
      "price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "original_price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "discount_percentage": 9.99,
      "compensation": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "compensation_reason_id": 1,
      "compensation_reason": "string",
      "compensation_note": "string",
      "tax_rate": {
        "id": 1,
        "name": "string",
        "percentage": 9.99,
        "kind": "string",
        "archived": true,
        "label": "string",
        "created_at": "2026-01-15T12:30:00Z",
        "updated_at": "2026-01-15T12:30:00Z"
      },
      "category_of_revenue": {
        "id": 1,
        "name": "string"
      },
      "cost_price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "unit_quantity": 1,
      "unit_name": "string",
      "course": 1,
      "preparation_state": "string",
      "representation_by": {
        "id": 1,
        "name": "string"
      },
      "own_use": true,
      "payment_status": "string",
      "refunded_item_id": 1,
      "voucher_card_id": 1,
      "kind": "sale",
      "voucher": {
        "id": 1,
        "name": "string"
      },
      "loyalty": {
        "id": 1,
        "name": "string"
      },
      "reservation": {
        "id": 1,
        "name": "string"
      },
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "customer": {
    "id": 1,
    "name": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "note": "string",
    "locale": "string",
    "pinned": true,
    "balance": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "temporary": true,
    "archived": true,
    "merged_into_id": 1,
    "group_ids": [
      1
    ],
    "last_receipt_at": "2026-01-15T12:30:00Z",
    "identifier": "string",
    "app_data": {},
    "created_at": "2026-01-15T12:30:00Z",
    "updated_at": "2026-01-15T12:30:00Z"
  },
  "payments": [
    {
      "id": 1,
      "receipt_id": 1,
      "payment_method_id": 1,
      "voucher_card_id": 1,
      "category_of_revenue": {
        "id": 1,
        "name": "string"
      },
      "kind": "payment",
      "voucher": {
        "id": 1,
        "name": "string"
      },
      "loyalty": {
        "id": 1,
        "name": "string"
      },
      "reservation": {
        "id": 1,
        "name": "string"
      },
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "total_amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "open_amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "discount_type": "string",
  "discount_percentage": 9.99,
  "absolute_discount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "guests_count": 1,
  "note": "string",
  "marker_ids": [
    1
  ],
  "paid_at": "2026-01-15T12:30:00Z",
  "voided_at": "2026-01-15T12:30:00Z",
  "voided_reason": "string",
  "refunded_receipt_id": 1,
  "daily_closing_id": 1,
  "pick_up_at": "2026-01-15T12:30:00Z",
  "reservation_id": 1,
  "opened_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
POST /v1/receipts/{receipt_id}/appendices receipt:write

Adds a line of text to the receipt's appendices. Appendices are printed at the bottom of the receipt, for example a reference to a transaction in your system.

Parameters

receipt_id path · integer req

Unique identifier of the receipt

Request body

appendix string req

Text to append to the receipt

{
  "appendix": "Loyalty points earned: 12"
}

Responses

201 Receipt Append an appendix to a receipt
Response attributes
id integer

Unique identifier of the receipt.

label string

Name of the receipt as shown on the register, for example the table, customer or a name typed in; prefixed with the pick-up time for takeout.

receiptable_type string

What the receipt is opened on: `table`, `customer`, `group`, `employee` (an employee ordering for themselves), `kiosk` or `app`.

receiptable_id integer

Unique identifier of the table, customer, group or employee the receipt is opened on.

items array of object

Line items on the receipt.

id integer

Unique identifier of the item.

product_id integer

Unique identifier of the ordered product; null for free-form items.

parent_id integer

Unique identifier of the item this item belongs to, for example a product option or a fee; null for top-level items.

description string

Description of the item as shown on the receipt.

note string

Note shown on the preparation receipt.

price Money

Unit price after discounts and compensation; this is what the guest pays.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

original_price Money

Unit price before discounts and compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

discount_percentage number

Discount percentage applied to the item, from a discount rule or the receipt discount; 0 without discount.

compensation Money

Amount taken off the item as compensation, for example for a cold dish; 0 without compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

compensation_reason_id integer

Unique identifier of the compensation reason; null without compensation.

compensation_reason string

Reason for the compensation, as set up in the back office; null without compensation.

compensation_note string

Note the employee added to the compensation.

tax_rate TaxRate

Tax rate applied to the item.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the item counts towards.

id integer

Unique identifier of the resource.

name string

Name of the resource.

cost_price Money

Cost price of the item.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

unit_quantity integer

Quantity sold of `unit_name`, for example 250 for 250 gram; null for items sold per piece.

unit_name string

Unit the item is sold per, for example `gram`; null for items sold per piece.

course integer

Course the item is served in, 0 for no course.

preparation_state string

Where the item is in preparation: `unrequested`, `requested`, `ready_to_prepare`, `preparing`, `prepared`, `ready_to_deliver` or `delivered`.

representation_by Reference

Employee the item was booked on as representation (on the house), if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

own_use boolean

Whether the item was booked as own use (consumed by staff or the business) instead of sold.

payment_status string

Payment status of the item: `open`, `pending` or `paid`.

refunded_item_id integer

On a return receipt: the item that was refunded; null otherwise.

voucher_card_id integer

Voucher card sold or topped up with the item (`GET /v1/voucher_cards/{id}`); null otherwise.

kind enum

`sale` for products and other items, `voucher` for a sold voucher card, `loyalty_topup` for balance topped up on a customer and `reservation_deposit` for a deposit paid on a reservation.

salevoucherloyalty_topupreservation_deposit

voucher Reference

Voucher sold with the item, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for top-up items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

created_at datetime

Time the item was added to the receipt.

updated_at datetime

Time the receipt item was last updated.

customer Customer

Customer the receipt belongs to, if any.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

payments array of Payment

Payments recorded on the receipt.

id integer

Unique identifier of the payment.

receipt_id integer

Unique identifier of the receipt the payment settles.

payment_method_id integer

Unique identifier of the payment method that was used.

voucher_card_id integer

Unique identifier of the voucher card the payment was made with; null for other payments.

category_of_revenue Reference

Category of revenue the payment counts towards, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

kind enum

`payment` for cash, card and other payment methods, `voucher` for a payment with a voucher card, `loyalty_balance` for a payment from a customer's balance and `reservation_deposit` for a paid deposit settled on the receipt.

paymentvoucherloyalty_balancereservation_deposit

voucher Reference

Voucher the payment was made with, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for balance payments.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit settlements.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount paid.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

created_at datetime

Time the payment was created.

updated_at datetime

Time the payment was last updated.

total_amount Money

Total of the items after discounts and compensations, excluding items booked as representation or own use.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

open_amount Money

Amount still to be paid.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

discount_type string

How a discount given on the whole receipt is expressed: `percentage` (see `discount_percentage`) or `absolute` (see `absolute_discount`).

discount_percentage number

Percentage discount given on the whole receipt, for example 10.0; 0 without one. Items get this or their own discount rule, whichever is higher.

absolute_discount Money

Amount taken off the whole receipt when `discount_type` is `absolute`, spread over the items.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

guests_count integer

Number of guests on the receipt; null when not registered.

note string

Note on the receipt, shown on the register.

marker_ids array of integer

Markers on the receipt, for example allergies or VIP (`GET /v1/markers`).

paid_at datetime

Time the receipt was paid in full; null while the receipt is open.

voided_at datetime

Time the receipt was voided; null unless voided. A voided receipt was cancelled and counts towards no revenue.

voided_reason string

Reason the employee gave for voiding the receipt.

refunded_receipt_id integer

For a return: the receipt whose items were refunded; null for regular receipts.

daily_closing_id integer

Daily closing the receipt was settled in; null until the day is closed.

pick_up_at datetime

Pick-up moment for takeout receipts; null otherwise.

reservation_id integer

Unique identifier of the reservation checked in on this receipt.

opened_at datetime

Time the receipt was opened.

created_at datetime

Time the receipt was created.

updated_at datetime

Time the receipt was last updated.

Example response
{
  "id": 1,
  "label": "string",
  "receiptable_type": "string",
  "receiptable_id": 1,
  "items": [
    {
      "id": 1,
      "product_id": 1,
      "parent_id": 1,
      "description": "string",
      "note": "string",
      "price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "original_price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "discount_percentage": 9.99,
      "compensation": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "compensation_reason_id": 1,
      "compensation_reason": "string",
      "compensation_note": "string",
      "tax_rate": {
        "id": 1,
        "name": "string",
        "percentage": 9.99,
        "kind": "string",
        "archived": true,
        "label": "string",
        "created_at": "2026-01-15T12:30:00Z",
        "updated_at": "2026-01-15T12:30:00Z"
      },
      "category_of_revenue": {
        "id": 1,
        "name": "string"
      },
      "cost_price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "unit_quantity": 1,
      "unit_name": "string",
      "course": 1,
      "preparation_state": "string",
      "representation_by": {
        "id": 1,
        "name": "string"
      },
      "own_use": true,
      "payment_status": "string",
      "refunded_item_id": 1,
      "voucher_card_id": 1,
      "kind": "sale",
      "voucher": {
        "id": 1,
        "name": "string"
      },
      "loyalty": {
        "id": 1,
        "name": "string"
      },
      "reservation": {
        "id": 1,
        "name": "string"
      },
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "customer": {
    "id": 1,
    "name": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "note": "string",
    "locale": "string",
    "pinned": true,
    "balance": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "temporary": true,
    "archived": true,
    "merged_into_id": 1,
    "group_ids": [
      1
    ],
    "last_receipt_at": "2026-01-15T12:30:00Z",
    "identifier": "string",
    "app_data": {},
    "created_at": "2026-01-15T12:30:00Z",
    "updated_at": "2026-01-15T12:30:00Z"
  },
  "payments": [
    {
      "id": 1,
      "receipt_id": 1,
      "payment_method_id": 1,
      "voucher_card_id": 1,
      "category_of_revenue": {
        "id": 1,
        "name": "string"
      },
      "kind": "payment",
      "voucher": {
        "id": 1,
        "name": "string"
      },
      "loyalty": {
        "id": 1,
        "name": "string"
      },
      "reservation": {
        "id": 1,
        "name": "string"
      },
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "total_amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "open_amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "discount_type": "string",
  "discount_percentage": 9.99,
  "absolute_discount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "guests_count": 1,
  "note": "string",
  "marker_ids": [
    1
  ],
  "paid_at": "2026-01-15T12:30:00Z",
  "voided_at": "2026-01-15T12:30:00Z",
  "voided_reason": "string",
  "refunded_receipt_id": 1,
  "daily_closing_id": 1,
  "pick_up_at": "2026-01-15T12:30:00Z",
  "reservation_id": 1,
  "opened_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Reports

GET /v1/reports/balance_sheet report:read

Returns the mutations per ledger account in the period: revenue, payments, and liabilities such as vouchers, deposits and loyalty balances.

Parameters

from query · date req

First day of the period

to query · date req

Last day of the period, at most 366 days after `from`

Responses

200 ReportBalanceSheet Balance sheet
Response attributes
revenue array of object

Mutations per ledger account.

ledger_account_id integer

Unique identifier of the ledger account.

name string

Name of the ledger account.

amount Money

Sum of the mutations.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

payments array of object

Mutations per ledger account.

ledger_account_id integer

Unique identifier of the ledger account.

name string

Name of the ledger account.

amount Money

Sum of the mutations.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

liability_credits array of object

Mutations per ledger account.

ledger_account_id integer

Unique identifier of the ledger account.

name string

Name of the ledger account.

amount Money

Sum of the mutations.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

liability_debits array of object

Mutations per ledger account.

ledger_account_id integer

Unique identifier of the ledger account.

name string

Name of the ledger account.

amount Money

Sum of the mutations.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

Example response
{
  "revenue": [
    {
      "ledger_account_id": 1,
      "name": "string",
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      }
    }
  ],
  "payments": [
    {
      "ledger_account_id": 1,
      "name": "string",
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      }
    }
  ],
  "liability_credits": [
    {
      "ledger_account_id": 1,
      "name": "string",
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      }
    }
  ],
  "liability_debits": [
    {
      "ledger_account_id": 1,
      "name": "string",
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      }
    }
  ]
}
GET /v1/reports/exceptions report:read

Returns the items given away (`representation`), the items removed after ordering (`removed_items`) or the voided receipts (`voided_receipts`) in the period, with the employee responsible.

Parameters

from query · date req

First day of the period

to query · date req

Last day of the period, at most 366 days after `from`

option query · enum

Which exceptions to return

representationremoved_itemsvoided_receipts default representation

Responses

200 array of ReportExceptionRow Exceptions report
Response attributes
receipt_id integer

Unique identifier of the receipt.

customer string

Table, customer or group of the receipt.

description string

The item; null for a voided receipt.

price Money

Price of the item, or the total of the voided receipt.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

employee string

Employee who gave away, removed or voided it.

at datetime

Time it was removed or voided; null for items given away.

Example response
[
  {
    "receipt_id": 1,
    "customer": "string",
    "description": "string",
    "price": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "employee": "string",
    "at": "2026-01-15T12:30:00Z"
  }
]
GET /v1/reports/overview report:read

Returns the revenue, cashflow and number of receipts in the period, and the same figures for the period of equal length before it.

Parameters

from query · date req

First day of the period

to query · date req

Last day of the period, at most 366 days after `from`

Responses

200 ReportOverview Overview report
Response attributes
from date

First day of the period.

to date

Last day of the period.

total_revenue Money

Revenue including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

total_cashflow Money

Money received.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

receipts_count integer

Number of receipts.

comparison object

The period of the same length before it.

from date

First day of the period.

to date

Last day of the period.

total_revenue Money

Revenue including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

total_cashflow Money

Money received.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

Example response
{
  "from": "2026-01-15",
  "to": "2026-01-15",
  "total_revenue": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "total_cashflow": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "receipts_count": 1,
  "comparison": {
    "from": "2026-01-15",
    "to": "2026-01-15",
    "total_revenue": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "total_cashflow": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    }
  }
}
GET /v1/reports/revenue report:read

Returns the revenue in the period per category of revenue, device, employee or shop.

Parameters

from query · date req

First day of the period

to query · date req

Last day of the period, at most 366 days after `from`

group_by query · enum

What to break the revenue down by

category_of_revenuedeviceemployeeshop default category_of_revenue

Responses

200 array of ReportRevenueRow Revenue report
Response attributes
source_id integer

Unique identifier of the category of revenue, device, employee or shop, depending on `group_by`.

source string

Its name.

revenue Money

Revenue including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

Example response
[
  {
    "source_id": 1,
    "source": "string",
    "revenue": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    }
  }
]
GET /v1/reports/revenue_per_day report:read

Returns the revenue per day closing for each category of revenue, for example to draw a chart.

Parameters

from query · date req

First day of the period

to query · date req

Last day of the period, at most 366 days after `from`

Responses

200 array of ReportRevenueSeries Revenue per day
Response attributes
category_of_revenue_id integer

Unique identifier of the category of revenue.

name string

Name of the category of revenue.

days array of object

Revenue per day closing.

date date

Date of the day closing.

revenue Money

Revenue including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

Example response
[
  {
    "category_of_revenue_id": 1,
    "name": "string",
    "days": [
      {
        "date": "2026-01-15",
        "revenue": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        }
      }
    ]
  }
]
GET /v1/reports/sales report:read

Returns what was sold in the period by day closing, with the options chosen and the revenue, most sold first. Filter by preparation location, product category or device.

Parameters

from query · date req

First day of the period

to query · date req

Last day of the period, at most 366 days after `from`

preparation_location_ids query · array of integer

Only items prepared at these locations

product_category_ids query · array of integer

Only products in these categories

device_ids query · array of integer

Only items ordered on these devices

Responses

200 array of ReportSalesRow Sales report
Response attributes
label string

Name of the product or item as it was sold.

count integer

Number of times it was sold.

options string

Options chosen with it and how often, for example `Large (12x)|||Small (3x)`; null when none.

total_price Money

Revenue including options and VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

Example response
[
  {
    "label": "string",
    "count": 1,
    "options": "string",
    "total_price": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    }
  }
]
GET /v1/reports/tax report:read

Returns the revenue and VAT in the period per tax rate.

Parameters

from query · date req

First day of the period

to query · date req

Last day of the period, at most 366 days after `from`

Responses

200 ReportTax Tax report
Response attributes
total_revenue Money

Revenue including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

total_tax Money

VAT over the revenue.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

rates array of object

Revenue and VAT per tax rate.

tax_rate_id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

revenue Money

Revenue including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

net_revenue Money

Revenue excluding VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_amount Money

VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

Example response
{
  "total_revenue": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "total_tax": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "rates": [
    {
      "tax_rate_id": 1,
      "name": "string",
      "percentage": 9.99,
      "revenue": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "net_revenue": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "tax_amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      }
    }
  ]
}

Reservations

GET /v1/reservations reservation:read

Returns the reservations starting on `date`, or between `from` and `to` (inclusive, at most 31 days). Blocks (reservations with a `party_size` of 0) are excluded unless `include_blocks` is set.

Parameters

date query · date

Day to list reservations for; defaults to today

from query · date

First day of the range

to query · date

Last day of the range

status query · array of enum

Only reservations with these statuses

pending_paymentrequestedoptionconfirmedpartially_seatedseatedcompletedcancelleddeclinedno_show

customer_id query · integer

Only reservations of this customer

include_blocks query · boolean

Include blocks

default false

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Reservation List reservations
Response attributes

The items on this page.

id integer

Unique identifier of the reservation.

status string

One of `pending_payment`, `requested`, `option`, `confirmed`, `partially_seated`, `seated`, `completed`, `cancelled`, `declined`, `no_show`.

source string

Channel the reservation came in through: `online`, `agent`, `manual`, `phone`, `email`, `walk_in`.

starts_at datetime

Time the reservation starts.

ends_at datetime

Time the reserved tables are free again.

party_size integer

Number of guests; 0 for a block.

arrived_party_size integer

Number of guests that arrived; null until check-in.

customer Customer

Guest the reservation is for; absent for blocks.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

table_ids array of integer

Unique identifiers of the assigned tables.

kinds array of object

Reservation kinds booked, with the guests per kind.

reservation_kind_id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

party_size integer

Number of guests booked for this kind.

note string

Note from the guest.

receipt_note string

Note copied to the receipt and kitchen at check-in.

marker_ids array of integer

Markers (for example allergies or a birthday) copied to the receipt and kitchen at check-in.

receipt_id integer

Unique identifier of the receipt opened at check-in; null before check-in.

deposit_per_person Money

Deposit charged per guest; null when no deposit is required.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

deposit_persons integer

Number of guests the deposit is charged for.

deposit_due_at datetime

Time the deposit must be paid by.

deposit_paid_at datetime

Time the deposit was paid.

deposit_applied_at datetime

Time the paid deposit was settled on the receipt at check-in.

deposit_refunded_at datetime

Time the paid deposit was refunded, for example after a timely cancellation.

deposit_forfeited_at datetime

Time the paid deposit was kept because of a late cancellation or no-show.

confirmed_at datetime

Time the reservation was confirmed.

cancelled_at datetime

Time the reservation was cancelled.

seated_at datetime

Time the guests were checked in.

created_at datetime

Time the reservation was created.

updated_at datetime

Time the reservation was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "status": "string",
      "source": "string",
      "starts_at": "2026-01-15T12:30:00Z",
      "ends_at": "2026-01-15T12:30:00Z",
      "party_size": 1,
      "arrived_party_size": 1,
      "customer": {
        "id": 1,
        "name": "string",
        "email": "string",
        "phone": "string",
        "address": "string",
        "note": "string",
        "locale": "string",
        "pinned": true,
        "balance": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "temporary": true,
        "archived": true,
        "merged_into_id": 1,
        "group_ids": [
          1
        ],
        "last_receipt_at": "2026-01-15T12:30:00Z",
        "identifier": "string",
        "app_data": {},
        "created_at": "2026-01-15T12:30:00Z",
        "updated_at": "2026-01-15T12:30:00Z"
      },
      "table_ids": [
        1
      ],
      "kinds": [
        {
          "reservation_kind_id": 1,
          "name": "string",
          "party_size": 1
        }
      ],
      "note": "string",
      "receipt_note": "string",
      "marker_ids": [
        1
      ],
      "receipt_id": 1,
      "deposit_per_person": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "deposit_persons": 1,
      "deposit_due_at": "2026-01-15T12:30:00Z",
      "deposit_paid_at": "2026-01-15T12:30:00Z",
      "deposit_applied_at": "2026-01-15T12:30:00Z",
      "deposit_refunded_at": "2026-01-15T12:30:00Z",
      "deposit_forfeited_at": "2026-01-15T12:30:00Z",
      "confirmed_at": "2026-01-15T12:30:00Z",
      "cancelled_at": "2026-01-15T12:30:00Z",
      "seated_at": "2026-01-15T12:30:00Z",
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/reservations reservation:write

Creates a reservation for an existing customer (`customer_id`) or a new or matching one (`customer`, matched by email address). With `source` set to `online` the reservation is booked the way a guest books it: the start time must be available, tables are assigned automatically, a deposit is requested when the window requires one and the guest receives the confirmation mail. Any other source books it like staff does: `table_ids` are assigned as given and `status` is `confirmed` or `option`.

Request body

starts_at datetime req

Start time

ends_at datetime

End time; defaults to the duration configured for the party size

party_size integer req

Number of guests

customer_id integer

Unique identifier of the customer

customer object

Guest details, used when no `customer_id` is given

name string req

Full name

email string

Email address, used to find an existing customer

phone string

Phone number

source enum

Channel the reservation came in through

onlinemanualphoneemailwalk_in default manual

status enum

Initial status; ignored for `online` reservations

confirmedoption default confirmed

table_ids array of integer

Tables to assign; ignored for `online` reservations

reservation_kind_id integer

Reservation kind to book

note string

Note from the guest

receipt_note string

Note copied to the receipt and kitchen at check-in

marker_ids array of integer

Markers copied to the receipt and kitchen at check-in, for example an allergy or a birthday (see `GET /v1/markers`)

{
  "starts_at": "2026-11-20T19:00:00+01:00",
  "party_size": 4,
  "customer": {
    "name": "Jan de Vries",
    "email": "jan@example.com",
    "phone": "+31612345678"
  },
  "source": "phone",
  "note": "Birthday"
}

Responses

201 Reservation Create a reservation
Response attributes
id integer

Unique identifier of the reservation.

status string

One of `pending_payment`, `requested`, `option`, `confirmed`, `partially_seated`, `seated`, `completed`, `cancelled`, `declined`, `no_show`.

source string

Channel the reservation came in through: `online`, `agent`, `manual`, `phone`, `email`, `walk_in`.

starts_at datetime

Time the reservation starts.

ends_at datetime

Time the reserved tables are free again.

party_size integer

Number of guests; 0 for a block.

arrived_party_size integer

Number of guests that arrived; null until check-in.

customer Customer

Guest the reservation is for; absent for blocks.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

table_ids array of integer

Unique identifiers of the assigned tables.

kinds array of object

Reservation kinds booked, with the guests per kind.

reservation_kind_id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

party_size integer

Number of guests booked for this kind.

note string

Note from the guest.

receipt_note string

Note copied to the receipt and kitchen at check-in.

marker_ids array of integer

Markers (for example allergies or a birthday) copied to the receipt and kitchen at check-in.

receipt_id integer

Unique identifier of the receipt opened at check-in; null before check-in.

deposit_per_person Money

Deposit charged per guest; null when no deposit is required.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

deposit_persons integer

Number of guests the deposit is charged for.

deposit_due_at datetime

Time the deposit must be paid by.

deposit_paid_at datetime

Time the deposit was paid.

deposit_applied_at datetime

Time the paid deposit was settled on the receipt at check-in.

deposit_refunded_at datetime

Time the paid deposit was refunded, for example after a timely cancellation.

deposit_forfeited_at datetime

Time the paid deposit was kept because of a late cancellation or no-show.

confirmed_at datetime

Time the reservation was confirmed.

cancelled_at datetime

Time the reservation was cancelled.

seated_at datetime

Time the guests were checked in.

created_at datetime

Time the reservation was created.

updated_at datetime

Time the reservation was last updated.

Example response
{
  "id": 1,
  "status": "string",
  "source": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "party_size": 1,
  "arrived_party_size": 1,
  "customer": {
    "id": 1,
    "name": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "note": "string",
    "locale": "string",
    "pinned": true,
    "balance": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "temporary": true,
    "archived": true,
    "merged_into_id": 1,
    "group_ids": [
      1
    ],
    "last_receipt_at": "2026-01-15T12:30:00Z",
    "identifier": "string",
    "app_data": {},
    "created_at": "2026-01-15T12:30:00Z",
    "updated_at": "2026-01-15T12:30:00Z"
  },
  "table_ids": [
    1
  ],
  "kinds": [
    {
      "reservation_kind_id": 1,
      "name": "string",
      "party_size": 1
    }
  ],
  "note": "string",
  "receipt_note": "string",
  "marker_ids": [
    1
  ],
  "receipt_id": 1,
  "deposit_per_person": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "deposit_persons": 1,
  "deposit_due_at": "2026-01-15T12:30:00Z",
  "deposit_paid_at": "2026-01-15T12:30:00Z",
  "deposit_applied_at": "2026-01-15T12:30:00Z",
  "deposit_refunded_at": "2026-01-15T12:30:00Z",
  "deposit_forfeited_at": "2026-01-15T12:30:00Z",
  "confirmed_at": "2026-01-15T12:30:00Z",
  "cancelled_at": "2026-01-15T12:30:00Z",
  "seated_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/reservations/availability reservation:read

Returns the start times guests can book online on the given day for the given party size, applying the reservation program's windows, lead time, capacity and table availability.

Parameters

date query · date req

Day to check

party_size query · integer req

Number of guests

reservation_kind_id query · array of integer

Reservation kinds the guests want to book

Responses

200 ReservationAvailability List available start times
Response attributes
date date

Day the availability is for.

party_size integer

Number of guests the availability is for.

closed_by_lead_time boolean

Whether the remaining start times are too soon to book.

slots array of object

Bookable start times.

starts_at datetime

Start time.

deposit_per_person Money

Deposit charged per guest when booking this start time; null without a deposit.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

reservation_kind_ids array of integer

Reservation kinds bookable at this start time.

kind_required boolean

Whether a reservation kind must be picked for this start time.

Example response
{
  "date": "2026-01-15",
  "party_size": 1,
  "closed_by_lead_time": true,
  "slots": [
    {
      "starts_at": "2026-01-15T12:30:00Z",
      "deposit_per_person": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "reservation_kind_ids": [
        1
      ],
      "kind_required": true
    }
  ]
}
GET /v1/reservations/{id} reservation:read

Retrieve a reservation

Parameters

id path · integer req

Unique identifier of the reservation

Responses

200 Reservation Retrieve a reservation
Response attributes
id integer

Unique identifier of the reservation.

status string

One of `pending_payment`, `requested`, `option`, `confirmed`, `partially_seated`, `seated`, `completed`, `cancelled`, `declined`, `no_show`.

source string

Channel the reservation came in through: `online`, `agent`, `manual`, `phone`, `email`, `walk_in`.

starts_at datetime

Time the reservation starts.

ends_at datetime

Time the reserved tables are free again.

party_size integer

Number of guests; 0 for a block.

arrived_party_size integer

Number of guests that arrived; null until check-in.

customer Customer

Guest the reservation is for; absent for blocks.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

table_ids array of integer

Unique identifiers of the assigned tables.

kinds array of object

Reservation kinds booked, with the guests per kind.

reservation_kind_id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

party_size integer

Number of guests booked for this kind.

note string

Note from the guest.

receipt_note string

Note copied to the receipt and kitchen at check-in.

marker_ids array of integer

Markers (for example allergies or a birthday) copied to the receipt and kitchen at check-in.

receipt_id integer

Unique identifier of the receipt opened at check-in; null before check-in.

deposit_per_person Money

Deposit charged per guest; null when no deposit is required.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

deposit_persons integer

Number of guests the deposit is charged for.

deposit_due_at datetime

Time the deposit must be paid by.

deposit_paid_at datetime

Time the deposit was paid.

deposit_applied_at datetime

Time the paid deposit was settled on the receipt at check-in.

deposit_refunded_at datetime

Time the paid deposit was refunded, for example after a timely cancellation.

deposit_forfeited_at datetime

Time the paid deposit was kept because of a late cancellation or no-show.

confirmed_at datetime

Time the reservation was confirmed.

cancelled_at datetime

Time the reservation was cancelled.

seated_at datetime

Time the guests were checked in.

created_at datetime

Time the reservation was created.

updated_at datetime

Time the reservation was last updated.

Example response
{
  "id": 1,
  "status": "string",
  "source": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "party_size": 1,
  "arrived_party_size": 1,
  "customer": {
    "id": 1,
    "name": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "note": "string",
    "locale": "string",
    "pinned": true,
    "balance": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "temporary": true,
    "archived": true,
    "merged_into_id": 1,
    "group_ids": [
      1
    ],
    "last_receipt_at": "2026-01-15T12:30:00Z",
    "identifier": "string",
    "app_data": {},
    "created_at": "2026-01-15T12:30:00Z",
    "updated_at": "2026-01-15T12:30:00Z"
  },
  "table_ids": [
    1
  ],
  "kinds": [
    {
      "reservation_kind_id": 1,
      "name": "string",
      "party_size": 1
    }
  ],
  "note": "string",
  "receipt_note": "string",
  "marker_ids": [
    1
  ],
  "receipt_id": 1,
  "deposit_per_person": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "deposit_persons": 1,
  "deposit_due_at": "2026-01-15T12:30:00Z",
  "deposit_paid_at": "2026-01-15T12:30:00Z",
  "deposit_applied_at": "2026-01-15T12:30:00Z",
  "deposit_refunded_at": "2026-01-15T12:30:00Z",
  "deposit_forfeited_at": "2026-01-15T12:30:00Z",
  "confirmed_at": "2026-01-15T12:30:00Z",
  "cancelled_at": "2026-01-15T12:30:00Z",
  "seated_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/reservations/{id} reservation:write

Updates the given attributes; attributes that are not included keep their current value. Moving `starts_at` without `ends_at` keeps the length of the reservation. Passing `table_ids` or `marker_ids` replaces the assigned tables or markers.

Parameters

id path · integer req

Unique identifier of the reservation

Request body

starts_at datetime

Start time

ends_at datetime

End time

party_size integer

Number of guests

table_ids array of integer

Tables to assign

reservation_kind_id integer

Reservation kind to book

note string

Note from the guest

receipt_note string

Note copied to the receipt and kitchen at check-in

marker_ids array of integer

Markers copied to the receipt and kitchen at check-in, for example an allergy or a birthday (see `GET /v1/markers`)

{
  "party_size": 6,
  "table_ids": [
    12,
    13
  ]
}

Responses

200 Reservation Update a reservation
Response attributes
id integer

Unique identifier of the reservation.

status string

One of `pending_payment`, `requested`, `option`, `confirmed`, `partially_seated`, `seated`, `completed`, `cancelled`, `declined`, `no_show`.

source string

Channel the reservation came in through: `online`, `agent`, `manual`, `phone`, `email`, `walk_in`.

starts_at datetime

Time the reservation starts.

ends_at datetime

Time the reserved tables are free again.

party_size integer

Number of guests; 0 for a block.

arrived_party_size integer

Number of guests that arrived; null until check-in.

customer Customer

Guest the reservation is for; absent for blocks.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

table_ids array of integer

Unique identifiers of the assigned tables.

kinds array of object

Reservation kinds booked, with the guests per kind.

reservation_kind_id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

party_size integer

Number of guests booked for this kind.

note string

Note from the guest.

receipt_note string

Note copied to the receipt and kitchen at check-in.

marker_ids array of integer

Markers (for example allergies or a birthday) copied to the receipt and kitchen at check-in.

receipt_id integer

Unique identifier of the receipt opened at check-in; null before check-in.

deposit_per_person Money

Deposit charged per guest; null when no deposit is required.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

deposit_persons integer

Number of guests the deposit is charged for.

deposit_due_at datetime

Time the deposit must be paid by.

deposit_paid_at datetime

Time the deposit was paid.

deposit_applied_at datetime

Time the paid deposit was settled on the receipt at check-in.

deposit_refunded_at datetime

Time the paid deposit was refunded, for example after a timely cancellation.

deposit_forfeited_at datetime

Time the paid deposit was kept because of a late cancellation or no-show.

confirmed_at datetime

Time the reservation was confirmed.

cancelled_at datetime

Time the reservation was cancelled.

seated_at datetime

Time the guests were checked in.

created_at datetime

Time the reservation was created.

updated_at datetime

Time the reservation was last updated.

Example response
{
  "id": 1,
  "status": "string",
  "source": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "party_size": 1,
  "arrived_party_size": 1,
  "customer": {
    "id": 1,
    "name": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "note": "string",
    "locale": "string",
    "pinned": true,
    "balance": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "temporary": true,
    "archived": true,
    "merged_into_id": 1,
    "group_ids": [
      1
    ],
    "last_receipt_at": "2026-01-15T12:30:00Z",
    "identifier": "string",
    "app_data": {},
    "created_at": "2026-01-15T12:30:00Z",
    "updated_at": "2026-01-15T12:30:00Z"
  },
  "table_ids": [
    1
  ],
  "kinds": [
    {
      "reservation_kind_id": 1,
      "name": "string",
      "party_size": 1
    }
  ],
  "note": "string",
  "receipt_note": "string",
  "marker_ids": [
    1
  ],
  "receipt_id": 1,
  "deposit_per_person": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "deposit_persons": 1,
  "deposit_due_at": "2026-01-15T12:30:00Z",
  "deposit_paid_at": "2026-01-15T12:30:00Z",
  "deposit_applied_at": "2026-01-15T12:30:00Z",
  "deposit_refunded_at": "2026-01-15T12:30:00Z",
  "deposit_forfeited_at": "2026-01-15T12:30:00Z",
  "confirmed_at": "2026-01-15T12:30:00Z",
  "cancelled_at": "2026-01-15T12:30:00Z",
  "seated_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
POST /v1/reservations/{id}/cancellation reservation:write

Cancels the reservation and mails the guest. A paid deposit is refunded when cancelled in time, and forfeited otherwise.

Parameters

id path · integer req

Unique identifier of the reservation

Responses

201 Reservation Cancel a reservation
Response attributes
id integer

Unique identifier of the reservation.

status string

One of `pending_payment`, `requested`, `option`, `confirmed`, `partially_seated`, `seated`, `completed`, `cancelled`, `declined`, `no_show`.

source string

Channel the reservation came in through: `online`, `agent`, `manual`, `phone`, `email`, `walk_in`.

starts_at datetime

Time the reservation starts.

ends_at datetime

Time the reserved tables are free again.

party_size integer

Number of guests; 0 for a block.

arrived_party_size integer

Number of guests that arrived; null until check-in.

customer Customer

Guest the reservation is for; absent for blocks.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

table_ids array of integer

Unique identifiers of the assigned tables.

kinds array of object

Reservation kinds booked, with the guests per kind.

reservation_kind_id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

party_size integer

Number of guests booked for this kind.

note string

Note from the guest.

receipt_note string

Note copied to the receipt and kitchen at check-in.

marker_ids array of integer

Markers (for example allergies or a birthday) copied to the receipt and kitchen at check-in.

receipt_id integer

Unique identifier of the receipt opened at check-in; null before check-in.

deposit_per_person Money

Deposit charged per guest; null when no deposit is required.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

deposit_persons integer

Number of guests the deposit is charged for.

deposit_due_at datetime

Time the deposit must be paid by.

deposit_paid_at datetime

Time the deposit was paid.

deposit_applied_at datetime

Time the paid deposit was settled on the receipt at check-in.

deposit_refunded_at datetime

Time the paid deposit was refunded, for example after a timely cancellation.

deposit_forfeited_at datetime

Time the paid deposit was kept because of a late cancellation or no-show.

confirmed_at datetime

Time the reservation was confirmed.

cancelled_at datetime

Time the reservation was cancelled.

seated_at datetime

Time the guests were checked in.

created_at datetime

Time the reservation was created.

updated_at datetime

Time the reservation was last updated.

Example response
{
  "id": 1,
  "status": "string",
  "source": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "party_size": 1,
  "arrived_party_size": 1,
  "customer": {
    "id": 1,
    "name": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "note": "string",
    "locale": "string",
    "pinned": true,
    "balance": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "temporary": true,
    "archived": true,
    "merged_into_id": 1,
    "group_ids": [
      1
    ],
    "last_receipt_at": "2026-01-15T12:30:00Z",
    "identifier": "string",
    "app_data": {},
    "created_at": "2026-01-15T12:30:00Z",
    "updated_at": "2026-01-15T12:30:00Z"
  },
  "table_ids": [
    1
  ],
  "kinds": [
    {
      "reservation_kind_id": 1,
      "name": "string",
      "party_size": 1
    }
  ],
  "note": "string",
  "receipt_note": "string",
  "marker_ids": [
    1
  ],
  "receipt_id": 1,
  "deposit_per_person": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "deposit_persons": 1,
  "deposit_due_at": "2026-01-15T12:30:00Z",
  "deposit_paid_at": "2026-01-15T12:30:00Z",
  "deposit_applied_at": "2026-01-15T12:30:00Z",
  "deposit_refunded_at": "2026-01-15T12:30:00Z",
  "deposit_forfeited_at": "2026-01-15T12:30:00Z",
  "confirmed_at": "2026-01-15T12:30:00Z",
  "cancelled_at": "2026-01-15T12:30:00Z",
  "seated_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
POST /v1/reservations/{id}/check_in reservation:write

Seats the guests: opens (or reuses) a receipt on the table, copies the notes and applies the deposit. Checking in again on a seated reservation updates the number of arrived guests.

Parameters

id path · integer req

Unique identifier of the reservation

Request body

table_id integer

Table to seat the guests at; defaults to the first assigned table

arrived_party_size integer

Number of guests that arrived; defaults to the party size

use_existing_receipt boolean

Add to the table's open receipt instead of opening a new one

default true

{
  "table_id": 12,
  "arrived_party_size": 5
}

Responses

201 Reservation Check in a reservation
Response attributes
id integer

Unique identifier of the reservation.

status string

One of `pending_payment`, `requested`, `option`, `confirmed`, `partially_seated`, `seated`, `completed`, `cancelled`, `declined`, `no_show`.

source string

Channel the reservation came in through: `online`, `agent`, `manual`, `phone`, `email`, `walk_in`.

starts_at datetime

Time the reservation starts.

ends_at datetime

Time the reserved tables are free again.

party_size integer

Number of guests; 0 for a block.

arrived_party_size integer

Number of guests that arrived; null until check-in.

customer Customer

Guest the reservation is for; absent for blocks.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

table_ids array of integer

Unique identifiers of the assigned tables.

kinds array of object

Reservation kinds booked, with the guests per kind.

reservation_kind_id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

party_size integer

Number of guests booked for this kind.

note string

Note from the guest.

receipt_note string

Note copied to the receipt and kitchen at check-in.

marker_ids array of integer

Markers (for example allergies or a birthday) copied to the receipt and kitchen at check-in.

receipt_id integer

Unique identifier of the receipt opened at check-in; null before check-in.

deposit_per_person Money

Deposit charged per guest; null when no deposit is required.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

deposit_persons integer

Number of guests the deposit is charged for.

deposit_due_at datetime

Time the deposit must be paid by.

deposit_paid_at datetime

Time the deposit was paid.

deposit_applied_at datetime

Time the paid deposit was settled on the receipt at check-in.

deposit_refunded_at datetime

Time the paid deposit was refunded, for example after a timely cancellation.

deposit_forfeited_at datetime

Time the paid deposit was kept because of a late cancellation or no-show.

confirmed_at datetime

Time the reservation was confirmed.

cancelled_at datetime

Time the reservation was cancelled.

seated_at datetime

Time the guests were checked in.

created_at datetime

Time the reservation was created.

updated_at datetime

Time the reservation was last updated.

Example response
{
  "id": 1,
  "status": "string",
  "source": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "party_size": 1,
  "arrived_party_size": 1,
  "customer": {
    "id": 1,
    "name": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "note": "string",
    "locale": "string",
    "pinned": true,
    "balance": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "temporary": true,
    "archived": true,
    "merged_into_id": 1,
    "group_ids": [
      1
    ],
    "last_receipt_at": "2026-01-15T12:30:00Z",
    "identifier": "string",
    "app_data": {},
    "created_at": "2026-01-15T12:30:00Z",
    "updated_at": "2026-01-15T12:30:00Z"
  },
  "table_ids": [
    1
  ],
  "kinds": [
    {
      "reservation_kind_id": 1,
      "name": "string",
      "party_size": 1
    }
  ],
  "note": "string",
  "receipt_note": "string",
  "marker_ids": [
    1
  ],
  "receipt_id": 1,
  "deposit_per_person": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "deposit_persons": 1,
  "deposit_due_at": "2026-01-15T12:30:00Z",
  "deposit_paid_at": "2026-01-15T12:30:00Z",
  "deposit_applied_at": "2026-01-15T12:30:00Z",
  "deposit_refunded_at": "2026-01-15T12:30:00Z",
  "deposit_forfeited_at": "2026-01-15T12:30:00Z",
  "confirmed_at": "2026-01-15T12:30:00Z",
  "cancelled_at": "2026-01-15T12:30:00Z",
  "seated_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/reservations/{id}/check_in reservation:write

Voids the receipt opened at check-in and returns the reservation to `confirmed`. Only possible while nothing was ordered or paid on the receipt.

Parameters

id path · integer req

Unique identifier of the reservation

Responses

200 Reservation Undo a check-in
Response attributes
id integer

Unique identifier of the reservation.

status string

One of `pending_payment`, `requested`, `option`, `confirmed`, `partially_seated`, `seated`, `completed`, `cancelled`, `declined`, `no_show`.

source string

Channel the reservation came in through: `online`, `agent`, `manual`, `phone`, `email`, `walk_in`.

starts_at datetime

Time the reservation starts.

ends_at datetime

Time the reserved tables are free again.

party_size integer

Number of guests; 0 for a block.

arrived_party_size integer

Number of guests that arrived; null until check-in.

customer Customer

Guest the reservation is for; absent for blocks.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

table_ids array of integer

Unique identifiers of the assigned tables.

kinds array of object

Reservation kinds booked, with the guests per kind.

reservation_kind_id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

party_size integer

Number of guests booked for this kind.

note string

Note from the guest.

receipt_note string

Note copied to the receipt and kitchen at check-in.

marker_ids array of integer

Markers (for example allergies or a birthday) copied to the receipt and kitchen at check-in.

receipt_id integer

Unique identifier of the receipt opened at check-in; null before check-in.

deposit_per_person Money

Deposit charged per guest; null when no deposit is required.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

deposit_persons integer

Number of guests the deposit is charged for.

deposit_due_at datetime

Time the deposit must be paid by.

deposit_paid_at datetime

Time the deposit was paid.

deposit_applied_at datetime

Time the paid deposit was settled on the receipt at check-in.

deposit_refunded_at datetime

Time the paid deposit was refunded, for example after a timely cancellation.

deposit_forfeited_at datetime

Time the paid deposit was kept because of a late cancellation or no-show.

confirmed_at datetime

Time the reservation was confirmed.

cancelled_at datetime

Time the reservation was cancelled.

seated_at datetime

Time the guests were checked in.

created_at datetime

Time the reservation was created.

updated_at datetime

Time the reservation was last updated.

Example response
{
  "id": 1,
  "status": "string",
  "source": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "party_size": 1,
  "arrived_party_size": 1,
  "customer": {
    "id": 1,
    "name": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "note": "string",
    "locale": "string",
    "pinned": true,
    "balance": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "temporary": true,
    "archived": true,
    "merged_into_id": 1,
    "group_ids": [
      1
    ],
    "last_receipt_at": "2026-01-15T12:30:00Z",
    "identifier": "string",
    "app_data": {},
    "created_at": "2026-01-15T12:30:00Z",
    "updated_at": "2026-01-15T12:30:00Z"
  },
  "table_ids": [
    1
  ],
  "kinds": [
    {
      "reservation_kind_id": 1,
      "name": "string",
      "party_size": 1
    }
  ],
  "note": "string",
  "receipt_note": "string",
  "marker_ids": [
    1
  ],
  "receipt_id": 1,
  "deposit_per_person": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "deposit_persons": 1,
  "deposit_due_at": "2026-01-15T12:30:00Z",
  "deposit_paid_at": "2026-01-15T12:30:00Z",
  "deposit_applied_at": "2026-01-15T12:30:00Z",
  "deposit_refunded_at": "2026-01-15T12:30:00Z",
  "deposit_forfeited_at": "2026-01-15T12:30:00Z",
  "confirmed_at": "2026-01-15T12:30:00Z",
  "cancelled_at": "2026-01-15T12:30:00Z",
  "seated_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
POST /v1/reservations/{id}/confirmation reservation:write

Confirms a requested reservation or option and mails the guest.

Parameters

id path · integer req

Unique identifier of the reservation

Responses

201 Reservation Confirm a reservation
Response attributes
id integer

Unique identifier of the reservation.

status string

One of `pending_payment`, `requested`, `option`, `confirmed`, `partially_seated`, `seated`, `completed`, `cancelled`, `declined`, `no_show`.

source string

Channel the reservation came in through: `online`, `agent`, `manual`, `phone`, `email`, `walk_in`.

starts_at datetime

Time the reservation starts.

ends_at datetime

Time the reserved tables are free again.

party_size integer

Number of guests; 0 for a block.

arrived_party_size integer

Number of guests that arrived; null until check-in.

customer Customer

Guest the reservation is for; absent for blocks.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

table_ids array of integer

Unique identifiers of the assigned tables.

kinds array of object

Reservation kinds booked, with the guests per kind.

reservation_kind_id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

party_size integer

Number of guests booked for this kind.

note string

Note from the guest.

receipt_note string

Note copied to the receipt and kitchen at check-in.

marker_ids array of integer

Markers (for example allergies or a birthday) copied to the receipt and kitchen at check-in.

receipt_id integer

Unique identifier of the receipt opened at check-in; null before check-in.

deposit_per_person Money

Deposit charged per guest; null when no deposit is required.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

deposit_persons integer

Number of guests the deposit is charged for.

deposit_due_at datetime

Time the deposit must be paid by.

deposit_paid_at datetime

Time the deposit was paid.

deposit_applied_at datetime

Time the paid deposit was settled on the receipt at check-in.

deposit_refunded_at datetime

Time the paid deposit was refunded, for example after a timely cancellation.

deposit_forfeited_at datetime

Time the paid deposit was kept because of a late cancellation or no-show.

confirmed_at datetime

Time the reservation was confirmed.

cancelled_at datetime

Time the reservation was cancelled.

seated_at datetime

Time the guests were checked in.

created_at datetime

Time the reservation was created.

updated_at datetime

Time the reservation was last updated.

Example response
{
  "id": 1,
  "status": "string",
  "source": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "party_size": 1,
  "arrived_party_size": 1,
  "customer": {
    "id": 1,
    "name": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "note": "string",
    "locale": "string",
    "pinned": true,
    "balance": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "temporary": true,
    "archived": true,
    "merged_into_id": 1,
    "group_ids": [
      1
    ],
    "last_receipt_at": "2026-01-15T12:30:00Z",
    "identifier": "string",
    "app_data": {},
    "created_at": "2026-01-15T12:30:00Z",
    "updated_at": "2026-01-15T12:30:00Z"
  },
  "table_ids": [
    1
  ],
  "kinds": [
    {
      "reservation_kind_id": 1,
      "name": "string",
      "party_size": 1
    }
  ],
  "note": "string",
  "receipt_note": "string",
  "marker_ids": [
    1
  ],
  "receipt_id": 1,
  "deposit_per_person": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "deposit_persons": 1,
  "deposit_due_at": "2026-01-15T12:30:00Z",
  "deposit_paid_at": "2026-01-15T12:30:00Z",
  "deposit_applied_at": "2026-01-15T12:30:00Z",
  "deposit_refunded_at": "2026-01-15T12:30:00Z",
  "deposit_forfeited_at": "2026-01-15T12:30:00Z",
  "confirmed_at": "2026-01-15T12:30:00Z",
  "cancelled_at": "2026-01-15T12:30:00Z",
  "seated_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
POST /v1/reservations/{id}/decline reservation:write

Declines a requested reservation or option, refunds a paid deposit and mails the guest.

Parameters

id path · integer req

Unique identifier of the reservation

Responses

201 Reservation Decline a reservation
Response attributes
id integer

Unique identifier of the reservation.

status string

One of `pending_payment`, `requested`, `option`, `confirmed`, `partially_seated`, `seated`, `completed`, `cancelled`, `declined`, `no_show`.

source string

Channel the reservation came in through: `online`, `agent`, `manual`, `phone`, `email`, `walk_in`.

starts_at datetime

Time the reservation starts.

ends_at datetime

Time the reserved tables are free again.

party_size integer

Number of guests; 0 for a block.

arrived_party_size integer

Number of guests that arrived; null until check-in.

customer Customer

Guest the reservation is for; absent for blocks.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

table_ids array of integer

Unique identifiers of the assigned tables.

kinds array of object

Reservation kinds booked, with the guests per kind.

reservation_kind_id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

party_size integer

Number of guests booked for this kind.

note string

Note from the guest.

receipt_note string

Note copied to the receipt and kitchen at check-in.

marker_ids array of integer

Markers (for example allergies or a birthday) copied to the receipt and kitchen at check-in.

receipt_id integer

Unique identifier of the receipt opened at check-in; null before check-in.

deposit_per_person Money

Deposit charged per guest; null when no deposit is required.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

deposit_persons integer

Number of guests the deposit is charged for.

deposit_due_at datetime

Time the deposit must be paid by.

deposit_paid_at datetime

Time the deposit was paid.

deposit_applied_at datetime

Time the paid deposit was settled on the receipt at check-in.

deposit_refunded_at datetime

Time the paid deposit was refunded, for example after a timely cancellation.

deposit_forfeited_at datetime

Time the paid deposit was kept because of a late cancellation or no-show.

confirmed_at datetime

Time the reservation was confirmed.

cancelled_at datetime

Time the reservation was cancelled.

seated_at datetime

Time the guests were checked in.

created_at datetime

Time the reservation was created.

updated_at datetime

Time the reservation was last updated.

Example response
{
  "id": 1,
  "status": "string",
  "source": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "party_size": 1,
  "arrived_party_size": 1,
  "customer": {
    "id": 1,
    "name": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "note": "string",
    "locale": "string",
    "pinned": true,
    "balance": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "temporary": true,
    "archived": true,
    "merged_into_id": 1,
    "group_ids": [
      1
    ],
    "last_receipt_at": "2026-01-15T12:30:00Z",
    "identifier": "string",
    "app_data": {},
    "created_at": "2026-01-15T12:30:00Z",
    "updated_at": "2026-01-15T12:30:00Z"
  },
  "table_ids": [
    1
  ],
  "kinds": [
    {
      "reservation_kind_id": 1,
      "name": "string",
      "party_size": 1
    }
  ],
  "note": "string",
  "receipt_note": "string",
  "marker_ids": [
    1
  ],
  "receipt_id": 1,
  "deposit_per_person": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "deposit_persons": 1,
  "deposit_due_at": "2026-01-15T12:30:00Z",
  "deposit_paid_at": "2026-01-15T12:30:00Z",
  "deposit_applied_at": "2026-01-15T12:30:00Z",
  "deposit_refunded_at": "2026-01-15T12:30:00Z",
  "deposit_forfeited_at": "2026-01-15T12:30:00Z",
  "confirmed_at": "2026-01-15T12:30:00Z",
  "cancelled_at": "2026-01-15T12:30:00Z",
  "seated_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
POST /v1/reservations/{id}/no_show reservation:write

Marks a confirmed reservation of today that has started as a no-show and forfeits a paid deposit.

Parameters

id path · integer req

Unique identifier of the reservation

Responses

201 Reservation Mark a reservation as no-show
Response attributes
id integer

Unique identifier of the reservation.

status string

One of `pending_payment`, `requested`, `option`, `confirmed`, `partially_seated`, `seated`, `completed`, `cancelled`, `declined`, `no_show`.

source string

Channel the reservation came in through: `online`, `agent`, `manual`, `phone`, `email`, `walk_in`.

starts_at datetime

Time the reservation starts.

ends_at datetime

Time the reserved tables are free again.

party_size integer

Number of guests; 0 for a block.

arrived_party_size integer

Number of guests that arrived; null until check-in.

customer Customer

Guest the reservation is for; absent for blocks.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

table_ids array of integer

Unique identifiers of the assigned tables.

kinds array of object

Reservation kinds booked, with the guests per kind.

reservation_kind_id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

party_size integer

Number of guests booked for this kind.

note string

Note from the guest.

receipt_note string

Note copied to the receipt and kitchen at check-in.

marker_ids array of integer

Markers (for example allergies or a birthday) copied to the receipt and kitchen at check-in.

receipt_id integer

Unique identifier of the receipt opened at check-in; null before check-in.

deposit_per_person Money

Deposit charged per guest; null when no deposit is required.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

deposit_persons integer

Number of guests the deposit is charged for.

deposit_due_at datetime

Time the deposit must be paid by.

deposit_paid_at datetime

Time the deposit was paid.

deposit_applied_at datetime

Time the paid deposit was settled on the receipt at check-in.

deposit_refunded_at datetime

Time the paid deposit was refunded, for example after a timely cancellation.

deposit_forfeited_at datetime

Time the paid deposit was kept because of a late cancellation or no-show.

confirmed_at datetime

Time the reservation was confirmed.

cancelled_at datetime

Time the reservation was cancelled.

seated_at datetime

Time the guests were checked in.

created_at datetime

Time the reservation was created.

updated_at datetime

Time the reservation was last updated.

Example response
{
  "id": 1,
  "status": "string",
  "source": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "party_size": 1,
  "arrived_party_size": 1,
  "customer": {
    "id": 1,
    "name": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "note": "string",
    "locale": "string",
    "pinned": true,
    "balance": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "temporary": true,
    "archived": true,
    "merged_into_id": 1,
    "group_ids": [
      1
    ],
    "last_receipt_at": "2026-01-15T12:30:00Z",
    "identifier": "string",
    "app_data": {},
    "created_at": "2026-01-15T12:30:00Z",
    "updated_at": "2026-01-15T12:30:00Z"
  },
  "table_ids": [
    1
  ],
  "kinds": [
    {
      "reservation_kind_id": 1,
      "name": "string",
      "party_size": 1
    }
  ],
  "note": "string",
  "receipt_note": "string",
  "marker_ids": [
    1
  ],
  "receipt_id": 1,
  "deposit_per_person": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "deposit_persons": 1,
  "deposit_due_at": "2026-01-15T12:30:00Z",
  "deposit_paid_at": "2026-01-15T12:30:00Z",
  "deposit_applied_at": "2026-01-15T12:30:00Z",
  "deposit_refunded_at": "2026-01-15T12:30:00Z",
  "deposit_forfeited_at": "2026-01-15T12:30:00Z",
  "confirmed_at": "2026-01-15T12:30:00Z",
  "cancelled_at": "2026-01-15T12:30:00Z",
  "seated_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/reservations/{id}/no_show reservation:write

Returns a no-show reservation to `confirmed`.

Parameters

id path · integer req

Unique identifier of the reservation

Responses

200 Reservation Undo a no-show
Response attributes
id integer

Unique identifier of the reservation.

status string

One of `pending_payment`, `requested`, `option`, `confirmed`, `partially_seated`, `seated`, `completed`, `cancelled`, `declined`, `no_show`.

source string

Channel the reservation came in through: `online`, `agent`, `manual`, `phone`, `email`, `walk_in`.

starts_at datetime

Time the reservation starts.

ends_at datetime

Time the reserved tables are free again.

party_size integer

Number of guests; 0 for a block.

arrived_party_size integer

Number of guests that arrived; null until check-in.

customer Customer

Guest the reservation is for; absent for blocks.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

table_ids array of integer

Unique identifiers of the assigned tables.

kinds array of object

Reservation kinds booked, with the guests per kind.

reservation_kind_id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

party_size integer

Number of guests booked for this kind.

note string

Note from the guest.

receipt_note string

Note copied to the receipt and kitchen at check-in.

marker_ids array of integer

Markers (for example allergies or a birthday) copied to the receipt and kitchen at check-in.

receipt_id integer

Unique identifier of the receipt opened at check-in; null before check-in.

deposit_per_person Money

Deposit charged per guest; null when no deposit is required.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

deposit_persons integer

Number of guests the deposit is charged for.

deposit_due_at datetime

Time the deposit must be paid by.

deposit_paid_at datetime

Time the deposit was paid.

deposit_applied_at datetime

Time the paid deposit was settled on the receipt at check-in.

deposit_refunded_at datetime

Time the paid deposit was refunded, for example after a timely cancellation.

deposit_forfeited_at datetime

Time the paid deposit was kept because of a late cancellation or no-show.

confirmed_at datetime

Time the reservation was confirmed.

cancelled_at datetime

Time the reservation was cancelled.

seated_at datetime

Time the guests were checked in.

created_at datetime

Time the reservation was created.

updated_at datetime

Time the reservation was last updated.

Example response
{
  "id": 1,
  "status": "string",
  "source": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "party_size": 1,
  "arrived_party_size": 1,
  "customer": {
    "id": 1,
    "name": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "note": "string",
    "locale": "string",
    "pinned": true,
    "balance": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "temporary": true,
    "archived": true,
    "merged_into_id": 1,
    "group_ids": [
      1
    ],
    "last_receipt_at": "2026-01-15T12:30:00Z",
    "identifier": "string",
    "app_data": {},
    "created_at": "2026-01-15T12:30:00Z",
    "updated_at": "2026-01-15T12:30:00Z"
  },
  "table_ids": [
    1
  ],
  "kinds": [
    {
      "reservation_kind_id": 1,
      "name": "string",
      "party_size": 1
    }
  ],
  "note": "string",
  "receipt_note": "string",
  "marker_ids": [
    1
  ],
  "receipt_id": 1,
  "deposit_per_person": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "deposit_persons": 1,
  "deposit_due_at": "2026-01-15T12:30:00Z",
  "deposit_paid_at": "2026-01-15T12:30:00Z",
  "deposit_applied_at": "2026-01-15T12:30:00Z",
  "deposit_refunded_at": "2026-01-15T12:30:00Z",
  "deposit_forfeited_at": "2026-01-15T12:30:00Z",
  "confirmed_at": "2026-01-15T12:30:00Z",
  "cancelled_at": "2026-01-15T12:30:00Z",
  "seated_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Reservation duration rules

GET /v1/reservation_duration_rules reservation:read

Returns the rules that set how long a reservation lasts, ordered by party size. A reservation's length comes from the rules of its window if any of them apply, otherwise from the organization-wide rules, otherwise from the program's `default_duration_minutes`. Among the applicable rules a rule for one of the booked kinds wins, then the highest `min_party_size` that is not above the party size. Example: rules `1 → 90`, `5 → 120` and `1 → 180 for kind High tea` give a party of 2 90 minutes, a party of 6 120 minutes and any high tea 180 minutes.

Parameters

reservation_window_id query · integer

Only the rules of this window

organization_wide query · boolean

Only the organization-wide rules (rules without a window)

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of ReservationDurationRule List reservation duration rules
Response attributes

The items on this page.

id integer

Unique identifier of the duration rule.

min_party_size integer

Smallest party the rule applies to; it applies up to the next rule's party size.

duration_minutes integer

Length of the reservation in minutes.

reservation_kind_id integer

Reservation kind the rule applies to; null for every kind.

reservation_window_id integer

Reservation window the rule applies to; null for an organization-wide rule.

created_at datetime

Time the duration rule was created.

updated_at datetime

Time the duration rule was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "min_party_size": 1,
      "duration_minutes": 1,
      "reservation_kind_id": 1,
      "reservation_window_id": 1,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/reservation_duration_rules reservation:write

Sets how long reservations last from a party size up, for example `{ "min_party_size": 5, "duration_minutes": 150 }` gives parties of five and more 150 minutes. Each combination of party size, kind and window can have one rule.

Request body

min_party_size integer req

Smallest party the rule applies to, for example `1` for everyone or `5` for parties of five and more

duration_minutes integer req

Length of the reservation in minutes, for example `120`

reservation_kind_id integer

Only for reservations of this kind, for example a 180-minute tasting menu; null for every kind

reservation_window_id integer

Only for reservations in this window; null for an organization-wide rule

{
  "min_party_size": 5,
  "duration_minutes": 150
}

Responses

201 ReservationDurationRule Create a reservation duration rule
Response attributes
id integer

Unique identifier of the duration rule.

min_party_size integer

Smallest party the rule applies to; it applies up to the next rule's party size.

duration_minutes integer

Length of the reservation in minutes.

reservation_kind_id integer

Reservation kind the rule applies to; null for every kind.

reservation_window_id integer

Reservation window the rule applies to; null for an organization-wide rule.

created_at datetime

Time the duration rule was created.

updated_at datetime

Time the duration rule was last updated.

Example response
{
  "id": 1,
  "min_party_size": 1,
  "duration_minutes": 1,
  "reservation_kind_id": 1,
  "reservation_window_id": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/reservation_duration_rules/{id} reservation:read

Retrieve a reservation duration rule

Parameters

id path · integer req

Unique identifier of the duration rule

Responses

200 ReservationDurationRule Retrieve a reservation duration rule
Response attributes
id integer

Unique identifier of the duration rule.

min_party_size integer

Smallest party the rule applies to; it applies up to the next rule's party size.

duration_minutes integer

Length of the reservation in minutes.

reservation_kind_id integer

Reservation kind the rule applies to; null for every kind.

reservation_window_id integer

Reservation window the rule applies to; null for an organization-wide rule.

created_at datetime

Time the duration rule was created.

updated_at datetime

Time the duration rule was last updated.

Example response
{
  "id": 1,
  "min_party_size": 1,
  "duration_minutes": 1,
  "reservation_kind_id": 1,
  "reservation_window_id": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/reservation_duration_rules/{id} reservation:write

Updates the given attributes; attributes that are not included keep their current value. Existing reservations keep their length.

Parameters

id path · integer req

Unique identifier of the duration rule

Request body

min_party_size integer

Smallest party the rule applies to, for example `1` for everyone or `5` for parties of five and more

duration_minutes integer

Length of the reservation in minutes, for example `120`

reservation_kind_id integer

Only for reservations of this kind, for example a 180-minute tasting menu; null for every kind

reservation_window_id integer

Only for reservations in this window; null for an organization-wide rule

{
  "duration_minutes": 150
}

Responses

200 ReservationDurationRule Update a reservation duration rule
Response attributes
id integer

Unique identifier of the duration rule.

min_party_size integer

Smallest party the rule applies to; it applies up to the next rule's party size.

duration_minutes integer

Length of the reservation in minutes.

reservation_kind_id integer

Reservation kind the rule applies to; null for every kind.

reservation_window_id integer

Reservation window the rule applies to; null for an organization-wide rule.

created_at datetime

Time the duration rule was created.

updated_at datetime

Time the duration rule was last updated.

Example response
{
  "id": 1,
  "min_party_size": 1,
  "duration_minutes": 1,
  "reservation_kind_id": 1,
  "reservation_window_id": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/reservation_duration_rules/{id} reservation:write

New reservations fall back to the remaining rules or the program's default duration. Existing reservations keep their length.

Parameters

id path · integer req

Unique identifier of the duration rule

Responses

204 Delete a reservation duration rule

Reservation kinds

GET /v1/reservation_kinds reservation:read

List reservation kinds

Parameters

include_archived query · boolean

Include archived kinds

default false

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of ReservationKind List reservation kinds
Response attributes

The items on this page.

id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

description string

Description shown to guests.

position integer

Display order.

visibility string

Where the kind can be booked: `everywhere`, `linked_windows` (only in the windows it is linked to) or `staff_only`.

max_party_size integer

Largest party that can book this kind; null for the program default.

minimum_lead_time_minutes integer

Minimum minutes between booking and start; null for the program default.

combinable boolean

Whether the kind can be combined with other kinds on one reservation.

archived boolean

Whether the kind is archived.

created_at datetime

Time the reservation kind was created.

updated_at datetime

Time the reservation kind was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "description": "string",
      "position": 1,
      "visibility": "string",
      "max_party_size": 1,
      "minimum_lead_time_minutes": 1,
      "combinable": true,
      "archived": true,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/reservation_kinds reservation:write

Adds a kind of reservation guests can book, for example a high tea or a tasting menu. Link it to reservation windows with `reservation_kind_ids` on the window to offer it only then.

Request body

name string req

Name of the kind, for example `High tea` or `Chef's table`

description string

Description shown to guests when they pick a kind

max_party_size integer

Largest party that can book this kind; leave empty for the program default

minimum_lead_time_minutes integer

Minimum minutes between booking and start; leave empty for the program default

combinable boolean

Whether guests can combine this kind with other kinds on one reservation

visibility enum

Where the kind can be booked: `everywhere`, only in the reservation windows it is linked to (`linked_windows`), or by staff only (`staff_only`)

everywherelinked_windowsstaff_only

{
  "name": "High tea",
  "description": "Tea with sweet and savoury bites",
  "max_party_size": 8,
  "minimum_lead_time_minutes": 1440
}

Responses

201 ReservationKind Create a reservation kind
Response attributes
id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

description string

Description shown to guests.

position integer

Display order.

visibility string

Where the kind can be booked: `everywhere`, `linked_windows` (only in the windows it is linked to) or `staff_only`.

max_party_size integer

Largest party that can book this kind; null for the program default.

minimum_lead_time_minutes integer

Minimum minutes between booking and start; null for the program default.

combinable boolean

Whether the kind can be combined with other kinds on one reservation.

archived boolean

Whether the kind is archived.

created_at datetime

Time the reservation kind was created.

updated_at datetime

Time the reservation kind was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "description": "string",
  "position": 1,
  "visibility": "string",
  "max_party_size": 1,
  "minimum_lead_time_minutes": 1,
  "combinable": true,
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/reservation_kinds/{id} reservation:read

Retrieve a reservation kind

Parameters

id path · integer req

Unique identifier of the reservation kind

Responses

200 ReservationKind Retrieve a reservation kind
Response attributes
id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

description string

Description shown to guests.

position integer

Display order.

visibility string

Where the kind can be booked: `everywhere`, `linked_windows` (only in the windows it is linked to) or `staff_only`.

max_party_size integer

Largest party that can book this kind; null for the program default.

minimum_lead_time_minutes integer

Minimum minutes between booking and start; null for the program default.

combinable boolean

Whether the kind can be combined with other kinds on one reservation.

archived boolean

Whether the kind is archived.

created_at datetime

Time the reservation kind was created.

updated_at datetime

Time the reservation kind was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "description": "string",
  "position": 1,
  "visibility": "string",
  "max_party_size": 1,
  "minimum_lead_time_minutes": 1,
  "combinable": true,
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/reservation_kinds/{id} reservation:write

Updates the given attributes; attributes that are not included keep their current value.

Parameters

id path · integer req

Unique identifier of the reservation kind

Request body

name string

Name of the kind, for example `High tea` or `Chef's table`

description string

Description shown to guests when they pick a kind

max_party_size integer

Largest party that can book this kind; leave empty for the program default

minimum_lead_time_minutes integer

Minimum minutes between booking and start; leave empty for the program default

combinable boolean

Whether guests can combine this kind with other kinds on one reservation

visibility enum

Where the kind can be booked: `everywhere`, only in the reservation windows it is linked to (`linked_windows`), or by staff only (`staff_only`)

everywherelinked_windowsstaff_only

{
  "visibility": "staff_only"
}

Responses

200 ReservationKind Update a reservation kind
Response attributes
id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

description string

Description shown to guests.

position integer

Display order.

visibility string

Where the kind can be booked: `everywhere`, `linked_windows` (only in the windows it is linked to) or `staff_only`.

max_party_size integer

Largest party that can book this kind; null for the program default.

minimum_lead_time_minutes integer

Minimum minutes between booking and start; null for the program default.

combinable boolean

Whether the kind can be combined with other kinds on one reservation.

archived boolean

Whether the kind is archived.

created_at datetime

Time the reservation kind was created.

updated_at datetime

Time the reservation kind was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "description": "string",
  "position": 1,
  "visibility": "string",
  "max_party_size": 1,
  "minimum_lead_time_minutes": 1,
  "combinable": true,
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/reservation_kinds/{id} reservation:write

Guests can no longer book the kind. Existing reservations keep it.

Parameters

id path · integer req

Unique identifier of the reservation kind

Responses

200 ReservationKind Archive a reservation kind
Response attributes
id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

description string

Description shown to guests.

position integer

Display order.

visibility string

Where the kind can be booked: `everywhere`, `linked_windows` (only in the windows it is linked to) or `staff_only`.

max_party_size integer

Largest party that can book this kind; null for the program default.

minimum_lead_time_minutes integer

Minimum minutes between booking and start; null for the program default.

combinable boolean

Whether the kind can be combined with other kinds on one reservation.

archived boolean

Whether the kind is archived.

created_at datetime

Time the reservation kind was created.

updated_at datetime

Time the reservation kind was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "description": "string",
  "position": 1,
  "visibility": "string",
  "max_party_size": 1,
  "minimum_lead_time_minutes": 1,
  "combinable": true,
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Reservation notes

GET /v1/reservation_notes reservation:read

Returns the staff notes on the reservation calendar that cover any day between `from` and `to` (inclusive, at most 366 days), or `date`. Guests never see these notes.

Parameters

date query · date

Day to list notes for; defaults to today

from query · date

First day of the range

to query · date

Last day of the range

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of ReservationNote List reservation notes
Response attributes

The items on this page.

id integer

Unique identifier of the note.

message string

Text of the note.

starts_on date

First day the note is shown.

ends_on date

Last day the note is shown.

created_at datetime

Time the note was created.

updated_at datetime

Time the note was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "message": "string",
      "starts_on": "2026-01-15",
      "ends_on": "2026-01-15",
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/reservation_notes reservation:write

Adds a note for staff to the reservation calendar on one day or a period, for example `{ "message": "Wine tasting upstairs, terrace closed", "starts_on": "2026-12-12" }`. A note doesn't close anything; use closures for that.

Request body

message string req

Text of the note

starts_on date req

First day the note is shown

ends_on date

Last day the note is shown; defaults to `starts_on`

{
  "message": "Wine tasting upstairs, terrace closed",
  "starts_on": "2026-12-12"
}

Responses

201 ReservationNote Create a reservation note
Response attributes
id integer

Unique identifier of the note.

message string

Text of the note.

starts_on date

First day the note is shown.

ends_on date

Last day the note is shown.

created_at datetime

Time the note was created.

updated_at datetime

Time the note was last updated.

Example response
{
  "id": 1,
  "message": "string",
  "starts_on": "2026-01-15",
  "ends_on": "2026-01-15",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/reservation_notes/{id} reservation:read

Retrieve a reservation note

Parameters

id path · integer req

Unique identifier of the reservation note

Responses

200 ReservationNote Retrieve a reservation note
Response attributes
id integer

Unique identifier of the note.

message string

Text of the note.

starts_on date

First day the note is shown.

ends_on date

Last day the note is shown.

created_at datetime

Time the note was created.

updated_at datetime

Time the note was last updated.

Example response
{
  "id": 1,
  "message": "string",
  "starts_on": "2026-01-15",
  "ends_on": "2026-01-15",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/reservation_notes/{id} reservation:write

Updates the given attributes; attributes that are not included keep their current value.

Parameters

id path · integer req

Unique identifier of the reservation note

Request body

message string

Text of the note

starts_on date

First day the note is shown

ends_on date

Last day the note is shown

{
  "message": "Terrace closed because of the market"
}

Responses

200 ReservationNote Update a reservation note
Response attributes
id integer

Unique identifier of the note.

message string

Text of the note.

starts_on date

First day the note is shown.

ends_on date

Last day the note is shown.

created_at datetime

Time the note was created.

updated_at datetime

Time the note was last updated.

Example response
{
  "id": 1,
  "message": "string",
  "starts_on": "2026-01-15",
  "ends_on": "2026-01-15",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/reservation_notes/{id} reservation:write

Delete a reservation note

Parameters

id path · integer req

Unique identifier of the reservation note

Responses

204 Delete a reservation note

Reservation setting

GET /v1/reservation_setting reservation:read

Retrieve the reservation program

Responses

200 ReservationSetting Retrieve the reservation program
Response attributes
id integer

Unique identifier of the reservation program.

name string

Name of the deposit line.

enabled boolean

Whether guests can book online.

auto_confirm boolean

Whether online bookings are confirmed without staff approval.

slot_interval_minutes integer

Minutes between bookable start times.

default_duration_minutes integer

Default length of a reservation.

min_party_size integer

Smallest party that can book online.

max_party_size integer

Largest party that can book online.

max_concurrent_covers integer

Maximum guests seated at the same time; null for no limit.

max_covers_per_slot integer

Maximum guests starting in one slot; null for no limit.

minimum_lead_time_minutes integer

Minimum minutes between booking and start.

horizon_days integer

How many days ahead guests can book.

no_show_after_minutes integer

Minutes after the start a reservation counts as a no-show.

reminder_days_before integer

Days before the reservation the guest gets a reminder; null for no reminder.

deposit_free_cancellation_hours integer

Hours before the start a paid deposit is still refunded on cancellation.

background_color string

Background color of the booking widget's header as #rrggbb.

text_color string

Text color of the booking widget's header as #rrggbb.

created_at datetime

Time the reservation program was created.

updated_at datetime

Time the reservation program was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "enabled": true,
  "auto_confirm": true,
  "slot_interval_minutes": 1,
  "default_duration_minutes": 1,
  "min_party_size": 1,
  "max_party_size": 1,
  "max_concurrent_covers": 1,
  "max_covers_per_slot": 1,
  "minimum_lead_time_minutes": 1,
  "horizon_days": 1,
  "no_show_after_minutes": 1,
  "reminder_days_before": 1,
  "deposit_free_cancellation_hours": 1,
  "background_color": "string",
  "text_color": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/reservation_setting reservation:write

Updates the given settings; settings that are not included keep their current value. Set `enabled` to let guests book online; they can only book inside reservation windows.

Request body

enabled boolean

Whether guests can book online

auto_confirm boolean

Whether online bookings are confirmed without staff approval

slot_interval_minutes integer

Minutes between bookable start times

default_duration_minutes integer

Default length of a reservation

min_party_size integer

Smallest party that can book online

max_party_size integer

Largest party that can book online

max_concurrent_covers integer

Maximum guests seated at the same time; empty for no limit

max_covers_per_slot integer

Maximum guests starting in one slot; empty for no limit

minimum_lead_time_minutes integer

Minimum minutes between booking and start

horizon_days integer

How many days ahead guests can book

no_show_after_minutes integer

Minutes after the start a reservation counts as a no-show

reminder_days_before integer

Days before the reservation the guest gets a reminder; empty for no reminder

deposit_free_cancellation_hours integer

Hours before the start a paid deposit is still refunded on cancellation

background_color string

Background color of the booking widget's header as #rrggbb

text_color string

Text color of the booking widget's header as #rrggbb

{
  "auto_confirm": true,
  "max_party_size": 12,
  "reminder_days_before": 1
}

Responses

200 ReservationSetting Update the reservation program
Response attributes
id integer

Unique identifier of the reservation program.

name string

Name of the deposit line.

enabled boolean

Whether guests can book online.

auto_confirm boolean

Whether online bookings are confirmed without staff approval.

slot_interval_minutes integer

Minutes between bookable start times.

default_duration_minutes integer

Default length of a reservation.

min_party_size integer

Smallest party that can book online.

max_party_size integer

Largest party that can book online.

max_concurrent_covers integer

Maximum guests seated at the same time; null for no limit.

max_covers_per_slot integer

Maximum guests starting in one slot; null for no limit.

minimum_lead_time_minutes integer

Minimum minutes between booking and start.

horizon_days integer

How many days ahead guests can book.

no_show_after_minutes integer

Minutes after the start a reservation counts as a no-show.

reminder_days_before integer

Days before the reservation the guest gets a reminder; null for no reminder.

deposit_free_cancellation_hours integer

Hours before the start a paid deposit is still refunded on cancellation.

background_color string

Background color of the booking widget's header as #rrggbb.

text_color string

Text color of the booking widget's header as #rrggbb.

created_at datetime

Time the reservation program was created.

updated_at datetime

Time the reservation program was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "enabled": true,
  "auto_confirm": true,
  "slot_interval_minutes": 1,
  "default_duration_minutes": 1,
  "min_party_size": 1,
  "max_party_size": 1,
  "max_concurrent_covers": 1,
  "max_covers_per_slot": 1,
  "minimum_lead_time_minutes": 1,
  "horizon_days": 1,
  "no_show_after_minutes": 1,
  "reminder_days_before": 1,
  "deposit_free_cancellation_hours": 1,
  "background_color": "string",
  "text_color": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Reservation windows

GET /v1/reservation_windows reservation:read

List reservation windows

Parameters

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of ReservationWindow List reservation windows
Response attributes

The items on this page.

id integer

Unique identifier of the window.

name string

Name of the window.

frequency string

How the window repeats: `day`, `week`, `month` or `year`; null for a one-time window.

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday; null for other windows.

ordinals array of integer

Which of the weekdays a monthly window opens on, 1 to 4 or -1 for the last; null for other windows.

from_time string

Time of day a repeating window opens, HH:MM; null for a one-time window.

till_time string

Time of day a repeating window closes, HH:MM; before from_time when it runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year.

repeats_until date

Last date a repeating window opens; null when it repeats forever.

starts_at datetime

Start of a one-time window; null for a repeating window.

ends_at datetime

End of a one-time window; null for a repeating window.

starts_on date

First date of a special period that replaces the regular windows; null for a regular window.

ends_on date

Last date of a special period; null when open-ended.

schedule string

When the window opens, in words.

min_party_size integer

Smallest party that can book; null for the program default.

max_party_size integer

Largest party that can book; null for the program default.

max_concurrent_covers integer

Maximum guests seated at the same time; null for the program default.

max_covers_per_slot integer

Maximum guests starting in one slot; null for the program default.

slot_interval_minutes integer

Minutes between bookable start times; null for the program default.

deposit_per_person Money

Deposit charged per guest; null without a deposit.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

deposit_minimum_party_size integer

Smallest party the deposit applies to.

requires_kind boolean

Whether guests must pick a reservation kind.

reservation_kind_ids array of integer

Reservation kinds bookable in this window; empty for all.

created_at datetime

Time the window was created.

updated_at datetime

Time the window was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "frequency": "string",
      "weekdays": [
        1
      ],
      "ordinals": [
        1
      ],
      "from_time": "string",
      "till_time": "string",
      "repeats_from": "2026-01-15",
      "repeats_until": "2026-01-15",
      "starts_at": "2026-01-15T12:30:00Z",
      "ends_at": "2026-01-15T12:30:00Z",
      "starts_on": "2026-01-15",
      "ends_on": "2026-01-15",
      "schedule": "string",
      "min_party_size": 1,
      "max_party_size": 1,
      "max_concurrent_covers": 1,
      "max_covers_per_slot": 1,
      "slot_interval_minutes": 1,
      "deposit_per_person": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "deposit_minimum_party_size": 1,
      "requires_kind": true,
      "reservation_kind_ids": [
        1
      ],
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/reservation_windows reservation:write

Opens online reservations, for example Tuesday to Saturday from 17:30 to 21:30. Guests can book start times inside the window. Windows can't overlap. A window either repeats (`frequency` with `weekdays`, `from_time` and `till_time`, optionally bounded by `repeats_from` and `repeats_until`) or opens once from `starts_at` to `ends_at`, next to the regular windows. Add `starts_on` and `ends_on` to make it a special period: on those dates it replaces the regular windows.

Request body

name string req

Name of the window, for example `Dinner` or `Weekend lunch`

frequency enum

How a repeating window repeats: `week` (on `weekdays`, the default), `day` (every day), `month` (on the `ordinals` of the `weekdays`, for example the first Tuesday) or `year` (every year on the date of `repeats_from`)

dayweekmonthyear

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday and 6 is Saturday

ordinals array of integer

Which of the `weekdays` in a month a monthly window opens on: 1 to 4 for the first to fourth, -1 for the last. `weekdays: [2], ordinals: [1, 3]` opens on the first and third Tuesday

1234-1

from_time string

Time of day a repeating window opens, HH:MM

till_time string

Time of day a repeating window closes, HH:MM. A time before `from_time` closes the next day, so `17:00` to `01:00` runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year. Leave empty to start right away

repeats_until date

Last date a repeating window opens; leave empty to repeat forever

starts_at datetime

Start of a one-time window, for example an extra evening for an event. A one-time window opens once from `starts_at` to `ends_at`, next to the regular windows; give it instead of the repeating fields

ends_at datetime

End of a one-time window

starts_on date

First date of a special period. A special period replaces the regular windows on the days it opens, for example different hours on Christmas Eve. Leave empty for a regular window.

ends_on date

Last date of a special period; leave empty for one that only starts on `starts_on`

min_party_size integer

Smallest party that can book; leave empty for the program default

max_party_size integer

Largest party that can book; leave empty for the program default

max_concurrent_covers integer

Maximum guests seated at the same time; leave empty for the program default

max_covers_per_slot integer

Maximum guests starting in one slot; leave empty for the program default

slot_interval_minutes integer

Minutes between bookable start times; leave empty for the program default

requires_kind boolean

Whether guests must pick a reservation kind

reservation_kind_ids array of integer

Reservation kinds bookable in this window; empty for all

deposit_per_person object

Deposit charged per guest; null or an amount of 0 for no deposit. Requires a deposit category of revenue in the reservation program.

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

deposit_minimum_party_size integer

Smallest party the deposit applies to

{
  "name": "Dinner",
  "frequency": "week",
  "weekdays": [
    3,
    4,
    5,
    6
  ],
  "from_time": "17:00",
  "till_time": "22:00",
  "max_covers_per_slot": 20
}

Responses

201 ReservationWindow Create a reservation window
Response attributes
id integer

Unique identifier of the window.

name string

Name of the window.

frequency string

How the window repeats: `day`, `week`, `month` or `year`; null for a one-time window.

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday; null for other windows.

ordinals array of integer

Which of the weekdays a monthly window opens on, 1 to 4 or -1 for the last; null for other windows.

from_time string

Time of day a repeating window opens, HH:MM; null for a one-time window.

till_time string

Time of day a repeating window closes, HH:MM; before from_time when it runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year.

repeats_until date

Last date a repeating window opens; null when it repeats forever.

starts_at datetime

Start of a one-time window; null for a repeating window.

ends_at datetime

End of a one-time window; null for a repeating window.

starts_on date

First date of a special period that replaces the regular windows; null for a regular window.

ends_on date

Last date of a special period; null when open-ended.

schedule string

When the window opens, in words.

min_party_size integer

Smallest party that can book; null for the program default.

max_party_size integer

Largest party that can book; null for the program default.

max_concurrent_covers integer

Maximum guests seated at the same time; null for the program default.

max_covers_per_slot integer

Maximum guests starting in one slot; null for the program default.

slot_interval_minutes integer

Minutes between bookable start times; null for the program default.

deposit_per_person Money

Deposit charged per guest; null without a deposit.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

deposit_minimum_party_size integer

Smallest party the deposit applies to.

requires_kind boolean

Whether guests must pick a reservation kind.

reservation_kind_ids array of integer

Reservation kinds bookable in this window; empty for all.

created_at datetime

Time the window was created.

updated_at datetime

Time the window was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "frequency": "string",
  "weekdays": [
    1
  ],
  "ordinals": [
    1
  ],
  "from_time": "string",
  "till_time": "string",
  "repeats_from": "2026-01-15",
  "repeats_until": "2026-01-15",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "starts_on": "2026-01-15",
  "ends_on": "2026-01-15",
  "schedule": "string",
  "min_party_size": 1,
  "max_party_size": 1,
  "max_concurrent_covers": 1,
  "max_covers_per_slot": 1,
  "slot_interval_minutes": 1,
  "deposit_per_person": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "deposit_minimum_party_size": 1,
  "requires_kind": true,
  "reservation_kind_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/reservation_windows/{id} reservation:read

Retrieve a reservation window

Parameters

id path · integer req

Unique identifier of the reservation window

Responses

200 ReservationWindow Retrieve a reservation window
Response attributes
id integer

Unique identifier of the window.

name string

Name of the window.

frequency string

How the window repeats: `day`, `week`, `month` or `year`; null for a one-time window.

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday; null for other windows.

ordinals array of integer

Which of the weekdays a monthly window opens on, 1 to 4 or -1 for the last; null for other windows.

from_time string

Time of day a repeating window opens, HH:MM; null for a one-time window.

till_time string

Time of day a repeating window closes, HH:MM; before from_time when it runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year.

repeats_until date

Last date a repeating window opens; null when it repeats forever.

starts_at datetime

Start of a one-time window; null for a repeating window.

ends_at datetime

End of a one-time window; null for a repeating window.

starts_on date

First date of a special period that replaces the regular windows; null for a regular window.

ends_on date

Last date of a special period; null when open-ended.

schedule string

When the window opens, in words.

min_party_size integer

Smallest party that can book; null for the program default.

max_party_size integer

Largest party that can book; null for the program default.

max_concurrent_covers integer

Maximum guests seated at the same time; null for the program default.

max_covers_per_slot integer

Maximum guests starting in one slot; null for the program default.

slot_interval_minutes integer

Minutes between bookable start times; null for the program default.

deposit_per_person Money

Deposit charged per guest; null without a deposit.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

deposit_minimum_party_size integer

Smallest party the deposit applies to.

requires_kind boolean

Whether guests must pick a reservation kind.

reservation_kind_ids array of integer

Reservation kinds bookable in this window; empty for all.

created_at datetime

Time the window was created.

updated_at datetime

Time the window was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "frequency": "string",
  "weekdays": [
    1
  ],
  "ordinals": [
    1
  ],
  "from_time": "string",
  "till_time": "string",
  "repeats_from": "2026-01-15",
  "repeats_until": "2026-01-15",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "starts_on": "2026-01-15",
  "ends_on": "2026-01-15",
  "schedule": "string",
  "min_party_size": 1,
  "max_party_size": 1,
  "max_concurrent_covers": 1,
  "max_covers_per_slot": 1,
  "slot_interval_minutes": 1,
  "deposit_per_person": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "deposit_minimum_party_size": 1,
  "requires_kind": true,
  "reservation_kind_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/reservation_windows/{id} reservation:write

Updates the given attributes; attributes that are not included keep their current value, so sending only `till_time` moves the closing time on the same weekdays. Sending `starts_at` and `ends_at` turns a repeating window into a one-time window, sending the repeating fields turns it back.

Parameters

id path · integer req

Unique identifier of the reservation window

Request body

name string

Name of the window, for example `Dinner` or `Weekend lunch`

frequency enum

How a repeating window repeats: `week` (on `weekdays`, the default), `day` (every day), `month` (on the `ordinals` of the `weekdays`, for example the first Tuesday) or `year` (every year on the date of `repeats_from`)

dayweekmonthyear

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday and 6 is Saturday

ordinals array of integer

Which of the `weekdays` in a month a monthly window opens on: 1 to 4 for the first to fourth, -1 for the last. `weekdays: [2], ordinals: [1, 3]` opens on the first and third Tuesday

1234-1

from_time string

Time of day a repeating window opens, HH:MM

till_time string

Time of day a repeating window closes, HH:MM. A time before `from_time` closes the next day, so `17:00` to `01:00` runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year. Leave empty to start right away

repeats_until date

Last date a repeating window opens; leave empty to repeat forever

starts_at datetime

Start of a one-time window, for example an extra evening for an event. A one-time window opens once from `starts_at` to `ends_at`, next to the regular windows; give it instead of the repeating fields

ends_at datetime

End of a one-time window

starts_on date

First date of a special period. A special period replaces the regular windows on the days it opens, for example different hours on Christmas Eve. Leave empty for a regular window.

ends_on date

Last date of a special period; leave empty for one that only starts on `starts_on`

min_party_size integer

Smallest party that can book; leave empty for the program default

max_party_size integer

Largest party that can book; leave empty for the program default

max_concurrent_covers integer

Maximum guests seated at the same time; leave empty for the program default

max_covers_per_slot integer

Maximum guests starting in one slot; leave empty for the program default

slot_interval_minutes integer

Minutes between bookable start times; leave empty for the program default

requires_kind boolean

Whether guests must pick a reservation kind

reservation_kind_ids array of integer

Reservation kinds bookable in this window; empty for all

deposit_per_person object

Deposit charged per guest; null or an amount of 0 for no deposit. Requires a deposit category of revenue in the reservation program.

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

deposit_minimum_party_size integer

Smallest party the deposit applies to

{
  "till_time": "21:30"
}

Responses

200 ReservationWindow Update a reservation window
Response attributes
id integer

Unique identifier of the window.

name string

Name of the window.

frequency string

How the window repeats: `day`, `week`, `month` or `year`; null for a one-time window.

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday; null for other windows.

ordinals array of integer

Which of the weekdays a monthly window opens on, 1 to 4 or -1 for the last; null for other windows.

from_time string

Time of day a repeating window opens, HH:MM; null for a one-time window.

till_time string

Time of day a repeating window closes, HH:MM; before from_time when it runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year.

repeats_until date

Last date a repeating window opens; null when it repeats forever.

starts_at datetime

Start of a one-time window; null for a repeating window.

ends_at datetime

End of a one-time window; null for a repeating window.

starts_on date

First date of a special period that replaces the regular windows; null for a regular window.

ends_on date

Last date of a special period; null when open-ended.

schedule string

When the window opens, in words.

min_party_size integer

Smallest party that can book; null for the program default.

max_party_size integer

Largest party that can book; null for the program default.

max_concurrent_covers integer

Maximum guests seated at the same time; null for the program default.

max_covers_per_slot integer

Maximum guests starting in one slot; null for the program default.

slot_interval_minutes integer

Minutes between bookable start times; null for the program default.

deposit_per_person Money

Deposit charged per guest; null without a deposit.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

deposit_minimum_party_size integer

Smallest party the deposit applies to.

requires_kind boolean

Whether guests must pick a reservation kind.

reservation_kind_ids array of integer

Reservation kinds bookable in this window; empty for all.

created_at datetime

Time the window was created.

updated_at datetime

Time the window was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "frequency": "string",
  "weekdays": [
    1
  ],
  "ordinals": [
    1
  ],
  "from_time": "string",
  "till_time": "string",
  "repeats_from": "2026-01-15",
  "repeats_until": "2026-01-15",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "starts_on": "2026-01-15",
  "ends_on": "2026-01-15",
  "schedule": "string",
  "min_party_size": 1,
  "max_party_size": 1,
  "max_concurrent_covers": 1,
  "max_covers_per_slot": 1,
  "slot_interval_minutes": 1,
  "deposit_per_person": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "deposit_minimum_party_size": 1,
  "requires_kind": true,
  "reservation_kind_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/reservation_windows/{id} reservation:write

Guests can no longer book in this window. Existing reservations are kept.

Parameters

id path · integer req

Unique identifier of the reservation window

Responses

204 Delete a reservation window

Shops

GET /v1/shops shop:read

List shops

Parameters

include_archived query · boolean

Include archived shops

default false

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Shop List shops
Response attributes

The items on this page.

kind string

One of `online`, `pay_now` or `pay_later`.

id integer

Unique identifier of the shop.

name string

Name of the shop.

enabled boolean

Whether the shop accepts orders.

open boolean

Whether the shop is open for orders right now.

quickselect_page_id integer

Unique identifier of the quickselect page used as the menu.

payment_method_id integer

Unique identifier of the payment method used for online payment.

minimum_order_amount Money

Minimum order amount, excluding fees; null without a minimum.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

slot_interval_minutes integer

Minutes between pick-up times (online shops).

lead_time_minutes integer

Minimum minutes between ordering and pick-up (online shops).

max_orders_per_slot integer

Maximum orders per pick-up time (online shops).

horizon_days integer

How many days ahead guests can order (online shops).

welcome_text string

Text shown when the shop opens.

closed_text string

Text shown while the shop is closed.

terms_url string

Link to the terms and conditions; null when the shop shows `terms_text` or has none.

terms_text string

Terms and conditions shown in the shop itself; null when it links to `terms_url`.

privacy_url string

Link to the privacy statement; null when the shop shows `privacy_text` or has none.

privacy_text string

Privacy statement shown in the shop itself; null when it links to `privacy_url`.

url string

Public URL of the shop.

fee_ids array of integer

Fees added to every order, for example a delivery fee (`GET /v1/fees`).

windows array of ShopWindow

Opening windows of the shop.

id integer

Unique identifier of the window.

name string

Name of the window.

frequency string

How the window repeats: `day`, `week`, `month` or `year`; null for a one-time window.

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday; null for other windows.

ordinals array of integer

Which of the weekdays a monthly window opens on, 1 to 4 or -1 for the last; null for other windows.

from_time string

Time of day a repeating window opens, HH:MM; null for a one-time window.

till_time string

Time of day a repeating window closes, HH:MM; before from_time when it runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year.

repeats_until date

Last date a repeating window opens; null when it repeats forever.

starts_at datetime

Start of a one-time window; null for a repeating window.

ends_at datetime

End of a one-time window; null for a repeating window.

starts_on date

First date of a special period that replaces the regular windows; null for a regular window.

ends_on date

Last date of a special period; null when open-ended.

schedule string

When the window opens, in words.

slot_interval_minutes integer

Minutes between pick-up times; null for the shop default.

lead_time_minutes integer

Minimum minutes between ordering and pick-up; null for the shop default.

max_orders_per_slot integer

Maximum orders per pick-up time; null for the shop default.

created_at datetime

Time the window was created.

updated_at datetime

Time the window was last updated.

archived boolean

Whether the shop is archived.

created_at datetime

Time the shop was created.

updated_at datetime

Time the shop was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "kind": "string",
      "id": 1,
      "name": "string",
      "enabled": true,
      "open": true,
      "quickselect_page_id": 1,
      "payment_method_id": 1,
      "minimum_order_amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "slot_interval_minutes": 1,
      "lead_time_minutes": 1,
      "max_orders_per_slot": 1,
      "horizon_days": 1,
      "welcome_text": "string",
      "closed_text": "string",
      "terms_url": "string",
      "terms_text": "string",
      "privacy_url": "string",
      "privacy_text": "string",
      "url": "string",
      "fee_ids": [
        1
      ],
      "windows": [
        {
          "id": 1,
          "name": "string",
          "frequency": "string",
          "weekdays": [
            1
          ],
          "ordinals": [
            1
          ],
          "from_time": "string",
          "till_time": "string",
          "repeats_from": "2026-01-15",
          "repeats_until": "2026-01-15",
          "starts_at": "2026-01-15T12:30:00Z",
          "ends_at": "2026-01-15T12:30:00Z",
          "starts_on": "2026-01-15",
          "ends_on": "2026-01-15",
          "schedule": "string",
          "slot_interval_minutes": 1,
          "lead_time_minutes": 1,
          "max_orders_per_slot": 1,
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        }
      ],
      "archived": true,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/shops shop:write

Creates a shop guests order in from their phone: `online` for takeaway and delivery with pick-up times, `pay_now` for ordering and paying at a table via its QR code, or `pay_later` for adding to an open receipt. Shops only accept orders inside their windows (`POST /v1/shop_windows`); create it disabled, add windows, then enable it.

Request body

kind enum req

One of `online`, `pay_now` or `pay_later`

onlinepay_nowpay_later

name string req

Name of the shop, for example `Takeaway` or `Order at your table`

enabled boolean

Whether the shop accepts orders. Enabling needs a menu (`quickselect_page_id`) and, for shops that take payment, a `payment_method_id`.

quickselect_page_id integer

Quickselect page used as the menu

payment_method_id integer

Payment method guests pay with online

minimum_order_amount object

Minimum order amount, excluding fees; null for none

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

welcome_text string

Text shown when the shop opens

closed_text string

Text shown while the shop is closed

back_url string

Link back to the organization's own website

background_color string

Background color as #rrggbb

text_color string

Text color as #rrggbb

slot_interval_minutes integer

Minutes between pick-up times (online shops)

lead_time_minutes integer

Minimum minutes between ordering and pick-up (online shops)

max_orders_per_slot integer

Maximum orders per pick-up time (online shops)

horizon_days integer

How many days ahead guests can order (online shops)

terms_url string

Link to the terms and conditions guests agree to; replaces `terms_text`

terms_text string

Terms and conditions shown in the shop itself; replaces `terms_url`

privacy_url string

Link to the privacy statement; replaces `privacy_text`

privacy_text string

Privacy statement shown in the shop itself; replaces `privacy_url`

fee_ids array of integer

Fees charged on every order, for example a delivery fee (`GET /v1/fees`). The list replaces the current fees, so `[]` removes them all

{
  "kind": "online",
  "name": "Takeaway",
  "enabled": false,
  "quickselect_page_id": 1,
  "payment_method_id": 6
}

Responses

201 Shop Create a shop
Response attributes
kind string

One of `online`, `pay_now` or `pay_later`.

id integer

Unique identifier of the shop.

name string

Name of the shop.

enabled boolean

Whether the shop accepts orders.

open boolean

Whether the shop is open for orders right now.

quickselect_page_id integer

Unique identifier of the quickselect page used as the menu.

payment_method_id integer

Unique identifier of the payment method used for online payment.

minimum_order_amount Money

Minimum order amount, excluding fees; null without a minimum.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

slot_interval_minutes integer

Minutes between pick-up times (online shops).

lead_time_minutes integer

Minimum minutes between ordering and pick-up (online shops).

max_orders_per_slot integer

Maximum orders per pick-up time (online shops).

horizon_days integer

How many days ahead guests can order (online shops).

welcome_text string

Text shown when the shop opens.

closed_text string

Text shown while the shop is closed.

terms_url string

Link to the terms and conditions; null when the shop shows `terms_text` or has none.

terms_text string

Terms and conditions shown in the shop itself; null when it links to `terms_url`.

privacy_url string

Link to the privacy statement; null when the shop shows `privacy_text` or has none.

privacy_text string

Privacy statement shown in the shop itself; null when it links to `privacy_url`.

url string

Public URL of the shop.

fee_ids array of integer

Fees added to every order, for example a delivery fee (`GET /v1/fees`).

Opening windows of the shop.

id integer

Unique identifier of the window.

name string

Name of the window.

frequency string

How the window repeats: `day`, `week`, `month` or `year`; null for a one-time window.

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday; null for other windows.

ordinals array of integer

Which of the weekdays a monthly window opens on, 1 to 4 or -1 for the last; null for other windows.

from_time string

Time of day a repeating window opens, HH:MM; null for a one-time window.

till_time string

Time of day a repeating window closes, HH:MM; before from_time when it runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year.

repeats_until date

Last date a repeating window opens; null when it repeats forever.

starts_at datetime

Start of a one-time window; null for a repeating window.

ends_at datetime

End of a one-time window; null for a repeating window.

starts_on date

First date of a special period that replaces the regular windows; null for a regular window.

ends_on date

Last date of a special period; null when open-ended.

schedule string

When the window opens, in words.

slot_interval_minutes integer

Minutes between pick-up times; null for the shop default.

lead_time_minutes integer

Minimum minutes between ordering and pick-up; null for the shop default.

max_orders_per_slot integer

Maximum orders per pick-up time; null for the shop default.

created_at datetime

Time the window was created.

updated_at datetime

Time the window was last updated.

archived boolean

Whether the shop is archived.

created_at datetime

Time the shop was created.

updated_at datetime

Time the shop was last updated.

Example response
{
  "kind": "string",
  "id": 1,
  "name": "string",
  "enabled": true,
  "open": true,
  "quickselect_page_id": 1,
  "payment_method_id": 1,
  "minimum_order_amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "slot_interval_minutes": 1,
  "lead_time_minutes": 1,
  "max_orders_per_slot": 1,
  "horizon_days": 1,
  "welcome_text": "string",
  "closed_text": "string",
  "terms_url": "string",
  "terms_text": "string",
  "privacy_url": "string",
  "privacy_text": "string",
  "url": "string",
  "fee_ids": [
    1
  ],
  "windows": [
    {
      "id": 1,
      "name": "string",
      "frequency": "string",
      "weekdays": [
        1
      ],
      "ordinals": [
        1
      ],
      "from_time": "string",
      "till_time": "string",
      "repeats_from": "2026-01-15",
      "repeats_until": "2026-01-15",
      "starts_at": "2026-01-15T12:30:00Z",
      "ends_at": "2026-01-15T12:30:00Z",
      "starts_on": "2026-01-15",
      "ends_on": "2026-01-15",
      "schedule": "string",
      "slot_interval_minutes": 1,
      "lead_time_minutes": 1,
      "max_orders_per_slot": 1,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/shops/{id} shop:read

Retrieve a shop

Parameters

id path · integer req

Unique identifier of the shop

Responses

200 Shop Retrieve a shop
Response attributes
kind string

One of `online`, `pay_now` or `pay_later`.

id integer

Unique identifier of the shop.

name string

Name of the shop.

enabled boolean

Whether the shop accepts orders.

open boolean

Whether the shop is open for orders right now.

quickselect_page_id integer

Unique identifier of the quickselect page used as the menu.

payment_method_id integer

Unique identifier of the payment method used for online payment.

minimum_order_amount Money

Minimum order amount, excluding fees; null without a minimum.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

slot_interval_minutes integer

Minutes between pick-up times (online shops).

lead_time_minutes integer

Minimum minutes between ordering and pick-up (online shops).

max_orders_per_slot integer

Maximum orders per pick-up time (online shops).

horizon_days integer

How many days ahead guests can order (online shops).

welcome_text string

Text shown when the shop opens.

closed_text string

Text shown while the shop is closed.

terms_url string

Link to the terms and conditions; null when the shop shows `terms_text` or has none.

terms_text string

Terms and conditions shown in the shop itself; null when it links to `terms_url`.

privacy_url string

Link to the privacy statement; null when the shop shows `privacy_text` or has none.

privacy_text string

Privacy statement shown in the shop itself; null when it links to `privacy_url`.

url string

Public URL of the shop.

fee_ids array of integer

Fees added to every order, for example a delivery fee (`GET /v1/fees`).

Opening windows of the shop.

id integer

Unique identifier of the window.

name string

Name of the window.

frequency string

How the window repeats: `day`, `week`, `month` or `year`; null for a one-time window.

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday; null for other windows.

ordinals array of integer

Which of the weekdays a monthly window opens on, 1 to 4 or -1 for the last; null for other windows.

from_time string

Time of day a repeating window opens, HH:MM; null for a one-time window.

till_time string

Time of day a repeating window closes, HH:MM; before from_time when it runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year.

repeats_until date

Last date a repeating window opens; null when it repeats forever.

starts_at datetime

Start of a one-time window; null for a repeating window.

ends_at datetime

End of a one-time window; null for a repeating window.

starts_on date

First date of a special period that replaces the regular windows; null for a regular window.

ends_on date

Last date of a special period; null when open-ended.

schedule string

When the window opens, in words.

slot_interval_minutes integer

Minutes between pick-up times; null for the shop default.

lead_time_minutes integer

Minimum minutes between ordering and pick-up; null for the shop default.

max_orders_per_slot integer

Maximum orders per pick-up time; null for the shop default.

created_at datetime

Time the window was created.

updated_at datetime

Time the window was last updated.

archived boolean

Whether the shop is archived.

created_at datetime

Time the shop was created.

updated_at datetime

Time the shop was last updated.

Example response
{
  "kind": "string",
  "id": 1,
  "name": "string",
  "enabled": true,
  "open": true,
  "quickselect_page_id": 1,
  "payment_method_id": 1,
  "minimum_order_amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "slot_interval_minutes": 1,
  "lead_time_minutes": 1,
  "max_orders_per_slot": 1,
  "horizon_days": 1,
  "welcome_text": "string",
  "closed_text": "string",
  "terms_url": "string",
  "terms_text": "string",
  "privacy_url": "string",
  "privacy_text": "string",
  "url": "string",
  "fee_ids": [
    1
  ],
  "windows": [
    {
      "id": 1,
      "name": "string",
      "frequency": "string",
      "weekdays": [
        1
      ],
      "ordinals": [
        1
      ],
      "from_time": "string",
      "till_time": "string",
      "repeats_from": "2026-01-15",
      "repeats_until": "2026-01-15",
      "starts_at": "2026-01-15T12:30:00Z",
      "ends_at": "2026-01-15T12:30:00Z",
      "starts_on": "2026-01-15",
      "ends_on": "2026-01-15",
      "schedule": "string",
      "slot_interval_minutes": 1,
      "lead_time_minutes": 1,
      "max_orders_per_slot": 1,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/shops/{id} shop:write

Updates the given attributes; attributes that are not included keep their current value.

Parameters

id path · integer req

Unique identifier of the shop

Request body

name string

Name of the shop, for example `Takeaway` or `Order at your table`

enabled boolean

Whether the shop accepts orders. Enabling needs a menu (`quickselect_page_id`) and, for shops that take payment, a `payment_method_id`.

quickselect_page_id integer

Quickselect page used as the menu

payment_method_id integer

Payment method guests pay with online

minimum_order_amount object

Minimum order amount, excluding fees; null for none

value integer req

Amount as a whole number in the precision of `minor_units`, for example `1250` for €12.50

currency enum req

ISO 4217 currency code

EUR

minor_units integer

Number of decimal places in `value`, from 0 up to that of the currency; defaults to the currency's (`2` for EUR). `value` 125 with `minor_units` 1 is €12.50

welcome_text string

Text shown when the shop opens

closed_text string

Text shown while the shop is closed

back_url string

Link back to the organization's own website

background_color string

Background color as #rrggbb

text_color string

Text color as #rrggbb

slot_interval_minutes integer

Minutes between pick-up times (online shops)

lead_time_minutes integer

Minimum minutes between ordering and pick-up (online shops)

max_orders_per_slot integer

Maximum orders per pick-up time (online shops)

horizon_days integer

How many days ahead guests can order (online shops)

terms_url string

Link to the terms and conditions guests agree to; replaces `terms_text`

terms_text string

Terms and conditions shown in the shop itself; replaces `terms_url`

privacy_url string

Link to the privacy statement; replaces `privacy_text`

privacy_text string

Privacy statement shown in the shop itself; replaces `privacy_url`

fee_ids array of integer

Fees charged on every order, for example a delivery fee (`GET /v1/fees`). The list replaces the current fees, so `[]` removes them all

{
  "enabled": true,
  "terms_url": "https://bistro.nl/terms"
}

Responses

200 Shop Update a shop
Response attributes
kind string

One of `online`, `pay_now` or `pay_later`.

id integer

Unique identifier of the shop.

name string

Name of the shop.

enabled boolean

Whether the shop accepts orders.

open boolean

Whether the shop is open for orders right now.

quickselect_page_id integer

Unique identifier of the quickselect page used as the menu.

payment_method_id integer

Unique identifier of the payment method used for online payment.

minimum_order_amount Money

Minimum order amount, excluding fees; null without a minimum.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

slot_interval_minutes integer

Minutes between pick-up times (online shops).

lead_time_minutes integer

Minimum minutes between ordering and pick-up (online shops).

max_orders_per_slot integer

Maximum orders per pick-up time (online shops).

horizon_days integer

How many days ahead guests can order (online shops).

welcome_text string

Text shown when the shop opens.

closed_text string

Text shown while the shop is closed.

terms_url string

Link to the terms and conditions; null when the shop shows `terms_text` or has none.

terms_text string

Terms and conditions shown in the shop itself; null when it links to `terms_url`.

privacy_url string

Link to the privacy statement; null when the shop shows `privacy_text` or has none.

privacy_text string

Privacy statement shown in the shop itself; null when it links to `privacy_url`.

url string

Public URL of the shop.

fee_ids array of integer

Fees added to every order, for example a delivery fee (`GET /v1/fees`).

Opening windows of the shop.

id integer

Unique identifier of the window.

name string

Name of the window.

frequency string

How the window repeats: `day`, `week`, `month` or `year`; null for a one-time window.

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday; null for other windows.

ordinals array of integer

Which of the weekdays a monthly window opens on, 1 to 4 or -1 for the last; null for other windows.

from_time string

Time of day a repeating window opens, HH:MM; null for a one-time window.

till_time string

Time of day a repeating window closes, HH:MM; before from_time when it runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year.

repeats_until date

Last date a repeating window opens; null when it repeats forever.

starts_at datetime

Start of a one-time window; null for a repeating window.

ends_at datetime

End of a one-time window; null for a repeating window.

starts_on date

First date of a special period that replaces the regular windows; null for a regular window.

ends_on date

Last date of a special period; null when open-ended.

schedule string

When the window opens, in words.

slot_interval_minutes integer

Minutes between pick-up times; null for the shop default.

lead_time_minutes integer

Minimum minutes between ordering and pick-up; null for the shop default.

max_orders_per_slot integer

Maximum orders per pick-up time; null for the shop default.

created_at datetime

Time the window was created.

updated_at datetime

Time the window was last updated.

archived boolean

Whether the shop is archived.

created_at datetime

Time the shop was created.

updated_at datetime

Time the shop was last updated.

Example response
{
  "kind": "string",
  "id": 1,
  "name": "string",
  "enabled": true,
  "open": true,
  "quickselect_page_id": 1,
  "payment_method_id": 1,
  "minimum_order_amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "slot_interval_minutes": 1,
  "lead_time_minutes": 1,
  "max_orders_per_slot": 1,
  "horizon_days": 1,
  "welcome_text": "string",
  "closed_text": "string",
  "terms_url": "string",
  "terms_text": "string",
  "privacy_url": "string",
  "privacy_text": "string",
  "url": "string",
  "fee_ids": [
    1
  ],
  "windows": [
    {
      "id": 1,
      "name": "string",
      "frequency": "string",
      "weekdays": [
        1
      ],
      "ordinals": [
        1
      ],
      "from_time": "string",
      "till_time": "string",
      "repeats_from": "2026-01-15",
      "repeats_until": "2026-01-15",
      "starts_at": "2026-01-15T12:30:00Z",
      "ends_at": "2026-01-15T12:30:00Z",
      "starts_on": "2026-01-15",
      "ends_on": "2026-01-15",
      "schedule": "string",
      "slot_interval_minutes": 1,
      "lead_time_minutes": 1,
      "max_orders_per_slot": 1,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/shops/{id} shop:write

Disables the shop and hides it. Its orders are kept.

Parameters

id path · integer req

Unique identifier of the shop

Responses

204 Archive a shop
POST /v1/shops/{id}/orders shop:write

Places an order the way a guest does in the shop: only products on the shop's menu can be ordered, the minimum order amount, pick-up time and shop fees apply and the receipt is decorated with the shop's color and markers. Online shops need `customer` and `pick_up_at`, pay-now shops a `table_id` and pay-later shops the `receipt_id` of the guest's open receipt. The order is submitted for preparation right away; record its payment with `POST /v1/payments`.

Parameters

id path · integer req

Unique identifier of the shop

Request body

customer object

Guest details (online shops)

name string req

Full name

email string req

Email address, used to find an existing customer

phone string

Phone number

pick_up_at datetime

Pick-up moment, one of the shop's pick-up times (online shops)

table_id integer

Table to order on (pay-now shops)

receipt_id integer

Open receipt to order on (pay-later shops)

items array of object req

Products to order

product_id integer req

Unique identifier of a product on the shop's menu

quantity integer

Number of times to order the product

default 1

options object

Chosen options per option group: `{ "": }` for single-choice groups, `{ "": { "": } }` for add-on groups

note string

Note shown on the preparation receipt

{
  "customer": {
    "name": "Jan de Vries",
    "email": "jan@example.com"
  },
  "pick_up_at": "2026-11-20T18:15:00+01:00",
  "items": [
    {
      "product_id": 101,
      "quantity": 2,
      "options": {
        "3": 14
      }
    }
  ]
}

Responses

201 Order Place an order in a shop
Response attributes
id integer

Unique identifier of the order.

receipt_id integer

Unique identifier of the receipt the order was placed on.

shop_id integer

Unique identifier of the shop the order was placed in; null for orders from the register or the API.

receiptable_type string

What the order was placed on: `table`, `customer`, `group` or `employee`.

receiptable_id integer

Unique identifier of the table, customer, group or employee the order was placed on.

pick_up_at datetime

Pick-up moment for takeout orders; null otherwise.

items array of object

Items that were ordered.

id integer

Unique identifier of the item.

product_id integer

Unique identifier of the ordered product; null for free-form items.

parent_id integer

Unique identifier of the item this item belongs to, for example a product option or a fee; null for top-level items.

description string

Description of the item as shown on the receipt.

note string

Note shown on the preparation receipt.

price Money

Unit price after discounts and compensation; this is what the guest pays.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

original_price Money

Unit price before discounts and compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

discount_percentage number

Discount percentage applied to the item, from a discount rule or the receipt discount; 0 without discount.

compensation Money

Amount taken off the item as compensation, for example for a cold dish; 0 without compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

compensation_reason_id integer

Unique identifier of the compensation reason; null without compensation.

compensation_reason string

Reason for the compensation, as set up in the back office; null without compensation.

compensation_note string

Note the employee added to the compensation.

tax_rate TaxRate

Tax rate applied to the item.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the item counts towards.

id integer

Unique identifier of the resource.

name string

Name of the resource.

cost_price Money

Cost price of the item.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

unit_quantity integer

Quantity sold of `unit_name`, for example 250 for 250 gram; null for items sold per piece.

unit_name string

Unit the item is sold per, for example `gram`; null for items sold per piece.

course integer

Course the item is served in, 0 for no course.

preparation_state string

Where the item is in preparation: `unrequested`, `requested`, `ready_to_prepare`, `preparing`, `prepared`, `ready_to_deliver` or `delivered`.

representation_by Reference

Employee the item was booked on as representation (on the house), if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

own_use boolean

Whether the item was booked as own use (consumed by staff or the business) instead of sold.

payment_status string

Payment status of the item: `open`, `pending` or `paid`.

refunded_item_id integer

On a return receipt: the item that was refunded; null otherwise.

voucher_card_id integer

Voucher card sold or topped up with the item (`GET /v1/voucher_cards/{id}`); null otherwise.

kind enum

`sale` for products and other items, `voucher` for a sold voucher card, `loyalty_topup` for balance topped up on a customer and `reservation_deposit` for a deposit paid on a reservation.

salevoucherloyalty_topupreservation_deposit

voucher Reference

Voucher sold with the item, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for top-up items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

created_at datetime

Time the item was added to the receipt.

updated_at datetime

Time the receipt item was last updated.

submitted_at datetime

Time the order was submitted for preparation; null while the order is still a cart.

created_at datetime

Time the order was created.

updated_at datetime

Time the order was last updated.

Example response
{
  "id": 1,
  "receipt_id": 1,
  "shop_id": 1,
  "receiptable_type": "string",
  "receiptable_id": 1,
  "pick_up_at": "2026-01-15T12:30:00Z",
  "items": [
    {
      "id": 1,
      "product_id": 1,
      "parent_id": 1,
      "description": "string",
      "note": "string",
      "price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "original_price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "discount_percentage": 9.99,
      "compensation": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "compensation_reason_id": 1,
      "compensation_reason": "string",
      "compensation_note": "string",
      "tax_rate": {
        "id": 1,
        "name": "string",
        "percentage": 9.99,
        "kind": "string",
        "archived": true,
        "label": "string",
        "created_at": "2026-01-15T12:30:00Z",
        "updated_at": "2026-01-15T12:30:00Z"
      },
      "category_of_revenue": {
        "id": 1,
        "name": "string"
      },
      "cost_price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "unit_quantity": 1,
      "unit_name": "string",
      "course": 1,
      "preparation_state": "string",
      "representation_by": {
        "id": 1,
        "name": "string"
      },
      "own_use": true,
      "payment_status": "string",
      "refunded_item_id": 1,
      "voucher_card_id": 1,
      "kind": "sale",
      "voucher": {
        "id": 1,
        "name": "string"
      },
      "loyalty": {
        "id": 1,
        "name": "string"
      },
      "reservation": {
        "id": 1,
        "name": "string"
      },
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "submitted_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/shops/{id}/pickup_slots shop:read

Returns the pick-up times guests can choose on the given day in an online shop, applying its windows, lead time, closures and orders per pick-up time.

Parameters

id path · integer req

Unique identifier of the shop

date query · date

Day to list pick-up times for; defaults to today

Responses

200 ShopPickupSlots List pick-up times
Response attributes
date date

Day the pick-up times are for.

slots array of datetime

Pick-up times that can still be chosen.

Example response
{
  "date": "2026-01-15",
  "slots": [
    "2026-01-15T12:30:00Z"
  ]
}

Shop windows

GET /v1/shop_windows shop:read

Returns the opening windows of all shops, or of one shop with `shop_id`. A shop only accepts orders inside its windows.

Parameters

shop_id query · integer

Only windows of this shop

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of ShopWindow List shop windows
Response attributes

The items on this page.

id integer

Unique identifier of the window.

name string

Name of the window.

frequency string

How the window repeats: `day`, `week`, `month` or `year`; null for a one-time window.

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday; null for other windows.

ordinals array of integer

Which of the weekdays a monthly window opens on, 1 to 4 or -1 for the last; null for other windows.

from_time string

Time of day a repeating window opens, HH:MM; null for a one-time window.

till_time string

Time of day a repeating window closes, HH:MM; before from_time when it runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year.

repeats_until date

Last date a repeating window opens; null when it repeats forever.

starts_at datetime

Start of a one-time window; null for a repeating window.

ends_at datetime

End of a one-time window; null for a repeating window.

starts_on date

First date of a special period that replaces the regular windows; null for a regular window.

ends_on date

Last date of a special period; null when open-ended.

schedule string

When the window opens, in words.

slot_interval_minutes integer

Minutes between pick-up times; null for the shop default.

lead_time_minutes integer

Minimum minutes between ordering and pick-up; null for the shop default.

max_orders_per_slot integer

Maximum orders per pick-up time; null for the shop default.

created_at datetime

Time the window was created.

updated_at datetime

Time the window was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "frequency": "string",
      "weekdays": [
        1
      ],
      "ordinals": [
        1
      ],
      "from_time": "string",
      "till_time": "string",
      "repeats_from": "2026-01-15",
      "repeats_until": "2026-01-15",
      "starts_at": "2026-01-15T12:30:00Z",
      "ends_at": "2026-01-15T12:30:00Z",
      "starts_on": "2026-01-15",
      "ends_on": "2026-01-15",
      "schedule": "string",
      "slot_interval_minutes": 1,
      "lead_time_minutes": 1,
      "max_orders_per_slot": 1,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/shop_windows shop:write

Opens a shop for orders, for example Friday and Saturday from 17:00 to 21:00. Windows of the same shop can't overlap. A window either repeats (`frequency` with `weekdays`, `from_time` and `till_time`, optionally bounded by `repeats_from` and `repeats_until`) or opens once from `starts_at` to `ends_at`, next to the regular windows. Add `starts_on` and `ends_on` to make it a special period: on those dates it replaces the regular windows.

Request body

shop_id integer req

Unique identifier of the shop

name string req

Name of the window, for example `Dinner` or `Weekend lunch`

frequency enum

How a repeating window repeats: `week` (on `weekdays`, the default), `day` (every day), `month` (on the `ordinals` of the `weekdays`, for example the first Tuesday) or `year` (every year on the date of `repeats_from`)

dayweekmonthyear

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday and 6 is Saturday

ordinals array of integer

Which of the `weekdays` in a month a monthly window opens on: 1 to 4 for the first to fourth, -1 for the last. `weekdays: [2], ordinals: [1, 3]` opens on the first and third Tuesday

1234-1

from_time string

Time of day a repeating window opens, HH:MM

till_time string

Time of day a repeating window closes, HH:MM. A time before `from_time` closes the next day, so `17:00` to `01:00` runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year. Leave empty to start right away

repeats_until date

Last date a repeating window opens; leave empty to repeat forever

starts_at datetime

Start of a one-time window, for example an extra evening for an event. A one-time window opens once from `starts_at` to `ends_at`, next to the regular windows; give it instead of the repeating fields

ends_at datetime

End of a one-time window

starts_on date

First date of a special period. A special period replaces the regular windows on the days it opens, for example different hours on Christmas Eve. Leave empty for a regular window.

ends_on date

Last date of a special period; leave empty for one that only starts on `starts_on`

slot_interval_minutes integer

Minutes between pick-up times (online shops); leave empty for the shop default

lead_time_minutes integer

Minimum minutes between ordering and pick-up (online shops); leave empty for the shop default

max_orders_per_slot integer

Maximum orders per pick-up time (online shops); leave empty for the shop default

{
  "shop_id": 2,
  "name": "Lunch",
  "frequency": "week",
  "weekdays": [
    1,
    2,
    3,
    4,
    5
  ],
  "from_time": "11:30",
  "till_time": "14:00"
}

Responses

201 ShopWindow Create a shop window
Response attributes
id integer

Unique identifier of the window.

name string

Name of the window.

frequency string

How the window repeats: `day`, `week`, `month` or `year`; null for a one-time window.

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday; null for other windows.

ordinals array of integer

Which of the weekdays a monthly window opens on, 1 to 4 or -1 for the last; null for other windows.

from_time string

Time of day a repeating window opens, HH:MM; null for a one-time window.

till_time string

Time of day a repeating window closes, HH:MM; before from_time when it runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year.

repeats_until date

Last date a repeating window opens; null when it repeats forever.

starts_at datetime

Start of a one-time window; null for a repeating window.

ends_at datetime

End of a one-time window; null for a repeating window.

starts_on date

First date of a special period that replaces the regular windows; null for a regular window.

ends_on date

Last date of a special period; null when open-ended.

schedule string

When the window opens, in words.

slot_interval_minutes integer

Minutes between pick-up times; null for the shop default.

lead_time_minutes integer

Minimum minutes between ordering and pick-up; null for the shop default.

max_orders_per_slot integer

Maximum orders per pick-up time; null for the shop default.

created_at datetime

Time the window was created.

updated_at datetime

Time the window was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "frequency": "string",
  "weekdays": [
    1
  ],
  "ordinals": [
    1
  ],
  "from_time": "string",
  "till_time": "string",
  "repeats_from": "2026-01-15",
  "repeats_until": "2026-01-15",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "starts_on": "2026-01-15",
  "ends_on": "2026-01-15",
  "schedule": "string",
  "slot_interval_minutes": 1,
  "lead_time_minutes": 1,
  "max_orders_per_slot": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/shop_windows/{id} shop:read

Retrieve a shop window

Parameters

id path · integer req

Unique identifier of the window

Responses

200 ShopWindow Retrieve a shop window
Response attributes
id integer

Unique identifier of the window.

name string

Name of the window.

frequency string

How the window repeats: `day`, `week`, `month` or `year`; null for a one-time window.

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday; null for other windows.

ordinals array of integer

Which of the weekdays a monthly window opens on, 1 to 4 or -1 for the last; null for other windows.

from_time string

Time of day a repeating window opens, HH:MM; null for a one-time window.

till_time string

Time of day a repeating window closes, HH:MM; before from_time when it runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year.

repeats_until date

Last date a repeating window opens; null when it repeats forever.

starts_at datetime

Start of a one-time window; null for a repeating window.

ends_at datetime

End of a one-time window; null for a repeating window.

starts_on date

First date of a special period that replaces the regular windows; null for a regular window.

ends_on date

Last date of a special period; null when open-ended.

schedule string

When the window opens, in words.

slot_interval_minutes integer

Minutes between pick-up times; null for the shop default.

lead_time_minutes integer

Minimum minutes between ordering and pick-up; null for the shop default.

max_orders_per_slot integer

Maximum orders per pick-up time; null for the shop default.

created_at datetime

Time the window was created.

updated_at datetime

Time the window was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "frequency": "string",
  "weekdays": [
    1
  ],
  "ordinals": [
    1
  ],
  "from_time": "string",
  "till_time": "string",
  "repeats_from": "2026-01-15",
  "repeats_until": "2026-01-15",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "starts_on": "2026-01-15",
  "ends_on": "2026-01-15",
  "schedule": "string",
  "slot_interval_minutes": 1,
  "lead_time_minutes": 1,
  "max_orders_per_slot": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/shop_windows/{id} shop:write

Updates the given attributes; attributes that are not included keep their current value, so sending only `till_time` moves the closing time on the same weekdays. Sending `starts_at` and `ends_at` turns a repeating window into a one-time window, sending the repeating fields turns it back.

Parameters

id path · integer req

Unique identifier of the window

Request body

name string

Name of the window, for example `Dinner` or `Weekend lunch`

frequency enum

How a repeating window repeats: `week` (on `weekdays`, the default), `day` (every day), `month` (on the `ordinals` of the `weekdays`, for example the first Tuesday) or `year` (every year on the date of `repeats_from`)

dayweekmonthyear

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday and 6 is Saturday

ordinals array of integer

Which of the `weekdays` in a month a monthly window opens on: 1 to 4 for the first to fourth, -1 for the last. `weekdays: [2], ordinals: [1, 3]` opens on the first and third Tuesday

1234-1

from_time string

Time of day a repeating window opens, HH:MM

till_time string

Time of day a repeating window closes, HH:MM. A time before `from_time` closes the next day, so `17:00` to `01:00` runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year. Leave empty to start right away

repeats_until date

Last date a repeating window opens; leave empty to repeat forever

starts_at datetime

Start of a one-time window, for example an extra evening for an event. A one-time window opens once from `starts_at` to `ends_at`, next to the regular windows; give it instead of the repeating fields

ends_at datetime

End of a one-time window

starts_on date

First date of a special period. A special period replaces the regular windows on the days it opens, for example different hours on Christmas Eve. Leave empty for a regular window.

ends_on date

Last date of a special period; leave empty for one that only starts on `starts_on`

slot_interval_minutes integer

Minutes between pick-up times (online shops); leave empty for the shop default

lead_time_minutes integer

Minimum minutes between ordering and pick-up (online shops); leave empty for the shop default

max_orders_per_slot integer

Maximum orders per pick-up time (online shops); leave empty for the shop default

{
  "max_orders_per_slot": 6
}

Responses

200 ShopWindow Update a shop window
Response attributes
id integer

Unique identifier of the window.

name string

Name of the window.

frequency string

How the window repeats: `day`, `week`, `month` or `year`; null for a one-time window.

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday; null for other windows.

ordinals array of integer

Which of the weekdays a monthly window opens on, 1 to 4 or -1 for the last; null for other windows.

from_time string

Time of day a repeating window opens, HH:MM; null for a one-time window.

till_time string

Time of day a repeating window closes, HH:MM; before from_time when it runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year.

repeats_until date

Last date a repeating window opens; null when it repeats forever.

starts_at datetime

Start of a one-time window; null for a repeating window.

ends_at datetime

End of a one-time window; null for a repeating window.

starts_on date

First date of a special period that replaces the regular windows; null for a regular window.

ends_on date

Last date of a special period; null when open-ended.

schedule string

When the window opens, in words.

slot_interval_minutes integer

Minutes between pick-up times; null for the shop default.

lead_time_minutes integer

Minimum minutes between ordering and pick-up; null for the shop default.

max_orders_per_slot integer

Maximum orders per pick-up time; null for the shop default.

created_at datetime

Time the window was created.

updated_at datetime

Time the window was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "frequency": "string",
  "weekdays": [
    1
  ],
  "ordinals": [
    1
  ],
  "from_time": "string",
  "till_time": "string",
  "repeats_from": "2026-01-15",
  "repeats_until": "2026-01-15",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "starts_on": "2026-01-15",
  "ends_on": "2026-01-15",
  "schedule": "string",
  "slot_interval_minutes": 1,
  "lead_time_minutes": 1,
  "max_orders_per_slot": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/shop_windows/{id} shop:write

The shop no longer accepts orders in this window.

Parameters

id path · integer req

Unique identifier of the window

Responses

204 Delete a shop window

Subscription

PATCH /v1/subscription

Updates the state of your app's subscription for this organization. Mark the subscription as active once your app has finished setting up.

Request body

state enum req

New state of the subscription

active

{
  "state": "active"
}

Responses

200 Update the subscription
DELETE /v1/subscription

Deletes your app's subscription for this organization, immediately revoking its access and refresh tokens.

Responses

204 Cancel the subscription

Tables

Returns the tables of the floor plan ordered by area and number, with their seats, whether they take online reservations and the tables they may be joined with.

Parameters

area_id query · integer

Only tables in this area

number query · integer

Only the table with this number

include_archived query · boolean

Include archived tables

default false

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Table List tables
Response attributes

The items on this page.

id integer

Unique identifier of the table.

area_id integer

Unique identifier of the area this table belongs to.

number integer

Table number shown to staff, for example 12.

capacity integer

Number of seats. Online reservations only get tables (or joined tables) with enough seats.

reservable boolean

Whether online reservations can be assigned to this table. Staff can always assign it.

shape string

Floor-plan shape: `round` or `square`.

width integer

Width as a percentage of a standard table footprint (1-200).

height integer

Height as a percentage of a standard table footprint (1-200).

links array of object

Tables this table may be joined with for one reservation. Only used when the area's `table_combination_mode` is `explicit`.

table_id integer

Unique identifier of the linked table.

capacity_loss integer

Seats lost when the two tables are pushed together, for example 2 when the joined ends can't seat anyone.

hidden boolean

Whether the table is temporarily hidden. Hidden tables are left out of the floor plan at the register and out of online reservations.

archived boolean

Whether the table is archived.

created_at datetime

Time the table was created.

updated_at datetime

Time the table was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "area_id": 1,
      "number": 1,
      "capacity": 1,
      "reservable": true,
      "shape": "string",
      "width": 1,
      "height": 1,
      "links": [
        {
          "table_id": 1,
          "capacity_loss": 1
        }
      ],
      "hidden": true,
      "archived": true,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}

Adds a table to an area, for example `{ "area_id": 1, "number": 12, "capacity": 4 }`. Online reservations are assigned to reservable tables with enough seats, or to a combination of tables in one area: any tables in an `automatic` area, only linked tables in an `explicit` area.

Request body

area_id integer req

Unique identifier of the area

number integer req

Table number shown to staff, for example `12`

capacity integer

Number of seats; defaults to 2. Online reservations only get tables, or joined tables, with enough seats

reservable boolean

Whether online reservations can be assigned to this table; defaults to `true`. Staff can always assign it

shape enum

Floor-plan shape; defaults to `square`

roundsquare

width integer

Width as a percentage of a standard table footprint; defaults to 100

height integer

Height as a percentage of a standard table footprint; defaults to 100

links array of object

Replaces the tables this table may be joined with for one reservation, for example `[{ "table_id": 4, "capacity_loss": 2 }]`. Only used when the area's `table_combination_mode` is `explicit`; links work both ways. Pass `[]` to remove all links

table_id integer req

Unique identifier of another table in the same area

capacity_loss integer

Seats lost when the two tables are pushed together; defaults to 0

{
  "area_id": 1,
  "number": 12,
  "capacity": 4
}

Responses

201 Table Create a table
Response attributes
id integer

Unique identifier of the table.

area_id integer

Unique identifier of the area this table belongs to.

number integer

Table number shown to staff, for example 12.

capacity integer

Number of seats. Online reservations only get tables (or joined tables) with enough seats.

reservable boolean

Whether online reservations can be assigned to this table. Staff can always assign it.

shape string

Floor-plan shape: `round` or `square`.

width integer

Width as a percentage of a standard table footprint (1-200).

height integer

Height as a percentage of a standard table footprint (1-200).

links array of object

Tables this table may be joined with for one reservation. Only used when the area's `table_combination_mode` is `explicit`.

table_id integer

Unique identifier of the linked table.

capacity_loss integer

Seats lost when the two tables are pushed together, for example 2 when the joined ends can't seat anyone.

hidden boolean

Whether the table is temporarily hidden. Hidden tables are left out of the floor plan at the register and out of online reservations.

archived boolean

Whether the table is archived.

created_at datetime

Time the table was created.

updated_at datetime

Time the table was last updated.

Example response
{
  "id": 1,
  "area_id": 1,
  "number": 1,
  "capacity": 1,
  "reservable": true,
  "shape": "string",
  "width": 1,
  "height": 1,
  "links": [
    {
      "table_id": 1,
      "capacity_loss": 1
    }
  ],
  "hidden": true,
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/tables/{id} floorplan:read

Retrieve a table

Parameters

id path · integer req

Unique identifier of the table

Responses

200 Table Retrieve a table
Response attributes
id integer

Unique identifier of the table.

area_id integer

Unique identifier of the area this table belongs to.

number integer

Table number shown to staff, for example 12.

capacity integer

Number of seats. Online reservations only get tables (or joined tables) with enough seats.

reservable boolean

Whether online reservations can be assigned to this table. Staff can always assign it.

shape string

Floor-plan shape: `round` or `square`.

width integer

Width as a percentage of a standard table footprint (1-200).

height integer

Height as a percentage of a standard table footprint (1-200).

links array of object

Tables this table may be joined with for one reservation. Only used when the area's `table_combination_mode` is `explicit`.

table_id integer

Unique identifier of the linked table.

capacity_loss integer

Seats lost when the two tables are pushed together, for example 2 when the joined ends can't seat anyone.

hidden boolean

Whether the table is temporarily hidden. Hidden tables are left out of the floor plan at the register and out of online reservations.

archived boolean

Whether the table is archived.

created_at datetime

Time the table was created.

updated_at datetime

Time the table was last updated.

Example response
{
  "id": 1,
  "area_id": 1,
  "number": 1,
  "capacity": 1,
  "reservable": true,
  "shape": "string",
  "width": 1,
  "height": 1,
  "links": [
    {
      "table_id": 1,
      "capacity_loss": 1
    }
  ],
  "hidden": true,
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/tables/{id} floorplan:write

Updates the given attributes; attributes that are not included keep their current value. Passing `links` replaces all links of the table. Set `archived` to `false` to restore an archived table. Moving a table to another area is not supported.

Parameters

id path · integer req

Unique identifier of the table

Request body

number integer

Table number shown to staff, for example `12`

capacity integer

Number of seats; defaults to 2. Online reservations only get tables, or joined tables, with enough seats

reservable boolean

Whether online reservations can be assigned to this table; defaults to `true`. Staff can always assign it

shape enum

Floor-plan shape; defaults to `square`

roundsquare

width integer

Width as a percentage of a standard table footprint; defaults to 100

height integer

Height as a percentage of a standard table footprint; defaults to 100

links array of object

Replaces the tables this table may be joined with for one reservation, for example `[{ "table_id": 4, "capacity_loss": 2 }]`. Only used when the area's `table_combination_mode` is `explicit`; links work both ways. Pass `[]` to remove all links

table_id integer req

Unique identifier of another table in the same area

capacity_loss integer

Seats lost when the two tables are pushed together; defaults to 0

hidden boolean

Hide the table from the register's floor plan and from online reservations

archived boolean

`true` archives the table, `false` restores it

{
  "capacity": 6,
  "links": [
    {
      "table_id": 4,
      "capacity_loss": 2
    }
  ]
}

Responses

200 Table Update a table
Response attributes
id integer

Unique identifier of the table.

area_id integer

Unique identifier of the area this table belongs to.

number integer

Table number shown to staff, for example 12.

capacity integer

Number of seats. Online reservations only get tables (or joined tables) with enough seats.

reservable boolean

Whether online reservations can be assigned to this table. Staff can always assign it.

shape string

Floor-plan shape: `round` or `square`.

width integer

Width as a percentage of a standard table footprint (1-200).

height integer

Height as a percentage of a standard table footprint (1-200).

links array of object

Tables this table may be joined with for one reservation. Only used when the area's `table_combination_mode` is `explicit`.

table_id integer

Unique identifier of the linked table.

capacity_loss integer

Seats lost when the two tables are pushed together, for example 2 when the joined ends can't seat anyone.

hidden boolean

Whether the table is temporarily hidden. Hidden tables are left out of the floor plan at the register and out of online reservations.

archived boolean

Whether the table is archived.

created_at datetime

Time the table was created.

updated_at datetime

Time the table was last updated.

Example response
{
  "id": 1,
  "area_id": 1,
  "number": 1,
  "capacity": 1,
  "reservable": true,
  "shape": "string",
  "width": 1,
  "height": 1,
  "links": [
    {
      "table_id": 1,
      "capacity_loss": 1
    }
  ],
  "hidden": true,
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/tables/{id} floorplan:write

Takes the table out of use. Refused while it has open receipts, upcoming reservations, is in a guest group or is placed on a map.

Parameters

id path · integer req

Unique identifier of the table

Responses

200 Table Archive a table
Response attributes
id integer

Unique identifier of the table.

area_id integer

Unique identifier of the area this table belongs to.

number integer

Table number shown to staff, for example 12.

capacity integer

Number of seats. Online reservations only get tables (or joined tables) with enough seats.

reservable boolean

Whether online reservations can be assigned to this table. Staff can always assign it.

shape string

Floor-plan shape: `round` or `square`.

width integer

Width as a percentage of a standard table footprint (1-200).

height integer

Height as a percentage of a standard table footprint (1-200).

links array of object

Tables this table may be joined with for one reservation. Only used when the area's `table_combination_mode` is `explicit`.

table_id integer

Unique identifier of the linked table.

capacity_loss integer

Seats lost when the two tables are pushed together, for example 2 when the joined ends can't seat anyone.

hidden boolean

Whether the table is temporarily hidden. Hidden tables are left out of the floor plan at the register and out of online reservations.

archived boolean

Whether the table is archived.

created_at datetime

Time the table was created.

updated_at datetime

Time the table was last updated.

Example response
{
  "id": 1,
  "area_id": 1,
  "number": 1,
  "capacity": 1,
  "reservable": true,
  "shape": "string",
  "width": 1,
  "height": 1,
  "links": [
    {
      "table_id": 1,
      "capacity_loss": 1
    }
  ],
  "hidden": true,
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Takeout setting

GET /v1/takeout_setting organization:read

Retrieve the takeout settings

Responses

200 TakeoutSetting Retrieve the takeout settings
Response attributes
enabled boolean

Whether staff can ring up takeout orders.

color string

Color that marks takeout orders.

printer_id integer

Printer the takeout slip is printed on; null for none.

undock_receipts boolean

Whether takeout receipts start undocked on the register.

future_takeouts boolean

Whether takeout orders can be scheduled for a later day.

create_task_on_future_order boolean

Whether a task is added for each takeout order on a later day.

created_at datetime

Time the takeout settings was created.

updated_at datetime

Time the takeout settings was last updated.

Example response
{
  "enabled": true,
  "color": "string",
  "printer_id": 1,
  "undock_receipts": true,
  "future_takeouts": true,
  "create_task_on_future_order": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
PATCH /v1/takeout_setting organization:write

Updates the given settings; settings that are not included keep their current value.

Request body

enabled boolean

Let staff ring up takeout orders

color enum

Color that marks takeout orders

slategrayzincneutralstoneredorangeamberyellowlimegreenemeraldtealcyanskyblueindigovioletpurplefuchsiapinkrose

printer_id integer

Printer the takeout slip is printed on; null for none

undock_receipts boolean

Start takeout receipts undocked on the register

future_takeouts boolean

Allow takeout orders for a later day

create_task_on_future_order boolean

Add a task for each takeout order on a later day

{
  "enabled": true,
  "color": "amber",
  "future_takeouts": true
}

Responses

200 TakeoutSetting Update the takeout settings
Response attributes
enabled boolean

Whether staff can ring up takeout orders.

color string

Color that marks takeout orders.

printer_id integer

Printer the takeout slip is printed on; null for none.

undock_receipts boolean

Whether takeout receipts start undocked on the register.

future_takeouts boolean

Whether takeout orders can be scheduled for a later day.

create_task_on_future_order boolean

Whether a task is added for each takeout order on a later day.

created_at datetime

Time the takeout settings was created.

updated_at datetime

Time the takeout settings was last updated.

Example response
{
  "enabled": true,
  "color": "string",
  "printer_id": 1,
  "undock_receipts": true,
  "future_takeouts": true,
  "create_task_on_future_order": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Tasks

GET /v1/tasks task:read

Returns the tasks in the taskmanager, newest first. By default only open tasks; pass `status=completed` for tasks that were marked as done, most recently completed first. Task types: `app` (created by an app through the API), `reservation_approval` (a requested reservation awaits confirmation), `reservation_creation` (a guest booked online), `reservation_note` (a guest booked online with a note), `reservation_cancellation` (a guest cancelled), `deposit_refund` (a paid deposit should be refunded), `deposit_expired` (a deposit was not paid in time), `future_order` (a takeout order for a later day came in) or `app_domain_review` (20tabs approved or rejected a domain of your apps).

Parameters

status query · enum

Which tasks to return: `open`, `completed` or `all`

opencompletedall default open

kind query · enum

Only tasks of this kind, for example `reservation_approval`

appreservation_approvalreservation_creationreservation_notereservation_cancellationdeposit_refunddeposit_expiredfuture_orderapp_domain_review

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Task List tasks
Response attributes

The items on this page.

id integer

Unique identifier of the task.

kind enum

Kind of task: `app` (created by an app through the API), `reservation_approval` (a requested reservation awaits confirmation), `reservation_creation` (a guest booked online), `reservation_note` (a guest booked online with a note), `reservation_cancellation` (a guest cancelled), `deposit_refund` (a paid deposit should be refunded), `deposit_expired` (a deposit was not paid in time), `future_order` (a takeout order for a later day came in) or `app_domain_review` (20tabs approved or rejected a domain of your apps).

appreservation_approvalreservation_creationreservation_notereservation_cancellationdeposit_refunddeposit_expiredfuture_orderapp_domain_review

name string

Task name in the organization's language.

name_translations object

Task name per language code, for example `{ "en": "Missing barcode", "nl": "Ontbrekende barcode" }`.

description string

Task description in the organization's language.

description_translations object

Task description per language code.

taskable_type string

Kind of record the task is about, for example `reservation`; null when it is about nothing specific.

taskable_id integer

Identifier of the record the task is about, for example the reservation id.

open boolean

Whether the task still has to be done.

completed_at datetime

Time the task was marked as done; null while the task is open.

completed_by_employee_id integer

Employee who marked the task as done; null when done through the API or while open.

created_at datetime

Time the task was created.

updated_at datetime

Time the task was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "kind": "app",
      "name": "string",
      "name_translations": {},
      "description": "string",
      "description_translations": {},
      "taskable_type": "string",
      "taskable_id": 1,
      "open": true,
      "completed_at": "2026-01-15T12:30:00Z",
      "completed_by_employee_id": 1,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
POST /v1/tasks task:write

Creates a task of type `app` in the taskmanager, open until someone marks it as done. Use tasks to ask staff to take action for your app, for example to link a product that is missing in the menu.

Request body

name string

Task name in the organization's language, for example `Ontbrekende barcode`

name_translations object

Task name per language code, for example `{ "en": "Missing barcode", "nl": "Ontbrekende barcode" }`

description string

Task description in the organization's language

description_translations object

Task description per language code, for example `{ "en": "Product Cola has no barcode", "nl": "Product Cola heeft geen barcode" }`

{
  "name_translations": {
    "en": "Missing barcode",
    "nl": "Ontbrekende barcode"
  },
  "description": "Product 1001 has no barcode yet"
}

Responses

201 Task Create a task
Response attributes
id integer

Unique identifier of the task.

kind enum

Kind of task: `app` (created by an app through the API), `reservation_approval` (a requested reservation awaits confirmation), `reservation_creation` (a guest booked online), `reservation_note` (a guest booked online with a note), `reservation_cancellation` (a guest cancelled), `deposit_refund` (a paid deposit should be refunded), `deposit_expired` (a deposit was not paid in time), `future_order` (a takeout order for a later day came in) or `app_domain_review` (20tabs approved or rejected a domain of your apps).

appreservation_approvalreservation_creationreservation_notereservation_cancellationdeposit_refunddeposit_expiredfuture_orderapp_domain_review

name string

Task name in the organization's language.

name_translations object

Task name per language code, for example `{ "en": "Missing barcode", "nl": "Ontbrekende barcode" }`.

description string

Task description in the organization's language.

description_translations object

Task description per language code.

taskable_type string

Kind of record the task is about, for example `reservation`; null when it is about nothing specific.

taskable_id integer

Identifier of the record the task is about, for example the reservation id.

open boolean

Whether the task still has to be done.

completed_at datetime

Time the task was marked as done; null while the task is open.

completed_by_employee_id integer

Employee who marked the task as done; null when done through the API or while open.

created_at datetime

Time the task was created.

updated_at datetime

Time the task was last updated.

Example response
{
  "id": 1,
  "kind": "app",
  "name": "string",
  "name_translations": {},
  "description": "string",
  "description_translations": {},
  "taskable_type": "string",
  "taskable_id": 1,
  "open": true,
  "completed_at": "2026-01-15T12:30:00Z",
  "completed_by_employee_id": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
GET /v1/tasks/{id} task:read

Retrieve a task

Parameters

id path · integer req

Unique identifier of the task

Responses

200 Task Retrieve a task
Response attributes
id integer

Unique identifier of the task.

kind enum

Kind of task: `app` (created by an app through the API), `reservation_approval` (a requested reservation awaits confirmation), `reservation_creation` (a guest booked online), `reservation_note` (a guest booked online with a note), `reservation_cancellation` (a guest cancelled), `deposit_refund` (a paid deposit should be refunded), `deposit_expired` (a deposit was not paid in time), `future_order` (a takeout order for a later day came in) or `app_domain_review` (20tabs approved or rejected a domain of your apps).

appreservation_approvalreservation_creationreservation_notereservation_cancellationdeposit_refunddeposit_expiredfuture_orderapp_domain_review

name string

Task name in the organization's language.

name_translations object

Task name per language code, for example `{ "en": "Missing barcode", "nl": "Ontbrekende barcode" }`.

description string

Task description in the organization's language.

description_translations object

Task description per language code.

taskable_type string

Kind of record the task is about, for example `reservation`; null when it is about nothing specific.

taskable_id integer

Identifier of the record the task is about, for example the reservation id.

open boolean

Whether the task still has to be done.

completed_at datetime

Time the task was marked as done; null while the task is open.

completed_by_employee_id integer

Employee who marked the task as done; null when done through the API or while open.

created_at datetime

Time the task was created.

updated_at datetime

Time the task was last updated.

Example response
{
  "id": 1,
  "kind": "app",
  "name": "string",
  "name_translations": {},
  "description": "string",
  "description_translations": {},
  "taskable_type": "string",
  "taskable_id": 1,
  "open": true,
  "completed_at": "2026-01-15T12:30:00Z",
  "completed_by_employee_id": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
POST /v1/tasks/{id}/completion task:write

Marks an open task as done, exactly like ticking it off in the taskmanager. This only closes the task; it never performs the action itself. Completing a `deposit_refund` task does not refund anything and completing a `reservation_approval` task does not confirm the reservation: use the reservation endpoints for that (approval tasks then complete themselves).

Parameters

id path · integer req

Unique identifier of the task

Responses

201 Task Mark a task as done
Response attributes
id integer

Unique identifier of the task.

kind enum

Kind of task: `app` (created by an app through the API), `reservation_approval` (a requested reservation awaits confirmation), `reservation_creation` (a guest booked online), `reservation_note` (a guest booked online with a note), `reservation_cancellation` (a guest cancelled), `deposit_refund` (a paid deposit should be refunded), `deposit_expired` (a deposit was not paid in time), `future_order` (a takeout order for a later day came in) or `app_domain_review` (20tabs approved or rejected a domain of your apps).

appreservation_approvalreservation_creationreservation_notereservation_cancellationdeposit_refunddeposit_expiredfuture_orderapp_domain_review

name string

Task name in the organization's language.

name_translations object

Task name per language code, for example `{ "en": "Missing barcode", "nl": "Ontbrekende barcode" }`.

description string

Task description in the organization's language.

description_translations object

Task description per language code.

taskable_type string

Kind of record the task is about, for example `reservation`; null when it is about nothing specific.

taskable_id integer

Identifier of the record the task is about, for example the reservation id.

open boolean

Whether the task still has to be done.

completed_at datetime

Time the task was marked as done; null while the task is open.

completed_by_employee_id integer

Employee who marked the task as done; null when done through the API or while open.

created_at datetime

Time the task was created.

updated_at datetime

Time the task was last updated.

Example response
{
  "id": 1,
  "kind": "app",
  "name": "string",
  "name_translations": {},
  "description": "string",
  "description_translations": {},
  "taskable_type": "string",
  "taskable_id": 1,
  "open": true,
  "completed_at": "2026-01-15T12:30:00Z",
  "completed_by_employee_id": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
DELETE /v1/tasks/{id}/completion task:write

Puts a task that was marked as done back in the taskmanager.

Parameters

id path · integer req

Unique identifier of the task

Responses

200 Task Reopen a task
Response attributes
id integer

Unique identifier of the task.

kind enum

Kind of task: `app` (created by an app through the API), `reservation_approval` (a requested reservation awaits confirmation), `reservation_creation` (a guest booked online), `reservation_note` (a guest booked online with a note), `reservation_cancellation` (a guest cancelled), `deposit_refund` (a paid deposit should be refunded), `deposit_expired` (a deposit was not paid in time), `future_order` (a takeout order for a later day came in) or `app_domain_review` (20tabs approved or rejected a domain of your apps).

appreservation_approvalreservation_creationreservation_notereservation_cancellationdeposit_refunddeposit_expiredfuture_orderapp_domain_review

name string

Task name in the organization's language.

name_translations object

Task name per language code, for example `{ "en": "Missing barcode", "nl": "Ontbrekende barcode" }`.

description string

Task description in the organization's language.

description_translations object

Task description per language code.

taskable_type string

Kind of record the task is about, for example `reservation`; null when it is about nothing specific.

taskable_id integer

Identifier of the record the task is about, for example the reservation id.

open boolean

Whether the task still has to be done.

completed_at datetime

Time the task was marked as done; null while the task is open.

completed_by_employee_id integer

Employee who marked the task as done; null when done through the API or while open.

created_at datetime

Time the task was created.

updated_at datetime

Time the task was last updated.

Example response
{
  "id": 1,
  "kind": "app",
  "name": "string",
  "name_translations": {},
  "description": "string",
  "description_translations": {},
  "taskable_type": "string",
  "taskable_id": 1,
  "open": true,
  "completed_at": "2026-01-15T12:30:00Z",
  "completed_by_employee_id": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Tax rates

GET /v1/tax_rates tax_rate:read

Returns all tax rates configured for the organization.

Parameters

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of TaxRate List tax rates
Response attributes

The items on this page.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "percentage": 9.99,
      "kind": "string",
      "archived": true,
      "label": "string",
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
GET /v1/tax_rates/{id} tax_rate:read

Retrieve a tax rate

Parameters

id path · integer req

Unique identifier of the tax rate

Responses

200 TaxRate Retrieve a tax rate
Response attributes
id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "percentage": 9.99,
  "kind": "string",
  "archived": true,
  "label": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Vouchers

GET /v1/vouchers voucher:read

Returns the kinds of vouchers (gift cards) the organization sells, for example `Gift card` or `Christmas voucher`. The cards sold of each voucher are listed with `GET /v1/voucher_cards`.

Parameters

include_archived query · boolean

Include archived vouchers

default false

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of Voucher List vouchers
Response attributes

The items on this page.

id integer

Unique identifier of the voucher.

name string

Name of the voucher, for example `Gift card`.

scan_methods array of string

How cards are read at the register: `camera` (QR code), `nfc` (tap) and/or `manual` (typing the code).

physical_cards boolean

Whether the voucher is issued as printed or plastic cards, besides digital wallet passes.

payment_method_id integer

Payment method that records redemptions of this voucher (`GET /v1/payment_methods`).

archived boolean

Whether the voucher is archived and no longer sold.

created_at datetime

Time the voucher was created.

updated_at datetime

Time the voucher was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "name": "string",
      "scan_methods": [
        "string"
      ],
      "physical_cards": true,
      "payment_method_id": 1,
      "archived": true,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
GET /v1/vouchers/{id} voucher:read

Retrieve a voucher

Parameters

id path · integer req

Unique identifier of the voucher

Responses

200 Voucher Retrieve a voucher
Response attributes
id integer

Unique identifier of the voucher.

name string

Name of the voucher, for example `Gift card`.

scan_methods array of string

How cards are read at the register: `camera` (QR code), `nfc` (tap) and/or `manual` (typing the code).

physical_cards boolean

Whether the voucher is issued as printed or plastic cards, besides digital wallet passes.

payment_method_id integer

Payment method that records redemptions of this voucher (`GET /v1/payment_methods`).

archived boolean

Whether the voucher is archived and no longer sold.

created_at datetime

Time the voucher was created.

updated_at datetime

Time the voucher was last updated.

Example response
{
  "id": 1,
  "name": "string",
  "scan_methods": [
    "string"
  ],
  "physical_cards": true,
  "payment_method_id": 1,
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Voucher cards

GET /v1/voucher_cards voucher:read

Returns voucher cards (gift cards) with their balance, newest first. Codes work like cash, so they are never returned; `code_ending` shows the last 4 characters.

Parameters

voucher_id query · integer

Only cards of this voucher

customer_id query · integer

Only cards of this customer

activated query · boolean

`true` for only sold cards, `false` for only cards printed in advance that are not sold yet

with_balance query · boolean

`true` for only cards with balance left, `false` for only used-up cards

include_archived query · boolean

Include archived cards

default false

limit query · integer

Maximum number of items to return, at most 500

default 100

cursor query · string

`next_cursor` of the previous page; leave out for the first page

Responses

200 list of VoucherCard List voucher cards
Response attributes

The items on this page.

id integer

Unique identifier of the card.

voucher_id integer

Voucher the card belongs to (`GET /v1/vouchers`).

customer_id integer

Customer the card was sold to or linked with; null when anonymous.

initial_value Money

Value the card was issued with.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

remaining_balance Money

Balance that can still be spent.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

activated boolean

Whether the card was sold and can be spent. Cards printed in advance stay inactive until they are sold at the register.

activated_at datetime

Time the card was sold; null while inactive.

archived boolean

Whether the card is archived and can no longer be spent.

code_ending string

Last 4 characters of the code, to recognise a card without exposing its code.

created_at datetime

Time the card was created.

updated_at datetime

Time the card was last updated.

next_cursor string

Pass as `cursor` to get the next page; null on the last page.

Example response
{
  "items": [
    {
      "id": 1,
      "voucher_id": 1,
      "customer_id": 1,
      "initial_value": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "remaining_balance": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "activated": true,
      "activated_at": "2026-01-15T12:30:00Z",
      "archived": true,
      "code_ending": "string",
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "next_cursor": "string"
}
GET /v1/voucher_cards/{id} voucher:read

Returns one card with its balance.

Parameters

id path · integer req

Unique identifier of the card

Responses

200 VoucherCard Retrieve a voucher card
Response attributes
id integer

Unique identifier of the card.

voucher_id integer

Voucher the card belongs to (`GET /v1/vouchers`).

customer_id integer

Customer the card was sold to or linked with; null when anonymous.

initial_value Money

Value the card was issued with.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

remaining_balance Money

Balance that can still be spent.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

activated boolean

Whether the card was sold and can be spent. Cards printed in advance stay inactive until they are sold at the register.

activated_at datetime

Time the card was sold; null while inactive.

archived boolean

Whether the card is archived and can no longer be spent.

code_ending string

Last 4 characters of the code, to recognise a card without exposing its code.

created_at datetime

Time the card was created.

updated_at datetime

Time the card was last updated.

Example response
{
  "id": 1,
  "voucher_id": 1,
  "customer_id": 1,
  "initial_value": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "remaining_balance": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "activated": true,
  "activated_at": "2026-01-15T12:30:00Z",
  "archived": true,
  "code_ending": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Objects

The resource objects returned by the API.

Allergen

An allergen products can contain, for example gluten or milk. New organizations start with the 14 EU allergens.

id integer

Unique identifier of the allergen.

name string

Name in the organization's language.

name_translations object

Name per language code, for example `{ "nl": "Noten", "en": "Nuts" }`.

icon string

Icon shown next to the name, for example `wheat` or `milk`.

position integer

Display order, starting at 1.

created_at datetime

Time the allergen was created.

updated_at datetime

Time the allergen was last updated.

Example
{
  "id": 1,
  "name": "string",
  "name_translations": {},
  "icon": "string",
  "position": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Area

A section of the floor plan, for example Terrace or Bar, holding tables.

id integer

Unique identifier of the area.

name string

Name of the area, for example `Terrace`.

position integer

Display order within the floor plan, starting at 1.

table_combination_mode string

How online reservations may join tables for larger parties: `automatic` combines any tables in the area, `explicit` only combines tables linked to each other (see the table's `links`).

hidden boolean

Whether the area is temporarily hidden, for example a terrace in winter. Hidden areas are left out of the floor plan at the register and out of online reservations.

archived boolean

Whether the area is archived.

tables_count integer

Number of unarchived tables in the area.

created_at datetime

Time the area was created.

updated_at datetime

Time the area was last updated.

Example
{
  "id": 1,
  "name": "string",
  "position": 1,
  "table_combination_mode": "string",
  "hidden": true,
  "archived": true,
  "tables_count": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

CashRegister

A cash drawer with its expected balance; cash payments, deposits, withdrawals and counts change it.

id integer

Unique identifier of the cash register.

name string

Name of the cash register, for example `Bar`.

location string

Where the cash register is, for example `Behind the bar`.

current_balance Money

Cash expected in the drawer.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

device_id integer

Printer that opens the drawer; null for none.

created_at datetime

Time the cash register was created.

updated_at datetime

Time the cash register was last updated.

Example
{
  "id": 1,
  "name": "string",
  "location": "string",
  "current_balance": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "device_id": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

CashRegisterCount

A count of the cash in a drawer; a difference with the expected balance is booked as a correction.

id integer

Unique identifier of the count.

expected_balance Money

Cash expected before the count.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

counted_total Money

Cash counted.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

difference Money

Counted minus expected; booked as a correction.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

quantities array of object

Pieces counted per coin or note.

denomination Money

The coin or note.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

quantity integer

Number of pieces.

employee_id integer

Employee who counted; null when counted in the back office or through the API.

note string

Note with the count.

created_at datetime

Time of the count.

Example
{
  "id": 1,
  "expected_balance": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "counted_total": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "difference": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "quantities": [
    {
      "denomination": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "quantity": 1
    }
  ],
  "employee_id": 1,
  "note": "string",
  "created_at": "2026-01-15T12:30:00Z"
}

CashRegisterMutation

A change of the cash in a drawer: a cash payment, a deposit, a withdrawal or a correction after a count.

id integer

Unique identifier of the mutation.

mutation_type enum

`payment`, `deposit`, `withdrawal` or `correction`.

paymentwithdrawaldepositcorrection

amount Money

Change of the balance; negative for a withdrawal.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

note string

Note with the mutation.

created_at datetime

Time of the mutation.

Example
{
  "id": 1,
  "mutation_type": "payment",
  "amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "note": "string",
  "created_at": "2026-01-15T12:30:00Z"
}

CategoryOfRevenue

A category used to break down revenue in closings and reports.

id integer

Unique identifier of the category of revenue.

name string

Name of the category of revenue.

archived boolean

Whether the category of revenue has been archived.

created_at datetime

Time the category of revenue was created.

updated_at datetime

Time the category of revenue was last updated.

Example
{
  "id": 1,
  "name": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Closure

A period in which the organization is closed for reservations, shops or both, for example a holiday.

id integer

Unique identifier of the closure.

name string

Name of the closure, for example `Christmas`.

starts_at datetime

Start of the closure.

ends_at datetime

End of the closure, inclusive; null when it has no end.

schedule string

The closure's schedule in words, also for recurring closures set up in the back office.

reservations boolean

Whether online reservations are closed.

all_shops boolean

Whether all shops are closed, including shops added later.

shop_ids array of integer

Shops that are closed when `all_shops` is false.

created_at datetime

Time the closure was created.

updated_at datetime

Time the closure was last updated.

Example
{
  "id": 1,
  "name": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "schedule": "string",
  "reservations": true,
  "all_shops": true,
  "shop_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

CompensationReason

A reason staff pick when they compensate an item, for example a dish that came out cold.

id integer

Unique identifier of the compensation reason.

name string

Name of the reason, for example `Cold dish`.

archived boolean

Whether the reason has been archived.

created_at datetime

Time the reason was created.

updated_at datetime

Time the reason was last updated.

Example
{
  "id": 1,
  "name": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Customer

A customer (guest) of the organization, for example a regular, a hotel guest or a company with a tab.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

Example
{
  "id": 1,
  "name": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "note": "string",
  "locale": "string",
  "pinned": true,
  "balance": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "temporary": true,
  "archived": true,
  "merged_into_id": 1,
  "group_ids": [
    1
  ],
  "last_receipt_at": "2026-01-15T12:30:00Z",
  "identifier": "string",
  "app_data": {},
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

DailyClosing

The financial closing of a single trading day.

id integer

Unique identifier of the daily closing.

cashflow object

Cashflow generated during the day, per payment method.

amounts object

Amount received per payment method, keyed by payment method ID, each in the money shape (`value`, `currency`, `minor_units`, `formatted`).

revenue object

Revenue generated during the day, broken down per dimension.

per_category_of_revenue array of Revenue

Revenue per category of revenue.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_employee array of Revenue

Revenue per employee.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_device array of Revenue

Revenue per device.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_voucher array of Revenue

Revenue per voucher.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_loyalty_topup array of Revenue

Revenue per loyalty top-up.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_reservation_deposit array of Revenue

Reservation deposits received.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher_redemptions array of object

Vouchers redeemed during the day.

voucher Reference

Voucher that was redeemed.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount redeemed.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

loyalty_redemption LoyaltyRedemption

Customer balance redeemed during the day.

loyalty Reference

Loyalty program the redemption belongs to.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount redeemed.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

reservation_deposit_redemption object

Reservation deposits settled during the day.

reservation Reference

Reservation program the redemption belongs to.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Deposit amount applied to receipts.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

forfeited Money

Part of the applied deposits kept as forfeit revenue.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

created_at datetime

Time the daily closing was created.

for_date date

Trading date the daily closing covers.

updated_at datetime

Time the daily closing was last updated.

Example
{
  "id": 1,
  "cashflow": {
    "amounts": {}
  },
  "revenue": {
    "per_category_of_revenue": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_employee": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_device": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_voucher": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_loyalty_topup": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_reservation_deposit": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ]
  },
  "voucher_redemptions": [
    {
      "voucher": {
        "id": 1,
        "name": "string"
      },
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      }
    }
  ],
  "loyalty_redemption": {
    "loyalty": {
      "id": 1,
      "name": "string"
    },
    "amount": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    }
  },
  "reservation_deposit_redemption": {
    "reservation": {
      "id": 1,
      "name": "string"
    },
    "amount": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "forfeited": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    }
  },
  "created_at": "2026-01-15T12:30:00Z",
  "for_date": "2026-01-15",
  "updated_at": "2026-01-15T12:30:00Z"
}

Device

A device of the organization, such as a register, display or printer.

id integer

Unique identifier of the device.

name string

Name of the device.

kind string

Device type: register, customer_facing_display, preparation_display, kiosk, backoffice_display, network_printer, or bluetooth_printer.

subtype string

Secondary classification within a kind (e.g. register or handheld for registers; preparation or runner for preparation displays).

quickselect_page_id integer

Unique identifier of the quickselect page shown on the device.

preparation_location_ids array of string

Unique identifiers of the preparation locations the device prepares.

linked_device_ids array of string

Unique identifiers of the devices linked to this device, such as its printers and customer-facing display.

archived boolean

Whether the device has been archived.

created_at datetime

Time the device was created.

updated_at datetime

Time the device was last updated.

Example
{
  "id": 1,
  "name": "string",
  "kind": "string",
  "subtype": "string",
  "quickselect_page_id": 1,
  "preparation_location_ids": [
    "string"
  ],
  "linked_device_ids": [
    "string"
  ],
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

DiscountRule

A discount rule that lowers item prices automatically, for example 20% off drinks during happy hour, a volume discount on snacks or a staff discount.

id integer

Unique identifier of the discount rule.

name string

Name of the discount rule, for example `Happy hour`.

kind string

How the discount is calculated: `percentage` (a percentage off each item), `volume` (a percentage that grows with the number of items, see `tiers`), `buy_x_pay_y` (buy `buy_quantity`, pay `pay_quantity`) or `flat_rate` (a fixed amount off each item).

enabled boolean

Whether the rule is applied; disabled rules are kept but never applied.

discount_percentage number

Percentage off each item for `percentage` rules, for example 20.0; null for other kinds.

flat_amount Money

Amount off each item for `flat_rate` rules; null for other kinds.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

buy_quantity integer

Items to buy for `buy_x_pay_y` rules, for example 3 in 'buy 3, pay 2'; null for other kinds.

pay_quantity integer

Items to pay for `buy_x_pay_y` rules, for example 2 in 'buy 3, pay 2'; null for other kinds.

tiers array of object

Steps of a `volume` rule, ordered by `min_quantity`; empty for other kinds.

min_quantity integer

Number of items from which the tier applies, for example 6.

discount_percentage number

Discount percentage for this tier, for example 20.0.

product_category_ids array of integer

Product categories the rule applies to (`GET /v1/product_categories`); empty when it applies to all products.

customer_id integer

Customer whose receipts get the discount; null when the rule isn't tied to a customer.

group_id integer

Customer group whose receipts get the discount; null when the rule isn't tied to a group.

employee_id integer

Employee whose own receipts get the discount, for example a staff discount; null when the rule isn't tied to an employee.

cascade boolean

For group rules: whether the discount also applies to receipts of the group's customers.

always boolean

Whether the rule applies at all times; when false, the schedule fields below say when.

weekdays array of integer

Weekdays a weekly rule applies on, 0 is Sunday; null when the rule isn't weekly.

from_time string

Time of day a weekly rule starts applying, HH:MM, for example `16:00`; null when the rule isn't weekly.

till_time string

Time of day a weekly rule stops applying, HH:MM, for example `18:00`. A time before `from_time` ends the next day.

starts_at datetime

Start of a one-off period the rule applies in; null for weekly rules and rules that always apply.

ends_at datetime

End of that one-off period, inclusive.

schedule string

When the rule applies, in words; also describes monthly or yearly schedules set up in the back office, which have no weekly or period fields.

created_at datetime

Time the rule was created.

updated_at datetime

Time the rule was last changed.

Example
{
  "id": 1,
  "name": "string",
  "kind": "string",
  "enabled": true,
  "discount_percentage": 9.99,
  "flat_amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "buy_quantity": 1,
  "pay_quantity": 1,
  "tiers": [
    {
      "min_quantity": 1,
      "discount_percentage": 9.99
    }
  ],
  "product_category_ids": [
    1
  ],
  "customer_id": 1,
  "group_id": 1,
  "employee_id": 1,
  "cascade": true,
  "always": true,
  "weekdays": [
    1
  ],
  "from_time": "string",
  "till_time": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "schedule": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

EmailSetting

The address mails to guests are sent from, on the organization's own domain.

email string

Sender address, for example `info@bistro.nl`.

status string

Whether the domain itself is verified through its DKIM records: `pending`, `verified` or `failed`. Mails are only sent from this address once it is `verified`.

mail_from_status string

Whether the bounce domain (MX and SPF records on a subdomain) is set up: `pending`, `verified` or `failed`. Not needed for sending, but without it strict receivers more often mark the mails as spam.

verified_at datetime

Time the domain was verified.

dns_records array of object

DNS records to add at the domain: the DKIM records for `status` and the MX and SPF records of the bounce domain for `mail_from_status`.

type string

Record type: `CNAME`, `MX` or `TXT`.

name string

Name of the record.

value string

Value of the record.

status string

Whether the record was found: `pending`, `verified` or `failed`.

created_at datetime

Time the sender address was created.

updated_at datetime

Time the sender address was last updated.

Example
{
  "email": "string",
  "status": "string",
  "mail_from_status": "string",
  "verified_at": "2026-01-15T12:30:00Z",
  "dns_records": [
    {
      "type": "string",
      "name": "string",
      "value": "string",
      "status": "string"
    }
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

EmailTemplate

The subject and text of a mail to guests in one language; null fields use the 20Tabs default.

kind enum

Which mail: receipt, order confirmation, voucher card, loyalty card or a reservation mail.

receipt_pdforder_confirmationvoucher_card_pdfloyaltyreservation_requestedreservation_confirmedreservation_declinedreservation_cancelledreservation_reminderreservation_deposit_requestedreservation_deposit_expired

locale string

Language of the mail, for example `nl` or `en`.

subject string

Subject; null for the default.

body string

Text; null for the default.

created_at datetime

Time the template was created.

updated_at datetime

Time the template was last updated.

Example
{
  "kind": "receipt_pdf",
  "locale": "string",
  "subject": "string",
  "body": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Employee

An employee of the organization who works on the registers. PIN codes and login cards are never exposed.

id integer

Unique identifier of the employee.

name string

Name of the employee, for example `Sanne`.

role_id integer

Role that limits what the employee may do on the register; null means the employee may do everything.

locale string

Language of the register for this employee, `nl` or `en`.

access_backoffice boolean

Whether the employee can open the back office from a register. Read-only; managed in the back office.

note string

Internal note about the employee. Only included by the employee endpoints.

archived boolean

Whether the employee is archived and can no longer log in.

created_at datetime

Time the employee was added to the organization.

updated_at datetime

Time the employee was last updated.

Example
{
  "id": 1,
  "name": "string",
  "role_id": 1,
  "locale": "string",
  "access_backoffice": true,
  "note": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

EmployeeRole

An employee role: the register actions employees with this role may perform.

id integer

Unique identifier of the role.

name string

Name of the role, for example `Bar staff` or `Manager`.

permissions array of enum

Register actions the role allows, for example `["payments", "discounts"]`. `representation` and `own_use` settle a receipt as business entertainment or own use, `email` sends receipts and balances to guests, `revert_course` undoes calling a course and `loyalty_balance` tops up or corrects customer balances.

move_receiptspaymentsvoid_receiptsremove_itemsrepresentationown_usediscountsrefundsopen_cash_draweremailrevert_courseloyalty_balancereservations

employee_ids array of integer

Identifiers of the active employees with this role.

created_at datetime

Time the role was created.

updated_at datetime

Time the role was last updated.

Example
{
  "id": 1,
  "name": "string",
  "permissions": [
    "move_receipts"
  ],
  "employee_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Fee

An extra charge added to the receipt with a product or a shop order, for example a bottle deposit or a delivery fee.

id integer

Unique identifier of the fee.

name string

Name of the fee as shown on the receipt.

price Money

Amount charged including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate_id integer

Unique identifier of the tax rate applied to the fee.

category_of_revenue_id integer

Unique identifier of the category of revenue the fee is booked on.

enabled boolean

Whether the fee is charged. Disabled fees stay assigned but aren't added to receipts.

created_at datetime

Time the fee was created.

updated_at datetime

Time the fee was last updated.

Example
{
  "id": 1,
  "name": "string",
  "price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "tax_rate_id": 1,
  "category_of_revenue_id": 1,
  "enabled": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Group

A customer group, for example a company, a sports club or a family. Members can share one combined receipt, and discount rules linked to the group apply to all members.

id integer

Unique identifier of the group.

name string

Name of the group, for example `Tennisclub De Lob`.

email string

Email address of the group, for example for invoices.

phone string

Phone number of the group.

address string

Postal address of the group.

combined_receipt boolean

Whether members order on one shared receipt of the group instead of on their own receipts.

archived boolean

Whether the group is archived.

customer_ids array of integer

Identifiers of the customers that are members of the group.

table_ids array of integer

Identifiers of the tables linked to the group.

created_at datetime

Time the group was created.

updated_at datetime

Time the group was last updated.

Example
{
  "id": 1,
  "name": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "combined_receipt": true,
  "archived": true,
  "customer_ids": [
    1
  ],
  "table_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

LedgerAccount

An account in the bookkeeping of the register, such as revenue per category, payments per method, VAT or voucher liabilities.

id integer

Unique identifier of the ledger account.

name string

Name of the account.

kind string

Kind of account, for example `revenue`, `payments`, `tax` or `vouchers`.

number integer

Account number in your bookkeeping.

code string

Code in your bookkeeping, for example a VAT code.

parent_id integer

Account this one is part of; null for a main account.

created_at datetime

Time the ledger account was created.

updated_at datetime

Time the ledger account was last updated.

Example
{
  "id": 1,
  "name": "string",
  "kind": "string",
  "number": 1,
  "code": "string",
  "parent_id": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

LedgerMutation

A booking on a ledger account.

id integer

Unique identifier of the mutation.

amount Money

Amount booked; positive is credit.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

daily_closing_id integer

Daily closing the booking belongs to.

source_type string

What caused the booking, for example `receipt` or `payment`.

source_id integer

Unique identifier of what caused the booking.

created_at datetime

Time of the booking.

Example
{
  "id": 1,
  "amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "daily_closing_id": 1,
  "source_type": "string",
  "source_id": 1,
  "created_at": "2026-01-15T12:30:00Z"
}

LoyaltyRedemption

A redemption of customer balance.

loyalty Reference

Loyalty program the redemption belongs to.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount redeemed.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

Example
{
  "loyalty": {
    "id": 1,
    "name": "string"
  },
  "amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  }
}

LoyaltySetting

The loyalty program: wallet passes for customers and, optionally, a prepaid balance.

enabled boolean

Whether customers get a loyalty card in their wallet.

balance_enabled boolean

Whether customers can top up a balance and pay with it.

self_registration_enabled boolean

Whether guests can sign up for a card themselves.

show_discounts boolean

Whether the wallet pass shows the customer's discounts.

loyalty_pass_name string

Name on the wallet pass.

wallet_pass_color string

Color of the wallet pass as #rrggbb.

prefer_barcode_over_qr boolean

Whether the pass shows a barcode instead of a QR code.

created_at datetime

Time the loyalty program was created.

updated_at datetime

Time the loyalty program was last updated.

Example
{
  "enabled": true,
  "balance_enabled": true,
  "self_registration_enabled": true,
  "show_discounts": true,
  "loyalty_pass_name": "string",
  "wallet_pass_color": "string",
  "prefer_barcode_over_qr": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Marker

A colored label with an icon, for example `Vegan` or `Spicy`, shown on products, receipts and reservations.

id integer

Unique identifier of the marker.

name string

Name of the marker.

icon string

Icon shown on the marker, for example `leaf`.

color string

Color of the marker, for example `green`.

created_at datetime

Time the marker was created.

updated_at datetime

Time the marker was last updated.

Example
{
  "id": 1,
  "name": "string",
  "icon": "string",
  "color": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Money

A monetary amount in a specific currency. Send amounts in the same shape; on input `minor_units` is optional and sets the precision of `value`, up to that of the currency. `formatted` is only for display and not needed when sending money.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

Example
{
  "value": 1,
  "currency": "string",
  "minor_units": 1,
  "formatted": "string"
}

MonthlyClosing

The financial closing of a calendar month, aggregating its daily closings.

id integer

Unique identifier of the monthly closing.

cashflow object

Combined cashflow of all daily closings in the month, per payment method.

amounts object

Amount received per payment method, keyed by payment method ID, each in the money shape (`value`, `currency`, `minor_units`, `formatted`).

revenue object

Combined revenue of all daily closings in the month, broken down per dimension.

per_category_of_revenue array of Revenue

Revenue per category of revenue.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_employee array of Revenue

Revenue per employee.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_device array of Revenue

Revenue per device.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_voucher array of Revenue

Revenue per voucher.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_loyalty_topup array of Revenue

Revenue per loyalty top-up.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_reservation_deposit array of Revenue

Reservation deposits received.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher_redemptions array of object

Vouchers redeemed during the month.

voucher Reference

Voucher that was redeemed.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount redeemed.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

loyalty_redemption LoyaltyRedemption

Customer balance redeemed during the month.

loyalty Reference

Loyalty program the redemption belongs to.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount redeemed.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

reservation_deposit_redemption object

Reservation deposits settled during the month.

reservation Reference

Reservation program the redemption belongs to.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Deposit amount applied to receipts.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

forfeited Money

Part of the applied deposits kept as forfeit revenue.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

daily_closings array of DailyClosing

Daily closings the monthly closing covers.

id integer

Unique identifier of the daily closing.

cashflow object

Cashflow generated during the day, per payment method.

amounts object

Amount received per payment method, keyed by payment method ID, each in the money shape (`value`, `currency`, `minor_units`, `formatted`).

revenue object

Revenue generated during the day, broken down per dimension.

per_category_of_revenue array of Revenue

Revenue per category of revenue.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_employee array of Revenue

Revenue per employee.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_device array of Revenue

Revenue per device.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_voucher array of Revenue

Revenue per voucher.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_loyalty_topup array of Revenue

Revenue per loyalty top-up.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

per_reservation_deposit array of Revenue

Reservation deposits received.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher_redemptions array of object

Vouchers redeemed during the day.

voucher Reference

Voucher that was redeemed.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount redeemed.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

loyalty_redemption LoyaltyRedemption

Customer balance redeemed during the day.

loyalty Reference

Loyalty program the redemption belongs to.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount redeemed.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

reservation_deposit_redemption object

Reservation deposits settled during the day.

reservation Reference

Reservation program the redemption belongs to.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Deposit amount applied to receipts.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

forfeited Money

Part of the applied deposits kept as forfeit revenue.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

created_at datetime

Time the daily closing was created.

for_date date

Trading date the daily closing covers.

updated_at datetime

Time the daily closing was last updated.

created_at datetime

Time the monthly closing was created.

updated_at datetime

Time the monthly closing was last updated.

Example
{
  "id": 1,
  "cashflow": {
    "amounts": {}
  },
  "revenue": {
    "per_category_of_revenue": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_employee": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_device": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_voucher": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_loyalty_topup": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ],
    "per_reservation_deposit": [
      {
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "tax_rate": {
          "id": 1,
          "name": "string",
          "percentage": 9.99,
          "kind": "string",
          "archived": true,
          "label": "string",
          "created_at": "2026-01-15T12:30:00Z",
          "updated_at": "2026-01-15T12:30:00Z"
        },
        "category_of_revenue": {
          "id": 1,
          "name": "string"
        },
        "employee": {
          "id": 1,
          "name": "string"
        },
        "device": {
          "id": 1,
          "name": "string"
        },
        "voucher": {
          "id": 1,
          "name": "string"
        },
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "reservation": {
          "id": 1,
          "name": "string"
        }
      }
    ]
  },
  "voucher_redemptions": [
    {
      "voucher": {
        "id": 1,
        "name": "string"
      },
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      }
    }
  ],
  "loyalty_redemption": {
    "loyalty": {
      "id": 1,
      "name": "string"
    },
    "amount": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    }
  },
  "reservation_deposit_redemption": {
    "reservation": {
      "id": 1,
      "name": "string"
    },
    "amount": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "forfeited": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    }
  },
  "daily_closings": [
    {
      "id": 1,
      "cashflow": {
        "amounts": {}
      },
      "revenue": {
        "per_category_of_revenue": [
          {
            "amount": {
              "value": 1,
              "currency": "string",
              "minor_units": 1,
              "formatted": "string"
            },
            "tax_rate": {
              "id": 1,
              "name": "string",
              "percentage": 9.99,
              "kind": "string",
              "archived": true,
              "label": "string",
              "created_at": "2026-01-15T12:30:00Z",
              "updated_at": "2026-01-15T12:30:00Z"
            },
            "category_of_revenue": {
              "id": 1,
              "name": "string"
            },
            "employee": {
              "id": 1,
              "name": "string"
            },
            "device": {
              "id": 1,
              "name": "string"
            },
            "voucher": {
              "id": 1,
              "name": "string"
            },
            "loyalty": {
              "id": 1,
              "name": "string"
            },
            "reservation": {
              "id": 1,
              "name": "string"
            }
          }
        ],
        "per_employee": [
          {
            "amount": {
              "value": 1,
              "currency": "string",
              "minor_units": 1,
              "formatted": "string"
            },
            "tax_rate": {
              "id": 1,
              "name": "string",
              "percentage": 9.99,
              "kind": "string",
              "archived": true,
              "label": "string",
              "created_at": "2026-01-15T12:30:00Z",
              "updated_at": "2026-01-15T12:30:00Z"
            },
            "category_of_revenue": {
              "id": 1,
              "name": "string"
            },
            "employee": {
              "id": 1,
              "name": "string"
            },
            "device": {
              "id": 1,
              "name": "string"
            },
            "voucher": {
              "id": 1,
              "name": "string"
            },
            "loyalty": {
              "id": 1,
              "name": "string"
            },
            "reservation": {
              "id": 1,
              "name": "string"
            }
          }
        ],
        "per_device": [
          {
            "amount": {
              "value": 1,
              "currency": "string",
              "minor_units": 1,
              "formatted": "string"
            },
            "tax_rate": {
              "id": 1,
              "name": "string",
              "percentage": 9.99,
              "kind": "string",
              "archived": true,
              "label": "string",
              "created_at": "2026-01-15T12:30:00Z",
              "updated_at": "2026-01-15T12:30:00Z"
            },
            "category_of_revenue": {
              "id": 1,
              "name": "string"
            },
            "employee": {
              "id": 1,
              "name": "string"
            },
            "device": {
              "id": 1,
              "name": "string"
            },
            "voucher": {
              "id": 1,
              "name": "string"
            },
            "loyalty": {
              "id": 1,
              "name": "string"
            },
            "reservation": {
              "id": 1,
              "name": "string"
            }
          }
        ],
        "per_voucher": [
          {
            "amount": {
              "value": 1,
              "currency": "string",
              "minor_units": 1,
              "formatted": "string"
            },
            "tax_rate": {
              "id": 1,
              "name": "string",
              "percentage": 9.99,
              "kind": "string",
              "archived": true,
              "label": "string",
              "created_at": "2026-01-15T12:30:00Z",
              "updated_at": "2026-01-15T12:30:00Z"
            },
            "category_of_revenue": {
              "id": 1,
              "name": "string"
            },
            "employee": {
              "id": 1,
              "name": "string"
            },
            "device": {
              "id": 1,
              "name": "string"
            },
            "voucher": {
              "id": 1,
              "name": "string"
            },
            "loyalty": {
              "id": 1,
              "name": "string"
            },
            "reservation": {
              "id": 1,
              "name": "string"
            }
          }
        ],
        "per_loyalty_topup": [
          {
            "amount": {
              "value": 1,
              "currency": "string",
              "minor_units": 1,
              "formatted": "string"
            },
            "tax_rate": {
              "id": 1,
              "name": "string",
              "percentage": 9.99,
              "kind": "string",
              "archived": true,
              "label": "string",
              "created_at": "2026-01-15T12:30:00Z",
              "updated_at": "2026-01-15T12:30:00Z"
            },
            "category_of_revenue": {
              "id": 1,
              "name": "string"
            },
            "employee": {
              "id": 1,
              "name": "string"
            },
            "device": {
              "id": 1,
              "name": "string"
            },
            "voucher": {
              "id": 1,
              "name": "string"
            },
            "loyalty": {
              "id": 1,
              "name": "string"
            },
            "reservation": {
              "id": 1,
              "name": "string"
            }
          }
        ],
        "per_reservation_deposit": [
          {
            "amount": {
              "value": 1,
              "currency": "string",
              "minor_units": 1,
              "formatted": "string"
            },
            "tax_rate": {
              "id": 1,
              "name": "string",
              "percentage": 9.99,
              "kind": "string",
              "archived": true,
              "label": "string",
              "created_at": "2026-01-15T12:30:00Z",
              "updated_at": "2026-01-15T12:30:00Z"
            },
            "category_of_revenue": {
              "id": 1,
              "name": "string"
            },
            "employee": {
              "id": 1,
              "name": "string"
            },
            "device": {
              "id": 1,
              "name": "string"
            },
            "voucher": {
              "id": 1,
              "name": "string"
            },
            "loyalty": {
              "id": 1,
              "name": "string"
            },
            "reservation": {
              "id": 1,
              "name": "string"
            }
          }
        ]
      },
      "voucher_redemptions": [
        {
          "voucher": {
            "id": 1,
            "name": "string"
          },
          "amount": {
            "value": 1,
            "currency": "string",
            "minor_units": 1,
            "formatted": "string"
          }
        }
      ],
      "loyalty_redemption": {
        "loyalty": {
          "id": 1,
          "name": "string"
        },
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        }
      },
      "reservation_deposit_redemption": {
        "reservation": {
          "id": 1,
          "name": "string"
        },
        "amount": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        },
        "forfeited": {
          "value": 1,
          "currency": "string",
          "minor_units": 1,
          "formatted": "string"
        }
      },
      "created_at": "2026-01-15T12:30:00Z",
      "for_date": "2026-01-15",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

OauthError

An OAuth 2.0 error response.

error string
error_description string
Example
{
  "error": "string",
  "error_description": "string"
}

OauthToken

An access token issued to your app for one organization.

token_type string
access_token string
refresh_token string
expires_in integer

Access token lifetime in seconds

scopes array of string

Scopes granted to the subscription

subscription_id string
Example
{
  "token_type": "string",
  "access_token": "string",
  "refresh_token": "string",
  "expires_in": 1,
  "scopes": [
    "string"
  ],
  "subscription_id": "string"
}

Order

An order placed on a receipt.

id integer

Unique identifier of the order.

receipt_id integer

Unique identifier of the receipt the order was placed on.

shop_id integer

Unique identifier of the shop the order was placed in; null for orders from the register or the API.

receiptable_type string

What the order was placed on: `table`, `customer`, `group` or `employee`.

receiptable_id integer

Unique identifier of the table, customer, group or employee the order was placed on.

pick_up_at datetime

Pick-up moment for takeout orders; null otherwise.

items array of object

Items that were ordered.

id integer

Unique identifier of the item.

product_id integer

Unique identifier of the ordered product; null for free-form items.

parent_id integer

Unique identifier of the item this item belongs to, for example a product option or a fee; null for top-level items.

description string

Description of the item as shown on the receipt.

note string

Note shown on the preparation receipt.

price Money

Unit price after discounts and compensation; this is what the guest pays.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

original_price Money

Unit price before discounts and compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

discount_percentage number

Discount percentage applied to the item, from a discount rule or the receipt discount; 0 without discount.

compensation Money

Amount taken off the item as compensation, for example for a cold dish; 0 without compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

compensation_reason_id integer

Unique identifier of the compensation reason; null without compensation.

compensation_reason string

Reason for the compensation, as set up in the back office; null without compensation.

compensation_note string

Note the employee added to the compensation.

tax_rate TaxRate

Tax rate applied to the item.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the item counts towards.

id integer

Unique identifier of the resource.

name string

Name of the resource.

cost_price Money

Cost price of the item.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

unit_quantity integer

Quantity sold of `unit_name`, for example 250 for 250 gram; null for items sold per piece.

unit_name string

Unit the item is sold per, for example `gram`; null for items sold per piece.

course integer

Course the item is served in, 0 for no course.

preparation_state string

Where the item is in preparation: `unrequested`, `requested`, `ready_to_prepare`, `preparing`, `prepared`, `ready_to_deliver` or `delivered`.

representation_by Reference

Employee the item was booked on as representation (on the house), if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

own_use boolean

Whether the item was booked as own use (consumed by staff or the business) instead of sold.

payment_status string

Payment status of the item: `open`, `pending` or `paid`.

refunded_item_id integer

On a return receipt: the item that was refunded; null otherwise.

voucher_card_id integer

Voucher card sold or topped up with the item (`GET /v1/voucher_cards/{id}`); null otherwise.

kind enum

`sale` for products and other items, `voucher` for a sold voucher card, `loyalty_topup` for balance topped up on a customer and `reservation_deposit` for a deposit paid on a reservation.

salevoucherloyalty_topupreservation_deposit

voucher Reference

Voucher sold with the item, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for top-up items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

created_at datetime

Time the item was added to the receipt.

updated_at datetime

Time the receipt item was last updated.

submitted_at datetime

Time the order was submitted for preparation; null while the order is still a cart.

created_at datetime

Time the order was created.

updated_at datetime

Time the order was last updated.

Example
{
  "id": 1,
  "receipt_id": 1,
  "shop_id": 1,
  "receiptable_type": "string",
  "receiptable_id": 1,
  "pick_up_at": "2026-01-15T12:30:00Z",
  "items": [
    {
      "id": 1,
      "product_id": 1,
      "parent_id": 1,
      "description": "string",
      "note": "string",
      "price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "original_price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "discount_percentage": 9.99,
      "compensation": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "compensation_reason_id": 1,
      "compensation_reason": "string",
      "compensation_note": "string",
      "tax_rate": {
        "id": 1,
        "name": "string",
        "percentage": 9.99,
        "kind": "string",
        "archived": true,
        "label": "string",
        "created_at": "2026-01-15T12:30:00Z",
        "updated_at": "2026-01-15T12:30:00Z"
      },
      "category_of_revenue": {
        "id": 1,
        "name": "string"
      },
      "cost_price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "unit_quantity": 1,
      "unit_name": "string",
      "course": 1,
      "preparation_state": "string",
      "representation_by": {
        "id": 1,
        "name": "string"
      },
      "own_use": true,
      "payment_status": "string",
      "refunded_item_id": 1,
      "voucher_card_id": 1,
      "kind": "sale",
      "voucher": {
        "id": 1,
        "name": "string"
      },
      "loyalty": {
        "id": 1,
        "name": "string"
      },
      "reservation": {
        "id": 1,
        "name": "string"
      },
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "submitted_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Organization

An organization using 20Tabs.

id integer

Unique identifier of the organization.

name string

Name of the organization.

display_name string

Trading name shown on receipts and customer-facing screens.

email string

Contact email address of the organization.

phone string

Contact phone number of the organization.

first_name string

First name of the contact person.

last_name string

Last name of the contact person.

coc string

Chamber of Commerce (KvK) registration number.

vat string

VAT identification number.

street string

Street of the business address.

building string

Name of the building of the business address.

building_number string

Building number of the business address.

postal_code string

Postal code of the business address.

city string

City of the business address.

country_code string

ISO 3166-1 alpha-2 country code of the business address.

latitude number

Latitude of the business address in decimal degrees.

longitude number

Longitude of the business address in decimal degrees.

locale string

Default locale of the organization, for example `nl` or `en`.

time_zone string

Time zone the organization works in, as a Rails time zone name, for example `Amsterdam`.

day_end_time string

Time of night the business day ends, HH:MM, for example `04:00` when sales after midnight count towards the previous day; null when the day ends at midnight.

domain string

Domain the organization's 20Tabs environment runs on, for example `bistro.20tabs.app`.

logo_url string

URL of the organization's logo; null without logo.

created_at datetime

Time the organization joined 20Tabs.

updated_at datetime

Time the organization was last updated.

Example
{
  "id": 1,
  "name": "string",
  "display_name": "string",
  "email": "string",
  "phone": "string",
  "first_name": "string",
  "last_name": "string",
  "coc": "string",
  "vat": "string",
  "street": "string",
  "building": "string",
  "building_number": "string",
  "postal_code": "string",
  "city": "string",
  "country_code": "string",
  "latitude": 9.99,
  "longitude": 9.99,
  "locale": "string",
  "time_zone": "string",
  "day_end_time": "string",
  "domain": "string",
  "logo_url": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Payment

A payment recorded on a receipt.

id integer

Unique identifier of the payment.

receipt_id integer

Unique identifier of the receipt the payment settles.

payment_method_id integer

Unique identifier of the payment method that was used.

voucher_card_id integer

Unique identifier of the voucher card the payment was made with; null for other payments.

category_of_revenue Reference

Category of revenue the payment counts towards, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

kind enum

`payment` for cash, card and other payment methods, `voucher` for a payment with a voucher card, `loyalty_balance` for a payment from a customer's balance and `reservation_deposit` for a paid deposit settled on the receipt.

paymentvoucherloyalty_balancereservation_deposit

voucher Reference

Voucher the payment was made with, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for balance payments.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit settlements.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount paid.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

created_at datetime

Time the payment was created.

updated_at datetime

Time the payment was last updated.

Example
{
  "id": 1,
  "receipt_id": 1,
  "payment_method_id": 1,
  "voucher_card_id": 1,
  "category_of_revenue": {
    "id": 1,
    "name": "string"
  },
  "kind": "payment",
  "voucher": {
    "id": 1,
    "name": "string"
  },
  "loyalty": {
    "id": 1,
    "name": "string"
  },
  "reservation": {
    "id": 1,
    "name": "string"
  },
  "amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

PaymentMethod

A payment method on the organization's registers, such as cash, card or one registered by an app.

id integer

Unique identifier of the payment method.

name string

Display name shown to users on the register.

kind enum

`external` for a method registered by an app, `internal` for one set up in the back office such as cash or card, `system` for vouchers, balance and deposits, `representation` or `own_use`.

representationown_useexternalsysteminternal

cash_register_id integer

Cash register that payments with this method go into; null when they don't touch a cash drawer.

online boolean

Whether the payment is processed online (`true`) or in store (`false`).

tap_to_pay boolean

Whether the payment method uses Tap to Pay.

operator_reference string

Reference that helps 20Tabs users identify the payment method in your system.

required_data object

Fields the user must fill in when paying with this method.

archived boolean

Whether the payment method is archived.

created_at datetime

Time the payment method was registered.

updated_at datetime

Time the payment method was last updated.

Example
{
  "id": 1,
  "name": "string",
  "kind": "representation",
  "cash_register_id": 1,
  "online": true,
  "tap_to_pay": true,
  "operator_reference": "string",
  "required_data": {},
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

PreparationLocation

id integer
name string
preparation_states string

Subset of canonical states this location tracks.

print_preparation_states string

States whose transitions trigger printing at this location.

print_movings boolean

Whether a slip is printed when items are moved between receipts.

created_at datetime

Time the preparation location was created.

updated_at datetime

Time the preparation location was last updated.

Example
{
  "id": 1,
  "name": "string",
  "preparation_states": "string",
  "print_preparation_states": "string",
  "print_movings": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

PreparationState

id integer
state string

Canonical state key: unrequested, requested, ready_to_prepare, preparing, prepared, ready_to_deliver, or delivered.

label string

Display label shown on kitchen displays.

next_state_button_label string

Label on the button that advances to the next state.

color string

Tailwind color name (e.g. amber, fuchsia, blue, green).

show_in_summary boolean

Whether items in this state appear in the receipt summary.

created_at datetime

Time the preparation state was created.

updated_at datetime

Time the preparation state was last updated.

Example
{
  "id": 1,
  "state": "string",
  "label": "string",
  "next_state_button_label": "string",
  "color": "string",
  "show_in_summary": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Product

A product in the organization's catalog.

id integer

Unique identifier of the product.

name string

Name of the product.

description string

Description shown to guests in shops and on the kiosk.

plu string

PLU or barcode identifying the product.

price Money

Selling price including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

cost_price Money

Purchase price excluding VAT; null when unknown.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate_id integer

Unique identifier of the tax rate applied to the product.

category_of_revenue_id integer

Unique identifier of the category of revenue the product belongs to.

product_category_ids array of integer

Product categories the product is assigned to.

default_course integer

Course the product is served in by default (0 for no course).

preparation_location_id integer

Unique identifier of the preparation location the product is prepared at, for example the kitchen; null when it needs no preparation.

no_discount boolean

Whether discounts are never applied to the product.

unit_name string

Unit the product is sold per, for example `gram`; null when sold per piece.

unit_default_quantity integer

Quantity of `unit_name` the price applies to, for example 100 for a price per 100 gram.

sold_out boolean

Whether the product is sold out right now.

sold_out_remaining integer

How many can still be sold until `sold_out_until`; null when the stock isn't counted.

sold_out_until datetime

Until when `sold_out_remaining` counts; null when the stock isn't counted.

allergen_ids array of integer

Allergens the product contains (`GET /v1/allergens`).

marker_ids array of integer

Markers shown on the product and copied to receipts it is ordered on (`GET /v1/markers`).

fee_ids array of integer

Fees added to a receipt with each product, for example a bottle deposit (`GET /v1/fees`).

sale_times array of object

Weekly periods the product can be sold in; empty when it can always be sold.

weekdays array of integer

Weekdays the product is sold on, 0 is Sunday.

from_time string

Time of day sales start, HH:MM.

till_time string

Time of day sales end, HH:MM. A time before `from_time` ends the next day.

image_url string

URL of the product image; null without image.

archived boolean

Whether the product is archived and no longer sold.

created_at datetime

Time the product was created.

updated_at datetime

Time the product was last updated.

Example
{
  "id": 1,
  "name": "string",
  "description": "string",
  "plu": "string",
  "price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "cost_price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "tax_rate_id": 1,
  "category_of_revenue_id": 1,
  "product_category_ids": [
    1
  ],
  "default_course": 1,
  "preparation_location_id": 1,
  "no_discount": true,
  "unit_name": "string",
  "unit_default_quantity": 1,
  "sold_out": true,
  "sold_out_remaining": 1,
  "sold_out_until": "2026-01-15T12:30:00Z",
  "allergen_ids": [
    1
  ],
  "marker_ids": [
    1
  ],
  "fee_ids": [
    1
  ],
  "sale_times": [
    {
      "weekdays": [
        1
      ],
      "from_time": "string",
      "till_time": "string"
    }
  ],
  "image_url": "string",
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

ProductCategory

A category used to group products for filtering, discount rules and reporting.

id integer

Unique identifier of the product category.

name string

Name of the product category.

created_at datetime

Time the product category was created.

updated_at datetime

Time the product category was last updated.

Example
{
  "id": 1,
  "name": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

ProductOption

id integer
kind string

Option type: custom (free-form name and price) or product (backed by an existing product).

name string
description string
price Money

Price of the option. Null for product-backed options that inherit the product price.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate_id integer

Tax rate of a custom option; null for product-backed options.

category_of_revenue_id integer

Category of revenue of a custom option; null for product-backed options.

product_id integer

Backing product sequence. Only set for kind=product.

max_choices integer

Maximum number of times this option can be selected. Null means no limit of its own, so only the group total and the stock apply.

no_discount boolean

Whether discounts are excluded from this option.

position integer

Display order within the group.

created_at datetime

Time the product option was created.

updated_at datetime

Time the product option was last updated.

Example
{
  "id": 1,
  "kind": "string",
  "name": "string",
  "description": "string",
  "price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "tax_rate_id": 1,
  "category_of_revenue_id": 1,
  "product_id": 1,
  "max_choices": 1,
  "no_discount": true,
  "position": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

ProductOptionGroup

id integer
name string
kind string

Group type: add_on or product_add_on appends items to the receipt; option or product_option substitutes or modifies the parent product.

required boolean

Whether the customer must choose at least one option.

substitutable boolean

Whether choosing an option substitutes the parent product.

hide_on_receipt boolean

Whether selected options are hidden on the printed receipt.

hide_parent boolean

Whether the parent product line is hidden when an option is selected.

total_choices integer

Maximum number of choices across the whole group, counting duplicates. Null means no total limit.

combine_on_receipt boolean

Whether the chosen options are stored as one comma separated receipt line instead of a line per choice.

archived string
created_at datetime

Time the product option group was created.

updated_at datetime

Time the product option group was last updated.

Example
{
  "id": 1,
  "name": "string",
  "kind": "string",
  "required": true,
  "substitutable": true,
  "hide_on_receipt": true,
  "hide_parent": true,
  "total_choices": 1,
  "combine_on_receipt": true,
  "archived": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

ProductsOptionGroup

id integer
product_id integer
product_option_group_id integer
position integer

Display order of this group on the product.

created_at datetime

Time the attachment was created.

updated_at datetime

Time the attachment was last updated.

Example
{
  "id": 1,
  "product_id": 1,
  "product_option_group_id": 1,
  "position": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Quickselect

id integer
kind string

Button type: product, voucher, manual, scan, search, or takeout.

label string

Custom display label. Falls back to the product or voucher name when blank.

color string

Tailwind color name for the button background.

position integer

Display order within the category.

quickselectable_id integer

Sequence of the backing record (product or voucher).

settings object

Settings of a `manual` button; null for other kinds.

default_name string

Name the free item gets; staff can change it.

default_price Money

Price the free item gets; staff can change it.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

category_of_revenue_ids array of integer

Ones staff may pick for the item; empty for all.

tax_rate_ids array of integer

Ones staff may pick for the item; empty for all.

preparation_location_ids array of integer

Ones staff may pick for the item; empty for all.

product_category_ids array of integer

Ones staff may pick for the item; empty for all.

created_at datetime

Time the quickselect was created.

updated_at datetime

Time the quickselect was last updated.

Example
{
  "id": 1,
  "kind": "string",
  "label": "string",
  "color": "string",
  "position": 1,
  "quickselectable_id": 1,
  "settings": {
    "default_name": "string",
    "default_price": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "category_of_revenue_ids": [
      1
    ],
    "tax_rate_ids": [
      1
    ],
    "preparation_location_ids": [
      1
    ],
    "product_category_ids": [
      1
    ]
  },
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

QuickselectCategory

id integer
quickselect_page_id integer

Unique identifier of the page this category belongs to.

name string
position integer

Display order within the page.

created_at datetime

Time the quickselect category was created.

updated_at datetime

Time the quickselect category was last updated.

Example
{
  "id": 1,
  "quickselect_page_id": 1,
  "name": "string",
  "position": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

QuickselectPage

id integer
name string
position integer

Display order of this page.

show_product_images boolean

Whether buttons on this page display product images.

switchable boolean

Whether registers can switch to this page from a page picker.

created_at datetime

Time the quickselect page was created.

updated_at datetime

Time the quickselect page was last updated.

Example
{
  "id": 1,
  "name": "string",
  "position": 1,
  "show_product_images": true,
  "switchable": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Receipt

A receipt grouping ordered items and the payments that settle them.

id integer

Unique identifier of the receipt.

label string

Name of the receipt as shown on the register, for example the table, customer or a name typed in; prefixed with the pick-up time for takeout.

receiptable_type string

What the receipt is opened on: `table`, `customer`, `group`, `employee` (an employee ordering for themselves), `kiosk` or `app`.

receiptable_id integer

Unique identifier of the table, customer, group or employee the receipt is opened on.

items array of object

Line items on the receipt.

id integer

Unique identifier of the item.

product_id integer

Unique identifier of the ordered product; null for free-form items.

parent_id integer

Unique identifier of the item this item belongs to, for example a product option or a fee; null for top-level items.

description string

Description of the item as shown on the receipt.

note string

Note shown on the preparation receipt.

price Money

Unit price after discounts and compensation; this is what the guest pays.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

original_price Money

Unit price before discounts and compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

discount_percentage number

Discount percentage applied to the item, from a discount rule or the receipt discount; 0 without discount.

compensation Money

Amount taken off the item as compensation, for example for a cold dish; 0 without compensation.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

compensation_reason_id integer

Unique identifier of the compensation reason; null without compensation.

compensation_reason string

Reason for the compensation, as set up in the back office; null without compensation.

compensation_note string

Note the employee added to the compensation.

tax_rate TaxRate

Tax rate applied to the item.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the item counts towards.

id integer

Unique identifier of the resource.

name string

Name of the resource.

cost_price Money

Cost price of the item.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

unit_quantity integer

Quantity sold of `unit_name`, for example 250 for 250 gram; null for items sold per piece.

unit_name string

Unit the item is sold per, for example `gram`; null for items sold per piece.

course integer

Course the item is served in, 0 for no course.

preparation_state string

Where the item is in preparation: `unrequested`, `requested`, `ready_to_prepare`, `preparing`, `prepared`, `ready_to_deliver` or `delivered`.

representation_by Reference

Employee the item was booked on as representation (on the house), if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

own_use boolean

Whether the item was booked as own use (consumed by staff or the business) instead of sold.

payment_status string

Payment status of the item: `open`, `pending` or `paid`.

refunded_item_id integer

On a return receipt: the item that was refunded; null otherwise.

voucher_card_id integer

Voucher card sold or topped up with the item (`GET /v1/voucher_cards/{id}`); null otherwise.

kind enum

`sale` for products and other items, `voucher` for a sold voucher card, `loyalty_topup` for balance topped up on a customer and `reservation_deposit` for a deposit paid on a reservation.

salevoucherloyalty_topupreservation_deposit

voucher Reference

Voucher sold with the item, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for top-up items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit items.

id integer

Unique identifier of the resource.

name string

Name of the resource.

created_at datetime

Time the item was added to the receipt.

updated_at datetime

Time the receipt item was last updated.

customer Customer

Customer the receipt belongs to, if any.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

payments array of Payment

Payments recorded on the receipt.

id integer

Unique identifier of the payment.

receipt_id integer

Unique identifier of the receipt the payment settles.

payment_method_id integer

Unique identifier of the payment method that was used.

voucher_card_id integer

Unique identifier of the voucher card the payment was made with; null for other payments.

category_of_revenue Reference

Category of revenue the payment counts towards, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

kind enum

`payment` for cash, card and other payment methods, `voucher` for a payment with a voucher card, `loyalty_balance` for a payment from a customer's balance and `reservation_deposit` for a paid deposit settled on the receipt.

paymentvoucherloyalty_balancereservation_deposit

voucher Reference

Voucher the payment was made with, if any.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program for balance payments.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program for deposit settlements.

id integer

Unique identifier of the resource.

name string

Name of the resource.

amount Money

Amount paid.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

created_at datetime

Time the payment was created.

updated_at datetime

Time the payment was last updated.

total_amount Money

Total of the items after discounts and compensations, excluding items booked as representation or own use.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

open_amount Money

Amount still to be paid.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

discount_type string

How a discount given on the whole receipt is expressed: `percentage` (see `discount_percentage`) or `absolute` (see `absolute_discount`).

discount_percentage number

Percentage discount given on the whole receipt, for example 10.0; 0 without one. Items get this or their own discount rule, whichever is higher.

absolute_discount Money

Amount taken off the whole receipt when `discount_type` is `absolute`, spread over the items.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

guests_count integer

Number of guests on the receipt; null when not registered.

note string

Note on the receipt, shown on the register.

marker_ids array of integer

Markers on the receipt, for example allergies or VIP (`GET /v1/markers`).

paid_at datetime

Time the receipt was paid in full; null while the receipt is open.

voided_at datetime

Time the receipt was voided; null unless voided. A voided receipt was cancelled and counts towards no revenue.

voided_reason string

Reason the employee gave for voiding the receipt.

refunded_receipt_id integer

For a return: the receipt whose items were refunded; null for regular receipts.

daily_closing_id integer

Daily closing the receipt was settled in; null until the day is closed.

pick_up_at datetime

Pick-up moment for takeout receipts; null otherwise.

reservation_id integer

Unique identifier of the reservation checked in on this receipt.

opened_at datetime

Time the receipt was opened.

created_at datetime

Time the receipt was created.

updated_at datetime

Time the receipt was last updated.

Example
{
  "id": 1,
  "label": "string",
  "receiptable_type": "string",
  "receiptable_id": 1,
  "items": [
    {
      "id": 1,
      "product_id": 1,
      "parent_id": 1,
      "description": "string",
      "note": "string",
      "price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "original_price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "discount_percentage": 9.99,
      "compensation": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "compensation_reason_id": 1,
      "compensation_reason": "string",
      "compensation_note": "string",
      "tax_rate": {
        "id": 1,
        "name": "string",
        "percentage": 9.99,
        "kind": "string",
        "archived": true,
        "label": "string",
        "created_at": "2026-01-15T12:30:00Z",
        "updated_at": "2026-01-15T12:30:00Z"
      },
      "category_of_revenue": {
        "id": 1,
        "name": "string"
      },
      "cost_price": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "unit_quantity": 1,
      "unit_name": "string",
      "course": 1,
      "preparation_state": "string",
      "representation_by": {
        "id": 1,
        "name": "string"
      },
      "own_use": true,
      "payment_status": "string",
      "refunded_item_id": 1,
      "voucher_card_id": 1,
      "kind": "sale",
      "voucher": {
        "id": 1,
        "name": "string"
      },
      "loyalty": {
        "id": 1,
        "name": "string"
      },
      "reservation": {
        "id": 1,
        "name": "string"
      },
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "customer": {
    "id": 1,
    "name": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "note": "string",
    "locale": "string",
    "pinned": true,
    "balance": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "temporary": true,
    "archived": true,
    "merged_into_id": 1,
    "group_ids": [
      1
    ],
    "last_receipt_at": "2026-01-15T12:30:00Z",
    "identifier": "string",
    "app_data": {},
    "created_at": "2026-01-15T12:30:00Z",
    "updated_at": "2026-01-15T12:30:00Z"
  },
  "payments": [
    {
      "id": 1,
      "receipt_id": 1,
      "payment_method_id": 1,
      "voucher_card_id": 1,
      "category_of_revenue": {
        "id": 1,
        "name": "string"
      },
      "kind": "payment",
      "voucher": {
        "id": 1,
        "name": "string"
      },
      "loyalty": {
        "id": 1,
        "name": "string"
      },
      "reservation": {
        "id": 1,
        "name": "string"
      },
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "total_amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "open_amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "discount_type": "string",
  "discount_percentage": 9.99,
  "absolute_discount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "guests_count": 1,
  "note": "string",
  "marker_ids": [
    1
  ],
  "paid_at": "2026-01-15T12:30:00Z",
  "voided_at": "2026-01-15T12:30:00Z",
  "voided_reason": "string",
  "refunded_receipt_id": 1,
  "daily_closing_id": 1,
  "pick_up_at": "2026-01-15T12:30:00Z",
  "reservation_id": 1,
  "opened_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Reference

A reference to another resource: its identifier and name.

id integer

Unique identifier of the resource.

name string

Name of the resource.

Example
{
  "id": 1,
  "name": "string"
}

ReportBalanceSheet

Mutations per ledger account in the period: revenue, payments and liabilities such as vouchers, deposits and loyalty balances.

revenue array of object

Mutations per ledger account.

ledger_account_id integer

Unique identifier of the ledger account.

name string

Name of the ledger account.

amount Money

Sum of the mutations.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

payments array of object

Mutations per ledger account.

ledger_account_id integer

Unique identifier of the ledger account.

name string

Name of the ledger account.

amount Money

Sum of the mutations.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

liability_credits array of object

Mutations per ledger account.

ledger_account_id integer

Unique identifier of the ledger account.

name string

Name of the ledger account.

amount Money

Sum of the mutations.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

liability_debits array of object

Mutations per ledger account.

ledger_account_id integer

Unique identifier of the ledger account.

name string

Name of the ledger account.

amount Money

Sum of the mutations.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

Example
{
  "revenue": [
    {
      "ledger_account_id": 1,
      "name": "string",
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      }
    }
  ],
  "payments": [
    {
      "ledger_account_id": 1,
      "name": "string",
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      }
    }
  ],
  "liability_credits": [
    {
      "ledger_account_id": 1,
      "name": "string",
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      }
    }
  ],
  "liability_debits": [
    {
      "ledger_account_id": 1,
      "name": "string",
      "amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      }
    }
  ]
}

ReportExceptionRow

An item given away, an item removed after ordering, or a voided receipt.

receipt_id integer

Unique identifier of the receipt.

customer string

Table, customer or group of the receipt.

description string

The item; null for a voided receipt.

price Money

Price of the item, or the total of the voided receipt.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

employee string

Employee who gave away, removed or voided it.

at datetime

Time it was removed or voided; null for items given away.

Example
{
  "receipt_id": 1,
  "customer": "string",
  "description": "string",
  "price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "employee": "string",
  "at": "2026-01-15T12:30:00Z"
}

ReportOverview

Revenue, cashflow and receipts in the period, compared with the period before.

from date

First day of the period.

to date

Last day of the period.

total_revenue Money

Revenue including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

total_cashflow Money

Money received.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

receipts_count integer

Number of receipts.

comparison object

The period of the same length before it.

from date

First day of the period.

to date

Last day of the period.

total_revenue Money

Revenue including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

total_cashflow Money

Money received.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

Example
{
  "from": "2026-01-15",
  "to": "2026-01-15",
  "total_revenue": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "total_cashflow": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "receipts_count": 1,
  "comparison": {
    "from": "2026-01-15",
    "to": "2026-01-15",
    "total_revenue": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "total_cashflow": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    }
  }
}

ReportRevenueRow

Revenue in the period for one category of revenue, device, employee or shop.

source_id integer

Unique identifier of the category of revenue, device, employee or shop, depending on `group_by`.

source string

Its name.

revenue Money

Revenue including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

Example
{
  "source_id": 1,
  "source": "string",
  "revenue": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  }
}

ReportRevenueSeries

Revenue per day for one category of revenue.

category_of_revenue_id integer

Unique identifier of the category of revenue.

name string

Name of the category of revenue.

days array of object

Revenue per day closing.

date date

Date of the day closing.

revenue Money

Revenue including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

Example
{
  "category_of_revenue_id": 1,
  "name": "string",
  "days": [
    {
      "date": "2026-01-15",
      "revenue": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      }
    }
  ]
}

ReportSalesRow

A product or free item sold in the period, with the options chosen with it.

label string

Name of the product or item as it was sold.

count integer

Number of times it was sold.

options string

Options chosen with it and how often, for example `Large (12x)|||Small (3x)`; null when none.

total_price Money

Revenue including options and VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

Example
{
  "label": "string",
  "count": 1,
  "options": "string",
  "total_price": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  }
}

ReportTax

Revenue and VAT in the period, per tax rate.

total_revenue Money

Revenue including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

total_tax Money

VAT over the revenue.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

rates array of object

Revenue and VAT per tax rate.

tax_rate_id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

revenue Money

Revenue including VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

net_revenue Money

Revenue excluding VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_amount Money

VAT.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

Example
{
  "total_revenue": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "total_tax": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "rates": [
    {
      "tax_rate_id": 1,
      "name": "string",
      "percentage": 9.99,
      "revenue": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "net_revenue": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "tax_amount": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      }
    }
  ]
}

Reservation

A table reservation, or a block that keeps tables free when `party_size` is 0.

id integer

Unique identifier of the reservation.

status string

One of `pending_payment`, `requested`, `option`, `confirmed`, `partially_seated`, `seated`, `completed`, `cancelled`, `declined`, `no_show`.

source string

Channel the reservation came in through: `online`, `agent`, `manual`, `phone`, `email`, `walk_in`.

starts_at datetime

Time the reservation starts.

ends_at datetime

Time the reserved tables are free again.

party_size integer

Number of guests; 0 for a block.

arrived_party_size integer

Number of guests that arrived; null until check-in.

customer Customer

Guest the reservation is for; absent for blocks.

id integer

Unique identifier of the customer.

name string

Full name of the customer, for example `Jan de Vries`.

email string

Email address of the customer.

phone string

Phone number of the customer.

address string

Postal address of the customer.

note string

Internal note for staff, for example `Allergic to nuts`.

locale string

Preferred language of the customer for mails, `nl` or `en`.

pinned boolean

Whether the customer is pinned: pinned customers always have an open receipt and are shown first on the register.

balance Money

Prepaid loyalty balance the customer can spend. Read-only; changed by top-ups and payments on the register.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

temporary boolean

Whether the customer was created on the fly for an "op naam" (on name) order. Temporary customers are left out of lists once their receipt is closed.

archived boolean

Whether the customer is archived.

merged_into_id integer

Customer this customer was merged into; null unless merged.

group_ids array of integer

Identifiers of the customer groups the customer belongs to.

last_receipt_at datetime

Time of the customer's most recent receipt.

identifier string

Unique identifier for external systems, for example on the customer's wallet pass. Read-only.

app_data object

Arbitrary data stored on the customer by your app.

created_at datetime

Time the customer was created.

updated_at datetime

Time the customer was last updated.

table_ids array of integer

Unique identifiers of the assigned tables.

kinds array of object

Reservation kinds booked, with the guests per kind.

reservation_kind_id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

party_size integer

Number of guests booked for this kind.

note string

Note from the guest.

receipt_note string

Note copied to the receipt and kitchen at check-in.

marker_ids array of integer

Markers (for example allergies or a birthday) copied to the receipt and kitchen at check-in.

receipt_id integer

Unique identifier of the receipt opened at check-in; null before check-in.

deposit_per_person Money

Deposit charged per guest; null when no deposit is required.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

deposit_persons integer

Number of guests the deposit is charged for.

deposit_due_at datetime

Time the deposit must be paid by.

deposit_paid_at datetime

Time the deposit was paid.

deposit_applied_at datetime

Time the paid deposit was settled on the receipt at check-in.

deposit_refunded_at datetime

Time the paid deposit was refunded, for example after a timely cancellation.

deposit_forfeited_at datetime

Time the paid deposit was kept because of a late cancellation or no-show.

confirmed_at datetime

Time the reservation was confirmed.

cancelled_at datetime

Time the reservation was cancelled.

seated_at datetime

Time the guests were checked in.

created_at datetime

Time the reservation was created.

updated_at datetime

Time the reservation was last updated.

Example
{
  "id": 1,
  "status": "string",
  "source": "string",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "party_size": 1,
  "arrived_party_size": 1,
  "customer": {
    "id": 1,
    "name": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "note": "string",
    "locale": "string",
    "pinned": true,
    "balance": {
      "value": 1,
      "currency": "string",
      "minor_units": 1,
      "formatted": "string"
    },
    "temporary": true,
    "archived": true,
    "merged_into_id": 1,
    "group_ids": [
      1
    ],
    "last_receipt_at": "2026-01-15T12:30:00Z",
    "identifier": "string",
    "app_data": {},
    "created_at": "2026-01-15T12:30:00Z",
    "updated_at": "2026-01-15T12:30:00Z"
  },
  "table_ids": [
    1
  ],
  "kinds": [
    {
      "reservation_kind_id": 1,
      "name": "string",
      "party_size": 1
    }
  ],
  "note": "string",
  "receipt_note": "string",
  "marker_ids": [
    1
  ],
  "receipt_id": 1,
  "deposit_per_person": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "deposit_persons": 1,
  "deposit_due_at": "2026-01-15T12:30:00Z",
  "deposit_paid_at": "2026-01-15T12:30:00Z",
  "deposit_applied_at": "2026-01-15T12:30:00Z",
  "deposit_refunded_at": "2026-01-15T12:30:00Z",
  "deposit_forfeited_at": "2026-01-15T12:30:00Z",
  "confirmed_at": "2026-01-15T12:30:00Z",
  "cancelled_at": "2026-01-15T12:30:00Z",
  "seated_at": "2026-01-15T12:30:00Z",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

ReservationAvailability

Start times guests can book on a day.

date date

Day the availability is for.

party_size integer

Number of guests the availability is for.

closed_by_lead_time boolean

Whether the remaining start times are too soon to book.

slots array of object

Bookable start times.

starts_at datetime

Start time.

deposit_per_person Money

Deposit charged per guest when booking this start time; null without a deposit.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

reservation_kind_ids array of integer

Reservation kinds bookable at this start time.

kind_required boolean

Whether a reservation kind must be picked for this start time.

Example
{
  "date": "2026-01-15",
  "party_size": 1,
  "closed_by_lead_time": true,
  "slots": [
    {
      "starts_at": "2026-01-15T12:30:00Z",
      "deposit_per_person": {
        "value": 1,
        "currency": "string",
        "minor_units": 1,
        "formatted": "string"
      },
      "reservation_kind_ids": [
        1
      ],
      "kind_required": true
    }
  ]
}

ReservationDurationRule

How long a reservation lasts from a party size up, optionally only for one reservation kind or one reservation window.

id integer

Unique identifier of the duration rule.

min_party_size integer

Smallest party the rule applies to; it applies up to the next rule's party size.

duration_minutes integer

Length of the reservation in minutes.

reservation_kind_id integer

Reservation kind the rule applies to; null for every kind.

reservation_window_id integer

Reservation window the rule applies to; null for an organization-wide rule.

created_at datetime

Time the duration rule was created.

updated_at datetime

Time the duration rule was last updated.

Example
{
  "id": 1,
  "min_party_size": 1,
  "duration_minutes": 1,
  "reservation_kind_id": 1,
  "reservation_window_id": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

ReservationKind

A kind of reservation guests can book, for example lunch or a tasting menu.

id integer

Unique identifier of the reservation kind.

name string

Name of the reservation kind.

description string

Description shown to guests.

position integer

Display order.

visibility string

Where the kind can be booked: `everywhere`, `linked_windows` (only in the windows it is linked to) or `staff_only`.

max_party_size integer

Largest party that can book this kind; null for the program default.

minimum_lead_time_minutes integer

Minimum minutes between booking and start; null for the program default.

combinable boolean

Whether the kind can be combined with other kinds on one reservation.

archived boolean

Whether the kind is archived.

created_at datetime

Time the reservation kind was created.

updated_at datetime

Time the reservation kind was last updated.

Example
{
  "id": 1,
  "name": "string",
  "description": "string",
  "position": 1,
  "visibility": "string",
  "max_party_size": 1,
  "minimum_lead_time_minutes": 1,
  "combinable": true,
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

ReservationNote

A note for staff shown on the reservation calendar on one or more days, for example `Wine tasting upstairs, terrace closed`.

id integer

Unique identifier of the note.

message string

Text of the note.

starts_on date

First day the note is shown.

ends_on date

Last day the note is shown.

created_at datetime

Time the note was created.

updated_at datetime

Time the note was last updated.

Example
{
  "id": 1,
  "message": "string",
  "starts_on": "2026-01-15",
  "ends_on": "2026-01-15",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

ReservationSetting

The organization's reservation program.

id integer

Unique identifier of the reservation program.

name string

Name of the deposit line.

enabled boolean

Whether guests can book online.

auto_confirm boolean

Whether online bookings are confirmed without staff approval.

slot_interval_minutes integer

Minutes between bookable start times.

default_duration_minutes integer

Default length of a reservation.

min_party_size integer

Smallest party that can book online.

max_party_size integer

Largest party that can book online.

max_concurrent_covers integer

Maximum guests seated at the same time; null for no limit.

max_covers_per_slot integer

Maximum guests starting in one slot; null for no limit.

minimum_lead_time_minutes integer

Minimum minutes between booking and start.

horizon_days integer

How many days ahead guests can book.

no_show_after_minutes integer

Minutes after the start a reservation counts as a no-show.

reminder_days_before integer

Days before the reservation the guest gets a reminder; null for no reminder.

deposit_free_cancellation_hours integer

Hours before the start a paid deposit is still refunded on cancellation.

background_color string

Background color of the booking widget's header as #rrggbb.

text_color string

Text color of the booking widget's header as #rrggbb.

created_at datetime

Time the reservation program was created.

updated_at datetime

Time the reservation program was last updated.

Example
{
  "id": 1,
  "name": "string",
  "enabled": true,
  "auto_confirm": true,
  "slot_interval_minutes": 1,
  "default_duration_minutes": 1,
  "min_party_size": 1,
  "max_party_size": 1,
  "max_concurrent_covers": 1,
  "max_covers_per_slot": 1,
  "minimum_lead_time_minutes": 1,
  "horizon_days": 1,
  "no_show_after_minutes": 1,
  "reminder_days_before": 1,
  "deposit_free_cancellation_hours": 1,
  "background_color": "string",
  "text_color": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

ReservationWindow

A period in which guests can book, with its own limits.

id integer

Unique identifier of the window.

name string

Name of the window.

frequency string

How the window repeats: `day`, `week`, `month` or `year`; null for a one-time window.

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday; null for other windows.

ordinals array of integer

Which of the weekdays a monthly window opens on, 1 to 4 or -1 for the last; null for other windows.

from_time string

Time of day a repeating window opens, HH:MM; null for a one-time window.

till_time string

Time of day a repeating window closes, HH:MM; before from_time when it runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year.

repeats_until date

Last date a repeating window opens; null when it repeats forever.

starts_at datetime

Start of a one-time window; null for a repeating window.

ends_at datetime

End of a one-time window; null for a repeating window.

starts_on date

First date of a special period that replaces the regular windows; null for a regular window.

ends_on date

Last date of a special period; null when open-ended.

schedule string

When the window opens, in words.

min_party_size integer

Smallest party that can book; null for the program default.

max_party_size integer

Largest party that can book; null for the program default.

max_concurrent_covers integer

Maximum guests seated at the same time; null for the program default.

max_covers_per_slot integer

Maximum guests starting in one slot; null for the program default.

slot_interval_minutes integer

Minutes between bookable start times; null for the program default.

deposit_per_person Money

Deposit charged per guest; null without a deposit.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

deposit_minimum_party_size integer

Smallest party the deposit applies to.

requires_kind boolean

Whether guests must pick a reservation kind.

reservation_kind_ids array of integer

Reservation kinds bookable in this window; empty for all.

created_at datetime

Time the window was created.

updated_at datetime

Time the window was last updated.

Example
{
  "id": 1,
  "name": "string",
  "frequency": "string",
  "weekdays": [
    1
  ],
  "ordinals": [
    1
  ],
  "from_time": "string",
  "till_time": "string",
  "repeats_from": "2026-01-15",
  "repeats_until": "2026-01-15",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "starts_on": "2026-01-15",
  "ends_on": "2026-01-15",
  "schedule": "string",
  "min_party_size": 1,
  "max_party_size": 1,
  "max_concurrent_covers": 1,
  "max_covers_per_slot": 1,
  "slot_interval_minutes": 1,
  "deposit_per_person": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "deposit_minimum_party_size": 1,
  "requires_kind": true,
  "reservation_kind_ids": [
    1
  ],
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Revenue

Revenue generated within one segment of a breakdown.

amount Money

Revenue amount.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

tax_rate TaxRate

Tax rate of the category of revenue.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

category_of_revenue Reference

Category of revenue the revenue belongs to, when broken down per category of revenue.

id integer

Unique identifier of the resource.

name string

Name of the resource.

employee Reference

Employee who generated the revenue, when broken down per employee.

id integer

Unique identifier of the resource.

name string

Name of the resource.

device Reference

Device the revenue was generated on, when broken down per device.

id integer

Unique identifier of the resource.

name string

Name of the resource.

voucher Reference

Voucher the revenue was generated with, when broken down per voucher.

id integer

Unique identifier of the resource.

name string

Name of the resource.

loyalty Reference

Loyalty program the top-up revenue belongs to, when broken down per loyalty top-up.

id integer

Unique identifier of the resource.

name string

Name of the resource.

reservation Reference

Reservation program the deposit belongs to, when broken down per reservation deposit.

id integer

Unique identifier of the resource.

name string

Name of the resource.

Example
{
  "amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "tax_rate": {
    "id": 1,
    "name": "string",
    "percentage": 9.99,
    "kind": "string",
    "archived": true,
    "label": "string",
    "created_at": "2026-01-15T12:30:00Z",
    "updated_at": "2026-01-15T12:30:00Z"
  },
  "category_of_revenue": {
    "id": 1,
    "name": "string"
  },
  "employee": {
    "id": 1,
    "name": "string"
  },
  "device": {
    "id": 1,
    "name": "string"
  },
  "voucher": {
    "id": 1,
    "name": "string"
  },
  "loyalty": {
    "id": 1,
    "name": "string"
  },
  "reservation": {
    "id": 1,
    "name": "string"
  }
}

Shop

A webshop: online ordering with pick-up (`online`), ordering at the table with payment (`pay_now`) or ordering at the table on an open receipt (`pay_later`).

kind string

One of `online`, `pay_now` or `pay_later`.

id integer

Unique identifier of the shop.

name string

Name of the shop.

enabled boolean

Whether the shop accepts orders.

open boolean

Whether the shop is open for orders right now.

quickselect_page_id integer

Unique identifier of the quickselect page used as the menu.

payment_method_id integer

Unique identifier of the payment method used for online payment.

minimum_order_amount Money

Minimum order amount, excluding fees; null without a minimum.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

slot_interval_minutes integer

Minutes between pick-up times (online shops).

lead_time_minutes integer

Minimum minutes between ordering and pick-up (online shops).

max_orders_per_slot integer

Maximum orders per pick-up time (online shops).

horizon_days integer

How many days ahead guests can order (online shops).

welcome_text string

Text shown when the shop opens.

closed_text string

Text shown while the shop is closed.

terms_url string

Link to the terms and conditions; null when the shop shows `terms_text` or has none.

terms_text string

Terms and conditions shown in the shop itself; null when it links to `terms_url`.

privacy_url string

Link to the privacy statement; null when the shop shows `privacy_text` or has none.

privacy_text string

Privacy statement shown in the shop itself; null when it links to `privacy_url`.

url string

Public URL of the shop.

fee_ids array of integer

Fees added to every order, for example a delivery fee (`GET /v1/fees`).

Opening windows of the shop.

id integer

Unique identifier of the window.

name string

Name of the window.

frequency string

How the window repeats: `day`, `week`, `month` or `year`; null for a one-time window.

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday; null for other windows.

ordinals array of integer

Which of the weekdays a monthly window opens on, 1 to 4 or -1 for the last; null for other windows.

from_time string

Time of day a repeating window opens, HH:MM; null for a one-time window.

till_time string

Time of day a repeating window closes, HH:MM; before from_time when it runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year.

repeats_until date

Last date a repeating window opens; null when it repeats forever.

starts_at datetime

Start of a one-time window; null for a repeating window.

ends_at datetime

End of a one-time window; null for a repeating window.

starts_on date

First date of a special period that replaces the regular windows; null for a regular window.

ends_on date

Last date of a special period; null when open-ended.

schedule string

When the window opens, in words.

slot_interval_minutes integer

Minutes between pick-up times; null for the shop default.

lead_time_minutes integer

Minimum minutes between ordering and pick-up; null for the shop default.

max_orders_per_slot integer

Maximum orders per pick-up time; null for the shop default.

created_at datetime

Time the window was created.

updated_at datetime

Time the window was last updated.

archived boolean

Whether the shop is archived.

created_at datetime

Time the shop was created.

updated_at datetime

Time the shop was last updated.

Example
{
  "kind": "string",
  "id": 1,
  "name": "string",
  "enabled": true,
  "open": true,
  "quickselect_page_id": 1,
  "payment_method_id": 1,
  "minimum_order_amount": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "slot_interval_minutes": 1,
  "lead_time_minutes": 1,
  "max_orders_per_slot": 1,
  "horizon_days": 1,
  "welcome_text": "string",
  "closed_text": "string",
  "terms_url": "string",
  "terms_text": "string",
  "privacy_url": "string",
  "privacy_text": "string",
  "url": "string",
  "fee_ids": [
    1
  ],
  "windows": [
    {
      "id": 1,
      "name": "string",
      "frequency": "string",
      "weekdays": [
        1
      ],
      "ordinals": [
        1
      ],
      "from_time": "string",
      "till_time": "string",
      "repeats_from": "2026-01-15",
      "repeats_until": "2026-01-15",
      "starts_at": "2026-01-15T12:30:00Z",
      "ends_at": "2026-01-15T12:30:00Z",
      "starts_on": "2026-01-15",
      "ends_on": "2026-01-15",
      "schedule": "string",
      "slot_interval_minutes": 1,
      "lead_time_minutes": 1,
      "max_orders_per_slot": 1,
      "created_at": "2026-01-15T12:30:00Z",
      "updated_at": "2026-01-15T12:30:00Z"
    }
  ],
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

ShopPickupSlots

Pick-up times guests can choose on a day.

date date

Day the pick-up times are for.

slots array of datetime

Pick-up times that can still be chosen.

Example
{
  "date": "2026-01-15",
  "slots": [
    "2026-01-15T12:30:00Z"
  ]
}

ShopWindow

A period in which a shop accepts orders.

id integer

Unique identifier of the window.

name string

Name of the window.

frequency string

How the window repeats: `day`, `week`, `month` or `year`; null for a one-time window.

weekdays array of integer

Weekdays a weekly or monthly window opens on, 0 is Sunday; null for other windows.

ordinals array of integer

Which of the weekdays a monthly window opens on, 1 to 4 or -1 for the last; null for other windows.

from_time string

Time of day a repeating window opens, HH:MM; null for a one-time window.

till_time string

Time of day a repeating window closes, HH:MM; before from_time when it runs past midnight.

repeats_from date

First date a repeating window opens; for a yearly window the date it opens every year.

repeats_until date

Last date a repeating window opens; null when it repeats forever.

starts_at datetime

Start of a one-time window; null for a repeating window.

ends_at datetime

End of a one-time window; null for a repeating window.

starts_on date

First date of a special period that replaces the regular windows; null for a regular window.

ends_on date

Last date of a special period; null when open-ended.

schedule string

When the window opens, in words.

slot_interval_minutes integer

Minutes between pick-up times; null for the shop default.

lead_time_minutes integer

Minimum minutes between ordering and pick-up; null for the shop default.

max_orders_per_slot integer

Maximum orders per pick-up time; null for the shop default.

created_at datetime

Time the window was created.

updated_at datetime

Time the window was last updated.

Example
{
  "id": 1,
  "name": "string",
  "frequency": "string",
  "weekdays": [
    1
  ],
  "ordinals": [
    1
  ],
  "from_time": "string",
  "till_time": "string",
  "repeats_from": "2026-01-15",
  "repeats_until": "2026-01-15",
  "starts_at": "2026-01-15T12:30:00Z",
  "ends_at": "2026-01-15T12:30:00Z",
  "starts_on": "2026-01-15",
  "ends_on": "2026-01-15",
  "schedule": "string",
  "slot_interval_minutes": 1,
  "lead_time_minutes": 1,
  "max_orders_per_slot": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Table

A table in an area of the floor plan, used for orders at the register and for reservations.

id integer

Unique identifier of the table.

area_id integer

Unique identifier of the area this table belongs to.

number integer

Table number shown to staff, for example 12.

capacity integer

Number of seats. Online reservations only get tables (or joined tables) with enough seats.

reservable boolean

Whether online reservations can be assigned to this table. Staff can always assign it.

shape string

Floor-plan shape: `round` or `square`.

width integer

Width as a percentage of a standard table footprint (1-200).

height integer

Height as a percentage of a standard table footprint (1-200).

links array of object

Tables this table may be joined with for one reservation. Only used when the area's `table_combination_mode` is `explicit`.

table_id integer

Unique identifier of the linked table.

capacity_loss integer

Seats lost when the two tables are pushed together, for example 2 when the joined ends can't seat anyone.

hidden boolean

Whether the table is temporarily hidden. Hidden tables are left out of the floor plan at the register and out of online reservations.

archived boolean

Whether the table is archived.

created_at datetime

Time the table was created.

updated_at datetime

Time the table was last updated.

Example
{
  "id": 1,
  "area_id": 1,
  "number": 1,
  "capacity": 1,
  "reservable": true,
  "shape": "string",
  "width": 1,
  "height": 1,
  "links": [
    {
      "table_id": 1,
      "capacity_loss": 1
    }
  ],
  "hidden": true,
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

TakeoutSetting

Takeout on the register: orders that guests pick up, with a pick-up time.

enabled boolean

Whether staff can ring up takeout orders.

color string

Color that marks takeout orders.

printer_id integer

Printer the takeout slip is printed on; null for none.

undock_receipts boolean

Whether takeout receipts start undocked on the register.

future_takeouts boolean

Whether takeout orders can be scheduled for a later day.

create_task_on_future_order boolean

Whether a task is added for each takeout order on a later day.

created_at datetime

Time the takeout settings was created.

updated_at datetime

Time the takeout settings was last updated.

Example
{
  "enabled": true,
  "color": "string",
  "printer_id": 1,
  "undock_receipts": true,
  "future_takeouts": true,
  "create_task_on_future_order": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Task

A to-do in the task manager of the back office and registers, for example a reservation that awaits approval or a deposit that should be refunded. A task stays open until someone marks it as done.

id integer

Unique identifier of the task.

kind enum

Kind of task: `app` (created by an app through the API), `reservation_approval` (a requested reservation awaits confirmation), `reservation_creation` (a guest booked online), `reservation_note` (a guest booked online with a note), `reservation_cancellation` (a guest cancelled), `deposit_refund` (a paid deposit should be refunded), `deposit_expired` (a deposit was not paid in time), `future_order` (a takeout order for a later day came in) or `app_domain_review` (20tabs approved or rejected a domain of your apps).

appreservation_approvalreservation_creationreservation_notereservation_cancellationdeposit_refunddeposit_expiredfuture_orderapp_domain_review

name string

Task name in the organization's language.

name_translations object

Task name per language code, for example `{ "en": "Missing barcode", "nl": "Ontbrekende barcode" }`.

description string

Task description in the organization's language.

description_translations object

Task description per language code.

taskable_type string

Kind of record the task is about, for example `reservation`; null when it is about nothing specific.

taskable_id integer

Identifier of the record the task is about, for example the reservation id.

open boolean

Whether the task still has to be done.

completed_at datetime

Time the task was marked as done; null while the task is open.

completed_by_employee_id integer

Employee who marked the task as done; null when done through the API or while open.

created_at datetime

Time the task was created.

updated_at datetime

Time the task was last updated.

Example
{
  "id": 1,
  "kind": "app",
  "name": "string",
  "name_translations": {},
  "description": "string",
  "description_translations": {},
  "taskable_type": "string",
  "taskable_id": 1,
  "open": true,
  "completed_at": "2026-01-15T12:30:00Z",
  "completed_by_employee_id": 1,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

TaxRate

A tax rate configured for the organization.

id integer

Unique identifier of the tax rate.

name string

Name of the tax rate.

percentage number

Tax percentage on a 0-100 scale, for example 21.0.

kind string

Country-independent role of the rate: standard, reduced, second_reduced, zero or other. Key on this instead of the percentage, which differs per country.

archived boolean

Whether the tax rate is archived.

label string

Human-readable label combining the name and percentage.

created_at datetime

Time the tax rate was created.

updated_at datetime

Time the tax rate was last updated.

Example
{
  "id": 1,
  "name": "string",
  "percentage": 9.99,
  "kind": "string",
  "archived": true,
  "label": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

Voucher

A kind of voucher (gift card) the organization sells, for example `Gift card`. Each physical or digital card sold is a voucher card with its own code and balance.

id integer

Unique identifier of the voucher.

name string

Name of the voucher, for example `Gift card`.

scan_methods array of string

How cards are read at the register: `camera` (QR code), `nfc` (tap) and/or `manual` (typing the code).

physical_cards boolean

Whether the voucher is issued as printed or plastic cards, besides digital wallet passes.

payment_method_id integer

Payment method that records redemptions of this voucher (`GET /v1/payment_methods`).

archived boolean

Whether the voucher is archived and no longer sold.

created_at datetime

Time the voucher was created.

updated_at datetime

Time the voucher was last updated.

Example
{
  "id": 1,
  "name": "string",
  "scan_methods": [
    "string"
  ],
  "physical_cards": true,
  "payment_method_id": 1,
  "archived": true,
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}

VoucherCard

A voucher card (gift card) with its balance. Its code works like cash, so the API never returns it; `code_ending` helps recognise a card.

id integer

Unique identifier of the card.

voucher_id integer

Voucher the card belongs to (`GET /v1/vouchers`).

customer_id integer

Customer the card was sold to or linked with; null when anonymous.

initial_value Money

Value the card was issued with.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

remaining_balance Money

Balance that can still be spent.

value integer

Amount as a whole number in the precision of `minor_units`, for example `1250` with `minor_units` 2 for €12.50; negative for refunds and corrections.

currency string

ISO 4217 currency code, for example `EUR`.

minor_units integer

Number of decimal places in `value`, always that of the currency in responses, `2` for EUR. On input it may be lower: `value` 125 with `minor_units` 1 is €12.50, with `minor_units` 0 it is €125.

formatted string

Amount formatted for display in the organization's language, for example `€ 12,50`. Don't parse it; use `value`.

activated boolean

Whether the card was sold and can be spent. Cards printed in advance stay inactive until they are sold at the register.

activated_at datetime

Time the card was sold; null while inactive.

archived boolean

Whether the card is archived and can no longer be spent.

code_ending string

Last 4 characters of the code, to recognise a card without exposing its code.

created_at datetime

Time the card was created.

updated_at datetime

Time the card was last updated.

Example
{
  "id": 1,
  "voucher_id": 1,
  "customer_id": 1,
  "initial_value": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "remaining_balance": {
    "value": 1,
    "currency": "string",
    "minor_units": 1,
    "formatted": "string"
  },
  "activated": true,
  "activated_at": "2026-01-15T12:30:00Z",
  "archived": true,
  "code_ending": "string",
  "created_at": "2026-01-15T12:30:00Z",
  "updated_at": "2026-01-15T12:30:00Z"
}
Try for free