API Changes and Improvements (Deployment in October)

We are implementing a set of optimizations to reduce execution time in the most commonly used v3 report endpoints — in some cases, reducing it by half.

📅 Deployment Date:
The release is planned for October 2025.
🔔 The exact date will be communicated closer to the time, but please make sure that by October 1st your integration is ready (changes prepared, but not necessarily deployed).

1. Removed Duplicated Fields in v3 Report Orders + Contents
  • API Product: Revo XEF
  • Description: Redundant fields from the order resource duplicated in the contents resource
  • Review Impact: Mandatory

Technical Details:

To reduce redundancy, the following fields from the order resource will no longer be included in the contents resource when accessing it via /api/external/v3/reports/orders?withContents endpoint, as they are already present in the corresponding order object:

  • "table_id"
  • "table" (name)

These fields will still appear if you query contents directly using /api/external/v3/reports/orderContents.

2. Removed Duplicated Fields in v3 Payments Resource
  • API Product: Revo XEF
  • Description: Redundant fields from the order and invoice resources duplicated in the payments resource
  • Review Impact: Mandatory

Technical Details:

To reduce redundancy, the following fields from the invoice resource will no longer be included in the payments resource when accessing it via the URL/api/external/v3/reports/orders?withInvoices&withPayments and URL/api/external/v3/reports/invoices?withPaymentsendpoints. They are already present in the corresponding invoices object:

  • "order" (order ID)
  • "invoice" (invoice fiscal number)

Also, the following field from the order resource will no longer be included in the payments resource when accessing it via the URL/api/external/v3/reports/orders?withInvoices&withPayments endpoint, as it is already present in the corresponding order object:

  • "table_name" ("table" is available in the order resource)

⚠️ Note: If queried via URL/api/external/v3/reports/invoices?withPayments, "table_name" field will no longer appear (may be considered a minor limitation).

All these 3 fields will still appear if you query contents directly using URL/api/external/v3/reports/payments.

3. "sub_contents" Structure Field Correction
  • API Product: Revo XEF
  • Description: Unnecessary "sub_contents" field in "sub_contents" resource
  • Review Impact: Optional

Technical Details:

The structure sub_contents → sub_contents is not valid, as menu products cannot contain nested menu products.
We will remove any "sub_contents" field found within another "sub_contents".

Correct structure contents → sub_contents.

Affected endpoints:

  • /api/external/v3/reports/orders?withContents&withSubContents
  • /api/external/v3/reports/orderContents?withSubContents
4. Legacy Menus Structure Cleanup
  • API Product: Revo XEF
  • Description: Old menu field "menu_menu_contents" will be removed (prior to APP v.4.0.0)
  • Review Impact: Optional

Technical Details:

This change only affects clients still using the deprecated ?withMenus filter and menu structures from APP versions below 4.0.0 (e.g., v3.X.X).
No current clients are expected to be impacted.

The current menu structure uses the ?withSubContents filter.

5. "gratuity" Field Now Optional
  • API Product: Revo XEF
  • Description: "gratuity" will be optional using ?withGratuity filter
  • Review Impact: Optional

Technical Details:

The "gratuity" field has been removed from the invoices and payments resources, due to performance issues caused by complex calculations.

To include it, use the optional flag "gratuity".

6. Invoice ID Now Always Included
  • API Product: Revo XEF
  • Description: Invoice "id" is now always shown in invoices resource
  • Review Impact: Optional

Technical Details:

The "id" field will now always be present in the "invoices" object, regardless of the entry point.