areas_create
ChatGPTCreate a new area. Position is auto-assigned to the end of the list.
areas_create
ChatGPTCreate a new area. Position is auto-assigned to the end of the list.
areas_list
ChatGPTList the venue's areas (sections of the floor plan, e.g. Patio, Bar). Includes the number of unarchived tables per area.
areas_list
ChatGPTList the venue's areas (sections of the floor plan, e.g. Patio, Bar). Includes the number of unarchived tables per area.
areas_show
ChatGPTShow a single area. Use tables_list with area_id to retrieve its tables.
areas_show
ChatGPTShow a single area. Use tables_list with area_id to retrieve its tables.
areas_update
ChatGPTUpdate an area's name or position.
areas_update
ChatGPTUpdate an area's name or position.
categories_of_revenue_list
ChatGPTList categories of revenue. Use the returned id as category_of_revenue_id in products_create / products_update.
categories_of_revenue_list
ChatGPTList categories of revenue. Use the returned id as category_of_revenue_id in products_create / products_update.
closings_daily
ChatGPTReturns the daily closing for a specific date, including revenue per category and cashflow.
closings_daily
ChatGPTReturns the daily closing for a specific date, including revenue per category and cashflow.
closings_monthly
ChatGPTReturns the monthly closing for a given year and month.
closings_monthly
ChatGPTReturns the monthly closing for a given year and month.
customers_list
ChatGPTPaginated list of active customers with last receipt timestamp and group memberships. By default returns id, name, locale, pinned, last_receipt_at, groups only; pass include_sensitive_data: true to include email/phone/address.
customers_list
ChatGPTPaginated list of active customers with last receipt timestamp and group memberships. By default returns id, name, locale, pinned, last_receipt_at, groups only; pass include_sensitive_data: true to include email/phone/address.
customers_purchase_history
ChatGPTReturns the receipt history for a customer within an optional date range.
customers_purchase_history
ChatGPTReturns the receipt history for a customer within an optional date range.
customers_search
ChatGPTSearch customers by name. By default returns id and name only; pass include_sensitive_data: true to include email/phone/address.
customers_search
ChatGPTSearch customers by name. By default returns id and name only; pass include_sensitive_data: true to include email/phone/address.
device_links_create
ChatGPTLink a child device to a parent device (e.g. attach a printer or customer-facing display to a register). The link is rejected if the child's kind is not in the parent's allowed_linked_device_kinds (see devices_show). Idempotent.
device_links_create
ChatGPTLink a child device to a parent device (e.g. attach a printer or customer-facing display to a register). The link is rejected if the child's kind is not in the parent's allowed_linked_device_kinds (see devices_show). Idempotent.
device_links_destroy
ChatGPTUnlink a child device from a parent device. The devices themselves are not deleted.
device_links_destroy
ChatGPTUnlink a child device from a parent device. The devices themselves are not deleted.
devices_create
ChatGPTCreate a device. The 'kind' determines required fields and the shape of 'settings': register (subtype: register|handheld) — settings: timeout_seconds, default_view, enable_direct_sales, enable_future_orders. Requires quickselect_page_id. customer_facing_display — no settings. preparation_display (subtype: preparation|runner) — settings: preparation_chime, undock_state. Requires preparation_location_ids. kiosk — settings: timeout_seconds, success_timeout_seconds, fail_timeout_seconds, touchscreen, split_direction, start_message, pin, qr_after_checkout. backoffice_display — no settings. network_printer — settings: host, port, characters_per_line (>=40). bluetooth_printer — settings: characters_per_line (>=40).
devices_create
ChatGPTCreate a device. The 'kind' determines required fields and the shape of 'settings': register (subtype: register|handheld) — settings: timeout_seconds, default_view, enable_direct_sales, enable_future_orders. Requires quickselect_page_id. customer_facing_display — no settings. preparation_display (subtype: preparation|runner) — settings: preparation_chime, undock_state. Requires preparation_location_ids. kiosk — settings: timeout_seconds, success_timeout_seconds, fail_timeout_seconds, touchscreen, split_direction, start_message, pin, qr_after_checkout. backoffice_display — no settings. network_printer — settings: host, port, characters_per_line (>=40). bluetooth_printer — settings: characters_per_line (>=40).
devices_list
ChatGPTList the organization's devices (POS registers, kitchen displays, printers, customer-facing screens). Filter by kind to narrow down. The returned settings hash is type-specific.
devices_list
ChatGPTList the organization's devices (POS registers, kitchen displays, printers, customer-facing screens). Filter by kind to narrow down. The returned settings hash is type-specific.
devices_show
ChatGPTShow a single device with its type-specific settings and the list of devices it has linked as children (e.g. printers and customer-facing displays attached to a register).
devices_show
ChatGPTShow a single device with its type-specific settings and the list of devices it has linked as children (e.g. printers and customer-facing displays attached to a register).
devices_update
ChatGPTUpdate a device. The kind (STI type) cannot be changed after creation. The settings hash is merged into the existing settings, not replaced — pass an explicit null to clear a key.
devices_update
ChatGPTUpdate a device. The kind (STI type) cannot be changed after creation. The settings hash is merged into the existing settings, not replaced — pass an explicit null to clear a key.
me
ChatGPTReturn the current authentication context: organization, app, granted scopes. Useful for debugging or branching tool usage on available permissions.
me
ChatGPTReturn the current authentication context: organization, app, granted scopes. Useful for debugging or branching tool usage on available permissions.
orders_revenue
ChatGPTReturns revenue totals for a date range, grouped by category, employee, device, or tax rate.
orders_revenue
ChatGPTReturns revenue totals for a date range, grouped by category, employee, device, or tax rate.
orders_revenue_timeseries
ChatGPTReturns daily revenue per category of revenue for a date range, useful for trend charts.
orders_revenue_timeseries
ChatGPTReturns daily revenue per category of revenue for a date range, useful for trend charts.
payment_methods_list
ChatGPTList payment methods. Use the returned id as payment_method_id in reports_payments / payments_search.
payment_methods_list
ChatGPTList payment methods. Use the returned id as payment_method_id in reports_payments / payments_search.
payments_search
ChatGPTTrack down a specific payment. Filter by date range, payment method, customer, receipt, or amount range (in EUR).
payments_search
ChatGPTTrack down a specific payment. Filter by date range, payment method, customer, receipt, or amount range (in EUR).
preparation_locations_create
ChatGPTCreate a preparation location. preparation_states must include the required states 'unrequested', 'requested', and 'delivered'. Defaults to the standard kitchen flow if omitted.
preparation_locations_create
ChatGPTCreate a preparation location. preparation_states must include the required states 'unrequested', 'requested', and 'delivered'. Defaults to the standard kitchen flow if omitted.
preparation_locations_destroy
ChatGPTPermanently delete a preparation location. Fails if it is still routing products or linked to a device.
preparation_locations_destroy
ChatGPTPermanently delete a preparation location. Fails if it is still routing products or linked to a device.
preparation_locations_list
ChatGPTList preparation locations (kitchens, bars, prep stations). Each location has a set of preparation states it tracks and an optional set of states that trigger printing. Use the returned id as preparation_location_id elsewhere.
preparation_locations_list
ChatGPTList preparation locations (kitchens, bars, prep stations). Each location has a set of preparation states it tracks and an optional set of states that trigger printing. Use the returned id as preparation_location_id elsewhere.
preparation_locations_show
ChatGPTShow a single preparation location along with counts of products routed to it and devices linked to it.
preparation_locations_show
ChatGPTShow a single preparation location along with counts of products routed to it and devices linked to it.
preparation_locations_update
ChatGPTUpdate a preparation location. When changing preparation_states the new list must still include 'unrequested', 'requested', and 'delivered'.
preparation_locations_update
ChatGPTUpdate a preparation location. When changing preparation_states the new list must still include 'unrequested', 'requested', and 'delivered'.
preparation_states_list
ChatGPTList the organization's preparation states (one row per canonical state: unrequested, requested, ready_to_prepare, preparing, prepared, ready_to_deliver, delivered). Each row carries the display label, button label, color, and visibility flag for kitchen displays.
preparation_states_list
ChatGPTList the organization's preparation states (one row per canonical state: unrequested, requested, ready_to_prepare, preparing, prepared, ready_to_deliver, delivered). Each row carries the display label, button label, color, and visibility flag for kitchen displays.
preparation_states_update
ChatGPTUpdate a preparation state's display attributes (color, label, button label, visibility). Preparation states are seeded one-per-organization and cannot be created or deleted via this API.
preparation_states_update
ChatGPTUpdate a preparation state's display attributes (color, label, button label, visibility). Preparation states are seeded one-per-organization and cannot be created or deleted via this API.
product_categories_create
ChatGPTCreate a product category. Assign it to products with products_create / products_update.
product_categories_list
ChatGPTList product categories. Use the returned id as product_category_ids in products_create / products_update, or as product_category_ids in reports_sales.
product_categories_show
ChatGPTShow a single product category.
product_categories_update
ChatGPTUpdate a product category's name.
product_option_groups_archive
ChatGPTArchive a product option group so it no longer appears in unarchived lists. Fails if the group is still attached to any product.
product_option_groups_archive
ChatGPTArchive a product option group so it no longer appears in unarchived lists. Fails if the group is still attached to any product.
product_option_groups_create
ChatGPTCreate a product option group. The 'kind' determines how its options behave: add_on/product_add_on append additional items to a receipt; option/product_option substitute or modify the parent product.
product_option_groups_create
ChatGPTCreate a product option group. The 'kind' determines how its options behave: add_on/product_add_on append additional items to a receipt; option/product_option substitute or modify the parent product.
product_option_groups_list
ChatGPTList product option groups. Each group bundles a set of options (modifiers, side dishes, sizes) that can be attached to one or more products.
product_option_groups_list
ChatGPTList product option groups. Each group bundles a set of options (modifiers, side dishes, sizes) that can be attached to one or more products.
product_option_groups_show
ChatGPTShow a single product option group and the options it contains.
product_option_groups_show
ChatGPTShow a single product option group and the options it contains.
product_option_groups_update
ChatGPTUpdate a product option group. The kind (STI type) cannot be changed after creation.
product_option_groups_update
ChatGPTUpdate a product option group. The kind (STI type) cannot be changed after creation.
product_options_create
ChatGPTAdd an option to a product option group. 'custom' options are free-form (name + price). 'product' options reference an existing product (price, tax, category, preparation location are inherited from that product unless overridden).
product_options_create
ChatGPTAdd an option to a product option group. 'custom' options are free-form (name + price). 'product' options reference an existing product (price, tax, category, preparation location are inherited from that product unless overridden).
product_options_destroy
ChatGPTPermanently delete a product option. Receipt items keep their snapshot price/name, so historical receipts are unaffected, but the option will disappear from any group it was part of.
product_options_destroy
ChatGPTPermanently delete a product option. Receipt items keep their snapshot price/name, so historical receipts are unaffected, but the option will disappear from any group it was part of.
product_options_update
ChatGPTUpdate an option within a product option group. The kind (STI type) cannot be changed after creation.
product_options_update
ChatGPTUpdate an option within a product option group. The kind (STI type) cannot be changed after creation.
products_create
ChatGPTCreate a new product.
products_create
ChatGPTCreate a new product.
products_option_groups_create
ChatGPTAttach a product option group to a product. Idempotent: returns the existing join row if the group is already attached.
products_option_groups_create
ChatGPTAttach a product option group to a product. Idempotent: returns the existing join row if the group is already attached.
products_option_groups_destroy
ChatGPTDetach a product option group from a product. The option group itself is not deleted.
products_option_groups_destroy
ChatGPTDetach a product option group from a product. The option group itself is not deleted.
products_search
ChatGPTSearch products by name or PLU/barcode.
products_search
ChatGPTSearch products by name or PLU/barcode.
products_top_selling
ChatGPTReturns the best-selling products for a date range, ordered by number of times sold.
products_top_selling
ChatGPTReturns the best-selling products for a date range, ordered by number of times sold.
products_update
ChatGPTUpdate an existing product's attributes.
products_update
ChatGPTUpdate an existing product's attributes.
quickselect_categories_create
ChatGPTCreate a category (tab) inside a quickselect page. Position is auto-assigned to the end.
quickselect_categories_create
ChatGPTCreate a category (tab) inside a quickselect page. Position is auto-assigned to the end.
quickselect_categories_destroy
ChatGPTDelete a quickselect category. Cascades to its buttons.
quickselect_categories_destroy
ChatGPTDelete a quickselect category. Cascades to its buttons.
quickselect_categories_update
ChatGPTUpdate a quickselect category's name or position.
quickselect_categories_update
ChatGPTUpdate a quickselect category's name or position.
quickselect_pages_create
ChatGPTCreate a new quickselect page. Position is auto-assigned to the end.
quickselect_pages_create
ChatGPTCreate a new quickselect page. Position is auto-assigned to the end.
quickselect_pages_destroy
ChatGPTDelete a quickselect page. Cascades to its categories and buttons. Any register devices that pointed to it have their quickselect_page_id set to null.
quickselect_pages_destroy
ChatGPTDelete a quickselect page. Cascades to its categories and buttons. Any register devices that pointed to it have their quickselect_page_id set to null.
quickselect_pages_list
ChatGPTList quickselect pages. A quickselect page is a screen of fast-pick buttons that a register device displays. Use the returned id as quickselect_page_id when creating or updating a register device.
quickselect_pages_list
ChatGPTList quickselect pages. A quickselect page is a screen of fast-pick buttons that a register device displays. Use the returned id as quickselect_page_id when creating or updating a register device.
quickselect_pages_show
ChatGPTShow a single quickselect page with its categories and the buttons inside each category.
quickselect_pages_show
ChatGPTShow a single quickselect page with its categories and the buttons inside each category.
quickselect_pages_update
ChatGPTUpdate a quickselect page's display attributes or position.
quickselect_pages_update
ChatGPTUpdate a quickselect page's display attributes or position.
quickselects_create
ChatGPTAdd a button to a quickselect category. The 'kind' picks the button type: product (requires product_id), voucher (requires voucher_id), manual (free-form item entry; settings may include default_name and default_price in cents), scan, search, buzzer (requires organization.use_buzzers), takeout (requires organization.takeout_setting.enabled).
quickselects_create
ChatGPTAdd a button to a quickselect category. The 'kind' picks the button type: product (requires product_id), voucher (requires voucher_id), manual (free-form item entry; settings may include default_name and default_price in cents), scan, search, buzzer (requires organization.use_buzzers), takeout (requires organization.takeout_setting.enabled).
quickselects_destroy
ChatGPTDelete a quickselect button. The underlying product or voucher is not affected.
quickselects_destroy
ChatGPTDelete a quickselect button. The underlying product or voucher is not affected.
quickselects_update
ChatGPTUpdate a quickselect button's display attributes. The kind (STI type) and the underlying quickselectable cannot be changed; delete and recreate instead. settings is merged into existing settings.
quickselects_update
ChatGPTUpdate a quickselect button's display attributes. The kind (STI type) and the underlying quickselectable cannot be changed; delete and recreate instead. settings is merged into existing settings.
receipts_search
ChatGPTList receipts in a date range. Optionally filter by customer and status (open, paid, voided).
receipts_search
ChatGPTList receipts in a date range. Optionally filter by customer and status (open, paid, voided).
receipts_show
ChatGPTFull overview of a single receipt: items, payments, totals, customer, voiding and representation flags. By default customer details are redacted to id/name; pass include_sensitive_data: true for email.
receipts_show
ChatGPTFull overview of a single receipt: items, payments, totals, customer, voiding and representation flags. By default customer details are redacted to id/name; pass include_sensitive_data: true for email.
reports_balance_sheet
ChatGPTLedger-based balance sheet for a date range: revenue accounts, payment accounts, and voucher credit/debit movements.
reports_balance_sheet
ChatGPTLedger-based balance sheet for a date range: revenue accounts, payment accounts, and voucher credit/debit movements.
reports_exceptions
ChatGPTReceipt-level exceptions for a date range: representation (comped) items, removed items, or voided receipts.
reports_exceptions
ChatGPTReceipt-level exceptions for a date range: representation (comped) items, removed items, or voided receipts.
reports_overview
ChatGPTHigh-level revenue and cashflow totals for a date range, with a comparison against the previous equivalent period.
reports_overview
ChatGPTHigh-level revenue and cashflow totals for a date range, with a comparison against the previous equivalent period.
reports_payments
ChatGPTIndividual payments for a date range, filtered to a single payment method.
reports_payments
ChatGPTIndividual payments for a date range, filtered to a single payment method.
reports_sales
ChatGPTAggregated sales per product for a date range. Returns product label, count, options summary, and total price. Optionally filter by preparation location, product category, or device.
reports_sales
ChatGPTAggregated sales per product for a date range. Returns product label, count, options summary, and total price. Optionally filter by preparation location, product category, or device.
reports_tax
ChatGPTTax breakdown for a date range. Returns revenue, net revenue, and tax amount per tax rate, plus totals.
reports_tax
ChatGPTTax breakdown for a date range. Returns revenue, net revenue, and tax amount per tax rate, plus totals.
reports_trends
ChatGPTHistorical trend data for a date range: hour-of-day, day-of-week, or top products.
reports_trends
ChatGPTHistorical trend data for a date range: hour-of-day, day-of-week, or top products.
tables_archive
ChatGPTArchive a table. Fails if the table has open receipts, is in a guest group, or has saved floor-plan positions.
tables_archive
ChatGPTArchive a table. Fails if the table has open receipts, is in a guest group, or has saved floor-plan positions.
tables_create
ChatGPTCreate a new table inside an area.
tables_create
ChatGPTCreate a new table inside an area.
tables_list
ChatGPTList tables, optionally filtered by area or table number. Excludes archived tables by default.
tables_list
ChatGPTList tables, optionally filtered by area or table number. Excludes archived tables by default.
tables_unarchive
ChatGPTRestore an archived table so it appears in the active table list again.
tables_unarchive
ChatGPTRestore an archived table so it appears in the active table list again.
tables_update
ChatGPTUpdate a table's attributes. Moving a table to a different area is not supported here.
tables_update
ChatGPTUpdate a table's attributes. Moving a table to a different area is not supported here.
tax_rates_list
ChatGPTList all tax rates. Use the returned id as tax_rate_id in products_create / products_update.
tax_rates_list
ChatGPTList all tax rates. Use the returned id as tax_rate_id in products_create / products_update.