Caisse Enregistreuse Api

Showing 25 of 41 from the live probe.

• List Kash accounts

  List all Kash / free-cash-register.net accounts linked to an email address. Use this before account_create to check if the user already has an account. Returns an array of accounts, each with accountTitle, accountID, and a getOTPForAccount URL that can be used to request a one-time password (OTP) to retrieve the APIKEY. This endpoint is public and requires no authentication.

• Create a Kash account

  Create a new Kash / free-cash-register.net account. Requires an email address and a shop name (accountTitle). Optional: configType to pre-load a dataset matching your business type (e.g. 'Restaurant', 'Bakery', 'Bar', 'Retail'...), plus address and legal info. On success, returns APIKEY and SHOPID and automatically initializes the session so all other tools can be used immediately. IMPORTANT: the user must validate their email via the link sent automatically, otherwise the account may be deleted

• Request a login OTP

  Step 1 of 2 for in-conversation authentication. Sends a one-time password (OTP) to the user's email address. If the user has multiple accounts, provide accountID (obtained from account_list) to target the right one. On success, an OTP code is sent by email — then call auth_login_with_otp with that code.

• Login with OTP

  Step 2 of 2 for in-conversation authentication. Exchange the OTP received by email for an APIKEY and SHOPID, and automatically initialize the session so all other tools work immediately. Call auth_request_otp first to receive the OTP by email.

• Edit shop account settings

  Modify the settings of the authenticated shop account. All fields are optional. Covers: basic info (name, address, legal numbers), receipt display options, order requirements, feature flags (stock, barcodes, variations, webshop, coupons...), delivery method toggles, and third-party integrations (PayPal, Prestashop, Yavin, Viva.com).

• Get shop account settings

  Retrieve all current settings of the authenticated shop account as a JSON object. Returns the full shop configuration: name, address, legal numbers, receipt options, order requirements, enabled features, delivery methods, webshop colours, and third-party integration settings. Use this to verify invoice prerequisites before creating orders: shopName, adressline1, and companyRegistrationNum must all be set for legally valid invoices. If any are missing, prompt the user to fill them in via account_

• Logout / clear session

  Clear the current authentication session (APIKEY and SHOPID). After this, all tools requiring authentication will fail until a new login is performed.

• Get a sales report

  Download a synthetic HTML sales report for a given period. Period logic: omit all date fields to get yesterday's report; provide y only for a full-year report; y + m for a full-month report; y + m + d for a specific day. Returns an HTML summary including total revenue, number of orders, breakdown by department, VAT summary, and payment methods.

• Record an order

  Record a new order in the connected shop. Input includes paymentMode, and items[]. Each item can be of type 'catalog' (with productId), 'department' (with price and deptId) or 'free' (with title and price). Check if the client already exists using data_list_clients and if the client exists, only specify idClient. If provided, paymentMode should correspond to a payment ID from data_list_payments_modes tool. Returns a sale confirmation JSON including: a link to the PDF invoice, and a link to a pri

• Edit an order

  Modify an existing order by its ID. Use the payment field to control the order state: -2 = keep as unvalidated quote (not paid); -1 = validate as invoice without payment; a payment method ID (from data_list_payments_modes) = record an actual payment and validate the order. Use paymentAmount to specify a partial payment amount (omit for full payment). Items can only be added or changed on unvalidated orders. Once validated, only payments can be recorded. Returns the orderID, a payment link, and a

• List items

  Retrieve the list of articles (products) configured in the shop. Returns an array of products with fields like id, title, price, and departmentId. Optional parameter 'format' allows output as json, csv, or html.

• List departments

  Get all departments (product categories) defined in the shop, including their names and default tax rates. Supports format=json|csv|html.

• List department groups

  Return the list of department groups, used to organize product categories. Each group may include multiple department IDs.

• List clients

  Get the list of clients registered in the shop, including contact info, loyalty points.

• List item variants

  Retrieve product variations (declinaisons) such as size or color. Returns an array of variant definitions with value and optional price delta.

• List delivery methods

  List all delivery methods available for the shop, such as in-store pickup, home delivery, or courier services.

• tools.data.list.payments.title

  tools.data.list.payments.description

• List cashboxes

  List the registered cashboxes (physical or virtual) linked to the shop, including their current status and identifiers.

• List delivery zones

  Return all configured delivery zones, including area names, postal codes, and applicable delivery fees or restrictions.

• List relay points

  List all relay points where customers can pick up their orders, including address, city, and postal code.

• List discounts

  Return all available discounts or promotions, including their names, types (percentage or fixed), values, and conditions.

• List users

  List all users (cashiers, managers, etc.) associated with the shop, including their roles and identifiers.

• List tables

  Retrieve the list of tables configured in the app, used for restaurant mode or table management.

• List VAT rates

  Retrieve the list of VAT rates configured in the shop, including their title, rate percentage, and optional accounting chapter.

• List pending orders

  Retrieve the list of unvalidated orders (that can still be modified)