{ "swagger":"2.0", "info":{ "version":"2026.03.11", "title":"Configuration and Content API Guide", "description":"

The Oracle Simphony Configuration and Content API provides you access to the Simphony Point of Sale configuration. The API uses the REST POST method to quickly read, update, and delete parameters and settings in areas such as menu items, discounts, locations, and service charges.

\n

The API uses the following:

\n\n

Important: See Change History for information on new endpoints and changes to the API.

", "x-summary":"The Oracle Simphony Configuration and Content API provides you access to the Simphony Point of Sale configuration." }, "consumes":[ "application/json", "multipart/form-data" ], "produces":[ "application/json" ], "externalDocs":{ "description":"Learn more about Simphony", "url":"https://docs.oracle.com/en/industries/food-beverage/pos.html" }, "tags":[ { "name":"v1/Devices/Kitchen Display Clients", "description":"

These APIs maintain Kitchen Display Clients

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Devices/Kitchen Display Controllers", "description":"

These APIs maintain Kitchen Display Controllers

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Devices/Order Devices", "description":"

These APIs maintain Order Devices:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.7 Introduced two new kdsOptions - 36 and 37.
\n" }, { "name":"v1/Devices/Print Classes", "description":"

These APIs maintain Print Classes:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Devices/Printers", "description":"

These APIs maintain Printers:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Devices/Workstation Classes", "description":"

These APIs maintain Workstation Classes

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Devices/Workstation Devices", "description":"

These APIs maintain devices configured to work with a workstations such as Barcode Scanners, Payment Devices, Cash Drawers etc.

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Devices/Workstations/SPI Client Certificate", "description":"

These APIs maintain SPI Client Certificate for a workstation of the organization:

\n\n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. \n
\n" }, { "name":"v1/Devices/Workstations/SPI Server Certificate", "description":"

These APIs maintain SPI Server Certificate for a workstation of the organization:

\n\n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. \n
\n" }, { "name":"v1/Devices/Workstations/Workstations", "description":"

These APIs maintain workstations:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details. \n
\n" }, { "name":"v1/Employees/Cashiers", "description":"

These APIs maintain the cashiers:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.3.1This endpoint was added in the API version 23.3.1
\n" }, { "name":"v1/Employees/Employee Class Operators", "description":"

These APIs maintain the revenue center operator options for the employee classes:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.3.1First introduced in this version
\n" }, { "name":"v1/Employees/Employee Classes", "description":"

These APIs maintain Employee Classes:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.\n
\n" }, { "name":"v1/Employees/Employee EMC Visibility", "description":"

These APIs maintain the EMC modules visible to the employee:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Employees/Employee Job Codes", "description":"

These APIs maintain the job codes at the property assigned to the employee:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Employees/Employee Properties", "description":"

These APIs maintain the properties assigned to the employee:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Employees/Employee Property Operators", "description":"

These APIs maintain the operator records for the property assigned to the employee:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Employees/Employee Roles", "description":"

These APIs maintain the roles associated with an employee:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Employees/Employees", "description":"

These APIs maintain Employees:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.5 Reactivate Employees v1 introduced
\n" }, { "name":"v1/Employees/Employees2", "description":"

These APIs maintain the basic employees, excluding the information stored in dependent tables that already have supporting API's - employee visibility, employee roles and employee properties.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.3.1First introduced in this version.
\n" }, { "name":"v1/Employees/Roles", "description":"

These APIs maintain Roles:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Hierarchy/Hierarchy", "description":"

These APIs maintain Hierarchy:

\n\n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Hierarchy/Locations/Location Parameters", "description":"

These APIs maintain Location Parameters:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Hierarchy/Locations/Locations", "description":"

This group of APIs maintains Locations:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.3.1.3 Starting with the API release 23.3.1.3, the Reporting & Analytics (R&A) version supported for this API is 20.1.15.1 and above.
\n" }, { "name":"v1/Hierarchy/Locations/Parent Enterprise Levels", "description":"

This API returns the enterprise levels available in an organization

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.3.1.3 First introduced in this version. The Reporting & Analytics (R&A) version supported for this API is 20.1.15.1 and above.
\n" }, { "name":"v1/Hierarchy/Locations/Reporting Hierarchy Relationships", "description":"

This group of APIs maintains parent enterprise levels assigned to a location within various reporting hierarchies.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.3.1.3 First introduced in this version. The Reporting & Analytics (R&A) version supported for this API is 20.1.15.1 and above.
\n" }, { "name":"v1/Hierarchy/Revenue Centers/Revenue Center Parameters", "description":"

These APIs maintain the parameters associated with a revenue center of a location:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Hierarchy/Revenue Centers/Revenue Centers", "description":"

These APIs maintain the revenue centers of a location for a specified\n organization:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.4 Starting with API release 23.4, a new field rvcMasterObjNum has been introduced which links a Revenue Center to Revenue Center Master.
23.4.1.6 The field rvcMasterObjNum has been removed.
\n" }, { "name":"v1/Hierarchy/Zones", "description":"

These APIs maintain Zones:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Menu Items/Barcodes", "description":"

These APIs maintain Barcodes:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.4Added bulk insert endpoint
\n" }, { "name":"v1/Menu Items/Combo Meals/Combo Meal Side Group Prices", "description":"

These APIs maintain the prices of side groups in combo meals for a specified\n organization:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Menu Items/Combo Meals/Combo Meal Side Groups", "description":"

These APIs maintain Combo Meal Side Groups:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Menu Items/Combo Meals/Combo Meals", "description":"

These APIs maintain Combo Meals:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.4Added bulk insert endpoint
23.7Introduced a new field - pricingAlgorithm
\n" }, { "name":"v1/Menu Items/Combo Side Groups/Combo Side Group Item", "description":"

These APIs maintain Combo Meal Side Groups:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.4Added bulk insert endpoint
\n" }, { "name":"v1/Menu Items/Combo Side Groups/Combo Side Group Item Prices", "description":"

These APIs maintain Combo Side Group Item Prices:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Menu Items/Combo Side Groups/Combo Side Groups", "description":"

These APIs maintain Combo Meal Side Groups:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.4Added bulk insert endpoint
\n" }, { "name":"v1/Menu Items/Condiment Groups", "description":"

These APIs maintain Condiment Groups:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Menu Items/Condiment Sets", "description":"

These APIs maintain Condiment Sets:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Menu Items/Condiment Sets/Condiment Set Items", "description":"

These APIs maintain Condiment Set Items:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Menu Items/Family Group Consumer Facing Content", "description":"

These APIs maintain Family Group Consumer Facing Content:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Menu Items/Family Groups", "description":"

These APIs maintain Family Groups:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.4Starting with the API release 23.4, Insert & Update operations for Family Groups are allowed only at Enterprise.
23.7The consumerDesc field now supports upto 1024 characters.
\n" }, { "name":"v1/Menu Items/Major Groups", "description":"

These APIs maintain Major Groups:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.4 Starting with the API release 23.4, Insert & Update operations for Major Groups are allowed only at Enterprise.
\n" }, { "name":"v1/Menu Items/Menu Item 2", "description":"

These APIs maintain Menu Items:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Menu Items/Menu Item Class", "description":"

These APIs maintain Menu Item Classes:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.5.0.2Starting from API release 23.5.0.2, it is recommended to use Menu Item Classes 2 instead of Menu Item Class.
\n" }, { "name":"v1/Menu Items/Menu Item Definitions/Menu Item Definition Consumer Facing Content", "description":"

These APIs maintain Menu Item Definition Consumer Facing Content:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.7 The params field under url in the GET response, which previously omitted the defSeqNum field in the documentation, now correctly includes it.
\n" }, { "name":"v1/Menu Items/Menu Item Definitions/Menu Item Definition Default Condiments", "description":"

These APIs maintain the default condiments for a given menu item\ndefinition:

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Menu Items/Menu Item Definitions/Menu Item Definitions", "description":"

These APIs maintain Menu Item Definitions:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.4Added bulk insert endpoint
23.7The consumerItemDescription field now supports upto 1024 characters.
\n" }, { "name":"v1/Menu Items/Menu Item Groups/Menu Item Group Details", "description":"

These APIs maintain Menu Item Group Details:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.2.2This endpoint was added in the API version 23.2.2
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.4Added bulk insert endpoint
\n" }, { "name":"v1/Menu Items/Menu Item Groups/Menu Item Groups", "description":"

These APIs maintain Menu Item Groups:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.2This endpoint was added in the API version 23.2
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.4Added bulk insert endpoint
\n" }, { "name":"v1/Menu Items/Menu Item Master", "description":"

These APIs maintain Menu Item Masters:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.4 \n
    \n
  • Starting with the API release 23.4, Insert and Update Menu Item Masters is permitted only for unique object numbers.
    • \n
  • Added bulk insert endpoint
    • \n
\n
23.5 Introduced two new fields for external references. These fields are supported starting from Simphony Version 19.8
\n" }, { "name":"v1/Menu Items/Menu Item Master Effectivity", "description":"

These APIs maintain Menu Item Effectivity Groups:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.3.1First introduced in this version.
\n" }, { "name":"v1/Menu Items/Menu Item Master Groups", "description":"

These APIs maintain Menu Item Master Groups:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.2This endpoint was added in the API version 23.2
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Menu Items/Menu Item Prices", "description":"

These APIs maintain Menu Item Prices:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.4Added bulk insert endpoint
23.5\n Introduced two new fields for external references. These fields are supported starting from Simphony Version 19.8\n
\n" }, { "name":"v1/Menu Items/Menu Items", "description":"

These APIs maintain Menu Items:

\n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.7 The GET response documentation has been updated to include the dataExtensions field, which was previously missing.
\n" }, { "name":"v1/Other/ Get Available Object Numbers", "description":"

This API returns available object numbers:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.3.1 First introduced in this version.
\n" }, { "name":"v1/Other/Bulk Request Status", "description":"

Use this API to obtain bulk processing request status updates.

\n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.4First introduced in this version
\n" }, { "name":"v1/Other/Clone Configuration", "description":"

These APIs clone configuration data from one organization to another.

\n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.7 The GET response documentation has been updated to include the fields currDateTimeUTC and requestedDateTimeUTC, which were previously missing.
\n" }, { "name":"v1/Other/Release Versions", "description":"

This API returns Version Information:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.2 First introduced in this version.
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Sales/Discount Itemizers", "description":"

These APIs maintain Discount Itemizers:

\n\n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
\n" }, { "name":"v1/Sales/Discounts/Discount", "description":"

These APIs maintain Discounts:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ReleaseDescription
23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
23.4 \n
  • Starting with the API release 23.4\n
      \n
    • Two new fields have been introduced to support Discounts by Order Type and Order Channel:\n
        \n
      • orderTypeRestrictions
        • \n
      • orderChannelRestrictions
        • \n
      \n These fields are only supported in Simphony 19.7 and above.
      • \n
    • Introduced a new field \"constraintType\" within \"autoRule\".\n
      • \n
    \n
    • \n
    23.5 Introduced two new fields for external references. These fields are supported starting from Simphony Version 19.8
    \n" }, { "name":"v1/Sales/Discounts/Discount Award Groups", "description":"

    These APIs maintain Discount Award Groups:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    23.7 The awardCount field, previously missing from the Get response and the Insert and Update request bodies, has now been added to the documentation.
    \n" }, { "name":"v1/Sales/Discounts/Discount Trigger Groups", "description":"

    These APIs maintain Discount Trigger Groups:

    \n\n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Sales/Service Charge Groups/Service Charge Group Details", "description":"

    These APIs maintain details of Service Charge Groups:

    \n\n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Sales/Service Charge Groups/Service Charge Groups", "description":"

    These APIs maintain Service Charge Groups:

    \n\n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Sales/Service Charge Itemizers", "description":"

    These APIs maintain Service Charge Itemizers:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Sales/Service Charges", "description":"

    These APIs maintain Service Charges:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    23.5 Introduced two new fields for external references. These fields are supported starting from Simphony Version 19.8
    \n" }, { "name":"v1/Sales/Tax Classes", "description":"

    These APIs maintain Tax Classes:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Sales/Tax Parameters", "description":"

    These APIs maintain Tax Parameters:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    23.5 Added 2 new option bits - 19 & 20, under internationalOptions
    23.7 Added a new option bit - 21, under internationalOptions
    \n" }, { "name":"v1/Sales/Taxes/Tax Breakpoints", "description":"

    These APIs maintain breakpoints for a Tax Rate:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Sales/Taxes/Tax Rates", "description":"

    These APIs maintain Tax Rates:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    23.7 The effGrpObjNum field, which was previously missing from the Delete request body in the documentation, has now been added.
    \n" }, { "name":"v1/Sales/Tender Media", "description":"

    These APIs maintain Tender Media:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    23.5 Introduced two new fields for external references. These fields are supported starting from Simphony Version 19.8
    23.7 The GET response documentation has been updated to include the fields transDefaultMainLevel, transDefaultSubLevel, mainLevelPopup, and subLevelPopup, which were previously missing.
    \n" }, { "name":"v1/Setup/Auto Menu Levels", "description":"\n

    These APIs maintain Auto Menu Levels:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/CAL/CAL Deployment Schedules", "description":"\n

    These APIs maintain CAL Deployment Schedules:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/CAL/CAL Packages", "description":"

    These APIs maintain CAL Packages:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Cash Management Receptacle Templates", "description":"\n

    These APIs maintain Cash Management Receptacle Templates:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 First introduced in this version.
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Currencies", "description":"\n

    These APIs maintain Currencies:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Currency Availability", "description":"\n

    These APIs maintain Currency Availability:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 First introduced in this version.
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Currency Conversions", "description":"\n

    These APIs maintain Currency Conversions:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 First introduced in this version.
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Currency Parameters", "description":"\n

    These APIs maintain Currency Parameters:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    23.6 The fields altCurrObjNum and altCurrObjName have been removed.
    \n" }, { "name":"v1/Setup/Custom Content", "description":"\n

    These APIs maintain Custom Content:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    23.7 The params field under url in the GET response, which previously contained incorrect fields in the documentation, now correctly includes id as the only field for customContentParameters.
    \n" }, { "name":"v1/Setup/Data Extensions", "description":"

    These APIs maintain Data Extensions:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.2 First introduced in this version.
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    23.7 The GET response documentation has been updated to include the valueLimits field, which was previously missing.
    \n" }, { "name":"v1/Setup/Effectivity Groups/Effectivity Groups", "description":"

    These APIs maintain Effectivity Groups:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Effectivity Groups/Enable Effectivity Groups", "description":"\n

    These APIs can be used to enable or disable inherited effectivity groups at each location.

    \n\n

    The User will require access to the 'Effectivity Groups' module to be able to access this API

    \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    23.3.1 First introduced in this version.
    \n" }, { "name":"v1/Setup/Headers Trailers", "description":"

    These APIs maintain Headers and Trailers:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 First introduced in this version.
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Languages", "description":"

    These APIs maintain Languages:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Locale", "description":"

    These APIs maintain Locales:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.2 First introduced in this version.
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Menu Levels/Menu Level Entries", "description":"\n

    These APIs maintain Menu Level Entries for a Menu Level Set:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Menu Levels/Menu Levels", "description":"

    These APIs maintain Menu Levels

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Order Channels/Order Channel Parameters", "description":"

    These APIs maintain Order Channel parameters.

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    23.3.1 First introduced in this version.
    \n" }, { "name":"v1/Setup/Order Channels/Order Channels", "description":"

    These APIs maintain Order Channels.

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    23.3.1 First introduced in this version.
    \n" }, { "name":"v1/Setup/Order Types/Order Type Names", "description":"

    These APIs maintain Order Types:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    23.5\n Starting from Simphony version 19.8, Add Order Types API will no longer be available and Update Order Types API will no longer add records.\n
    \n" }, { "name":"v1/Setup/Order Types/Order Type Parameters", "description":"

    These APIs maintain Order Type Parameters:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    23.7 Added a new option bit - 17, under options. The options string length has been updated to 24 starting from Simphony version 19.9.
    \n" }, { "name":"v1/Setup/Payment Drivers/Payment Driver Configurations", "description":"\n

    These APIs maintain Payment Driver Configurations:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    23.7 The GET response documentation has been updated to include the displayName field, which was previously missing.
    \n" }, { "name":"v1/Setup/Payment Drivers/Payment Drivers", "description":"\n

    These APIs maintain Payment Drivers:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Print Logos", "description":"

    These APIs maintain Print Logos:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Report Groups", "description":"\n

    These APIs maintain Report Groups:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Sales Itemizers", "description":"\n

    These APIs maintain Sales Itemizers:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.2 First introduced in this version.
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Screen Look Ups/Screen Look Up Consumer Facing Content", "description":"\n

    These APIs maintain SLU Consumer Facing Content:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Screen Look Ups/Screen Look Ups", "description":"\n

    These APIs maintain Screen Look Ups:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Tag Groups", "description":"\n

    These APIs maintain Tag Groups:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.2 First introduced in this version.
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    \n" }, { "name":"v1/Setup/Tags and Dietary Labels", "description":"\n

    These APIs maintain Tags and Dietary Labels

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.2 First introduced in this version.
    23.3 The Simphony-OrgShortName parameter is deprecated. The authentication token contains the organization access details.
    23.7The Tags API has been expanded to support Dietary Labels through the introduction of a new field, dietaryLabel.
    \n" }, { "name":"v2/Devices/Device Status/Details", "description":"

    This API return detailed information of Device Status

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5First release
    \n" }, { "name":"v2/Devices/Device Status/Device Status", "description":"

    This API return Device Status information

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5First release
    \n" }, { "name":"v2/Devices/Kitchen Display Clients", "description":"

    These APIs maintain Kitchen Display Clients

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Kitchen Display Clients v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Devices/Kitchen Display Controllers", "description":"

    These APIs maintain Kitchen Display Controllers

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Kitchen Display Controllers v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Devices/Order Devices", "description":"

    These APIs maintain Order Devices:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Order Devices v2 introduced.
    23.7 Introduced two new kdsOptions - 36 and 37.
    \n" }, { "name":"v2/Devices/Print Classes", "description":"

    These APIs maintain Print Classes:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Print Classes v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Devices/Printers", "description":"

    These APIs maintain Printers:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Printers v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Devices/Workstation Classes", "description":"

    These APIs maintain Workstation Classes

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Workstation Classes v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Devices/Workstation Devices", "description":"

    These APIs maintain devices configured to work with a workstations such as Barcode Scanners, Payment Devices, Cash Drawers etc.

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Workstation Devices v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Devices/Workstations/SPI Client Certificate", "description":"

    These APIs maintain SPI Client Certificate for a workstation of the organization:

    \n\n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5Add, Update and Delete SPI Client Certificate v2 introduced.
    \n" }, { "name":"v2/Devices/Workstations/SPI Server Certificate", "description":"

    These APIs maintain SPI Server Certificate for a workstation of the organization:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5Add, Update and Delete SPI Server Certificate v2 introduced.
    \n" }, { "name":"v2/Devices/Workstations/Workstations", "description":"

    These APIs maintain workstations:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5Workstations v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    23.7 Added support for workstation type 7: Castle Devices
    \n" }, { "name":"v2/Employees/Cashiers", "description":"

    These APIs maintain the cashiers:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Cashiers v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Employees/Employee", "description":"

    These APIs maintain Employee:

    \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.7First introduced in this version.
    \n" }, { "name":"v2/Employees/Employee Class Operators", "description":"

    These APIs maintain the revenue center operator options for the employee classes:

    \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Employee Class Operators v2 introduced.
    \n" }, { "name":"v2/Employees/Employee Classes", "description":"

    These APIs maintain Employee Classes:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Employee Classes v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Employees/Employee EMC Visibility", "description":"

    These APIs maintain the EMC modules visible to the employee:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Employee EMC Visibility v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Employees/Employee Job Codes", "description":"

    These APIs maintain the job codes at the property assigned to the employee:

    \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Get Employee Job Codes v2 introduced.
    \n" }, { "name":"v2/Employees/Employee Properties", "description":"

    These APIs maintain the properties assigned to the employee:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Employee Properties v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Employees/Employee Property Operators", "description":"

    These APIs maintain the operator records for the property assigned to the employee:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Employee Property Operators v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Employees/Employee Roles", "description":"

    These APIs maintain the roles associated with an employee:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Employee Roles v2 introduced
    23.6 Support for system employee roles introduced
    \n" }, { "name":"v2/Employees/Employees", "description":"

    These APIs maintain Employees:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Employees v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Employees/Employees2", "description":"

    These APIs maintain the basic employees, excluding the information stored in dependent tables that already have supporting API's - employee visibility, employee roles and employee properties.

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Basic employees v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Employees/Roles", "description":"

    These APIs maintain Roles:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Roles v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Employees/System Employee Properties", "description":"

    These APIs maintain system employee properties only when Labor Management is enabled and are not supported for a Simphony Essentials Edition:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.6First introduced in this version.
    \n" }, { "name":"v2/Employees/System Employee Property Operators", "description":"

    These APIs maintain system employee property operators only when Labor Management is enabled and are not supported for a Simphony Essentials Edition:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.6First introduced in this version.
    \n" }, { "name":"v2/Employees/System Employees", "description":"

    These APIs maintain system employees only when Labor Management is enabled and are not supported for a Simphony Essentials Edition:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.6First introduced in this version.
    \n" }, { "name":"v2/Hierarchy/Hierarchy", "description":"

    These APIs maintain Hierarchy:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5Get Hierarchy v2 introduced
    23.6Get Hierarchy Nodes introduced
    \n" }, { "name":"v2/Hierarchy/Locations/Location Parameters", "description":"

    These APIs maintain Location Parameters:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Get and Update Location Parameters v2 introduced.
    23.6 \n
      \n
    • Update endpoint will only update an existing record and will not insert a new record.
      • \n
    • Replaced languageName with langId under languages
      • \n
    \n" }, { "name":"v2/Hierarchy/Locations/Locations", "description":"

    This group of APIs maintains Locations:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Locations v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Hierarchy/Locations/Parent Enterprise Levels", "description":"

    This API returns the enterprise levels available in an organization

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Get Enterprise Levels v2 introduced.
    \n" }, { "name":"v2/Hierarchy/Locations/Reporting Hierarchy Relationships", "description":"

    This group of APIs maintains parent enterprise levels assigned to a location within various reporting hierarchies.

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Get Reporting Hierarchy Levels and Get, Update and Delete Reporting Hierarchy Relationships v2 introduced.
    \n" }, { "name":"v2/Hierarchy/Revenue Centers/Revenue Center Parameters", "description":"

    These APIs maintain the parameters associated with a revenue center of a location:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Get and Update Revenue Center Parameters v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Hierarchy/Revenue Centers/Revenue Centers", "description":"

    These APIs maintain the revenue centers of a location for a specified\n organization:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Revenue Centers v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Hierarchy/Zones/EMC Modules", "description":"

    These APIs maintain EMC Modules for a hierarchy node:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.6First introduced in this version.
    23.7\n
      \n
    • Introduced bulk enable and disable endpoints. These endpoints are available from Simphony 19.9 and above.
      • \n
    • Updated list of valid EMC Modules
      • \n
    \n
    \n" }, { "name":"v2/Hierarchy/Zones/Nodes", "description":"

    These APIs maintain hierarchy nodes of hierType 'Zone':

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.6First introduced in this version.
    23.7Introduced bulk insert and update endpoints. These endpoints are available from Simphony 19.9 and above.
    \n" }, { "name":"v2/Hierarchy/Zones/Zones", "description":"

    These APIs maintain Zones:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5Get Zones v2 introduced
    23.7\n
      \n
    • Introduced bulk delete and predelete endpoints. These endpoints are available from Simphony 19.9 and above.
      • \n
    • Updated list of EMC Module options
      • \n
    \n
    \n" }, { "name":"v2/Hierarchy/Zones/Zones2", "description":"

    These APIs maintain Zones2:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.6Get Zones2 introduced
    23.7Updated list of EMC Modules
    \n" }, { "name":"v2/Menu Items/Allergen Classes", "description":"

    These APIs maintain Allergen Classes:

    \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.7First introduced in this version.
    \n" }, { "name":"v2/Menu Items/Allergen Names", "description":"

    These APIs maintain Allergen Names:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.7First introduced in this version.
    \n" }, { "name":"v2/Menu Items/Barcodes", "description":"

    These APIs maintain Barcodes:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5\n
      \n
    • Barcodes v2 introduced
      • \n
    • Added Bulk Update endpoint
      • \n
    \n
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Menu Items/Combo Meals/Combo Meal Side Group Prices", "description":"

    These APIs maintain the prices of side groups in combo meals for a specified\n organization:

    \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Combo Meal Side Group Prices v2 introduced.
    \n" }, { "name":"v2/Menu Items/Combo Meals/Combo Meal Side Groups", "description":"

    These APIs maintain Combo Meal Side Groups:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Combo Meal Side Groups v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Menu Items/Combo Meals/Combo Meals", "description":"

    These APIs maintain Combo Meals:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5\n
      \n
    • Combo Meals v2 introduced
      • \n
    • Added bulk update endpoint. This endpoint is supported starting from Simphony Version 19.8
      • \n
    \n
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    23.7Introduced a new field - pricingAlgorithm
    \n" }, { "name":"v2/Menu Items/Combo Meals/Combo Meals Lite", "description":"

    These APIs maintain Combo Meals:

    \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.7First introduced in this version.
    \n" }, { "name":"v2/Menu Items/Combo Side Groups/Combo Side Group Item", "description":"

    These APIs maintain Combo Meal Side Groups:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5\n
      \n
    • Combo Side Group Items v2 introduced
      • \n
    • Added bulk update endpoint
      • \n
    \n
    23.6 \n
      \n
    • Update endpoint will only update an existing record and will not insert a new record.
      • \n
    • comboMealGroupObjNum has been replaced by comboMealGroupId
      • \n
    • Introduced hierUnitId property under the prices array, representing the hierarchy unit where the price is located.
      • \n
    • Bulk API operations for this object are supported starting from Simphony version 19.8.2.
      • \n
    \n" }, { "name":"v2/Menu Items/Combo Side Groups/Combo Side Group Item Prices", "description":"

    These APIs maintain Combo Side Group Item Prices:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 \n
      \n
    • Combo Side Group Items v2 introduced
      • \n
    • Added bulk insert and update endpoints
      • \n
    \n
    23.6 \n
      \n
    • Update endpoint will only update an existing record and will not insert a new record.
      • \n
    • comboMealGroupObjNum has been replaced by comboMealGroupId
      • \n
    • The hierUnitId field now represents the hierarchy unit where the price is located.
      • \n
    • Bulk API operations for this object are supported starting from Simphony version 19.8.2.
      • \n
    \n" }, { "name":"v2/Menu Items/Combo Side Groups/Combo Side Group Items Lite", "description":"

    These APIs maintain Combo Side Group Items:

    \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.7First introduced in this version.
    \n" }, { "name":"v2/Menu Items/Combo Side Groups/Combo Side Groups", "description":"

    These APIs maintain Combo Meal Side Groups:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5\n
      \n
    • Combo Side Groups v2 introduced
      • \n
    • Added bulk update endpoint. This endpoint is supported starting from Simphony Version 19.8
      • \n
    \n
    23.6 \n
      \n
    • Update endpoint will only update an existing record and will not insert a new record.
      • \n
    • comboMealGroupObjNum has been replaced by comboMealGroupId
      • \n
    • Introduced hierUnitId property under the prices array, representing the hierarchy unit where the price is located
      • \n
    • Bulk API operations for this object are supported starting from Simphony version 19.8.2.
      • \n
    \n" }, { "name":"v2/Menu Items/Combo Side Groups/Combo Side Groups Lite", "description":"

    These APIs maintain Combo Side Groups:

    \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.7First introduced in this version.
    \n" }, { "name":"v2/Menu Items/Condiment Groups", "description":"

    These APIs maintain Condiment Groups:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Condiment Groups v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Menu Items/Condiment Sets", "description":"

    These APIs maintain Condiment Sets:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Condiment Sets v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Menu Items/Condiment Sets/Condiment Set Items", "description":"

    These APIs maintain Condiment Set Items:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Condiment Set Items v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Menu Items/Family Group Consumer Facing Content", "description":"

    These APIs maintain Family Group Consumer Facing Content:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Family Group Consumer Facing Content v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Menu Items/Family Groups", "description":"

    These APIs maintain Family Groups:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Family Groups v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    23.7The consumerDesc field now supports upto 1024 characters.
    \n" }, { "name":"v2/Menu Items/Major Groups", "description":"

    These APIs maintain Major Groups:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Major Groups v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Menu Items/Menu Item 2", "description":"

    These APIs maintain Menu Items:

    \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5Get Menu Items 2 v2 introduced
    \n" }, { "name":"v2/Menu Items/Menu Item Class", "description":"

    These APIs maintain Menu Item Classes:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Menu Item Classes v2 introduced
    23.5.0.2Starting from API release 23.5.0.2, it is recommended to use Menu Item Classes 2 instead of Menu Item Class.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Menu Items/Menu Item Class 2", "description":"

    These APIs maintain Menu Item Classes 2:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5.0.2First introduced in this version
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Menu Items/Menu Item Definitions/Menu Item Definition Consumer Facing Content", "description":"

    These APIs maintain Menu Item Definition Consumer Facing Content:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Menu Item Defintion Consumer Facing Content v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    23.7 The params field under url in the GET response, which previously omitted the defSeqNum field in the documentation, now correctly includes it.
    \n" }, { "name":"v2/Menu Items/Menu Item Definitions/Menu Item Definition Default Condiments", "description":"

    These APIs maintain the default condiments for a given menu item\ndefinition:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Menu Item Definition Default Condiments v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Menu Items/Menu Item Definitions/Menu Item Definitions", "description":"

    These APIs maintain Menu Item Definitions:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5\n
      \n
    • Menu Item Definitions v2 introduced
      • \n
    • Added bulk update endpoint
      • \n
    \n
    23.7The consumerItemDescription field now supports upto 1024 characters.
    \n" }, { "name":"v2/Menu Items/Menu Item Groups/Menu Item Group Details", "description":"

    These APIs maintain Menu Item Group Details:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5\n
      \n
    • Menu Item Group Details v2 introduced
      • \n
    • Added bulk update endpoint
      • \n
    \n
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Menu Items/Menu Item Groups/Menu Item Groups", "description":"

    These APIs maintain Menu Item Groups:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5\n
      \n
    • Menu Item Groups v2 introduced
      • \n
    • Added bulk update endpoint
      • \n
    \n
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Menu Items/Menu Item Groups/Menu Item Groups Lite", "description":"

    These APIs maintain Menu Item Groups:

    \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.7First introduced in this version.
    \n" }, { "name":"v2/Menu Items/Menu Item Master", "description":"

    These APIs maintain Menu Item Masters:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 \n
      \n
    • Menu Item Masters v2 introduced
      • \n
    • Introduced two new fields for external references. These fields are supported starting from Simphony Version 19.8
      • \n
    • Added bulk update endpoint. This endpoint is supported starting from Simphony Version 19.8
      • \n
    \n
    23.6 \n
      \n
    • Update endpoint will only update an existing record and will not insert a new record.
      • \n
    • Introduced new field - name2
      • \n
    \n
    \n" }, { "name":"v2/Menu Items/Menu Item Master Effectivity", "description":"

    These APIs maintain Menu Item Effectivity Groups:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Menu Item Master Effectivity Groups v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Menu Items/Menu Item Master Groups", "description":"

    These APIs maintain Menu Item Master Groups:

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Menu Item Master Groups v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Menu Items/Menu Item Prices", "description":"

    These APIs maintain Menu Item Prices:

    \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 \n
      \n
    • Menu Item Prices v2 introduced
      • \n
    • Introduced two new fields for external references. These fields are supported starting from Simphony Version 19.8
      • \n
    • Added bulk update endpoint
      • \n
    \n
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Menu Items/Nutrient Sets/Nutrient Sets", "description":"

    These APIs maintain Nutrient Sets.

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.7First introduced in this version.
    \n" }, { "name":"v2/Menu Items/Nutrient Sets/Nutrients", "description":"

    These APIs maintain Nutrients for a Nutrient Set.

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.7First introduced in this version.
    \n" }, { "name":"v2/Menu Items/Nutrition Names", "description":"

    These APIs maintain Nutrition Names:

    \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.7First introduced in this version.
    \n" }, { "name":"v2/Other/ Get Available Object Numbers", "description":"

    This API returns available object numbers:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5Get Available Object Numbers v2 introduced.
    \n" }, { "name":"v2/Other/Audit Trail", "description":"

    This API returns audit trail information

    \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.7First introduced in this version.
    \n" }, { "name":"v2/Other/Bulk Request Status", "description":"

    Use this API to obtain bulk processing request status updates.

    \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5Bulk Status Request v2 introduced.
    \n" }, { "name":"v2/Other/Release Versions", "description":"

    This API returns Version Information:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5Release Versions v2 introduced.
    \n" }, { "name":"v2/Sales/Discount Itemizers", "description":"

    These APIs maintain Discount Itemizers:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Discount Itemizers v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Sales/Discounts/Discount", "description":"

    These APIs maintain Discounts:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 \n
      \n
    • Discounts v2 introduced
      • \n
    • Introduced two new fields for external references. These fields are supported starting from Simphony Version 19.8
      • \n
    \n
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Sales/Discounts/Discount Award Groups", "description":"

    These APIs maintain Discount Award Groups:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Discount Award Groups v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    23.7 The awardCount field, previously missing from the Get response and the Insert and Update request bodies, has now been added to the documentation.
    \n" }, { "name":"v2/Sales/Discounts/Discount Trigger Groups", "description":"

    These APIs maintain Discount Trigger Groups:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Discount Trigger Groups v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Sales/Service Charge Groups/Service Charge Group Details", "description":"

    These APIs maintain details of Service Charge Groups:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Service Charge Group Details v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Sales/Service Charge Groups/Service Charge Groups", "description":"

    These APIs maintain Service Charge Groups:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Service Charge Groups v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Sales/Service Charge Itemizers", "description":"

    These APIs maintain Service Charge Itemizers:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Service Charge Itemizers v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Sales/Service Charges", "description":"

    These APIs maintain Service Charges:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 \n
      \n
    • Service Charges v2 introduced.
      • \n
    • Introduced two new fields for external references. These fields are supported starting from Simphony Version 19.8
      • \n
    \n
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Sales/Tax Classes", "description":"

    These APIs maintain Tax Classes:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Tax Classes v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Sales/Tax Parameters", "description":"

    These APIs maintain Tax Parameters:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Tax Parameters v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    23.7 Added a new option bit - 21, under internationalOptions
    \n" }, { "name":"v2/Sales/Taxes/Tax Breakpoints", "description":"

    These APIs maintain breakpoints for a Tax Rate:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Tax Breakpoints v2 introduced.
    \n" }, { "name":"v2/Sales/Taxes/Tax Rates", "description":"

    These APIs maintain Tax Rates:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Get, Add, Update and Delete Tax Rates v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    23.7 The effGrpObjNum field, which was previously missing from the Delete request body in the documentation, has now been added.
    \n" }, { "name":"v2/Sales/Tender Media", "description":"

    These APIs maintain Tender Media:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 \n
      \n
    • Tender Media v2 introduced.
      • \n
    • Introduced two new fields for external references. These fields are supported starting from Simphony Version 19.8
      • \n
    \n
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    23.7 The GET response documentation has been updated to include the fields transDefaultMainLevel, transDefaultSubLevel, mainLevelPopup, and subLevelPopup, which were previously missing.
    \n" }, { "name":"v2/Setup/Auto Menu Levels", "description":"\n

    These APIs maintain Auto Menu Levels:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Auto Menu Levels v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/CAL/CAL Deployment Schedules", "description":"\n

    These APIs maintain CAL Deployment Schedules:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 CAL Deployment Schedules v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/CAL/CAL Packages", "description":"

    These APIs maintain CAL Packages:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Get CAL Packages v2 introduced.
    \n" }, { "name":"v2/Setup/CAL/CAL Packages Install Status", "description":"

    This API returns CAL Packages Installation Status

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5First release
    \n" }, { "name":"v2/Setup/Cash Management Receptacle Templates", "description":"\n

    These APIs maintain Cash Management Receptacle Templates:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Cash Management Receptacle Templates v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Currencies", "description":"\n

    These APIs maintain Currencies:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Currencies v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Currency Availability", "description":"\n

    These APIs maintain Currency Availability:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Currency Availability v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Currency Conversions", "description":"\n

    These APIs maintain Currency Conversions:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Currency Conversions v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Currency Parameters", "description":"\n

    These APIs maintain Currency Parameters:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Currency Parameters v2 introduced.
    23.6 \n
      \n
    • Update endpoint will only update an existing record and will not insert a new record.
      • \n
    • The field altCurrObjNum has been removed.
      • \n
    \n
    \n" }, { "name":"v2/Setup/Custom Content", "description":"\n

    These APIs maintain Custom Content:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Custom Content v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    23.7 The params field under url in the GET response, which previously contained incorrect fields in the documentation, now correctly includes id as the only field for customContentParameters.
    \n" }, { "name":"v2/Setup/Data Extensions", "description":"

    These APIs maintain Data Extensions:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Data Extensions v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    23.7 The GET response documentation has been updated to include the valueLimits field, which was previously missing.
    \n" }, { "name":"v2/Setup/Dining Tables", "description":"

    These APIs maintain Dining Tables:

    \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.6First introduced in this version.
    \n" }, { "name":"v2/Setup/Effectivity Groups/Effectivity Groups", "description":"

    These APIs maintain Effectivity Groups:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Effectivity Groups v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    23.7 Introduced bulk insert and bulk update endpoints. These endpoints are available from Simphony 19.9 and above.
    \n" }, { "name":"v2/Setup/Effectivity Groups/Enable Effectivity Groups", "description":"\n

    These APIs can be used to enable or disable inherited effectivity groups at each location.

    \n\n

    The User will require access to the 'Effectivity Groups' module to be able to access this API

    \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Enable Effectivity Groups v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Headers Trailers", "description":"

    These APIs maintain Headers and Trailers:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Headers/Trailers v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Headers Trailers By Channel Type", "description":"

    These APIs maintain headers trailers by channel type:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.6First introduced in this version. These endpoints are available from Simphony 19.8 and above.
    \n" }, { "name":"v2/Setup/Languages/Languages", "description":"

    These APIs maintain Languages:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Languages v2 introduced
    23.6 \n
      \n
    • Update endpoint will only update an existing record and will not insert a new record.
      • \n
    • Introduced langId field in the insert and update response.
      • \n
    \n
    \n" }, { "name":"v2/Setup/Languages/Text File Configurations", "description":"

    These APIs maintain Text File Configurations

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.6 \n First introduced in this version.\n
    \n" }, { "name":"v2/Setup/Locale", "description":"

    These APIs maintain Locales:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Locales v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Menu Levels/Menu Level Entries", "description":"\n

    These APIs maintain Menu Level Entries for a Menu Level Set:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Menu Level Entries v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Menu Levels/Menu Levels", "description":"

    These APIs maintain Menu Levels

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Menu Levels v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Order Channels/Order Channel Parameters", "description":"

    These APIs maintain Order Channel parameters.

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Order Channel Parameters v2 introduced.
    23.6\n
      \n
    • Update endpoint will only update an existing record and will not insert a new record.
      • \n
    • Introduced 4 new fields - guestCheckHeaderObjNum, guestCheckTrailerObjNum, receiptHeaderObjNum, slaTime
      • \n
    \n
    \n" }, { "name":"v2/Setup/Order Channels/Order Channels", "description":"

    These APIs maintain Order Channels.

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Order Channels v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Order Types/Order Type Names", "description":"

    These APIs maintain Order Types:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5\n
      \n
    • Order Types v2 introduced\n
    • Starting from Simphony version 19.8, Add Order Types API will no longer be available and Update Order Types API will no longer add records.\n
    \n
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Order Types/Order Type Parameters", "description":"

    These APIs maintain Order Type Parameters:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Order Types Parameters v2 introduced.
    23.6\n
      \n
    • Update endpoint will only update an existing record and will not insert a new record.
      • \n
    • Introduced 4 new fields - guestCheckHeaderObjNum, guestCheckTrailerObjNum, receiptHeaderObjNum, defaultOrderChannelObjNum
      • \n
    \n
    23.7 Added a new option bit - 17, under options. The options string length has been updated to 24 starting from Simphony version 19.9.
    \n" }, { "name":"v2/Setup/Payment Drivers/Payment Driver Configurations", "description":"\n

    These APIs maintain Payment Driver Configurations:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Payment Driver Configuration v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    23.7 The GET response documentation has been updated to include the displayName field, which was previously missing.
    \n" }, { "name":"v2/Setup/Payment Drivers/Payment Drivers", "description":"\n

    These APIs maintain Payment Drivers:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Payment Drivers v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Print Logos", "description":"

    These APIs maintain Print Logos:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Print Logos v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Reason Codes", "description":"

    These APIs maintain Reason Codes:

    \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.6First introduced in this version.
    \n" }, { "name":"v2/Setup/Report Groups", "description":"\n

    These APIs maintain Report Groups:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Report Groups v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Sales Itemizers", "description":"\n

    These APIs maintain Sales Itemizers:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Sales Itemizers v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Screen Look Ups/Screen Look Up Consumer Facing Content", "description":"\n

    These APIs maintain SLU Consumer Facing Content:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 SLU Consumer Facing Content v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Screen Look Ups/Screen Look Ups", "description":"\n

    These APIs maintain Screen Look Ups:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Screen Look Ups v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Serving Periods", "description":"

    These APIs maintain serving periods:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.6First introduced in this version.
    \n" }, { "name":"v2/Setup/Tag Groups", "description":"\n

    These APIs maintain Tag Groups:

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Tag Groups v2 introduced.
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    \n" }, { "name":"v2/Setup/Tags and Dietary Labels", "description":"\n

    These APIs maintain Tags and Dietary Labels

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5 Tags v2 introduced
    23.6 Update endpoint will only update an existing record and will not insert a new record.
    23.7The Tags API has been expanded to support Dietary Labels through the introduction of a new field, dietaryLabel.
    \n" } ], "schemes":[ "https" ], "paths":{ "/config/sim/v1/setup/getorderchannels":{ "post":{ "tags":[ "v1/Setup/Order Channels/Order Channels" ], "summary":"Get Order Channels", "description":"Gets all the Order Channels", "operationId":"getOrderChannels", "parameters":[ { "$ref":"#/parameters/body.OrderChannelGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Order Channel objects.", "schema":{ "$ref":"#/definitions/OrderChannelGetResponse" } } }, "x-internal-id":"config-sim-v1-setup-getorderchannels-post", "x-filename-id":"config-sim-v1-setup-getorderchannels-post" } }, "/config/sim/v2/setup/getOrderChannels":{ "post":{ "tags":[ "v2/Setup/Order Channels/Order Channels" ], "summary":"Get Order Channels", "description":"Gets all the Order Channels", "operationId":"getOrderChannelsv2", "parameters":[ { "$ref":"#/parameters/body.OrderChannelGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Order Channel objects.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Order Channel objects of the organization.", "items":{ "$ref":"#/definitions/OrderChannelv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getOrderChannels-post", "x-filename-id":"config-sim-v2-setup-getorderchannels-post" } }, "/config/sim/v1/setup/orderchannels":{ "post":{ "tags":[ "v1/Setup/Order Channels/Order Channels" ], "summary":"Add Order Channels", "description":"Add the Order Channel object to a specified hierarchy unit .", "operationId":"createOrderChannels", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderChannelCURequestBody" } ], "responses":{ "200":{ "description":"Order Channel Added.", "schema":{ "$ref":"#/definitions/OrderChannelResponse" } } }, "x-internal-id":"config-sim-v1-setup-orderchannels-post", "x-filename-id":"config-sim-v1-setup-orderchannels-post" } }, "/config/sim/v2/setup/orderChannels":{ "post":{ "tags":[ "v2/Setup/Order Channels/Order Channels" ], "summary":"Add Order Channels", "description":"Add the Order Channel object to a specified hierarchy unit .", "operationId":"createOrderChannelsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderChannelCURequestBodyv2" } ], "responses":{ "200":{ "description":"Order Channel Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Order Channel" } } } } }, "x-internal-id":"config-sim-v2-setup-orderChannels-post", "x-filename-id":"config-sim-v2-setup-orderchannels-post" } }, "/config/sim/v1/setup/updateorderchannels":{ "post":{ "tags":[ "v1/Setup/Order Channels/Order Channels" ], "summary":"Update Order Channels", "description":"Updates the Order Channels. If Order Channel is not found, it creates a new Order Channel.", "operationId":"updateOrderChannels", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderChannelCURequestBody" } ], "responses":{ "200":{ "description":"Order Channel Updated or Added.", "schema":{ "$ref":"#/definitions/OrderChannelResponse" } } }, "x-internal-id":"config-sim-v1-setup-updateorderchannels-post", "x-filename-id":"config-sim-v1-setup-updateorderchannels-post" } }, "/config/sim/v2/setup/updateOrderChannels":{ "post":{ "tags":[ "v2/Setup/Order Channels/Order Channels" ], "summary":"Update Order Channels", "description":"Updates the Order Channels.", "operationId":"updateOrderChannelsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderChannelCURequestBodyv2" } ], "responses":{ "200":{ "description":"Order Channel Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Order Channel" } } } } }, "x-internal-id":"config-sim-v2-setup-updateOrderChannels-post", "x-filename-id":"config-sim-v2-setup-updateorderchannels-post" } }, "/config/sim/v1/menuItems/getMenuItemMasterEffectivity":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Master Effectivity" ], "summary":"Get Menu Item Master Effectivity Groups", "description":"Gets all the Menu Item Master Effectivity Groups configured.", "operationId":"getMenuItemMasterEffectivity", "parameters":[ { "$ref":"#/parameters/body.MenuItemMasterEffectivityGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of menuItem Master Effectivity Groups.", "schema":{ "$ref":"#/definitions/menuItemMasterEffectivityGetResponsev1" } } }, "x-internal-id":"config-sim-v1-menuItems-getMenuItemMasterEffectivity-post", "x-filename-id":"config-sim-v1-menuitems-getmenuitemmastereffectivity-post" } }, "/config/sim/v2/menuItems/getMenuItemMasterEffectivity":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Master Effectivity" ], "summary":"Get Menu Item Master Effectivity Groups", "description":"Gets all the Menu Item Master Effectivity Groups configured.", "operationId":"getMenuItemMasterEffectivityv2", "parameters":[ { "$ref":"#/parameters/body.MenuItemMasterEffectivityGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of menuItem Master Effectivity Groups.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Master Effectivity objects of the organization.", "items":{ "$ref":"#/definitions/MenuItemMasterEffectivityv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getMenuItemMasterEffectivity-post", "x-filename-id":"config-sim-v2-menuitems-getmenuitemmastereffectivity-post" } }, "/config/sim/v1/menuItems/menuItemMasterEffectivity":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Master Effectivity" ], "summary":"Add Menu Item Master Effectivity Group", "description":"Add the Menu Item Master Effectivity Group object to a specified hierarchy unit .", "operationId":"addMenuItemMasterEffectivity", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterEffectivityRequestBody" } ], "responses":{ "200":{ "description":"MenuItem Master Effectivity Group Added", "schema":{ "$ref":"#/definitions/menuItemMasterEffectivityResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-menuItemMasterEffectivity-post", "x-filename-id":"config-sim-v1-menuitems-menuitemmastereffectivity-post" } }, "/config/sim/v2/menuItems/menuItemMasterEffectivity":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Master Effectivity" ], "summary":"Add Menu Item Master Effectivity Group", "description":"Add the Menu Item Master Effectivity Group object to a specified hierarchy unit .", "operationId":"addMenuItemMasterEffectivityv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterEffectivityRequestBody" } ], "responses":{ "200":{ "description":"MenuItem Master Effectivity Group Added", "schema":{ "type":"object", "properties":{ "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Menu item master effectivity group object number" }, "hierUnitId":{ "type":"integer", "example":662, "description":"Unique hierarchy unit reference" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemMasterEffectivity-post", "x-filename-id":"config-sim-v2-menuitems-menuitemmastereffectivity-post" } }, "/config/sim/v1/menuItems/updateMenuItemMasterEffectivity":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Master Effectivity" ], "summary":"Update Menu Item Master Effectivity Group", "description":"Updates Menu Item Master Effectivity Group. If Menu Item Master Effectivity group is not present, it adds a new Menu Item Master Effectivity group.", "operationId":"updateMenuItemMasterEffectivity", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterEffectivityRequestBody" } ], "responses":{ "200":{ "description":"MenuItem Master Effectivity Group Updated or Added.", "schema":{ "$ref":"#/definitions/menuItemMasterEffectivityResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-updateMenuItemMasterEffectivity-post", "x-filename-id":"config-sim-v1-menuitems-updatemenuitemmastereffectivity-post" } }, "/config/sim/v2/menuItems/updateMenuItemMasterEffectivity":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Master Effectivity" ], "summary":"Update Menu Item Master Effectivity Group", "description":"Updates Menu Item Master Effectivity Group", "operationId":"updateMenuItemMasterEffectivityv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterEffectivityRequestBody" } ], "responses":{ "200":{ "description":"MenuItem Master Effectivity Group Updated.", "schema":{ "type":"object", "properties":{ "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Menu item master effectivity group object number" }, "hierUnitId":{ "type":"integer", "example":662, "description":"Unique hierarchy unit reference" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateMenuItemMasterEffectivity-post", "x-filename-id":"config-sim-v2-menuitems-updatemenuitemmastereffectivity-post" } }, "/config/sim/v1/menuItems/deleteMenuItemMasterEffectivity":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Master Effectivity" ], "summary":"Delete Menu Item Master Effectivity Group", "description":"Deletes a Menu Item Master Effectivity Group", "operationId":"deleteMenuItemMasterEffectivity", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterEffectivityDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/DeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-deleteMenuItemMasterEffectivity-post", "x-filename-id":"config-sim-v1-menuitems-deletemenuitemmastereffectivity-post" } }, "/config/sim/v2/menuItems/deleteMenuItemMasterEffectivity":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Master Effectivity" ], "summary":"Delete Menu Item Master Effectivity Group", "description":"Deletes a Menu Item Master Effectivity Group", "operationId":"deleteMenuItemMasterEffectivityv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterEffectivityDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteMenuItemMasterEffectivity-post", "x-filename-id":"config-sim-v2-menuitems-deletemenuitemmastereffectivity-post" } }, "/config/sim/v1/employees/getEmployeeRoles":{ "post":{ "tags":[ "v1/Employees/Employee Roles" ], "summary":"Get Employee Roles", "description":"Gets a list of all the roles associated with the given employee in the specified organization", "operationId":"getEmployeeRoles", "parameters":[ { "$ref":"#/parameters/body.EmployeeRolesGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Employee Roles.", "schema":{ "$ref":"#/definitions/EmployeeRoleGetResponsev1" } } }, "x-internal-id":"config-sim-v1-employees-getEmployeeRoles-post", "x-filename-id":"config-sim-v1-employees-getemployeeroles-post" } }, "/config/sim/v2/employees/getEmployeeRoles":{ "post":{ "tags":[ "v2/Employees/Employee Roles" ], "summary":"Get Employee Roles", "description":"Gets a list of all the roles associated with the given employee in the specified organization", "operationId":"getEmployeeRolesv2", "parameters":[ { "$ref":"#/parameters/body.EmployeeRolesGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Employee Roles.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Employee Role objects of the organization.", "items":{ "$ref":"#/definitions/EmployeeRolev2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-employees-getEmployeeRoles-post", "x-filename-id":"config-sim-v2-employees-getemployeeroles-post" } }, "/config/sim/v1/employees/employeeRoles":{ "post":{ "tags":[ "v1/Employees/Employee Roles" ], "summary":"Add Employee Roles", "description":"Assign a role to an Employee at the specified hierarchy unit .", "operationId":"addEmployeeRoles", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeRoleInsertRequest" } ], "responses":{ "200":{ "description":"Employee Role Added.", "schema":{ "$ref":"#/definitions/EmployeeRoleResponse" } } }, "x-internal-id":"config-sim-v1-employees-employeeRoles-post", "x-filename-id":"config-sim-v1-employees-employeeroles-post" } }, "/config/sim/v2/employees/employeeRoles":{ "post":{ "tags":[ "v2/Employees/Employee Roles" ], "summary":"Add Employee Roles", "description":"Assign a role to an Employee at the specified hierarchy unit .", "operationId":"addEmployeeRolesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeRoleInsertRequest" } ], "responses":{ "200":{ "description":"Employee Role Added.", "schema":{ "description":"Model for Employee Role Insert and Update Response Body", "type":"object", "properties":{ "objectNum":{ "description":"Unique reference of the employee in the system.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the employee role is configured", "type":"integer", "example":3599 }, "roleEmployeeId":{ "description":"Unique reference of Employee Role Association", "type":"integer", "example":1 }, "roleObjNum":{ "type":"integer", "example":1, "description":"The object number of the role assigned to the employee" } } } } }, "x-internal-id":"config-sim-v2-employees-employeeRoles-post", "x-filename-id":"config-sim-v2-employees-employeeroles-post" } }, "/config/sim/v1/employees/updateEmployeeRoles":{ "post":{ "tags":[ "v1/Employees/Employee Roles" ], "summary":"Update Employee Roles", "description":"Updates the employee role record with the unique roleEmployeeId provided. If no record exits for given roleEmployeeId, it throws a validation error.", "operationId":"updateEmployeeRoles", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeRoleUpdateRequest" } ], "responses":{ "200":{ "description":"Employee Role Updated.", "schema":{ "$ref":"#/definitions/EmployeeRoleResponse" } } }, "x-internal-id":"config-sim-v1-employees-updateEmployeeRoles-post", "x-filename-id":"config-sim-v1-employees-updateemployeeroles-post" } }, "/config/sim/v2/employees/updateEmployeeRoles":{ "post":{ "tags":[ "v2/Employees/Employee Roles" ], "summary":"Update Employee Roles", "description":"Updates the employee role record with the unique roleEmployeeId provided. If no record exits for given roleEmployeeId, it throws a validation error.", "operationId":"updateEmployeeRolesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeRoleUpdateRequest" } ], "responses":{ "200":{ "description":"Employee Role Updated.", "schema":{ "description":"Model for Employee Role Insert and Update Response Body", "type":"object", "properties":{ "objectNum":{ "description":"Unique reference of the employee in the system.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the employee role is configured", "type":"integer", "example":3599 }, "roleEmployeeId":{ "description":"Unique reference of Employee Role Association", "type":"integer", "example":1 }, "roleObjNum":{ "type":"integer", "example":1, "description":"The object number of the role assigned to the employee" } } } } }, "x-internal-id":"config-sim-v2-employees-updateEmployeeRoles-post", "x-filename-id":"config-sim-v2-employees-updateemployeeroles-post" } }, "/config/sim/v1/employees/deleteEmployeeRoles":{ "post":{ "tags":[ "v1/Employees/Employee Roles" ], "summary":"Delete Employee Roles", "description":"Unassigns the role from the specified employee at the hierarchy unit linked with the roleEmployeeId.", "operationId":"deleteEmployeeRoles", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeRoleDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-employees-deleteEmployeeRoles-post", "x-filename-id":"config-sim-v1-employees-deleteemployeeroles-post" } }, "/config/sim/v2/employees/deleteEmployeeRoles":{ "post":{ "tags":[ "v2/Employees/Employee Roles" ], "summary":"Delete Employee Roles", "description":"Unassigns the role from the specified employee at the hierarchy unit linked with the roleEmployeeId.", "operationId":"deleteEmployeeRolesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeRoleDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-employees-deleteEmployeeRoles-post", "x-filename-id":"config-sim-v2-employees-deleteemployeeroles-post" } }, "/config/sim/v1/employees/getRoles":{ "post":{ "tags":[ "v1/Employees/Roles" ], "summary":"Get Roles", "description":"Gets all the roles", "operationId":"getRoles", "parameters":[ { "$ref":"#/parameters/body.RolesGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Roles.", "schema":{ "$ref":"#/definitions/RolesGetResponsev1" } } }, "x-internal-id":"config-sim-v1-employees-getRoles-post", "x-filename-id":"config-sim-v1-employees-getroles-post" } }, "/config/sim/v2/employees/getRoles":{ "post":{ "tags":[ "v2/Employees/Roles" ], "summary":"Get Roles", "description":"Gets all the roles", "operationId":"getRolesv2", "parameters":[ { "$ref":"#/parameters/body.RolesGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Roles.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of role objects of the organization.", "items":{ "$ref":"#/definitions/RolesResourceObjectv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-employees-getRoles-post", "x-filename-id":"config-sim-v2-employees-getroles-post" } }, "/config/sim/v1/employees/roles":{ "post":{ "tags":[ "v1/Employees/Roles" ], "summary":"Add Roles", "description":"Add the role to the specified organization.", "operationId":"addRoles", "parameters":[ { "$ref":"#/parameters/body.RolesCURequestBody" } ], "responses":{ "200":{ "description":"Roles Added.", "schema":{ "$ref":"#/definitions/RolesResponse" } } }, "x-internal-id":"config-sim-v1-employees-roles-post", "x-filename-id":"config-sim-v1-employees-roles-post" } }, "/config/sim/v2/employees/roles":{ "post":{ "tags":[ "v2/Employees/Roles" ], "summary":"Add Roles", "description":"Add the role to the specified organization.", "operationId":"addRolesv2", "parameters":[ { "$ref":"#/parameters/body.RolesCURequestBodyv2" } ], "responses":{ "200":{ "description":"Roles Added.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object number of the role" } } } } }, "x-internal-id":"config-sim-v2-employees-roles-post", "x-filename-id":"config-sim-v2-employees-roles-post" } }, "/config/sim/v1/employees/updateRoles":{ "post":{ "tags":[ "v1/Employees/Roles" ], "summary":"Update Roles", "description":"Updates the role. If role is not found, it creates a new role.", "operationId":"updateRoles", "parameters":[ { "$ref":"#/parameters/body.RolesCURequestBody" } ], "responses":{ "200":{ "description":"Roles Updated or Added.", "schema":{ "$ref":"#/definitions/RolesResponse" } } }, "x-internal-id":"config-sim-v1-employees-updateRoles-post", "x-filename-id":"config-sim-v1-employees-updateroles-post" } }, "/config/sim/v2/employees/updateRoles":{ "post":{ "tags":[ "v2/Employees/Roles" ], "summary":"Update Roles", "description":"Updates the role.", "operationId":"updateRolesv2", "parameters":[ { "$ref":"#/parameters/body.RolesCURequestBodyv2" } ], "responses":{ "200":{ "description":"Roles Updated.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object number of the role" } } } } }, "x-internal-id":"config-sim-v2-employees-updateRoles-post", "x-filename-id":"config-sim-v2-employees-updateroles-post" } }, "/config/sim/v1/employees/deleteRoles":{ "post":{ "tags":[ "v1/Employees/Roles" ], "summary":"Delete Roles", "description":"Deletes the role object.", "operationId":"deleteRoles", "parameters":[ { "$ref":"#/parameters/body.RolesDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "$ref":"#/definitions/RolesDeleteResponse" } } }, "x-internal-id":"config-sim-v1-employees-deleteRoles-post", "x-filename-id":"config-sim-v1-employees-deleteroles-post" } }, "/config/sim/v2/employees/deleteRoles":{ "post":{ "tags":[ "v2/Employees/Roles" ], "summary":"Delete Roles", "description":"Deletes the role object.", "operationId":"deleteRolesv2", "parameters":[ { "$ref":"#/parameters/body.RolesDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-employees-deleteRoles-post", "x-filename-id":"config-sim-v2-employees-deleteroles-post" } }, "/config/sim/v1/setup/getheaderstrailers":{ "post":{ "tags":[ "v1/Setup/Headers Trailers" ], "summary":"Get Headers/Trailers", "description":"Gets Headers and Trailers.", "operationId":"getHeadersTrailers", "parameters":[ { "$ref":"#/parameters/body.HeadersTrailersGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Headers/Trailers", "schema":{ "$ref":"#/definitions/HeadersTrailersGetResponsev1" } } }, "x-internal-id":"config-sim-v1-setup-getheaderstrailers-post", "x-filename-id":"config-sim-v1-setup-getheaderstrailers-post" } }, "/config/sim/v2/setup/getHeadersTrailers":{ "post":{ "tags":[ "v2/Setup/Headers Trailers" ], "summary":"Get Headers/Trailers", "description":"Gets Headers and Trailers.", "operationId":"getHeadersTrailersv2", "parameters":[ { "$ref":"#/parameters/body.HeadersTrailersGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Headers/Trailers", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Headers/Trailers objects of the organization.", "items":{ "$ref":"#/definitions/HeadersTrailersv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getHeadersTrailers-post", "x-filename-id":"config-sim-v2-setup-getheaderstrailers-post" } }, "/config/sim/v1/setup/headerstrailers":{ "post":{ "tags":[ "v1/Setup/Headers Trailers" ], "summary":"Add Headers/Trailers", "description":"Add the header/trailer object of a specific type to a specified hierarchy unit of specified organization.", "operationId":"createHeadersTrailers", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.HeadersTrailersCURequestBody" } ], "responses":{ "200":{ "description":"Header/Trailer Added.", "schema":{ "$ref":"#/definitions/HeadersTrailersResponse" } } }, "x-internal-id":"config-sim-v1-setup-headerstrailers-post", "x-filename-id":"config-sim-v1-setup-headerstrailers-post" } }, "/config/sim/v2/setup/headersTrailers":{ "post":{ "tags":[ "v2/Setup/Headers Trailers" ], "summary":"Add Headers/Trailers", "description":"Add the header/trailer object of a specific type to a specified hierarchy unit of specified organization.", "operationId":"createHeadersTrailersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.HeadersTrailersCURequestBodyv2" } ], "responses":{ "200":{ "description":"Header/Trailer Added.", "schema":{ "type":"object", "properties":{ "lineNum":{ "type":"integer", "example":1, "description":"line number added" }, "descriptorTypeNum":{ "description":"

    Descriptor Type Number assigned to the Header/Trailer

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    descriptorTypeNum descriptorTypeName
    1 Customer Receipt Header
    2 Check Header
    3 Training Header
    5 Check Trailer
    7 Credit Card Header
    8 Credit Card Trailer
    37 Autofire Check Offline Header
    46 Waste Header
    47 Waste Trailer
    52 Report Header
    53 Report Trailer
    \n", "type":"integer", "example":2 }, "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" } } } } }, "x-internal-id":"config-sim-v2-setup-headersTrailers-post", "x-filename-id":"config-sim-v2-setup-headerstrailers-post" } }, "/config/sim/v1/setup/updateheaderstrailers":{ "post":{ "tags":[ "v1/Setup/Headers Trailers" ], "summary":"Update Headers/Trailers", "description":"Updates the header/trailer for the specified organization. If header/trailer is not found, it creates a new header/trailer.", "operationId":"updateHeadersTrailers", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.HeadersTrailersCURequestBody" } ], "responses":{ "200":{ "description":"Header/Trailer Updated or Added.", "schema":{ "$ref":"#/definitions/HeadersTrailersResponse" } } }, "x-internal-id":"config-sim-v1-setup-updateheaderstrailers-post", "x-filename-id":"config-sim-v1-setup-updateheaderstrailers-post" } }, "/config/sim/v2/setup/updateHeadersTrailers":{ "post":{ "tags":[ "v2/Setup/Headers Trailers" ], "summary":"Update Headers/Trailers", "description":"Updates the header/trailer for the specified organization.", "operationId":"updateHeadersTrailersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.HeadersTrailersCURequestBodyv2" } ], "responses":{ "200":{ "description":"Header/Trailer Updated.", "schema":{ "type":"object", "properties":{ "lineNum":{ "type":"integer", "example":1, "description":"line number added" }, "descriptorTypeNum":{ "description":"

    Descriptor Type Number assigned to the Header/Trailer

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    descriptorTypeNum descriptorTypeName
    1 Customer Receipt Header
    2 Check Header
    3 Training Header
    5 Check Trailer
    7 Credit Card Header
    8 Credit Card Trailer
    37 Autofire Check Offline Header
    46 Waste Header
    47 Waste Trailer
    52 Report Header
    53 Report Trailer
    \n", "type":"integer", "example":2 }, "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" } } } } }, "x-internal-id":"config-sim-v2-setup-updateHeadersTrailers-post", "x-filename-id":"config-sim-v2-setup-updateheaderstrailers-post" } }, "/config/sim/v1/setup/deleteheaderstrailers":{ "post":{ "tags":[ "v1/Setup/Headers Trailers" ], "summary":"Delete Header/Trailer", "description":"Deletes the header/trailer object for the specified organization.", "operationId":"deleteHeadersTrailers", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.HeadersTrailersDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/HeadersTrailersDeleteResponse" } } }, "x-internal-id":"config-sim-v1-setup-deleteheaderstrailers-post", "x-filename-id":"config-sim-v1-setup-deleteheaderstrailers-post" } }, "/config/sim/v2/setup/deleteHeadersTrailers":{ "post":{ "tags":[ "v2/Setup/Headers Trailers" ], "summary":"Delete Header/Trailer", "description":"Deletes the header/trailer object for the specified organization.", "operationId":"deleteHeadersTrailersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.HeadersTrailersDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteHeadersTrailers-post", "x-filename-id":"config-sim-v2-setup-deleteheaderstrailers-post" } }, "/config/sim/v1/setup/getCashManagementReceptacleTemplates":{ "post":{ "tags":[ "v1/Setup/Cash Management Receptacle Templates" ], "summary":"Get Cash Management Receptacle Templates", "description":"Get Cash Management Receptacle Templates", "operationId":"getCashManagementReceptacleTemplates", "parameters":[ { "$ref":"#/parameters/body.CMReceptacleTemplateGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Cash Management Receptacle Templates.", "schema":{ "$ref":"#/definitions/CMTemplateGetResponse" } } }, "x-internal-id":"config-sim-v1-setup-getCashManagementReceptacleTemplates-post", "x-filename-id":"config-sim-v1-setup-getcashmanagementreceptacletemplates-post" } }, "/config/sim/v2/setup/getCashManagementReceptacleTemplates":{ "post":{ "tags":[ "v2/Setup/Cash Management Receptacle Templates" ], "summary":"Get Cash Management Receptacle Templates", "description":"Get Cash Management Receptacle Templates", "operationId":"getCashManagementReceptacleTemplatesv2", "parameters":[ { "$ref":"#/parameters/body.CMReceptacleTemplateGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Cash Management Receptacle Templates.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of cash management template objects of the organization.", "items":{ "$ref":"#/definitions/CMReceptacleTemplatev2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getCashManagementReceptacleTemplates-post", "x-filename-id":"config-sim-v2-setup-getcashmanagementreceptacletemplates-post" } }, "/config/sim/v1/setup/cashManagementReceptacleTemplates":{ "post":{ "tags":[ "v1/Setup/Cash Management Receptacle Templates" ], "summary":"Add Cash Management Receptacle Templates", "description":"Add Cash Management Receptacle Templates", "operationId":"createCashManagementReceptacleTemplates", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CMTemplateRequestBody" } ], "responses":{ "200":{ "description":"Cash Management Receptacle Template Added.", "schema":{ "$ref":"#/definitions/CMTemplateDeleteBodyAndCUResponse" } } }, "x-internal-id":"config-sim-v1-setup-cashManagementReceptacleTemplates-post", "x-filename-id":"config-sim-v1-setup-cashmanagementreceptacletemplates-post" } }, "/config/sim/v2/setup/cashManagementReceptacleTemplates":{ "post":{ "tags":[ "v2/Setup/Cash Management Receptacle Templates" ], "summary":"Add Cash Management Receptacle Templates", "description":"Add Cash Management Receptacle Templates", "operationId":"createCashManagementReceptacleTemplatesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CMTemplateRequestBodyv2" } ], "responses":{ "200":{ "description":"Cash Management Receptacle Template Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "objectNum":{ "description":"Object number of the cash management template", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-cashManagementReceptacleTemplates-post", "x-filename-id":"config-sim-v2-setup-cashmanagementreceptacletemplates-post" } }, "/config/sim/v1/setup/deleteCashManagementReceptacleTemplates":{ "post":{ "tags":[ "v1/Setup/Cash Management Receptacle Templates" ], "summary":"Delete Cash Management Receptacle Templates", "description":"Delete Cash Management Receptacle Templates", "operationId":"deleteCashManagementReceptacleTemplates", "parameters":[ { "$ref":"#/parameters/body.CMTemplateDeleteBodyAndCUResponse" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-setup-deleteCashManagementReceptacleTemplates-post", "x-filename-id":"config-sim-v1-setup-deletecashmanagementreceptacletemplates-post" } }, "/config/sim/v2/setup/deleteCashManagementReceptacleTemplates":{ "post":{ "tags":[ "v2/Setup/Cash Management Receptacle Templates" ], "summary":"Delete Cash Management Receptacle Templates", "description":"Delete Cash Management Receptacle Templates", "operationId":"deleteCashManagementReceptacleTemplatesv2", "parameters":[ { "$ref":"#/parameters/body.CMTemplateDeleteBodyAndCUResponse" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteCashManagementReceptacleTemplates-post", "x-filename-id":"config-sim-v2-setup-deletecashmanagementreceptacletemplates-post" } }, "/config/sim/v1/setup/updateCashManagementReceptacleTemplates":{ "post":{ "tags":[ "v1/Setup/Cash Management Receptacle Templates" ], "summary":"Update Cash Management Receptacle Templates", "description":"Update Cash Management Receptacle Templates", "operationId":"updateCashManagementReceptacleTemplates", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CMTemplateRequestBody" } ], "responses":{ "200":{ "description":"Cash Management Receptacle Template Updated or Added.", "schema":{ "$ref":"#/definitions/CMTemplateDeleteBodyAndCUResponse" } } }, "x-internal-id":"config-sim-v1-setup-updateCashManagementReceptacleTemplates-post", "x-filename-id":"config-sim-v1-setup-updatecashmanagementreceptacletemplates-post" } }, "/config/sim/v2/setup/updateCashManagementReceptacleTemplates":{ "post":{ "tags":[ "v2/Setup/Cash Management Receptacle Templates" ], "summary":"Update Cash Management Receptacle Templates", "description":"Update Cash Management Receptacle Templates", "operationId":"updateCashManagementReceptacleTemplatesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CMTemplateRequestBodyv2" } ], "responses":{ "200":{ "description":"Cash Management Receptacle Template Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "objectNum":{ "description":"Object number of the cash management template", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-updateCashManagementReceptacleTemplates-post", "x-filename-id":"config-sim-v2-setup-updatecashmanagementreceptacletemplates-post" } }, "/config/sim/v2/menuItems/getAllergenNames":{ "post":{ "tags":[ "v2/Menu Items/Allergen Names" ], "summary":"Get Allergen Names", "description":"Gets Allergen Names", "operationId":"getAllergenNames", "parameters":[ { "$ref":"#/parameters/body.AllergenNamesGetParameters" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "description":"Total number of records in the data set", "type":"integer", "example":100 }, "hasMore":{ "description":"Indicates whether there are additional pages of records", "type":"boolean", "example":true }, "count":{ "description":"Number of records returned on this page", "type":"integer", "example":10 }, "offset":{ "description":"The page number of this data. Starts at 0.", "type":"integer", "example":0 }, "limit":{ "description":"The maximum number of records returned on a page", "type":"integer", "example":10 }, "items":{ "description":"Allergen Name records", "type":"array", "items":{ "$ref":"#/definitions/AllergenName" } } } } } }, "x-internal-id":"config-sim-v2-menuItems-getAllergenNames-post", "x-filename-id":"config-sim-v2-menuitems-getallergennames-post" } }, "/config/sim/v2/menuItems/allergenNames":{ "post":{ "tags":[ "v2/Menu Items/Allergen Names" ], "summary":"Add Allergen Names", "description":"Adds Allergen Names", "operationId":"createAllergenNames", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.AllergenNameInsertRequest" } ], "responses":{ "200":{ "description":"Insert operation executed successfully.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "allergenId":{ "description":"Allergen ID", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-menuItems-allergenNames-post", "x-filename-id":"config-sim-v2-menuitems-allergennames-post" } }, "/config/sim/v2/menuItems/deleteAllergenNames":{ "post":{ "tags":[ "v2/Menu Items/Allergen Names" ], "summary":"Delete Allergen Names", "description":"Deletes Allergen Names", "operationId":"deleteAllergenNames", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.AllergenNameDeleteRequest" } ], "responses":{ "200":{ "description":"Delete operation executed successfully.", "schema":{ "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteAllergenNames-post", "x-filename-id":"config-sim-v2-menuitems-deleteallergennames-post" } }, "/config/sim/v2/menuItems/updateAllergenNames":{ "post":{ "tags":[ "v2/Menu Items/Allergen Names" ], "summary":"Update Allergen Names", "description":"Updates Allergen Names", "operationId":"updateAllergenNames", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.AllergenNameUpdateRequest" } ], "responses":{ "200":{ "description":"Update operation executed successfully.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "allergenId":{ "description":"Allergen ID", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateAllergenNames-post", "x-filename-id":"config-sim-v2-menuitems-updateallergennames-post" } }, "/config/sim/v2/getAuditTrail":{ "post":{ "tags":[ "v2/Other/Audit Trail" ], "summary":"Get Audit Trail", "description":"Gets all audit trail records", "operationId":"getAuditTrail", "parameters":[ { "$ref":"#/parameters/body.AuditTrailGetParameters" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of records in the data set" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Number of records returned on this page." }, "items":{ "type":"array", "description":"Audit Trail records.", "items":{ "$ref":"#/definitions/AuditTrail" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"The maximum number of records returned on a page" } } } } }, "x-internal-id":"config-sim-v2-getAuditTrail-post", "x-filename-id":"config-sim-v2-getaudittrail-post" } }, "/config/sim/v1/getAvailableObjectNumbers":{ "post":{ "tags":[ "v1/Other/ Get Available Object Numbers" ], "summary":"Get Available Object Numbers", "description":"Gets available object numbers for a module based on count and starting position.", "operationId":"getAvailableObjectNumbers", "parameters":[ { "$ref":"#/parameters/body.GetAvailableObjNumbersGetParameters" } ], "responses":{ "200":{ "description":"A list of available object numbers for the module and the hierarchy where the object numbers can be added.", "schema":{ "$ref":"#/definitions/GetAvailableObjNumResponse" } } }, "x-internal-id":"config-sim-v1-getAvailableObjectNumbers-post", "x-filename-id":"config-sim-v1-getavailableobjectnumbers-post" } }, "/config/sim/v2/getAvailableObjectNumbers":{ "post":{ "tags":[ "v2/Other/ Get Available Object Numbers" ], "summary":"Get Available Object Numbers", "description":"Gets available object numbers for a module based on count and starting position.", "operationId":"getAvailableObjectNumbersV2", "parameters":[ { "$ref":"#/parameters/body.GetAvailableObjNumbersGetParameters" } ], "responses":{ "200":{ "description":"A list of available object numbers for the module and the hierarchy where the object numbers can be added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "objectNumbers":{ "description":"List of available object numbers", "type":"array", "items":{ "type":"integer" }, "example":[ 1001, 1002, 1004, 1005 ] } } } } }, "x-internal-id":"config-sim-v2-getAvailableObjectNumbers-post", "x-filename-id":"config-sim-v2-getavailableobjectnumbers-post" } }, "/config/sim/v2/employees/getSystemEmployeePropertyOperators":{ "post":{ "tags":[ "v2/Employees/System Employee Property Operators" ], "summary":"Get System Employee Property Operators", "description":"Gets all System Employee Property Operators", "operationId":"getSystemEmployeePropertyOperators", "parameters":[ { "$ref":"#/parameters/body.SystemEmployeePropertyOperatorsGetParameters" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "description":"Total number of records in the data set", "type":"integer", "example":100 }, "hasMore":{ "description":"Indicates whether there are additional pages of records", "type":"boolean", "example":true }, "count":{ "description":"Number of records returned on this page", "type":"integer", "example":10 }, "offset":{ "description":"The page number of this data. Starts at 0.", "type":"integer", "example":0 }, "limit":{ "description":"The maximum number of records returned on a page", "type":"integer", "example":10 }, "items":{ "description":"System employee property operator records", "type":"array", "items":{ "$ref":"#/definitions/SystemEmployeePropertyOperator" } } } } } }, "x-internal-id":"config-sim-v2-employees-getSystemEmployeePropertyOperators-post", "x-filename-id":"config-sim-v2-employees-getsystememployeepropertyoperators-post" } }, "/config/sim/v2/employees/systemEmployeePropertyOperators":{ "post":{ "tags":[ "v2/Employees/System Employee Property Operators" ], "summary":"Add System Employee Property Operators", "description":"Assigns a System Employee Property Operator", "operationId":"createSystemEmployeePropertyOperators", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SystemEmployeePropertyOperatorCURequest" } ], "responses":{ "200":{ "description":"Insert operation executed successfully.", "schema":{ "type":"object", "properties":{ "objectNum":{ "description":"Object number of the system employee", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Hierarchy unit value of the associated operator", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-employees-systemEmployeePropertyOperators-post", "x-filename-id":"config-sim-v2-employees-systememployeepropertyoperators-post" } }, "/config/sim/v2/employees/deleteSystemEmployeePropertyOperators":{ "post":{ "tags":[ "v2/Employees/System Employee Property Operators" ], "summary":"Delete System Employee Property Operators", "description":"Unassigns a System Employee Property Operator", "operationId":"deleteSystemEmployeePropertyOperators", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SystemEmployeePropertyOperatorDeleteRequest" } ], "responses":{ "200":{ "description":"Delete operation executed successfully.", "schema":{ "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-employees-deleteSystemEmployeePropertyOperators-post", "x-filename-id":"config-sim-v2-employees-deletesystememployeepropertyoperators-post" } }, "/config/sim/v2/employees/updateSystemEmployeePropertyOperators":{ "post":{ "tags":[ "v2/Employees/System Employee Property Operators" ], "summary":"Update System Employee Property Operators", "description":"Updates a System Employee Property Operator", "operationId":"updateSystemEmployeePropertyOperators", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SystemEmployeePropertyOperatorCURequest" } ], "responses":{ "200":{ "description":"Update operation executed successfully.", "schema":{ "type":"object", "properties":{ "objectNum":{ "description":"Object number of the system employee", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Hierarchy unit value of the associated operator", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-employees-updateSystemEmployeePropertyOperators-post", "x-filename-id":"config-sim-v2-employees-updatesystememployeepropertyoperators-post" } }, "/content/sim/v1/menuitems/familyGroups/getConsumerContent":{ "post":{ "tags":[ "v1/Menu Items/Family Group Consumer Facing Content" ], "summary":"Get Family Group Consumer Facing Content", "description":"Gets a list of Family Group Consumer Facing Content.", "operationId":"getFamilyGroupConsumerFacingContent", "parameters":[ { "$ref":"#/parameters/body.FamilyGroupConsumerFacingContentGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Family Group Consumer Facing Content.", "schema":{ "$ref":"#/definitions/FamilyGroupConsumerFacingContentGetResponsev1" } } }, "x-internal-id":"content-sim-v1-menuitems-familyGroups-getConsumerContent-post", "x-filename-id":"content-sim-v1-menuitems-familygroups-getconsumercontent-post" } }, "/content/sim/v2/menuItems/familyGroups/getConsumerContent":{ "post":{ "tags":[ "v2/Menu Items/Family Group Consumer Facing Content" ], "summary":"Get Family Group Consumer Facing Content", "description":"Gets a list of Family Group Consumer Facing Content.", "operationId":"getFamilyGroupConsumerFacingContentv2", "parameters":[ { "$ref":"#/parameters/body.FamilyGroupConsumerFacingContentGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Family Group Consumer Facing Content.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Family Group Consumer Facing Content objects of the organization.", "items":{ "$ref":"#/definitions/FamilyGroupConsumerFacingContentv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"content-sim-v2-menuItems-familyGroups-getConsumerContent-post", "x-filename-id":"content-sim-v2-menuitems-familygroups-getconsumercontent-post" } }, "/content/sim/v1/menuitems/familyGroups/consumerContent":{ "post":{ "tags":[ "v1/Menu Items/Family Group Consumer Facing Content" ], "summary":"Add Family Group Consumer Facing Content", "description":"Add the Family Group Consumer Facing Content to a specified hierarchy unit .", "operationId":"addFamilyGroupConsumerFacingContent", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.FamilyGroupConsumerFacingContentCUDRequestBody" } ], "responses":{ "200":{ "description":"Family Group Consumer Facing Content Added.", "schema":{ "$ref":"#/definitions/FamilyGroupConsumerFacingContentAddResponse" } } }, "x-internal-id":"content-sim-v1-menuitems-familyGroups-consumerContent-post", "x-filename-id":"content-sim-v1-menuitems-familygroups-consumercontent-post" } }, "/content/sim/v2/menuItems/familyGroups/consumerContent":{ "post":{ "tags":[ "v2/Menu Items/Family Group Consumer Facing Content" ], "summary":"Add Family Group Consumer Facing Content", "description":"Add the Family Group Consumer Facing Content to a specified hierarchy unit .", "operationId":"addFamilyGroupConsumerFacingContentv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.FamilyGroupConsumerFacingContentCUDRequestBody" } ], "responses":{ "200":{ "description":"Family Group Consumer Facing Content Added.", "schema":{ "description":"Response object for Content related Objects", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the family group", "type":"integer", "example":1 }, "imageIndex":{ "description":"Number of the image. Values range from 1-10.", "type":"integer", "example":1 }, "url":{ "description":"Object storage url of the uploaded image, can be used for downloading the uploaded image.", "type":"string", "example":"https://objectstorage.oracle.com/xyz.jpg" } } } } }, "x-internal-id":"content-sim-v2-menuItems-familyGroups-consumerContent-post", "x-filename-id":"content-sim-v2-menuitems-familygroups-consumercontent-post" } }, "/content/sim/v1/menuitems/familyGroups/updateConsumerContent":{ "post":{ "tags":[ "v1/Menu Items/Family Group Consumer Facing Content" ], "summary":"Update Family Group Consumer Facing Content", "description":"Updates the Family Group Consumer Facing Content. If Family Group Consumer Facing Content is not found it creates a new entry for Family Group Consumer Facing Content.", "operationId":"updateFamilyGroupConsumerFacingContent", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.FamilyGroupConsumerFacingContentCUDRequestBody" } ], "responses":{ "200":{ "description":"Family Group Consumer Facing Content Updated or Added.", "schema":{ "$ref":"#/definitions/FamilyGroupConsumerFacingContentUpdateResponse" } } }, "x-internal-id":"content-sim-v1-menuitems-familyGroups-updateConsumerContent-post", "x-filename-id":"content-sim-v1-menuitems-familygroups-updateconsumercontent-post" } }, "/content/sim/v2/menuItems/familyGroups/updateConsumerContent":{ "post":{ "tags":[ "v2/Menu Items/Family Group Consumer Facing Content" ], "summary":"Update Family Group Consumer Facing Content", "description":"Updates the Family Group Consumer Facing Content.", "operationId":"updateFamilyGroupConsumerFacingContentv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.FamilyGroupConsumerFacingContentCUDRequestBody" } ], "responses":{ "200":{ "description":"Family Group Consumer Facing Content Updated.", "schema":{ "description":"Response object for Content related Objects", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the family group", "type":"integer", "example":1 }, "imageIndex":{ "description":"Image number of the family group", "type":"integer", "example":1 }, "url":{ "description":"Object storage url of the uploaded image, can be used for downloading the uploaded image.", "type":"string", "example":"https://objectstorage.oracle.com/xyz.jpg" } } } } }, "x-internal-id":"content-sim-v2-menuItems-familyGroups-updateConsumerContent-post", "x-filename-id":"content-sim-v2-menuitems-familygroups-updateconsumercontent-post" } }, "/content/sim/v1/menuitems/familyGroups/deleteConsumerContent":{ "post":{ "tags":[ "v1/Menu Items/Family Group Consumer Facing Content" ], "summary":"Delete Family Group Consumer Facing Content", "description":"Deletes the Family Group Consumer Facing Content object.", "operationId":"deleteFamilyGroupConsumerFacingContent", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.FamilyGroupConsumerFacingContentDelete" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"content-sim-v1-menuitems-familyGroups-deleteConsumerContent-post", "x-filename-id":"content-sim-v1-menuitems-familygroups-deleteconsumercontent-post" } }, "/content/sim/v2/menuItems/familyGroups/deleteConsumerContent":{ "post":{ "tags":[ "v2/Menu Items/Family Group Consumer Facing Content" ], "summary":"Delete Family Group Consumer Facing Content", "description":"Deletes the Family Group Consumer Facing Content object.", "operationId":"deleteFamilyGroupConsumerFacingContentv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.FamilyGroupConsumerFacingContentDelete" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"content-sim-v2-menuItems-familyGroups-deleteConsumerContent-post", "x-filename-id":"content-sim-v2-menuitems-familygroups-deleteconsumercontent-post" } }, "/content/sim/v1/menuitems/familyGroups/downloadConsumerContent":{ "post":{ "tags":[ "v1/Menu Items/Family Group Consumer Facing Content" ], "summary":"Download Family Group Consumer Facing Content", "description":"Downloads the Family Group Consumer Facing Content object.", "operationId":"downloadFamilyGroupConsumerFacingContent", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.FamilyGroupConsumerFacingContentDelete" } ], "responses":{ "200":{ "description":"Download the file as a octet stream", "schema":{ "type":"string", "format":"binary" } } }, "x-internal-id":"content-sim-v1-menuitems-familyGroups-downloadConsumerContent-post", "x-filename-id":"content-sim-v1-menuitems-familygroups-downloadconsumercontent-post" } }, "/content/sim/v2/menuItems/familyGroups/downloadConsumerContent":{ "post":{ "tags":[ "v2/Menu Items/Family Group Consumer Facing Content" ], "summary":"Download Family Group Consumer Facing Content", "description":"Downloads the Family Group Consumer Facing Content object.", "operationId":"downloadFamilyGroupConsumerFacingContentv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.FamilyGroupConsumerFacingContentDelete" } ], "responses":{ "200":{ "description":"Download the file as a octet stream", "schema":{ "type":"string", "format":"binary" } } }, "x-internal-id":"content-sim-v2-menuItems-familyGroups-downloadConsumerContent-post", "x-filename-id":"content-sim-v2-menuitems-familygroups-downloadconsumercontent-post" } }, "/config/sim/v1/setup/getLanguages":{ "post":{ "tags":[ "v1/Setup/Languages" ], "summary":"Get Languages", "description":"Gets all the languages", "operationId":"getLanguages", "parameters":[ { "$ref":"#/parameters/body.LanguagesGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Languages", "schema":{ "$ref":"#/definitions/LanguageGetResponsev1" } } }, "x-internal-id":"config-sim-v1-setup-getLanguages-post", "x-filename-id":"config-sim-v1-setup-getlanguages-post" } }, "/config/sim/v2/setup/getLanguages":{ "post":{ "tags":[ "v2/Setup/Languages/Languages" ], "summary":"Get Languages", "description":"Gets all the languages", "operationId":"getLanguagesV2", "parameters":[ { "$ref":"#/parameters/body.LanguagesGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Languages", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of language objects of the organization.", "items":{ "$ref":"#/definitions/Languagev2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getLanguages-post", "x-filename-id":"config-sim-v2-setup-getlanguages-post" } }, "/config/sim/v1/setup/languages":{ "post":{ "tags":[ "v1/Setup/Languages" ], "summary":"Add Languages", "description":"Add the language to the specified organization.", "operationId":"addLanguage", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LanguageCUDRequest" } ], "responses":{ "200":{ "description":"Language Added.", "schema":{ "$ref":"#/definitions/LanguageResponse" } } }, "x-internal-id":"config-sim-v1-setup-languages-post", "x-filename-id":"config-sim-v1-setup-languages-post" } }, "/config/sim/v2/setup/languages":{ "post":{ "tags":[ "v2/Setup/Languages/Languages" ], "summary":"Add Languages", "description":"Add the language to the specified organization.", "operationId":"addLanguageV2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LanguageCUDRequestV2" } ], "responses":{ "200":{ "description":"Language Added.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object number of the language" }, "langId":{ "description":"Lang Id of the language.", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-languages-post", "x-filename-id":"config-sim-v2-setup-languages-post" } }, "/config/sim/v1/setup/updateLanguages":{ "post":{ "tags":[ "v1/Setup/Languages" ], "summary":"Update Languages", "description":"Updates the language. If language is not found, it creates a new language.", "operationId":"updateLanguages", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LanguageCUDRequest" } ], "responses":{ "200":{ "description":"Language Updated or Added.", "schema":{ "$ref":"#/definitions/LanguageResponse" } } }, "x-internal-id":"config-sim-v1-setup-updateLanguages-post", "x-filename-id":"config-sim-v1-setup-updatelanguages-post" } }, "/config/sim/v2/setup/updateLanguages":{ "post":{ "tags":[ "v2/Setup/Languages/Languages" ], "summary":"Update Languages", "description":"Updates the language.", "operationId":"updateLanguagesV2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LanguageCUDRequestV2" } ], "responses":{ "200":{ "description":"Language Updated.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object number of the language" }, "langId":{ "description":"Lang Id of the language.", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-updateLanguages-post", "x-filename-id":"config-sim-v2-setup-updatelanguages-post" } }, "/config/sim/v1/setup/deleteLanguages":{ "post":{ "tags":[ "v1/Setup/Languages" ], "summary":"Delete Languages", "description":"Deletes the language object.", "operationId":"deleteLanguages", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LanguageDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/LanguagesDeleteResponse" } } }, "x-internal-id":"config-sim-v1-setup-deleteLanguages-post", "x-filename-id":"config-sim-v1-setup-deletelanguages-post" } }, "/config/sim/v2/setup/deleteLanguages":{ "post":{ "tags":[ "v2/Setup/Languages/Languages" ], "summary":"Delete Languages", "description":"Deletes the language object.", "operationId":"deleteLanguagesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LanguageDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteLanguages-post", "x-filename-id":"config-sim-v2-setup-deletelanguages-post" } }, "/config/sim/v1/devices/getWorkstations":{ "post":{ "tags":[ "v1/Devices/Workstations/Workstations" ], "summary":"Get Workstations", "description":"Gets all the Workstation configured", "operationId":"getWorkstations", "parameters":[ { "$ref":"#/parameters/body.WorkstationGetRequest" } ], "responses":{ "200":{ "description":"A collection of Workstations.", "schema":{ "$ref":"#/definitions/WorkstationGetResponsev1" } } }, "x-internal-id":"config-sim-v1-devices-getWorkstations-post", "x-filename-id":"config-sim-v1-devices-getworkstations-post" } }, "/config/sim/v2/devices/getWorkstations":{ "post":{ "tags":[ "v2/Devices/Workstations/Workstations" ], "summary":"Get Workstations", "description":"Gets all the Workstation configured", "operationId":"getWorkstationsv2", "parameters":[ { "$ref":"#/parameters/body.WorkstationGetRequestv2" } ], "responses":{ "200":{ "description":"A collection of Workstations.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Workstations objects of the organization.", "items":{ "$ref":"#/definitions/Workstationv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-devices-getWorkstations-post", "x-filename-id":"config-sim-v2-devices-getworkstations-post" } }, "/config/sim/v1/devices/workstations":{ "post":{ "tags":[ "v1/Devices/Workstations/Workstations" ], "summary":"Add Workstations", "description":"Insert Workstations.", "operationId":"addWorkstations", "parameters":[ { "$ref":"#/parameters/body.WorkstationCUDRequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Workstation Added.", "schema":{ "$ref":"#/definitions/WorkstationResponse" } } }, "x-internal-id":"config-sim-v1-devices-workstations-post", "x-filename-id":"config-sim-v1-devices-workstations-post" } }, "/config/sim/v2/devices/workstations":{ "post":{ "tags":[ "v2/Devices/Workstations/Workstations" ], "summary":"Add Workstations", "description":"Insert Workstations.", "operationId":"addWorkstationsv2", "parameters":[ { "$ref":"#/parameters/body.WorkstationCUDRequestv2" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Workstation Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the workstation", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-devices-workstations-post", "x-filename-id":"config-sim-v2-devices-workstations-post" } }, "/config/sim/v1/devices/updateWorkstations":{ "post":{ "tags":[ "v1/Devices/Workstations/Workstations" ], "summary":"Update Workstations", "description":"Updates a Workstation record for the current organization.", "operationId":"updateWorkstations", "parameters":[ { "$ref":"#/parameters/body.WorkstationCUDRequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Workstation Updated or Added.", "schema":{ "$ref":"#/definitions/WorkstationResponse" } } }, "x-internal-id":"config-sim-v1-devices-updateWorkstations-post", "x-filename-id":"config-sim-v1-devices-updateworkstations-post" } }, "/config/sim/v2/devices/updateWorkstations":{ "post":{ "tags":[ "v2/Devices/Workstations/Workstations" ], "summary":"Update Workstations", "description":"Updates a Workstation record for the current organization.", "operationId":"updateWorkstationsv2", "parameters":[ { "$ref":"#/parameters/body.WorkstationCUDRequestv2" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Workstation Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the workstation", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-devices-updateWorkstations-post", "x-filename-id":"config-sim-v2-devices-updateworkstations-post" } }, "/config/sim/v1/devices/deleteworkstations":{ "post":{ "tags":[ "v1/Devices/Workstations/Workstations" ], "summary":"Delete Workstations", "description":"Deletes the Workstation object.", "operationId":"deleteWorkstations", "parameters":[ { "$ref":"#/parameters/body.WorkstationResponse" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-devices-deleteworkstations-post", "x-filename-id":"config-sim-v1-devices-deleteworkstations-post" } }, "/config/sim/v2/devices/deleteWorkstations":{ "post":{ "tags":[ "v2/Devices/Workstations/Workstations" ], "summary":"Delete Workstations", "description":"Deletes the Workstation object.", "operationId":"deleteWorkstationsv2", "parameters":[ { "$ref":"#/parameters/body.WorkstationResponse" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-devices-deleteWorkstations-post", "x-filename-id":"config-sim-v2-devices-deleteworkstations-post" } }, "/config/sim/v1/devices/getPrinterClasses":{ "post":{ "tags":[ "v1/Devices/Print Classes" ], "summary":"Get Print Classes", "description":"Gets all the Print Classes configured", "operationId":"getPrintClasses", "parameters":[ { "$ref":"#/parameters/body.PrintClassesGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Print Classes.", "schema":{ "$ref":"#/definitions/PrintClassGetResponsev1" } } }, "x-internal-id":"config-sim-v1-devices-getPrinterClasses-post", "x-filename-id":"config-sim-v1-devices-getprinterclasses-post" } }, "/config/sim/v2/devices/getPrinterClasses":{ "post":{ "tags":[ "v2/Devices/Print Classes" ], "summary":"Get Print Classes", "description":"Gets all the Print Classes configured", "operationId":"getPrintClassesv2", "parameters":[ { "$ref":"#/parameters/body.PrintClassesGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Print Classes.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Print Class objects of the organization.", "items":{ "$ref":"#/definitions/PrintClassv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-devices-getPrinterClasses-post", "x-filename-id":"config-sim-v2-devices-getprinterclasses-post" } }, "/config/sim/v1/devices/printerclasses":{ "post":{ "tags":[ "v1/Devices/Print Classes" ], "summary":"Add Print Classes", "description":"Add the Print Class object to a specified hierarchy unit of specified organization", "operationId":"addPrintClasses", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PrintClassCUDRequest" } ], "responses":{ "200":{ "description":"Print Class Added.", "schema":{ "$ref":"#/definitions/PrintClasses" } } }, "x-internal-id":"config-sim-v1-devices-printerclasses-post", "x-filename-id":"config-sim-v1-devices-printerclasses-post" } }, "/config/sim/v2/devices/printerClasses":{ "post":{ "tags":[ "v2/Devices/Print Classes" ], "summary":"Add Print Classes", "description":"Add the Print Class object to a specified hierarchy unit of specified organization", "operationId":"addPrintClassesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PrintClassCUDRequestv2" } ], "responses":{ "200":{ "description":"Print Class Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the printer", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-devices-printerClasses-post", "x-filename-id":"config-sim-v2-devices-printerclasses-post" } }, "/config/sim/v1/devices/updateprinterClasses":{ "post":{ "tags":[ "v1/Devices/Print Classes" ], "summary":"Update Print Classes", "description":"Update the Print Class object. If a Print Class is not found, it adds a new Print Class.", "operationId":"updatePrintClasses", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PrintClassCUDRequest" } ], "responses":{ "200":{ "description":"Print Class Updated or Added.", "schema":{ "$ref":"#/definitions/PrintClasses" } } }, "x-internal-id":"config-sim-v1-devices-updateprinterClasses-post", "x-filename-id":"config-sim-v1-devices-updateprinterclasses-post" } }, "/config/sim/v2/devices/updatePrinterClasses":{ "post":{ "tags":[ "v2/Devices/Print Classes" ], "summary":"Update Print Classes", "description":"Update the Print Class object.", "operationId":"updatePrintClassesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PrintClassCUDRequestv2" } ], "responses":{ "200":{ "description":"Print Class Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the printer", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-devices-updatePrinterClasses-post", "x-filename-id":"config-sim-v2-devices-updateprinterclasses-post" } }, "/config/sim/v1/devices/deletePrinterClasses":{ "post":{ "tags":[ "v1/Devices/Print Classes" ], "summary":"Delete Print Classes", "description":"Deletes the Print Class object.", "operationId":"deletePrintClass", "parameters":[ { "$ref":"#/parameters/body.PrintClasses" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-devices-deletePrinterClasses-post", "x-filename-id":"config-sim-v1-devices-deleteprinterclasses-post" } }, "/config/sim/v2/devices/deletePrinterClasses":{ "post":{ "tags":[ "v2/Devices/Print Classes" ], "summary":"Delete Print Classes", "description":"Deletes the Print Class object.", "operationId":"deletePrintClassv2", "parameters":[ { "$ref":"#/parameters/body.PrintClasses" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-devices-deletePrinterClasses-post", "x-filename-id":"config-sim-v2-devices-deleteprinterclasses-post" } }, "/content/sim/v1/setup/getPrintLogos":{ "post":{ "tags":[ "v1/Setup/Print Logos" ], "summary":"Get Print Logos", "description":"Gets all the Print Logos configured", "operationId":"getPrintLogos", "parameters":[ { "$ref":"#/parameters/body.PrintLogosGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Print Logos.", "schema":{ "$ref":"#/definitions/PrintLogosGetResponsev1" } } }, "x-internal-id":"content-sim-v1-setup-getPrintLogos-post", "x-filename-id":"content-sim-v1-setup-getprintlogos-post" } }, "/content/sim/v2/setup/getPrintLogos":{ "post":{ "tags":[ "v2/Setup/Print Logos" ], "summary":"Get Print Logos", "description":"Gets all the Print Logos configured", "operationId":"getPrintLogosv2", "parameters":[ { "$ref":"#/parameters/body.PrintLogosGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Print Logos.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Print Logo objects of the organization.", "items":{ "$ref":"#/definitions/PrintLogov2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"content-sim-v2-setup-getPrintLogos-post", "x-filename-id":"content-sim-v2-setup-getprintlogos-post" } }, "/content/sim/v1/setup/printLogos":{ "post":{ "tags":[ "v1/Setup/Print Logos" ], "summary":"Add Print Logos", "description":"Add the Print Logos object to a specified hierarchy unit", "operationId":"addPrintLogos", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PrintLogosCURequest" } ], "responses":{ "200":{ "description":"Print Logos Added.", "schema":{ "$ref":"#/definitions/PrintLogosBody" } } }, "x-internal-id":"content-sim-v1-setup-printLogos-post", "x-filename-id":"content-sim-v1-setup-printlogos-post" } }, "/content/sim/v2/setup/printLogos":{ "post":{ "tags":[ "v2/Setup/Print Logos" ], "summary":"Add Print Logos", "description":"Add the Print Logos object to a specified hierarchy unit", "operationId":"addPrintLogosv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PrintLogosCURequestv2" } ], "responses":{ "200":{ "description":"Print Logos Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Print Logos is configured", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object Number of the Print Logos.", "type":"integer", "example":1 } } } } }, "x-internal-id":"content-sim-v2-setup-printLogos-post", "x-filename-id":"content-sim-v2-setup-printlogos-post" } }, "/content/sim/v1/setup/updatePrintLogos":{ "post":{ "tags":[ "v1/Setup/Print Logos" ], "summary":"Update Print Logos", "description":"Updates the Print Logos. If Print Logo is not found, it creates a new Print Logo.", "operationId":"updatePrintLogos", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PrintLogosCURequest" } ], "responses":{ "200":{ "description":"Print Logos Updated or Added.", "schema":{ "$ref":"#/definitions/PrintLogosBody" } } }, "x-internal-id":"content-sim-v1-setup-updatePrintLogos-post", "x-filename-id":"content-sim-v1-setup-updateprintlogos-post" } }, "/content/sim/v2/setup/updatePrintLogos":{ "post":{ "tags":[ "v2/Setup/Print Logos" ], "summary":"Update Print Logos", "description":"Updates the Print Logos.", "operationId":"updatePrintLogosv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PrintLogosCURequestv2" } ], "responses":{ "200":{ "description":"Print Logos Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Print Logos is configured", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object Number of the Print Logos.", "type":"integer", "example":1 } } } } }, "x-internal-id":"content-sim-v2-setup-updatePrintLogos-post", "x-filename-id":"content-sim-v2-setup-updateprintlogos-post" } }, "/content/sim/v1/setup/deletePrintLogos":{ "post":{ "tags":[ "v1/Setup/Print Logos" ], "summary":"Delete Print Logos", "description":"Deletes the Print Logos object.", "operationId":"deletePrintLogos", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PrintLogosDelete" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"content-sim-v1-setup-deletePrintLogos-post", "x-filename-id":"content-sim-v1-setup-deleteprintlogos-post" } }, "/content/sim/v2/setup/deletePrintLogos":{ "post":{ "tags":[ "v2/Setup/Print Logos" ], "summary":"Delete Print Logos", "description":"Deletes the Print Logos object.", "operationId":"deletePrintLogosv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PrintLogosDelete" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"content-sim-v2-setup-deletePrintLogos-post", "x-filename-id":"content-sim-v2-setup-deleteprintlogos-post" } }, "/content/sim/v1/setup/downloadPrintLogos":{ "post":{ "tags":[ "v1/Setup/Print Logos" ], "summary":"Download Print Logos", "description":"Downloads the content file for the specified object in the specified organization.", "operationId":"downloadPrintlogos", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PrintLogosDelete" } ], "responses":{ "200":{ "description":"Download the file as a octet stream", "schema":{ "type":"string", "format":"binary" } } }, "x-internal-id":"content-sim-v1-setup-downloadPrintLogos-post", "x-filename-id":"content-sim-v1-setup-downloadprintlogos-post" } }, "/content/sim/v2/setup/downloadPrintLogos":{ "post":{ "tags":[ "v2/Setup/Print Logos" ], "summary":"Download Print Logos", "description":"Downloads the content file for the specified object in the specified organization.", "operationId":"downloadPrintlogosv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PrintLogosDelete" } ], "responses":{ "200":{ "description":"Download the file as a octet stream", "schema":{ "type":"string", "format":"binary" } } }, "x-internal-id":"content-sim-v2-setup-downloadPrintLogos-post", "x-filename-id":"content-sim-v2-setup-downloadprintlogos-post" } }, "/config/sim/v2/menuItems/getNutrientSets":{ "post":{ "tags":[ "v2/Menu Items/Nutrient Sets/Nutrient Sets" ], "summary":"Get Nutrient Sets", "description":"Gets all the Nutrient Sets", "operationId":"getNutrientSets", "parameters":[ { "$ref":"#/parameters/body.NutrientSetGetParameters" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "description":"Total number of records in the data set", "type":"integer", "example":100 }, "hasMore":{ "description":"Indicates whether there are additional pages of records", "type":"boolean", "example":true }, "count":{ "description":"Number of records returned on this page", "type":"integer", "example":10 }, "offset":{ "description":"The page number of this data. Starts at 0.", "type":"integer", "example":0 }, "limit":{ "description":"The maximum number of records returned on a page", "type":"integer", "example":10 }, "items":{ "description":"Nutrient Set records", "type":"array", "items":{ "$ref":"#/definitions/NutrientSet" } } } } } }, "x-internal-id":"config-sim-v2-menuItems-getNutrientSets-post", "x-filename-id":"config-sim-v2-menuitems-getnutrientsets-post" } }, "/config/sim/v2/menuItems/nutrientSets":{ "post":{ "tags":[ "v2/Menu Items/Nutrient Sets/Nutrient Sets" ], "summary":"Add Nutrient Set", "description":"Adds a nutrient set", "operationId":"createNutrientSet", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.NutrientSetInsertRequest" } ], "responses":{ "200":{ "description":"Nutrient Set inserted.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit. Only Enterprise hierarchy is allowed.", "type":"integer", "example":50 }, "objectNum":{ "description":"Object number of the nutrient set.", "type":"integer", "example":10 } } } } }, "x-internal-id":"config-sim-v2-menuItems-nutrientSets-post", "x-filename-id":"config-sim-v2-menuitems-nutrientsets-post" } }, "/config/sim/v2/menuItems/deleteNutrientSets":{ "post":{ "tags":[ "v2/Menu Items/Nutrient Sets/Nutrient Sets" ], "summary":"Delete Nutrient Set", "description":"Deletes a nutrient set", "operationId":"deleteNutrientSet", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.NutrientSetDeleteRequest" } ], "responses":{ "200":{ "description":"Nutrient Set deleted.", "schema":{ "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteNutrientSets-post", "x-filename-id":"config-sim-v2-menuitems-deletenutrientsets-post" } }, "/config/sim/v2/menuItems/updateNutrientSets":{ "post":{ "tags":[ "v2/Menu Items/Nutrient Sets/Nutrient Sets" ], "summary":"Update Nutrient Set", "description":"Updates an existing nutrient set", "operationId":"updateNutrientSet", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.NutrientSetUpdateRequest" } ], "responses":{ "200":{ "description":"Nutrient Set updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit. Only Enterprise hierarchy is allowed.", "type":"integer", "example":50 }, "objectNum":{ "description":"Object number of the nutrient set.", "type":"integer", "example":10 } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateNutrientSets-post", "x-filename-id":"config-sim-v2-menuitems-updatenutrientsets-post" } }, "/config/sim/v2/setup/cal/getInstallStatus":{ "post":{ "tags":[ "v2/Setup/CAL/CAL Packages Install Status" ], "summary":"Get Install Status", "description":"Get Installation Status of CAL Packages", "operationId":"getCalPackageInstallStatus", "parameters":[ { "$ref":"#/parameters/body.InstallStatusGetRequest" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "description":"Total number of records in the data set", "type":"integer", "example":100 }, "hasMore":{ "description":"Indicates whether there are additional pages of records", "type":"boolean", "example":true }, "count":{ "description":"Number of records returned on this page", "type":"integer", "example":10 }, "offset":{ "description":"The page number of this data. Starts at 0.", "type":"integer", "example":0 }, "limit":{ "description":"The maximum number of records returned on a page", "type":"integer", "example":10 }, "items":{ "description":"CAL Package Install Status records", "type":"array", "items":{ "$ref":"#/definitions/CALPackageInstallStatus" } } } } } }, "x-internal-id":"config-sim-v2-setup-cal-getInstallStatus-post", "x-filename-id":"config-sim-v2-setup-cal-getinstallstatus-post" } }, "/config/sim/v1/devices/getprinters":{ "post":{ "tags":[ "v1/Devices/Printers" ], "summary":"Get Printers", "description":"Gets all the Printers configured", "operationId":"getPrinters", "parameters":[ { "$ref":"#/parameters/body.PrintersGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Printers.", "schema":{ "$ref":"#/definitions/PrintersGetResponsev1" } } }, "x-internal-id":"config-sim-v1-devices-getprinters-post", "x-filename-id":"config-sim-v1-devices-getprinters-post" } }, "/config/sim/v2/devices/getPrinters":{ "post":{ "tags":[ "v2/Devices/Printers" ], "summary":"Get Printers", "description":"Gets all the Printers configured", "operationId":"getPrintersv2", "parameters":[ { "$ref":"#/parameters/body.PrintersGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Printers.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Printer objects of the organization.", "items":{ "$ref":"#/definitions/Printersv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-devices-getPrinters-post", "x-filename-id":"config-sim-v2-devices-getprinters-post" } }, "/config/sim/v1/devices/printers":{ "post":{ "tags":[ "v1/Devices/Printers" ], "summary":"Add Printers", "description":"Adds a printer record for the current organization.", "operationId":"addPrinters", "parameters":[ { "$ref":"#/parameters/body.PrinterCUDRequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Printer Object Added.", "schema":{ "$ref":"#/definitions/PrinterResponse" } } }, "x-internal-id":"config-sim-v1-devices-printers-post", "x-filename-id":"config-sim-v1-devices-printers-post" } }, "/config/sim/v2/devices/printers":{ "post":{ "tags":[ "v2/Devices/Printers" ], "summary":"Add Printers", "description":"Adds a printer record for the current organization.", "operationId":"addPrintersv2", "parameters":[ { "$ref":"#/parameters/body.PrinterCUDRequestv2" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Printer Object Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the printer", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-devices-printers-post", "x-filename-id":"config-sim-v2-devices-printers-post" } }, "/config/sim/v1/devices/updatePrinters":{ "post":{ "tags":[ "v1/Devices/Printers" ], "summary":"Update Printers", "description":"Updates a printer record for the current organization.", "operationId":"updatePrinters", "parameters":[ { "$ref":"#/parameters/body.PrinterCUDRequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Printer Object Updated or Added.", "schema":{ "$ref":"#/definitions/PrinterResponse" } } }, "x-internal-id":"config-sim-v1-devices-updatePrinters-post", "x-filename-id":"config-sim-v1-devices-updateprinters-post" } }, "/config/sim/v2/devices/updatePrinters":{ "post":{ "tags":[ "v2/Devices/Printers" ], "summary":"Update Printers", "description":"Updates a printer record for the current organization.", "operationId":"updatePrintersv2", "parameters":[ { "$ref":"#/parameters/body.PrinterCUDRequestv2" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Printer Object Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the printer", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-devices-updatePrinters-post", "x-filename-id":"config-sim-v2-devices-updateprinters-post" } }, "/config/sim/v1/devices/deletePrinters":{ "post":{ "tags":[ "v1/Devices/Printers" ], "summary":"Delete Printers", "description":"Deletes a printer record for the current organization.", "operationId":"deletePrinters", "parameters":[ { "$ref":"#/parameters/body.PrinterResponse" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-devices-deletePrinters-post", "x-filename-id":"config-sim-v1-devices-deleteprinters-post" } }, "/config/sim/v2/devices/deletePrinters":{ "post":{ "tags":[ "v2/Devices/Printers" ], "summary":"Delete Printers", "description":"Deletes a printer record for the current organization.", "operationId":"deletePrintersv2", "parameters":[ { "$ref":"#/parameters/body.PrinterResponse" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-devices-deletePrinters-post", "x-filename-id":"config-sim-v2-devices-deleteprinters-post" } }, "/config/sim/v1/getReleaseVersions":{ "post":{ "tags":[ "v1/Other/Release Versions" ], "summary":"Get version information", "description":"Gets the Simphony Enterprise version number and the Configuration and Content API version number", "operationId":"getReleaseVersions", "parameters":[ { "$ref":"#/parameters/body.VersionInformationGetParametersv1" } ], "responses":{ "200":{ "description":"Gets the component version information.", "schema":{ "$ref":"#/definitions/VersionInformation" } } }, "x-internal-id":"config-sim-v1-getReleaseVersions-post", "x-filename-id":"config-sim-v1-getreleaseversions-post" } }, "/config/sim/v2/getReleaseVersions":{ "post":{ "tags":[ "v2/Other/Release Versions" ], "summary":"Get version information", "description":"Gets the Simphony Enterprise version number and the Configuration and Content API version number", "operationId":"getReleaseVersionsv2", "parameters":[ { "$ref":"#/parameters/body.VersionInformationGetParametersv2" } ], "responses":{ "200":{ "description":"Gets the component version information.", "schema":{ "description":"Model for Version Information", "type":"object", "properties":{ "simphonyEnterpriseVersion":{ "description":"Installed Simphony Enterprise Version", "type":"string", "example":"19.4.1.0.49" }, "C&CVersion":{ "description":"Configuration & Content API Cloud Service Release Version", "type":"string", "example":"23.2.0.0" } } } } }, "x-internal-id":"config-sim-v2-getReleaseVersions-post", "x-filename-id":"config-sim-v2-getreleaseversions-post" } }, "/config/sim/v1/hierarchy/locations/getEnterpriseLevels":{ "post":{ "tags":[ "v1/Hierarchy/Locations/Parent Enterprise Levels" ], "summary":"Get Enterprise Levels", "description":"Gets available enterprise levels of the organization.", "operationId":"getEnterpriseLevels", "parameters":[ { "$ref":"#/parameters/body.ParentEnterpriseLevelsGetParameters" } ], "responses":{ "200":{ "description":"A Collection of Parent Enterprise Levels.", "schema":{ "$ref":"#/definitions/GetEnterpriseLevelsResponse" } } }, "x-internal-id":"config-sim-v1-hierarchy-locations-getEnterpriseLevels-post", "x-filename-id":"config-sim-v1-hierarchy-locations-getenterpriselevels-post" } }, "/config/sim/v2/hierarchy/locations/getEnterpriseLevels":{ "post":{ "tags":[ "v2/Hierarchy/Locations/Parent Enterprise Levels" ], "summary":"Get Enterprise Levels", "description":"Gets available enterprise levels of the organization.", "operationId":"getEnterpriseLevelsv2", "parameters":[ { "$ref":"#/parameters/body.ParentEnterpriseLevelsGetParameters" } ], "responses":{ "200":{ "description":"A Collection of Parent Enterprise Levels.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":1, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":false, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Enterprise Levels.", "items":{ "$ref":"#/definitions/EnterpriseLevels" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-locations-getEnterpriseLevels-post", "x-filename-id":"config-sim-v2-hierarchy-locations-getenterpriselevels-post" } }, "/config/sim/v1/devices/workstations/getDevices":{ "post":{ "tags":[ "v1/Devices/Workstation Devices" ], "summary":"Get Workstation Devices", "description":"Gets all the Workstation Device configured for the specified organization", "operationId":"getWorkstationDevices", "parameters":[ { "$ref":"#/parameters/body.WorkstationDeviceGetRequest" } ], "responses":{ "200":{ "description":"A collection of Workstation Devices.", "schema":{ "$ref":"#/definitions/WorkstationDeviceGetResponsev1" } } }, "x-internal-id":"config-sim-v1-devices-workstations-getDevices-post", "x-filename-id":"config-sim-v1-devices-workstations-getdevices-post" } }, "/config/sim/v2/devices/workstations/getDevices":{ "post":{ "tags":[ "v2/Devices/Workstation Devices" ], "summary":"Get Workstation Devices", "description":"Gets all the Workstation Device configured for the specified organization", "operationId":"getWorkstationDevicesv2", "parameters":[ { "$ref":"#/parameters/body.WorkstationDeviceGetRequestv2" } ], "responses":{ "200":{ "description":"A collection of Workstation Devices.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Workstation Device objects of the organization.", "items":{ "$ref":"#/definitions/WorkstationDevicev2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-devices-workstations-getDevices-post", "x-filename-id":"config-sim-v2-devices-workstations-getdevices-post" } }, "/config/sim/v1/devices/workstations/devices":{ "post":{ "tags":[ "v1/Devices/Workstation Devices" ], "summary":"Add Workstation Devices", "description":"Add a Workstation Device record for the current organization.", "operationId":"addWorkstationDevices", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.WorkstationDeviceCUDRequest" } ], "responses":{ "200":{ "description":"Workstation Device Added.", "schema":{ "$ref":"#/definitions/WorkstationDeviceResponse" } } }, "x-internal-id":"config-sim-v1-devices-workstations-devices-post", "x-filename-id":"config-sim-v1-devices-workstations-devices-post" } }, "/config/sim/v2/devices/workstations/devices":{ "post":{ "tags":[ "v2/Devices/Workstation Devices" ], "summary":"Add Workstation Devices", "description":"Add a Workstation Device record for the current organization.", "operationId":"addWorkstationDevicesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.WorkstationDeviceCUDRequest" } ], "responses":{ "200":{ "description":"Workstation Device Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the workstation", "type":"integer", "example":1 }, "deviceNum":{ "description":"The sequence number of the device", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-devices-workstations-devices-post", "x-filename-id":"config-sim-v2-devices-workstations-devices-post" } }, "/config/sim/v1/devices/workstations/updateDevices":{ "post":{ "tags":[ "v1/Devices/Workstation Devices" ], "summary":"Update Workstation Devices", "description":"Updates a Workstation Device record for the current organization.", "operationId":"updateWorkstationDevices", "parameters":[ { "$ref":"#/parameters/body.WorkstationDeviceCUDRequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Workstation Device Updated or Added.", "schema":{ "$ref":"#/definitions/WorkstationDeviceResponse" } } }, "x-internal-id":"config-sim-v1-devices-workstations-updateDevices-post", "x-filename-id":"config-sim-v1-devices-workstations-updatedevices-post" } }, "/config/sim/v2/devices/workstations/updateDevices":{ "post":{ "tags":[ "v2/Devices/Workstation Devices" ], "summary":"Update Workstation Devices", "description":"Updates a Workstation Device record for the current organization.", "operationId":"updateWorkstationDevicesv2", "parameters":[ { "$ref":"#/parameters/body.WorkstationDeviceCUDRequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Workstation Device Updated .", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the workstation", "type":"integer", "example":1 }, "deviceNum":{ "description":"The sequence number of the device", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-devices-workstations-updateDevices-post", "x-filename-id":"config-sim-v2-devices-workstations-updatedevices-post" } }, "/config/sim/v1/devices/workstations/deleteDevices":{ "post":{ "tags":[ "v1/Devices/Workstation Devices" ], "summary":"Delete Workstation Devices", "description":"Deletes the Workstation Device object.", "operationId":"deleteWorkstationDevices", "parameters":[ { "$ref":"#/parameters/body.WorkstationDeviceResponse" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-devices-workstations-deleteDevices-post", "x-filename-id":"config-sim-v1-devices-workstations-deletedevices-post" } }, "/config/sim/v2/devices/workstations/deleteDevices":{ "post":{ "tags":[ "v2/Devices/Workstation Devices" ], "summary":"Delete Workstation Devices", "description":"Deletes the Workstation Device object.", "operationId":"deleteWorkstationDevicesv2", "parameters":[ { "$ref":"#/parameters/body.WorkstationDeviceResponse" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-devices-workstations-deleteDevices-post", "x-filename-id":"config-sim-v2-devices-workstations-deletedevices-post" } }, "/config/sim/v1/setup/getOrderTypeParameters":{ "post":{ "tags":[ "v1/Setup/Order Types/Order Type Parameters" ], "summary":"Get Order Types Parameters", "description":"Gets all the Order Type Parameters", "operationId":"getOrderTypeParameters", "parameters":[ { "$ref":"#/parameters/body.OrderTypeParametersGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Order Type Parameters.", "schema":{ "$ref":"#/definitions/OrderTypeParametersGetResponse" } } }, "x-internal-id":"config-sim-v1-setup-getOrderTypeParameters-post", "x-filename-id":"config-sim-v1-setup-getordertypeparameters-post" } }, "/config/sim/v2/setup/getOrderTypeParameters":{ "post":{ "tags":[ "v2/Setup/Order Types/Order Type Parameters" ], "summary":"Get Order Types Parameters", "description":"Gets all the Order Type Parameters", "operationId":"getOrderTypeParametersv2", "parameters":[ { "$ref":"#/parameters/body.OrderTypeParametersGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Order Type Parameters", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Order Type Parameters objects of the organization.", "items":{ "$ref":"#/definitions/OrderTypeParametersv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getOrderTypeParameters-post", "x-filename-id":"config-sim-v2-setup-getordertypeparameters-post" } }, "/config/sim/v1/setup/orderTypeParameters":{ "post":{ "tags":[ "v1/Setup/Order Types/Order Type Parameters" ], "summary":"Add Order Type Parameters", "description":"Add the Order Type Parameter.", "operationId":"addOrderTypeParameters", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderTypeParameterCUDRequest" } ], "responses":{ "200":{ "description":"Order Type Parameter Added.", "schema":{ "$ref":"#/definitions/OrderTypeParameterResponse" } } }, "x-internal-id":"config-sim-v1-setup-orderTypeParameters-post", "x-filename-id":"config-sim-v1-setup-ordertypeparameters-post" } }, "/config/sim/v2/setup/orderTypeParameters":{ "post":{ "tags":[ "v2/Setup/Order Types/Order Type Parameters" ], "summary":"Add Order Type Parameters", "description":"Add the Order Type Parameter.", "operationId":"addOrderTypeParametersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderTypeParameterCUDRequestv2" } ], "responses":{ "200":{ "description":"Order Type Parameter Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the Order Type Parameter" } } } } }, "x-internal-id":"config-sim-v2-setup-orderTypeParameters-post", "x-filename-id":"config-sim-v2-setup-ordertypeparameters-post" } }, "/config/sim/v1/setup/updateOrderTypeParameters":{ "post":{ "tags":[ "v1/Setup/Order Types/Order Type Parameters" ], "summary":"Update Order Type Parameters", "description":"Updates the Order Type Parameter. If Order Type Parameter is not found, it creates a new Order Type Parameter.", "operationId":"updateOrderTypeParameters", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderTypeParameterCUDRequest" } ], "responses":{ "200":{ "description":"Order Type Parameter Updated or Added.", "schema":{ "$ref":"#/definitions/OrderTypeParameterResponse" } } }, "x-internal-id":"config-sim-v1-setup-updateOrderTypeParameters-post", "x-filename-id":"config-sim-v1-setup-updateordertypeparameters-post" } }, "/config/sim/v2/setup/updateOrderTypeParameters":{ "post":{ "tags":[ "v2/Setup/Order Types/Order Type Parameters" ], "summary":"Update Order Type Parameters", "description":"Updates the Order Type Parameter.", "operationId":"updateOrderTypeParametersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderTypeParameterCUDRequestv2" } ], "responses":{ "200":{ "description":"Order Type Parameter Updated.", "schema":{ "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the Order Type Parameter" } } } } }, "x-internal-id":"config-sim-v2-setup-updateOrderTypeParameters-post", "x-filename-id":"config-sim-v2-setup-updateordertypeparameters-post" } }, "/config/sim/v1/setup/deleteOrderTypeParameters":{ "post":{ "tags":[ "v1/Setup/Order Types/Order Type Parameters" ], "summary":"Delete Order Type Parameters", "description":"Deletes the Order Type Parameter object.", "operationId":"deleteOrderTypeParameters", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderTypeParamterDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/OrderTypeParameterDeleteResponse" } } }, "x-internal-id":"config-sim-v1-setup-deleteOrderTypeParameters-post", "x-filename-id":"config-sim-v1-setup-deleteordertypeparameters-post" } }, "/config/sim/v2/setup/deleteOrderTypeParameters":{ "post":{ "tags":[ "v2/Setup/Order Types/Order Type Parameters" ], "summary":"Delete Order Type Parameters", "description":"Deletes the Order Type Parameter object.", "operationId":"deleteOrderTypeParametersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderTypeParamterDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteOrderTypeParameters-post", "x-filename-id":"config-sim-v2-setup-deleteordertypeparameters-post" } }, "/content/sim/v2/setup/languages/getTextFileConfigurations":{ "post":{ "tags":[ "v2/Setup/Languages/Text File Configurations" ], "summary":"Get Text File Configurations", "description":"Gets all the Text File Configurations", "operationId":"getTextFileConfigurations", "parameters":[ { "$ref":"#/parameters/body.TextFileConfigurationsGetParameters" } ], "responses":{ "200":{ "description":"A collection of Text File Configurations.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Text File Configurations.", "items":{ "$ref":"#/definitions/TextFileConfiguration" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":100, "description":"Server page size" } } } } }, "x-internal-id":"content-sim-v2-setup-languages-getTextFileConfigurations-post", "x-filename-id":"content-sim-v2-setup-languages-gettextfileconfigurations-post" } }, "/content/sim/v2/setup/languages/textFileConfigurations":{ "post":{ "tags":[ "v2/Setup/Languages/Text File Configurations" ], "summary":"Add Text File Configurations", "description":"Adds the Text File Configuration.", "operationId":"addTextFileConfigurations", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TextFileConfigurationInsertRequest" } ], "responses":{ "200":{ "description":"Text File Configuration Added.", "schema":{ "type":"object", "properties":{ "langId":{ "description":"Unique identifier of the language.", "type":"integer", "example":1 }, "baseFileName":{ "description":"Base File Name of the Text File Configuration.", "type":"string", "example":"Micros.Payment.Cash" }, "fileType":{ "description":"File Type of the Text File Configuration.", "type":"integer", "example":3 } } } } }, "x-internal-id":"content-sim-v2-setup-languages-textFileConfigurations-post", "x-filename-id":"content-sim-v2-setup-languages-textfileconfigurations-post" } }, "/content/sim/v2/setup/languages/updateTextFileConfigurations":{ "post":{ "tags":[ "v2/Setup/Languages/Text File Configurations" ], "summary":"Update Text File Configurations", "description":"Updates the Text File Configuration.", "operationId":"updateTextFileConfigurations", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TextFileConfigurationUpdateRequest" } ], "responses":{ "200":{ "description":"Text File Configuration Updated.", "schema":{ "type":"object", "properties":{ "langId":{ "description":"Unique identifier of the language.", "type":"integer", "example":1 }, "baseFileName":{ "description":"Base File Name of the Text File Configuration.", "type":"string", "example":"Micros.Payment.Cash" } } } } }, "x-internal-id":"content-sim-v2-setup-languages-updateTextFileConfigurations-post", "x-filename-id":"content-sim-v2-setup-languages-updatetextfileconfigurations-post" } }, "/content/sim/v2/setup/languages/deleteTextFileConfigurations":{ "post":{ "tags":[ "v2/Setup/Languages/Text File Configurations" ], "summary":"Delete Text File Configuration", "description":"Deletes the Text File Configuration.", "operationId":"deleteTextFileConfigurations", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TextFileConfigurationDeleteDownloadRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"content-sim-v2-setup-languages-deleteTextFileConfigurations-post", "x-filename-id":"content-sim-v2-setup-languages-deletetextfileconfigurations-post" } }, "/content/sim/v2/setup/languages/downloadTextFileConfigurations":{ "post":{ "tags":[ "v2/Setup/Languages/Text File Configurations" ], "summary":"Download Text File Configuration", "description":"Downloads the Text File.", "operationId":"downloadTextFileConfigurations", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TextFileConfigurationDeleteDownloadRequest" } ], "responses":{ "200":{ "description":"Text File downloaded", "schema":{ "type":"string", "format":"binary" } } }, "x-internal-id":"content-sim-v2-setup-languages-downloadTextFileConfigurations-post", "x-filename-id":"content-sim-v2-setup-languages-downloadtextfileconfigurations-post" } }, "/config/sim/v1/setup/getorderchannelparameters":{ "post":{ "tags":[ "v1/Setup/Order Channels/Order Channel Parameters" ], "summary":"Get Order Channel Parameters", "description":"Gets all the Order Channel Parameters", "operationId":"getOrderChannelParameters", "parameters":[ { "$ref":"#/parameters/body.OrderChannelParametersGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Order Channel Parameters.", "schema":{ "$ref":"#/definitions/OrderChannelParametersGetResponse" } } }, "x-internal-id":"config-sim-v1-setup-getorderchannelparameters-post", "x-filename-id":"config-sim-v1-setup-getorderchannelparameters-post" } }, "/config/sim/v2/setup/getOrderChannelParameters":{ "post":{ "tags":[ "v2/Setup/Order Channels/Order Channel Parameters" ], "summary":"Get Order Channel Parameters", "description":"Gets all the Order Channel Parameters", "operationId":"getOrderChannelParametersv2", "parameters":[ { "$ref":"#/parameters/body.OrderChannelParametersGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Order Channel Parameters.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Order Channel Parameter objects of the organization.", "items":{ "$ref":"#/definitions/OrderChannelParametersv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getOrderChannelParameters-post", "x-filename-id":"config-sim-v2-setup-getorderchannelparameters-post" } }, "/config/sim/v1/setup/orderchannelparameters":{ "post":{ "tags":[ "v1/Setup/Order Channels/Order Channel Parameters" ], "summary":"Add Order Channel Parameters", "description":"Add the Order Channel Parameter object to a specified hierarchy unit.", "operationId":"createOrderChannelParameters", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderChannelParametersCURequestBody" } ], "responses":{ "200":{ "description":"Order channel parameters Added.", "schema":{ "$ref":"#/definitions/OrderChannelParameterCUResponse" } } }, "x-internal-id":"config-sim-v1-setup-orderchannelparameters-post", "x-filename-id":"config-sim-v1-setup-orderchannelparameters-post" } }, "/config/sim/v2/setup/orderChannelParameters":{ "post":{ "tags":[ "v2/Setup/Order Channels/Order Channel Parameters" ], "summary":"Add Order Channel Parameters", "description":"Add the Order Channel Parameter object to a specified hierarchy unit.", "operationId":"createOrderChannelParametersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderChannelParametersCURequestBodyv2" } ], "responses":{ "200":{ "description":"Order channel parameters Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Order Channel Parameter" } } } } }, "x-internal-id":"config-sim-v2-setup-orderChannelParameters-post", "x-filename-id":"config-sim-v2-setup-orderchannelparameters-post" } }, "/config/sim/v1/setup/updateorderchannelparameters":{ "post":{ "tags":[ "v1/Setup/Order Channels/Order Channel Parameters" ], "summary":"Update Order Channel Parameters", "description":"Updates the Order Channel Parameter. If Order Channel Parameter is not found, it creates a new Order Channel Parameter.", "operationId":"updateOrderChannelParameters", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderChannelParametersCURequestBody" } ], "responses":{ "200":{ "description":"Order channel parameters Updated or Added.", "schema":{ "$ref":"#/definitions/OrderChannelParameterCUResponse" } } }, "x-internal-id":"config-sim-v1-setup-updateorderchannelparameters-post", "x-filename-id":"config-sim-v1-setup-updateorderchannelparameters-post" } }, "/config/sim/v2/setup/updateOrderChannelParameters":{ "post":{ "tags":[ "v2/Setup/Order Channels/Order Channel Parameters" ], "summary":"Update Order Channel Parameters", "description":"Updates the Order Channel Parameter.", "operationId":"updateOrderChannelParametersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderChannelParametersCURequestBodyv2" } ], "responses":{ "200":{ "description":"Order channel parameters Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Order Channel Parameter" } } } } }, "x-internal-id":"config-sim-v2-setup-updateOrderChannelParameters-post", "x-filename-id":"config-sim-v2-setup-updateorderchannelparameters-post" } }, "/config/sim/v1/setup/deleteorderchannelparameters":{ "post":{ "tags":[ "v1/Setup/Order Channels/Order Channel Parameters" ], "summary":"Delete Order Channel Parameters", "description":"Deletes the Order Channel Parameters.", "operationId":"deleteOrderChannelParameters", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderChannelParamterDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/OrderChannelParameterDeleteResponse" } } }, "x-internal-id":"config-sim-v1-setup-deleteorderchannelparameters-post", "x-filename-id":"config-sim-v1-setup-deleteorderchannelparameters-post" } }, "/config/sim/v2/setup/deleteOrderChannelParameters":{ "post":{ "tags":[ "v2/Setup/Order Channels/Order Channel Parameters" ], "summary":"Delete Order Channel Parameters", "description":"Deletes the Order Channel Parameters.", "operationId":"deleteOrderChannelParametersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderChannelParamterDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted", "description":"A message depicting the number of records deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteOrderChannelParameters-post", "x-filename-id":"config-sim-v2-setup-deleteorderchannelparameters-post" } }, "/config/sim/v1/menuItems/menuitemdefinition/getdefaultcondiments":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Definitions/Menu Item Definition Default Condiments" ], "summary":"Get Menu Item Definition Default Condiments", "description":"Get all the default condiments for the menu item definition of a hierarchy unit of the specified organization", "operationId":"getDefaultCondiments", "parameters":[ { "$ref":"#/parameters/body.MenuItemDefinitionDefaultCondimentGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Menu Item definition default condiments.", "schema":{ "$ref":"#/definitions/defaultcondimentGetResponsev1" } } }, "x-internal-id":"config-sim-v1-menuItems-menuitemdefinition-getdefaultcondiments-post", "x-filename-id":"config-sim-v1-menuitems-menuitemdefinition-getdefaultcondiments-post" } }, "/config/sim/v2/menuItems/menuItemDefinition/getDefaultCondiments":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Definitions/Menu Item Definition Default Condiments" ], "summary":"Get Menu Item Definition Default Condiments", "description":"Get all the default condiments for the menu item definition of a hierarchy unit of the specified organization", "operationId":"getDefaultCondimentsv2", "parameters":[ { "$ref":"#/parameters/body.MenuItemDefinitionDefaultCondimentGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Menu Item Definition Default Condiments.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of default condiment objects of the organization.", "items":{ "$ref":"#/definitions/MenuItemDefinitionDefaultCondimentv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemDefinition-getDefaultCondiments-post", "x-filename-id":"config-sim-v2-menuitems-menuitemdefinition-getdefaultcondiments-post" } }, "/config/sim/v1/menuItems/menuitemdefinition/defaultcondiments":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Definitions/Menu Item Definition Default Condiments" ], "summary":"Insert Menu Item Definition Default Condiments", "description":"Add a default condiment to a specified menu item definition to a specified hierarchy unit .", "operationId":"insertDefaultCondiments", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.defaultcondimentInsertRequestBody" } ], "responses":{ "200":{ "description":"Menu Item Definition Default Condiment Added.", "schema":{ "$ref":"#/definitions/DefaultCondimentResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-menuitemdefinition-defaultcondiments-post", "x-filename-id":"config-sim-v1-menuitems-menuitemdefinition-defaultcondiments-post" } }, "/config/sim/v2/menuItems/menuItemDefinition/defaultCondiments":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Definitions/Menu Item Definition Default Condiments" ], "summary":"Insert Menu Item Definition Default Condiments", "description":"Add a default condiment to a specified menu item definition to a specified hierarchy unit .", "operationId":"insertDefaultCondimentsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.defaultcondimentInsertRequestBody" } ], "responses":{ "200":{ "description":"Menu Item Definition Default Condiment Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "miMstrObjNum":{ "type":"integer", "example":1, "description":"Object Number of the menu item master for which the condiments are associated." }, "miDefSequence":{ "type":"integer", "example":1, "description":"Sequence number of the menu item definition to which the condiments are associated" }, "menuItemDefaultCondimentId":{ "type":"integer", "example":1000, "description":"Unique reference of the Menu Item Default Condiment" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemDefinition-defaultCondiments-post", "x-filename-id":"config-sim-v2-menuitems-menuitemdefinition-defaultcondiments-post" } }, "/config/sim/v1/menuItems/menuitemdefinition/updatedefaultcondiments":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Definitions/Menu Item Definition Default Condiments" ], "summary":"Update Menu Item Definition Default Condiments", "description":"Updates the default condiments. If default condiments is not found, it creates a new default condiment.", "operationId":"updateDefaultCondiments", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.defaultcondimentUpdateRequestBody" } ], "responses":{ "200":{ "description":"Menu Item Definition Default Condiment Updated or Added.", "schema":{ "$ref":"#/definitions/DefaultCondimentResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-menuitemdefinition-updatedefaultcondiments-post", "x-filename-id":"config-sim-v1-menuitems-menuitemdefinition-updatedefaultcondiments-post" } }, "/config/sim/v2/menuItems/menuItemDefinition/updateDefaultCondiments":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Definitions/Menu Item Definition Default Condiments" ], "summary":"Update Menu Item Definition Default Condiments", "description":"Updates the default condiments.", "operationId":"updateDefaultCondimentsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.defaultcondimentUpdateRequestBody" } ], "responses":{ "200":{ "description":"Menu Item Definition Default Condiment Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "miMstrObjNum":{ "type":"integer", "example":1, "description":"Object Number of the menu item master for which the condiments are associated." }, "miDefSequence":{ "type":"integer", "example":1, "description":"Sequence number of the menu item definition to which the condiments are associated" }, "menuItemDefaultCondimentId":{ "type":"integer", "example":1000, "description":"Unique reference of the Menu Item Default Condiment" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemDefinition-updateDefaultCondiments-post", "x-filename-id":"config-sim-v2-menuitems-menuitemdefinition-updatedefaultcondiments-post" } }, "/config/sim/v1/menuItems/menuitemdefinition/deletedefaultcondiments":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Definitions/Menu Item Definition Default Condiments" ], "summary":"Delete Menu Item Definition Default Condiments", "description":"Deletes the default condiments object.", "operationId":"deleteDefaultCondiments", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DefaultCondimentDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "$ref":"#/definitions/DefaultCondimentDeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-menuitemdefinition-deletedefaultcondiments-post", "x-filename-id":"config-sim-v1-menuitems-menuitemdefinition-deletedefaultcondiments-post" } }, "/config/sim/v2/menuItems/menuItemDefinition/deleteDefaultCondiments":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Definitions/Menu Item Definition Default Condiments" ], "summary":"Delete Menu Item Definition Default Condiments", "description":"Deletes the default condiments object.", "operationId":"deleteDefaultCondimentsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DefaultCondimentDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemDefinition-deleteDefaultCondiments-post", "x-filename-id":"config-sim-v2-menuitems-menuitemdefinition-deletedefaultcondiments-post" } }, "/config/sim/v1/menuItems/menuItemGroups/details":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Groups/Menu Item Group Details" ], "summary":"Add Menu Item Group Details", "description":"Add Menu Item Group Details", "operationId":"addMenuItemGroupDetails", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemGroupDetailCURequestBody" } ], "responses":{ "200":{ "description":"Menu Item Group Details Added.", "schema":{ "$ref":"#/definitions/MenuItemGroupDetailResponsev1" } } }, "x-internal-id":"config-sim-v1-menuItems-menuItemGroups-details-post", "x-filename-id":"config-sim-v1-menuitems-menuitemgroups-details-post" } }, "/config/sim/v2/menuItems/menuItemGroups/details":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Groups/Menu Item Group Details" ], "summary":"Add Menu Item Group Details", "description":"Add Menu Item Group Details", "operationId":"addMenuItemGroupDetailsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemGroupDetailCURequestBody" } ], "responses":{ "200":{ "description":"Menu Item Group Details Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "menuItemGroupObjNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "seq":{ "type":"integer", "example":1, "description":"Sequence number of the Menu Item Group Detail entry. Value must lie between 1 and 32767." }, "exclude":{ "type":"boolean", "example":false, "description":"Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not active" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemGroups-details-post", "x-filename-id":"config-sim-v2-menuitems-menuitemgroups-details-post" } }, "/config/sim/v1/menuItems/MenuItemGroups/deleteDetails":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Groups/Menu Item Group Details" ], "summary":"Delete Menu Item Group Details", "description":"Delete Menu Item Group Details", "operationId":"deleteMenuItemGroupDetails", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemGroupDetailDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "$ref":"#/definitions/DeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-MenuItemGroups-deleteDetails-post", "x-filename-id":"config-sim-v1-menuitems-menuitemgroups-deletedetails-post" } }, "/config/sim/v2/menuItems/menuItemGroups/deleteDetails":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Groups/Menu Item Group Details" ], "summary":"Delete Menu Item Group Details", "description":"Delete Menu Item Group Details", "operationId":"deleteMenuItemGroupDetailsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemGroupDetailDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemGroups-deleteDetails-post", "x-filename-id":"config-sim-v2-menuitems-menuitemgroups-deletedetails-post" } }, "/config/sim/v1/menuItems/MenuItemGroups/getDetails":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Groups/Menu Item Group Details" ], "summary":"Get Menu Item Group Details", "description":"Get Menu Item Group Details", "operationId":"getMenuItemGroupDetails", "parameters":[ { "$ref":"#/parameters/body.MenuItemGroupDetailsGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Menu Item Group Details.", "schema":{ "$ref":"#/definitions/MenuItemGroupDetailGetResponsev1" } } }, "x-internal-id":"config-sim-v1-menuItems-MenuItemGroups-getDetails-post", "x-filename-id":"config-sim-v1-menuitems-menuitemgroups-getdetails-post" } }, "/config/sim/v2/menuItems/menuItemGroups/getDetails":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Groups/Menu Item Group Details" ], "summary":"Get Menu Item Group Details", "description":"Get Menu Item Group Details", "operationId":"getMenuItemGroupDetailsv2", "parameters":[ { "$ref":"#/parameters/body.MenuItemGroupDetailsGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Menu Item Group Details.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Group Detail objects of the organization.", "items":{ "$ref":"#/definitions/MenuItemGroupDetailResponsev2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemGroups-getDetails-post", "x-filename-id":"config-sim-v2-menuitems-menuitemgroups-getdetails-post" } }, "/config/sim/v1/menuItems/MenuItemGroups/updateDetails":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Groups/Menu Item Group Details" ], "summary":"Update Menu Item Group Details", "description":"Update Menu Item Group Details. If not found, it creates a new Menu Item Group Detail.", "operationId":"updateMenuItemGroupDetails", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemGroupDetailCURequestBody" } ], "responses":{ "200":{ "description":"Menu Item Group Details Updated or Added.", "schema":{ "$ref":"#/definitions/MenuItemGroupDetailUpdateResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-MenuItemGroups-updateDetails-post", "x-filename-id":"config-sim-v1-menuitems-menuitemgroups-updatedetails-post" } }, "/config/sim/v2/menuItems/menuItemGroups/updateDetails":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Groups/Menu Item Group Details" ], "summary":"Update Menu Item Group Details", "description":"Update Menu Item Group Details", "operationId":"updateMenuItemGroupDetailsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemGroupDetailCURequestBody" } ], "responses":{ "200":{ "description":"Menu Item Group Details Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "menuItemGroupObjNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "seq":{ "type":"integer", "example":1, "description":"Sequence number of the Menu Item Group Detail entry. Value must lie between 1 and 32767." }, "exclude":{ "type":"boolean", "example":false, "description":"Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not active" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemGroups-updateDetails-post", "x-filename-id":"config-sim-v2-menuitems-menuitemgroups-updatedetails-post" } }, "/config/sim/v1/menuItems/MenuItemGroups/bulkInsertDetails":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Groups/Menu Item Group Details" ], "summary":"Bulk Insert Menu Item Group Details", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertMenuItemGroupDetails", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertMenuItemGroupDetailRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v1-menuItems-MenuItemGroups-bulkInsertDetails-post", "x-filename-id":"config-sim-v1-menuitems-menuitemgroups-bulkinsertdetails-post" } }, "/config/sim/v2/menuItems/menuItemGroups/bulkInsertDetails":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Groups/Menu Item Group Details" ], "summary":"Bulk Insert Menu Item Group Details", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertMenuItemGroupDetailsv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertMenuItemGroupDetailRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemGroups-bulkInsertDetails-post", "x-filename-id":"config-sim-v2-menuitems-menuitemgroups-bulkinsertdetails-post" } }, "/config/sim/v2/menuItems/menuItemGroups/bulkUpdateDetails":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Groups/Menu Item Group Details" ], "summary":"Bulk Update Menu Item Group Details", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkUpdateMenuItemGroupDetailsV2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkUpdateMenuItemGroupDetailRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemGroups-bulkUpdateDetails-post", "x-filename-id":"config-sim-v2-menuitems-menuitemgroups-bulkupdatedetails-post" } }, "/config/sim/v1/setup/getcurrencyconversion":{ "post":{ "tags":[ "v1/Setup/Currency Conversions" ], "summary":"Get currency conversions", "description":"Gets all the currency conversions for the specified organization.", "operationId":"getCurrencyConversions", "parameters":[ { "$ref":"#/parameters/body.CurrencyConversionGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Currency Conversion objects", "schema":{ "$ref":"#/definitions/CurrencyConversionGetResponsev1" } } }, "x-internal-id":"config-sim-v1-setup-getcurrencyconversion-post", "x-filename-id":"config-sim-v1-setup-getcurrencyconversion-post" } }, "/config/sim/v2/setup/getCurrencyConversion":{ "post":{ "tags":[ "v2/Setup/Currency Conversions" ], "summary":"Get currency conversions", "description":"Gets all the currency conversions for the specified organization.", "operationId":"getCurrencyConversionsv2", "parameters":[ { "$ref":"#/parameters/body.CurrencyConversionGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Currency Conversion objects", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Currency Conversion objects of the organization.", "items":{ "$ref":"#/definitions/CurrencyConversionv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getCurrencyConversion-post", "x-filename-id":"config-sim-v2-setup-getcurrencyconversion-post" } }, "/config/sim/v1/setup/currencyconversion":{ "post":{ "tags":[ "v1/Setup/Currency Conversions" ], "summary":"Add Currency Conversion", "description":"Add the Currency Conversion to the specified organization.", "operationId":"addCurrencyConversions", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUDCurrencyConversionRequest" } ], "responses":{ "200":{ "description":"Currency Conversion object Added.", "schema":{ "$ref":"#/definitions/DeleteRequestBody" } } }, "x-internal-id":"config-sim-v1-setup-currencyconversion-post", "x-filename-id":"config-sim-v1-setup-currencyconversion-post" } }, "/config/sim/v2/setup/currencyConversion":{ "post":{ "tags":[ "v2/Setup/Currency Conversions" ], "summary":"Add Currency Conversion", "description":"Add the Currency Conversion to the specified organization.", "operationId":"addCurrencyConversionsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUDCurrencyConversionRequest" } ], "responses":{ "200":{ "description":"Currency Conversion object Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Currency Conversion", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-currencyConversion-post", "x-filename-id":"config-sim-v2-setup-currencyconversion-post" } }, "/config/sim/v1/setup/updatecurrencyconversion":{ "post":{ "tags":[ "v1/Setup/Currency Conversions" ], "summary":"Update currency conversion", "description":"Updates the currency conversion for the specified organization. If the currency conversion is not found, it creates a new currency conversion.", "operationId":"updateCurrencyConversions", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUDCurrencyConversionRequest" } ], "responses":{ "200":{ "description":"Currency Conversion object Updated or Added .", "schema":{ "$ref":"#/definitions/DeleteRequestBody" } } }, "x-internal-id":"config-sim-v1-setup-updatecurrencyconversion-post", "x-filename-id":"config-sim-v1-setup-updatecurrencyconversion-post" } }, "/config/sim/v2/setup/updateCurrencyConversion":{ "post":{ "tags":[ "v2/Setup/Currency Conversions" ], "summary":"Update currency conversion", "description":"Updates the currency conversion for the specified organization.", "operationId":"updateCurrencyConversionsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUDCurrencyConversionRequest" } ], "responses":{ "200":{ "description":"Currency Conversion object Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Currency Conversion", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-updateCurrencyConversion-post", "x-filename-id":"config-sim-v2-setup-updatecurrencyconversion-post" } }, "/config/sim/v1/setup/deletecurrencyconversion":{ "post":{ "tags":[ "v1/Setup/Currency Conversions" ], "summary":"Delete currency conversion", "description":"Deletes the currency conversion object for the specified organization.", "operationId":"deleteCurrencyConversions", "parameters":[ { "$ref":"#/parameters/body.DeleteRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-setup-deletecurrencyconversion-post", "x-filename-id":"config-sim-v1-setup-deletecurrencyconversion-post" } }, "/config/sim/v2/setup/deleteCurrencyConversion":{ "post":{ "tags":[ "v2/Setup/Currency Conversions" ], "summary":"Delete currency conversion", "description":"Deletes the currency conversion object for the specified organization.", "operationId":"deleteCurrencyConversionsv2", "parameters":[ { "$ref":"#/parameters/body.DeleteRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteCurrencyConversion-post", "x-filename-id":"config-sim-v2-setup-deletecurrencyconversion-post" } }, "/config/sim/v1/setup/getcurrencyavailability":{ "post":{ "tags":[ "v1/Setup/Currency Availability" ], "summary":"Get Currency Availability", "description":"Gets all the currency availability.", "operationId":"getCurrencyAvailability", "parameters":[ { "$ref":"#/parameters/body.CurrencyAvailabilityGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Currency Availability objects.", "schema":{ "$ref":"#/definitions/CurrencyAvailabilityGetResponsev1" } } }, "x-internal-id":"config-sim-v1-setup-getcurrencyavailability-post", "x-filename-id":"config-sim-v1-setup-getcurrencyavailability-post" } }, "/config/sim/v2/setup/getCurrencyAvailability":{ "post":{ "tags":[ "v2/Setup/Currency Availability" ], "summary":"Get Currency Availability", "description":"Gets all the currency availability.", "operationId":"getCurrencyAvailabilityv2", "parameters":[ { "$ref":"#/parameters/body.CurrencyAvailabilityGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Currency Availability objects.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Currency Availability objects of the organization.", "items":{ "$ref":"#/definitions/CurrencyAvailabilityv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getCurrencyAvailability-post", "x-filename-id":"config-sim-v2-setup-getcurrencyavailability-post" } }, "/config/sim/v1/setup/currencyavailability":{ "post":{ "tags":[ "v1/Setup/Currency Availability" ], "summary":"Add Currency Availability", "description":"Add the Currency Availability to the specified organization.", "operationId":"createCurrencyAvailability", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUDCurrencyAvailabilityRequest" } ], "responses":{ "200":{ "description":"Currency Availability object Added.", "schema":{ "$ref":"#/definitions/CurrencyAvailabilityCUResponseBody" } } }, "x-internal-id":"config-sim-v1-setup-currencyavailability-post", "x-filename-id":"config-sim-v1-setup-currencyavailability-post" } }, "/config/sim/v2/setup/currencyAvailability":{ "post":{ "tags":[ "v2/Setup/Currency Availability" ], "summary":"Add Currency Availability", "description":"Add the Currency Availability to the specified organization.", "operationId":"createCurrencyAvailabilityv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUDCurrencyAvailabilityRequest" } ], "responses":{ "200":{ "description":"Currency Availability object Added.", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Currency Availability", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-currencyAvailability-post", "x-filename-id":"config-sim-v2-setup-currencyavailability-post" } }, "/config/sim/v1/setup/updatecurrencyavailability":{ "post":{ "tags":[ "v1/Setup/Currency Availability" ], "summary":"Update Currency Availability", "description":"Updates the currency availability. If the currency availability is not found, it creates a new currency availability.", "operationId":"updateCurrencyAvailability", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUDCurrencyAvailabilityRequest" } ], "responses":{ "200":{ "description":"Currency Availability object Updated or Added.", "schema":{ "$ref":"#/definitions/CurrencyAvailabilityCUResponseBody" } } }, "x-internal-id":"config-sim-v1-setup-updatecurrencyavailability-post", "x-filename-id":"config-sim-v1-setup-updatecurrencyavailability-post" } }, "/config/sim/v2/setup/updateCurrencyAvailability":{ "post":{ "tags":[ "v2/Setup/Currency Availability" ], "summary":"Update Currency Availability", "description":"Updates the currency availability.", "operationId":"updateCurrencyAvailabilityv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUDCurrencyAvailabilityRequest" } ], "responses":{ "200":{ "description":"Currency Availability object Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Currency Availability", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-updateCurrencyAvailability-post", "x-filename-id":"config-sim-v2-setup-updatecurrencyavailability-post" } }, "/config/sim/v1/setup/deletecurrencyavailability":{ "post":{ "tags":[ "v1/Setup/Currency Availability" ], "summary":"Delete Currency Availability", "description":"Deletes the currency availability object.", "operationId":"deleteCurrencyAvailability", "parameters":[ { "$ref":"#/parameters/body.DeleteCurrencyAvailabilityRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-setup-deletecurrencyavailability-post", "x-filename-id":"config-sim-v1-setup-deletecurrencyavailability-post" } }, "/config/sim/v2/setup/deleteCurrencyAvailability":{ "post":{ "tags":[ "v2/Setup/Currency Availability" ], "summary":"Delete Currency Availability", "description":"Deletes the currency availability object.", "operationId":"deleteCurrencyAvailabilityv2", "parameters":[ { "$ref":"#/parameters/body.DeleteCurrencyAvailabilityRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteCurrencyAvailability-post", "x-filename-id":"config-sim-v2-setup-deletecurrencyavailability-post" } }, "/clones/sim/v1/createConfig":{ "post":{ "tags":[ "v1/Other/Clone Configuration" ], "summary":"Create Clone", "description":"Create the clone request for the given organization.", "operationId":"createCloneConfiguration", "parameters":[ { "$ref":"#/parameters/body.CreateCloneRequest" } ], "responses":{ "200":{ "description":"The request details after successfully submitting a request for export operation.", "schema":{ "$ref":"#/definitions/CreateCloneResponse" } } }, "x-internal-id":"clones-sim-v1-createConfig-post", "x-filename-id":"clones-sim-v1-createconfig-post" } }, "/clones/sim/v1/getStatus":{ "post":{ "tags":[ "v1/Other/Clone Configuration" ], "summary":"Get Clone Request Status", "description":"Gets the status of a specific clone request.", "operationId":"getCloneStatus", "parameters":[ { "$ref":"#/parameters/body.RequestDetails" } ], "responses":{ "200":{ "description":"Response object consisting of the status of the previously submitted clone request.", "schema":{ "$ref":"#/definitions/GetCloneStatusResponse" } } }, "x-internal-id":"clones-sim-v1-getStatus-post", "x-filename-id":"clones-sim-v1-getstatus-post" } }, "/clones/sim/v1/getClones":{ "post":{ "tags":[ "v1/Other/Clone Configuration" ], "summary":"Get Clones", "description":"Gets the list of successful clone requests. The system maintains only last five clone configurations that were created for the organization.", "operationId":"getAvailableClones", "responses":{ "200":{ "description":"Response object consisting of list of successful clones created.", "schema":{ "$ref":"#/definitions/GetAvailableCloneResponse" } } }, "x-internal-id":"clones-sim-v1-getClones-post", "x-filename-id":"clones-sim-v1-getclones-post" } }, "/clones/sim/v1/importConfig":{ "post":{ "tags":[ "v1/Other/Clone Configuration" ], "summary":"Import Clone", "description":"Import configuration data either from a configuration data file or from a configuration file URL. Execute create config before this call. To download the configuration data use the URL from Status response(this url will be active for 15 min only in Object storage) and then import", "operationId":"importCloneConfig", "parameters":[ { "$ref":"#/parameters/formdata.ConfigDataFile" }, { "$ref":"#/parameters/formdata.ConfigFileURL" }, { "$ref":"#/parameters/formdata.ImportType" } ], "responses":{ "200":{ "description":"The request details after successfully submitting a request for the import operation.", "schema":{ "$ref":"#/definitions/ImportCloneResponse" } } }, "x-internal-id":"clones-sim-v1-importConfig-post", "x-filename-id":"clones-sim-v1-importconfig-post" } }, "/config/sim/v1/setup/tagGroups":{ "post":{ "tags":[ "v1/Setup/Tag Groups" ], "summary":"Add Tag Groups", "description":"Add Tag Groups", "operationId":"createTagGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TagGroups" } ], "responses":{ "200":{ "description":"Tag group Added.", "schema":{ "$ref":"#/definitions/TagGroupsResponse" } } }, "x-internal-id":"config-sim-v1-setup-tagGroups-post", "x-filename-id":"config-sim-v1-setup-taggroups-post" } }, "/config/sim/v2/setup/tagGroups":{ "post":{ "tags":[ "v2/Setup/Tag Groups" ], "summary":"Add Tag Groups", "description":"Add Tag Groups", "operationId":"createTagGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TagGroups" } ], "responses":{ "200":{ "description":"Tag group Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value. Only enterprise hierUnitId is allowed", "example":1 }, "objectNum":{ "description":"Object number of the tag groups", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-tagGroups-post", "x-filename-id":"config-sim-v2-setup-taggroups-post" } }, "/config/sim/v1/setup/deleteTagGroups":{ "post":{ "tags":[ "v1/Setup/Tag Groups" ], "summary":"Delete Tag Groups", "description":"Delete Tag Groups", "operationId":"deleteTagGroups", "parameters":[ { "$ref":"#/parameters/body.TagGroupsDelete" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-setup-deleteTagGroups-post", "x-filename-id":"config-sim-v1-setup-deletetaggroups-post" } }, "/config/sim/v2/setup/deleteTagGroups":{ "post":{ "tags":[ "v2/Setup/Tag Groups" ], "summary":"Delete Tag Groups", "description":"Delete Tag Groups", "operationId":"deleteTagGroupsv2", "parameters":[ { "$ref":"#/parameters/body.TagGroupsDelete" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteTagGroups-post", "x-filename-id":"config-sim-v2-setup-deletetaggroups-post" } }, "/config/sim/v1/setup/getTagGroups":{ "post":{ "tags":[ "v1/Setup/Tag Groups" ], "summary":"Get Tag Groups", "description":"Get Tag Groups", "operationId":"getTagGroups", "parameters":[ { "$ref":"#/parameters/body.TagGroupsGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Tag Groups.", "schema":{ "$ref":"#/definitions/TagGroupsGetResponse" } } }, "x-internal-id":"config-sim-v1-setup-getTagGroups-post", "x-filename-id":"config-sim-v1-setup-gettaggroups-post" } }, "/config/sim/v2/setup/getTagGroups":{ "post":{ "tags":[ "v2/Setup/Tag Groups" ], "summary":"Get Tag Groups", "description":"Get Tag Groups", "operationId":"getTagGroupsv2", "parameters":[ { "$ref":"#/parameters/body.TagGroupsGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Tag Groups.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Tag Group objects of the organization.", "items":{ "$ref":"#/definitions/TagGroups" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getTagGroups-post", "x-filename-id":"config-sim-v2-setup-gettaggroups-post" } }, "/config/sim/v1/setup/updateTagGroups":{ "post":{ "tags":[ "v1/Setup/Tag Groups" ], "summary":"Update Tag Groups", "description":"Update Tag Groups", "operationId":"updateTagGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TagGroups" } ], "responses":{ "200":{ "description":"Tag Group Updated or Added.", "schema":{ "$ref":"#/definitions/TagGroupsResponse" } } }, "x-internal-id":"config-sim-v1-setup-updateTagGroups-post", "x-filename-id":"config-sim-v1-setup-updatetaggroups-post" } }, "/config/sim/v2/setup/updateTagGroups":{ "post":{ "tags":[ "v2/Setup/Tag Groups" ], "summary":"Update Tag Groups", "description":"Update Tag Groups", "operationId":"updateTagGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TagGroups" } ], "responses":{ "200":{ "description":"Tag Group Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value. Only enterprise hierUnitId is allowed", "example":1 }, "objectNum":{ "description":"Object number of the tag groups", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-updateTagGroups-post", "x-filename-id":"config-sim-v2-setup-updatetaggroups-post" } }, "/config/sim/v1/menuItems/menuItemGroups":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Groups/Menu Item Groups" ], "summary":"Add Menu Item Groups", "description":"Add Menu Item Groups", "operationId":"addMenuItemGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemGroupCUDRequest" } ], "responses":{ "200":{ "description":"Menu Item Groups Added.", "schema":{ "$ref":"#/definitions/MenuItemGroupResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-menuItemGroups-post", "x-filename-id":"config-sim-v1-menuitems-menuitemgroups-post" } }, "/config/sim/v2/menuItems/menuItemGroups":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Groups/Menu Item Groups" ], "summary":"Add Menu Item Groups", "description":"Add Menu Item Groups", "operationId":"addMenuItemGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemGroupCUDRequestv2" } ], "responses":{ "200":{ "description":"Menu Item Groups Added.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemGroups-post", "x-filename-id":"config-sim-v2-menuitems-menuitemgroups-post" } }, "/config/sim/v1/menuItems/deleteMenuItemGroups":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Groups/Menu Item Groups" ], "summary":"Delete Menu Item Groups", "description":"Delete Menu Item Groups", "operationId":"deleteMenuItemGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemGroupDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/DeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-deleteMenuItemGroups-post", "x-filename-id":"config-sim-v1-menuitems-deletemenuitemgroups-post" } }, "/config/sim/v2/menuItems/deleteMenuItemGroups":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Groups/Menu Item Groups" ], "summary":"Delete Menu Item Groups", "description":"Delete Menu Item Groups", "operationId":"deleteMenuItemGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemGroupDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteMenuItemGroups-post", "x-filename-id":"config-sim-v2-menuitems-deletemenuitemgroups-post" } }, "/config/sim/v1/menuItems/getMenuItemGroups":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Groups/Menu Item Groups" ], "summary":"Get Menu Item Groups", "description":"Get Menu Item Groups", "operationId":"getMenuItemGroups", "parameters":[ { "$ref":"#/parameters/body.MenuItemGroupsGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of menuItemGroups.", "schema":{ "$ref":"#/definitions/MenuItemGroupGetResponsev1" } } }, "x-internal-id":"config-sim-v1-menuItems-getMenuItemGroups-post", "x-filename-id":"config-sim-v1-menuitems-getmenuitemgroups-post" } }, "/config/sim/v2/menuItems/getMenuItemGroups":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Groups/Menu Item Groups" ], "summary":"Get Menu Item Groups", "description":"Get Menu Item Groups", "operationId":"getMenuItemGroupsv2", "parameters":[ { "$ref":"#/parameters/body.MenuItemGroupsGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of menuItemGroups.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Group objects of the organization.", "items":{ "$ref":"#/definitions/MenuItemGroupv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getMenuItemGroups-post", "x-filename-id":"config-sim-v2-menuitems-getmenuitemgroups-post" } }, "/config/sim/v1/menuItems/updateMenuItemGroups":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Groups/Menu Item Groups" ], "summary":"Update Menu Item Groups", "description":"Updates Menu Item Group. If Menu Item Group is not found, it creates a new Menu Item Group.", "operationId":"updateMenuItemGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemGroupCUDRequest" } ], "responses":{ "200":{ "description":"Menu Item Group Updated or Added.", "schema":{ "$ref":"#/definitions/MenuItemGroupResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-updateMenuItemGroups-post", "x-filename-id":"config-sim-v1-menuitems-updatemenuitemgroups-post" } }, "/config/sim/v2/menuItems/updateMenuItemGroups":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Groups/Menu Item Groups" ], "summary":"Update Menu Item Groups", "description":"Update Menu Item Groups", "operationId":"updateMenuItemGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemGroupCUDRequestv2" } ], "responses":{ "200":{ "description":"Menu Item Group Updated.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateMenuItemGroups-post", "x-filename-id":"config-sim-v2-menuitems-updatemenuitemgroups-post" } }, "/config/sim/v1/menuItems/bulkInsertMenuItemGroups":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Groups/Menu Item Groups" ], "summary":"Bulk Insert Menu Item Groups", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertMenuItemGroups", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertMenuItemGroupRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v1-menuItems-bulkInsertMenuItemGroups-post", "x-filename-id":"config-sim-v1-menuitems-bulkinsertmenuitemgroups-post" } }, "/config/sim/v2/menuItems/bulkInsertMenuItemGroups":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Groups/Menu Item Groups" ], "summary":"Bulk Insert Menu Item Groups", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertMenuItemGroupsv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertMenuItemGroupRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-bulkInsertMenuItemGroups-post", "x-filename-id":"config-sim-v2-menuitems-bulkinsertmenuitemgroups-post" } }, "/config/sim/v2/menuItems/bulkUpdateMenuItemGroups":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Groups/Menu Item Groups" ], "summary":"Bulk Update Menu Item Groups", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkUpdateMenuItemGroupsv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkUpdateMenuItemGroupRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-bulkUpdateMenuItemGroups-post", "x-filename-id":"config-sim-v2-menuitems-bulkupdatemenuitemgroups-post" } }, "/config/sim/v1/menuItems/menuItemMasterGroups":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Master Groups" ], "summary":"Add Menu Item Master Groups", "description":"Add Menu Item Master Groups", "operationId":"addMenuItemMasterGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterGroupCUDRequest" } ], "responses":{ "200":{ "description":"Menu Item Master Group added.", "schema":{ "$ref":"#/definitions/MenuItemMasterGroupResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-menuItemMasterGroups-post", "x-filename-id":"config-sim-v1-menuitems-menuitemmastergroups-post" } }, "/config/sim/v2/menuItems/menuItemMasterGroups":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Master Groups" ], "summary":"Add Menu Item Master Groups", "description":"Add Menu Item Master Groups", "operationId":"addMenuItemMasterGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterGroupCUDRequestv2" } ], "responses":{ "200":{ "description":"Menu Item Master Group added.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemMasterGroups-post", "x-filename-id":"config-sim-v2-menuitems-menuitemmastergroups-post" } }, "/config/sim/v1/menuItems/deleteMenuItemMasterGroups":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Master Groups" ], "summary":"Delete Menu Item Master Groups", "description":"Delete Menu Item Master Groups", "operationId":"deleteMenuItemMasterGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterGroupDeleteRequest.Required" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/DeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-deleteMenuItemMasterGroups-post", "x-filename-id":"config-sim-v1-menuitems-deletemenuitemmastergroups-post" } }, "/config/sim/v2/menuItems/deleteMenuItemMasterGroups":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Master Groups" ], "summary":"Delete Menu Item Master Groups", "description":"Delete Menu Item Master Groups", "operationId":"deleteMenuItemMasterGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterGroupDeleteRequest.Required" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteMenuItemMasterGroups-post", "x-filename-id":"config-sim-v2-menuitems-deletemenuitemmastergroups-post" } }, "/config/sim/v1/menuItems/getMenuItemMasterGroups":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Master Groups" ], "summary":"Get Menu Item Master Groups", "description":"Get Menu Item Master Groups", "operationId":"getMenuItemMasterGroups", "parameters":[ { "$ref":"#/parameters/body.MenuItemMasterGroupGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Menu Item Master Groups.", "schema":{ "$ref":"#/definitions/MenuItemMasterGroupGetResponsev1" } } }, "x-internal-id":"config-sim-v1-menuItems-getMenuItemMasterGroups-post", "x-filename-id":"config-sim-v1-menuitems-getmenuitemmastergroups-post" } }, "/config/sim/v2/menuItems/getMenuItemMasterGroups":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Master Groups" ], "summary":"Get Menu Item Master Groups", "description":"Get Menu Item Master Groups", "operationId":"getMenuItemMasterGroupsv2", "parameters":[ { "$ref":"#/parameters/body.MenuItemMasterGroupGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Menu Item Master Groups.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Master Group objects of the organization.", "items":{ "$ref":"#/definitions/MenuItemMasterGroupResponsev2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getMenuItemMasterGroups-post", "x-filename-id":"config-sim-v2-menuitems-getmenuitemmastergroups-post" } }, "/config/sim/v1/menuItems/updateMenuItemMasterGroups":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Master Groups" ], "summary":"Update Menu Item Master Groups", "description":"Updates Menu Item Master Group. If Menu Item Master Group is not found, it creates a new Menu Item Master Group.", "operationId":"updateMenuItemMasterGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterGroupCUDRequest" } ], "responses":{ "200":{ "description":"Menu Item Master Group Updated or Added.", "schema":{ "$ref":"#/definitions/MenuItemMasterGroupResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-updateMenuItemMasterGroups-post", "x-filename-id":"config-sim-v1-menuitems-updatemenuitemmastergroups-post" } }, "/config/sim/v2/menuItems/updateMenuItemMasterGroups":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Master Groups" ], "summary":"Update Menu Item Master Groups", "description":"Update Menu Item Master Groups", "operationId":"updateMenuItemMasterGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterGroupCUDRequestv2" } ], "responses":{ "200":{ "description":"Menu Item Master Group Updated", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateMenuItemMasterGroups-post", "x-filename-id":"config-sim-v2-menuitems-updatemenuitemmastergroups-post" } }, "/content/sim/v1/devices/workstations/spiServerCertificate":{ "post":{ "tags":[ "v1/Devices/Workstations/SPI Server Certificate" ], "summary":"Add SPI Server Certificate", "description":"Add the SPI server certificate to the given workstation device", "operationId":"addSPIServerCertificates", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SPIServerCertificateCURequest" } ], "responses":{ "200":{ "description":"SPI Server Certificate Added.", "schema":{ "$ref":"#/definitions/SPICertificateResponse" } } }, "x-internal-id":"content-sim-v1-devices-workstations-spiServerCertificate-post", "x-filename-id":"content-sim-v1-devices-workstations-spiservercertificate-post" } }, "/content/sim/v2/devices/workstations/SPIServerCertificate":{ "post":{ "tags":[ "v2/Devices/Workstations/SPI Server Certificate" ], "summary":"Add SPI Server Certificate", "description":"Add the SPI server certificate to the given workstation device", "operationId":"addSPIServerCertificatesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SPIServerCertificateCURequest" } ], "responses":{ "200":{ "description":"SPI Server Certificate Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the workstation" }, "deviceNum":{ "type":"integer", "example":1, "description":"Sequence number of the device" } } } } }, "x-internal-id":"content-sim-v2-devices-workstations-SPIServerCertificate-post", "x-filename-id":"content-sim-v2-devices-workstations-spiservercertificate-post" } }, "/content/sim/v1/devices/workstations/updateSPIserverCertificate":{ "post":{ "tags":[ "v1/Devices/Workstations/SPI Server Certificate" ], "summary":"Update SPI server certificate", "description":"Updates the SPI server certificate for the given workstation device. If certificate is not found, it adds a new SPI server certificate to the workstation device.", "operationId":"updateSPIserverCertificates", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SPIServerCertificateCURequest" } ], "responses":{ "200":{ "description":"SPI Server Certificate Updated or Added.", "schema":{ "$ref":"#/definitions/SPICertificateResponse" } } }, "x-internal-id":"content-sim-v1-devices-workstations-updateSPIserverCertificate-post", "x-filename-id":"content-sim-v1-devices-workstations-updatespiservercertificate-post" } }, "/content/sim/v2/devices/workstations/updateSPIServerCertificate":{ "post":{ "tags":[ "v2/Devices/Workstations/SPI Server Certificate" ], "summary":"Update SPI server certificate", "description":"Updates the SPI server certificate for the given workstation device.", "operationId":"updateSPIserverCertificatesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SPIServerCertificateCURequest" } ], "responses":{ "200":{ "description":"SPI Server Certificate Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the workstation" }, "deviceNum":{ "type":"integer", "example":1, "description":"Sequence number of the device" } } } } }, "x-internal-id":"content-sim-v2-devices-workstations-updateSPIServerCertificate-post", "x-filename-id":"content-sim-v2-devices-workstations-updatespiservercertificate-post" } }, "/content/sim/v1/devices/workstations/deleteSPIserverCertificate":{ "post":{ "tags":[ "v1/Devices/Workstations/SPI Server Certificate" ], "summary":"Delete SPI server certificate", "description":"Deletes the SPI server certificate for the given workstation device.", "operationId":"deleteSPIserverCertificates", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SPIServerCertificateDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"content-sim-v1-devices-workstations-deleteSPIserverCertificate-post", "x-filename-id":"content-sim-v1-devices-workstations-deletespiservercertificate-post" } }, "/content/sim/v2/devices/workstations/deleteSPIServerCertificate":{ "post":{ "tags":[ "v2/Devices/Workstations/SPI Server Certificate" ], "summary":"Delete SPI server certificate", "description":"Deletes the SPI server certificate for the given workstation device.", "operationId":"deleteSPIserverCertificatesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SPIServerCertificateDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"content-sim-v2-devices-workstations-deleteSPIServerCertificate-post", "x-filename-id":"content-sim-v2-devices-workstations-deletespiservercertificate-post" } }, "/content/sim/v1/devices/workstations/spiClientCertificate":{ "post":{ "tags":[ "v1/Devices/Workstations/SPI Client Certificate" ], "summary":"Add SPI client certificate", "description":"Add the SPI client certificate to the given workstation device", "operationId":"addSPIClientCertificates", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SPIClientCertificateCURequest" } ], "responses":{ "200":{ "description":"SPI Client Certificate Added.", "schema":{ "$ref":"#/definitions/SPICertificateResponse" } } }, "x-internal-id":"content-sim-v1-devices-workstations-spiClientCertificate-post", "x-filename-id":"content-sim-v1-devices-workstations-spiclientcertificate-post" } }, "/content/sim/v2/devices/workstations/SPIClientCertificate":{ "post":{ "tags":[ "v2/Devices/Workstations/SPI Client Certificate" ], "summary":"Add SPI client certificate", "description":"Add the SPI client certificate to the given workstation device", "operationId":"addSPIClientCertificatesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SPIClientCertificateCURequest" } ], "responses":{ "200":{ "description":"SPI Client Certificate Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the workstation" }, "deviceNum":{ "type":"integer", "example":1, "description":"Sequence number of the device" } } } } }, "x-internal-id":"content-sim-v2-devices-workstations-SPIClientCertificate-post", "x-filename-id":"content-sim-v2-devices-workstations-spiclientcertificate-post" } }, "/content/sim/v1/devices/workstations/updateSPIclientCertificate":{ "post":{ "tags":[ "v1/Devices/Workstations/SPI Client Certificate" ], "summary":"Update SPI Client Certificate", "description":"Updates the SPI client certificate for the given workstation device. If certificate is not found, it adds a new SPI client certificate to the workstation device.", "operationId":"updateSPIclientCertificates", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SPIClientCertificateCURequest" } ], "responses":{ "200":{ "description":"SPI Client Certificate Updated or Added.", "schema":{ "$ref":"#/definitions/SPICertificateResponse" } } }, "x-internal-id":"content-sim-v1-devices-workstations-updateSPIclientCertificate-post", "x-filename-id":"content-sim-v1-devices-workstations-updatespiclientcertificate-post" } }, "/content/sim/v2/devices/workstations/updateSPIClientCertificate":{ "post":{ "tags":[ "v2/Devices/Workstations/SPI Client Certificate" ], "summary":"Update SPI Client Certificate", "description":"Updates the SPI client certificate for the given workstation device.", "operationId":"updateSPIclientCertificatesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SPIClientCertificateCURequest" } ], "responses":{ "200":{ "description":"SPI Client Certificate Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the workstation" }, "deviceNum":{ "type":"integer", "example":1, "description":"Sequence number of the device" } } } } }, "x-internal-id":"content-sim-v2-devices-workstations-updateSPIClientCertificate-post", "x-filename-id":"content-sim-v2-devices-workstations-updatespiclientcertificate-post" } }, "/content/sim/v1/devices/workstations/deleteSPIClientCertificate":{ "post":{ "tags":[ "v1/Devices/Workstations/SPI Client Certificate" ], "summary":"Delete SPI Client Certificate", "description":"Deletes the SPI Client Certificate for the given workstation device.", "operationId":"deleteSPIClientCertificates", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SPIClientCertificateDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"content-sim-v1-devices-workstations-deleteSPIClientCertificate-post", "x-filename-id":"content-sim-v1-devices-workstations-deletespiclientcertificate-post" } }, "/content/sim/v2/devices/workstations/deleteSPIClientCertificate":{ "post":{ "tags":[ "v2/Devices/Workstations/SPI Client Certificate" ], "summary":"Delete SPI Client Certificate", "description":"Deletes the SPI Client Certificate for the given workstation device.", "operationId":"deleteSPIClientCertificatesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SPIClientCertificateDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"content-sim-v2-devices-workstations-deleteSPIClientCertificate-post", "x-filename-id":"content-sim-v2-devices-workstations-deletespiclientcertificate-post" } }, "/config/sim/v1/sales/getTenderMedia":{ "post":{ "tags":[ "v1/Sales/Tender Media" ], "summary":"Get Tender Media", "description":"Gets all the Tender Media configured", "operationId":"getTenderMedia", "parameters":[ { "$ref":"#/parameters/body.TenderMediaGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Tender Media objects.", "schema":{ "$ref":"#/definitions/TenderMediaGetResponsev1" } } }, "x-internal-id":"config-sim-v1-sales-getTenderMedia-post", "x-filename-id":"config-sim-v1-sales-gettendermedia-post" } }, "/config/sim/v2/sales/getTenderMedia":{ "post":{ "tags":[ "v2/Sales/Tender Media" ], "summary":"Get Tender Media", "description":"Gets all the Tender Media configured", "operationId":"getTenderMediav2", "parameters":[ { "$ref":"#/parameters/body.TenderMediaGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Tender Media objects.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of tender media objects of the organization.", "items":{ "$ref":"#/definitions/TenderMediav2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-sales-getTenderMedia-post", "x-filename-id":"config-sim-v2-sales-gettendermedia-post" } }, "/config/sim/v1/sales/tenderMedia":{ "post":{ "tags":[ "v1/Sales/Tender Media" ], "summary":"Add Tender Media", "description":"Add a Tender Media record for the current organization.", "operationId":"addTenderMedia", "parameters":[ { "$ref":"#/parameters/body.TenderMediaCURequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Tender Media object Added.", "schema":{ "$ref":"#/definitions/TenderMediaResponse" } } }, "x-internal-id":"config-sim-v1-sales-tenderMedia-post", "x-filename-id":"config-sim-v1-sales-tendermedia-post" } }, "/config/sim/v2/sales/tenderMedia":{ "post":{ "tags":[ "v2/Sales/Tender Media" ], "summary":"Add Tender Media", "description":"Add a Tender Media record for the current organization.", "operationId":"addTenderMediav2", "parameters":[ { "$ref":"#/parameters/body.TenderMediaCURequestBodyv2" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Tender Media object Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the tender media", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"Effectivity Group object number", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-tenderMedia-post", "x-filename-id":"config-sim-v2-sales-tendermedia-post" } }, "/config/sim/v1/sales/updateTenderMedia":{ "post":{ "tags":[ "v1/Sales/Tender Media" ], "summary":"Update Tender Media", "description":"Updates a Tender Media record for the current organization.", "operationId":"updateTenderMedia", "parameters":[ { "$ref":"#/parameters/body.TenderMediaCURequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Tender Media object Updated or Added.", "schema":{ "$ref":"#/definitions/TenderMediaResponse" } } }, "x-internal-id":"config-sim-v1-sales-updateTenderMedia-post", "x-filename-id":"config-sim-v1-sales-updatetendermedia-post" } }, "/config/sim/v2/sales/updateTenderMedia":{ "post":{ "tags":[ "v2/Sales/Tender Media" ], "summary":"Update Tender Media", "description":"Updates a Tender Media record for the current organization.", "operationId":"updateTenderMediav2", "parameters":[ { "$ref":"#/parameters/body.TenderMediaCURequestBodyv2" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Tender Media object Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the tender media", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"Effectivity Group object number", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-updateTenderMedia-post", "x-filename-id":"config-sim-v2-sales-updatetendermedia-post" } }, "/config/sim/v1/sales/deleteTenderMedia":{ "post":{ "tags":[ "v1/Sales/Tender Media" ], "summary":"Delete Tender Media", "description":"Deletes the Tender Media object.", "operationId":"deleteTenderMedia", "parameters":[ { "$ref":"#/parameters/body.TenderMediaDeleteRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-sales-deleteTenderMedia-post", "x-filename-id":"config-sim-v1-sales-deletetendermedia-post" } }, "/config/sim/v2/sales/deleteTenderMedia":{ "post":{ "tags":[ "v2/Sales/Tender Media" ], "summary":"Delete Tender Media", "description":"Deletes the Tender Media object.", "operationId":"deleteTenderMediav2", "parameters":[ { "$ref":"#/parameters/body.TenderMediaDeleteRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-sales-deleteTenderMedia-post", "x-filename-id":"config-sim-v2-sales-deletetendermedia-post" } }, "/config/sim/v1/sales/gettaxbreakpoints":{ "post":{ "tags":[ "v1/Sales/Taxes/Tax Breakpoints" ], "summary":"Get Tax Breakpoints", "description":"Gets all the breakpoints for a given tax", "operationId":"getTaxBreakpoints", "parameters":[ { "$ref":"#/parameters/body.TaxBreakPointsGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Tax breakpoints", "schema":{ "$ref":"#/definitions/TaxBreakpointsGetResponsev1" } } }, "x-internal-id":"config-sim-v1-sales-gettaxbreakpoints-post", "x-filename-id":"config-sim-v1-sales-gettaxbreakpoints-post" } }, "/config/sim/v2/sales/getTaxBreakpoints":{ "post":{ "tags":[ "v2/Sales/Taxes/Tax Breakpoints" ], "summary":"Get Tax Breakpoints", "description":"Gets all the breakpoints for a given tax", "operationId":"getTaxBreakpointsv2", "parameters":[ { "$ref":"#/parameters/body.TaxBreakPointsGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Tax breakpoints.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Tax Breakpoint objects of the organization.", "items":{ "$ref":"#/definitions/TaxBreakpointv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-sales-getTaxBreakpoints-post", "x-filename-id":"config-sim-v2-sales-gettaxbreakpoints-post" } }, "/config/sim/v1/sales/updatetaxbreakpoints":{ "post":{ "tags":[ "v1/Sales/Taxes/Tax Breakpoints" ], "summary":"Update Tax Breakpoints", "description":"Updates the tax breakpoint for a given tax.", "operationId":"updateTaxBreakpoints", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxBreakpointsCURequestBody" } ], "responses":{ "200":{ "description":"Tax Breakpoint Updated.", "schema":{ "$ref":"#/definitions/TaxBrkPointResponse" } } }, "x-internal-id":"config-sim-v1-sales-updatetaxbreakpoints-post", "x-filename-id":"config-sim-v1-sales-updatetaxbreakpoints-post" } }, "/config/sim/v2/sales/updateTaxBreakpoints":{ "post":{ "tags":[ "v2/Sales/Taxes/Tax Breakpoints" ], "summary":"Update Tax Breakpoints", "description":"Updates the tax breakpoint for a given tax.", "operationId":"updateTaxBreakpointsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxBreakpointsCURequestBody" } ], "responses":{ "200":{ "description":"Tax Breakpoint Updated.", "schema":{ "description":"Model for the tax break point response", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Tax rate", "type":"integer", "example":1 }, "index":{ "description":"index of the breakpoint", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-updateTaxBreakpoints-post", "x-filename-id":"config-sim-v2-sales-updatetaxbreakpoints-post" } }, "/config/sim/v1/setup/cal/getPackages":{ "post":{ "tags":[ "v1/Setup/CAL/CAL Packages" ], "summary":"Get CAL Packages", "description":"Gets a list of all CAL Packages in the specified organization", "operationId":"getCalPackages", "parameters":[ { "$ref":"#/parameters/body.PackagesGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of CAL Packages.", "schema":{ "$ref":"#/definitions/CalPackageGetResponse" } } }, "x-internal-id":"config-sim-v1-setup-cal-getPackages-post", "x-filename-id":"config-sim-v1-setup-cal-getpackages-post" } }, "/config/sim/v2/setup/cal/getPackages":{ "post":{ "tags":[ "v2/Setup/CAL/CAL Packages" ], "summary":"Get CAL Packages", "description":"Gets a list of all CAL Packages in the specified organization", "operationId":"getCalPackagesv2", "parameters":[ { "$ref":"#/parameters/body.PackagesGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of CAL Packages.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of CAL Package objects of the organization.", "items":{ "$ref":"#/definitions/CalPackage" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-cal-getPackages-post", "x-filename-id":"config-sim-v2-setup-cal-getpackages-post" } }, "/config/sim/v1/setup/getscreenlookups":{ "post":{ "tags":[ "v1/Setup/Screen Look Ups/Screen Look Ups" ], "summary":"Get Screen Look Ups", "description":"Gets a list of SLUs in a given organization", "operationId":"getSLUs", "parameters":[ { "$ref":"#/parameters/body.SLUGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Screen Look Ups.", "schema":{ "$ref":"#/definitions/SLUGetResponsev1" } } }, "x-internal-id":"config-sim-v1-setup-getscreenlookups-post", "x-filename-id":"config-sim-v1-setup-getscreenlookups-post" } }, "/config/sim/v2/setup/getScreenLookups":{ "post":{ "tags":[ "v2/Setup/Screen Look Ups/Screen Look Ups" ], "summary":"Get Screen Look Ups", "description":"Gets a list of SLUs in a given organization", "operationId":"getSLUsv2", "parameters":[ { "$ref":"#/parameters/body.SLUGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Screen Look Ups.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of SLU objects of the organization.", "items":{ "$ref":"#/definitions/SLUv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getScreenLookups-post", "x-filename-id":"config-sim-v2-setup-getscreenlookups-post" } }, "/config/sim/v1/setup/screenlookups":{ "post":{ "tags":[ "v1/Setup/Screen Look Ups/Screen Look Ups" ], "summary":"Add Screen Look Ups", "description":"Add SLU object", "operationId":"addSLUs", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SLUInsertRequest" } ], "responses":{ "200":{ "description":"Screen Look Up Added.", "schema":{ "$ref":"#/definitions/SLUDeleteRequestBody" } } }, "x-internal-id":"config-sim-v1-setup-screenlookups-post", "x-filename-id":"config-sim-v1-setup-screenlookups-post" } }, "/config/sim/v2/setup/screenLookups":{ "post":{ "tags":[ "v2/Setup/Screen Look Ups/Screen Look Ups" ], "summary":"Add Screen Look Ups", "description":"Add SLU object", "operationId":"addSLUsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SLUInsertRequestv2" } ], "responses":{ "200":{ "description":"Screen Look Up Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the SLU", "type":"integer", "example":1 }, "type":{ "description":"

    Slu Type Number assigned to the SLU

    \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    Slu TypeSLU NameAllowed Hierarchy LevelAllowed objectNum
    1Discount SLUZone/Location1-64
    2Service Charges SLUZone/Location1-64
    3Tender Media SLUZone/Location1-64
    6Menu Items SLUEnterprise/Zone/Location/RVC1-999999999
    7Menu Item Master Groups SLUZone/Location1-32
    \n", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-screenLookups-post", "x-filename-id":"config-sim-v2-setup-screenlookups-post" } }, "/config/sim/v1/setup/updatescreenlookups":{ "post":{ "tags":[ "v1/Setup/Screen Look Ups/Screen Look Ups" ], "summary":"Update Screen Look Ups", "description":"Updates SLU object.", "operationId":"updateSLUs", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SLUUpdateRequest" } ], "responses":{ "200":{ "description":"Screen Look Up Updated or Added.", "schema":{ "$ref":"#/definitions/SLUUpdateResponseBody" } } }, "x-internal-id":"config-sim-v1-setup-updatescreenlookups-post", "x-filename-id":"config-sim-v1-setup-updatescreenlookups-post" } }, "/config/sim/v2/setup/updateScreenLookups":{ "post":{ "tags":[ "v2/Setup/Screen Look Ups/Screen Look Ups" ], "summary":"Update Screen Look Ups", "description":"Updates SLU object.", "operationId":"updateSLUsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SLUUpdateRequestv2" } ], "responses":{ "200":{ "description":"Screen Look Up Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the SLU", "type":"integer", "example":1 }, "type":{ "description":"

    Slu Type Number assigned to the SLU

    \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    Slu TypeSLU NameAllowed Hierarchy LevelAllowed objectNum
    1Discount SLUZone/Location1-64
    2Service Charges SLUZone/Location1-64
    3Tender Media SLUZone/Location1-64
    6Menu Items SLUEnterprise/Zone/Location/RVC1-999999999
    7Menu Item Master Groups SLUZone/Location1-32
    \n", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-updateScreenLookups-post", "x-filename-id":"config-sim-v2-setup-updatescreenlookups-post" } }, "/config/sim/v1/setup/deletescreenlookups":{ "post":{ "tags":[ "v1/Setup/Screen Look Ups/Screen Look Ups" ], "summary":"Delete Screen Look Ups", "description":"Deletes SLU object", "operationId":"deleteSLUs", "parameters":[ { "$ref":"#/parameters/body.SLUDeleteRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-setup-deletescreenlookups-post", "x-filename-id":"config-sim-v1-setup-deletescreenlookups-post" } }, "/config/sim/v2/setup/deleteScreenLookups":{ "post":{ "tags":[ "v2/Setup/Screen Look Ups/Screen Look Ups" ], "summary":"Delete Screen Look Ups", "description":"Deletes SLU object", "operationId":"deleteSLUsv2", "parameters":[ { "$ref":"#/parameters/body.SLUDeleteRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteScreenLookups-post", "x-filename-id":"config-sim-v2-setup-deletescreenlookups-post" } }, "/config/sim/v1/setup/getReportGroups":{ "post":{ "tags":[ "v1/Setup/Report Groups" ], "summary":"Get Report Groups", "description":"Gets all the Report Groups configured", "operationId":"getReportGroups", "parameters":[ { "$ref":"#/parameters/body.ReportGroupsGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Report Groups.", "schema":{ "$ref":"#/definitions/ReportGroupsGetResponsev1" } } }, "x-internal-id":"config-sim-v1-setup-getReportGroups-post", "x-filename-id":"config-sim-v1-setup-getreportgroups-post" } }, "/config/sim/v2/setup/getReportGroups":{ "post":{ "tags":[ "v2/Setup/Report Groups" ], "summary":"Get Report Groups", "description":"Gets all the Report Groups configured", "operationId":"getReportGroupsv2", "parameters":[ { "$ref":"#/parameters/body.ReportGroupsGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Report Groups.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Report Groups objects of the organization.", "items":{ "$ref":"#/definitions/ReportGroupv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getReportGroups-post", "x-filename-id":"config-sim-v2-setup-getreportgroups-post" } }, "/config/sim/v1/setup/reportGroups":{ "post":{ "tags":[ "v1/Setup/Report Groups" ], "summary":"Add Report Groups", "description":"Add the Report Groups object to a specified hierarchy unit", "operationId":"addReportGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ReportGroupCUDRequest" } ], "responses":{ "200":{ "description":"Report Group Added.", "schema":{ "$ref":"#/definitions/ReportGroupResponse" } } }, "x-internal-id":"config-sim-v1-setup-reportGroups-post", "x-filename-id":"config-sim-v1-setup-reportgroups-post" } }, "/config/sim/v2/setup/reportGroups":{ "post":{ "tags":[ "v2/Setup/Report Groups" ], "summary":"Add Report Groups", "description":"Add the Report Groups object to a specified hierarchy unit", "operationId":"addReportGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ReportGroupCUDRequestv2" } ], "responses":{ "200":{ "description":"Report Group Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Report Group", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-reportGroups-post", "x-filename-id":"config-sim-v2-setup-reportgroups-post" } }, "/config/sim/v1/setup/updateReportGroups":{ "post":{ "tags":[ "v1/Setup/Report Groups" ], "summary":"Update Report Groups", "description":"Updates the Report Groups. If Report Group is not found, it creates a new Report Group.", "operationId":"updateReportGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ReportGroupCUDRequest" } ], "responses":{ "200":{ "description":"Report Group Updated or Added.", "schema":{ "$ref":"#/definitions/ReportGroupResponse" } } }, "x-internal-id":"config-sim-v1-setup-updateReportGroups-post", "x-filename-id":"config-sim-v1-setup-updatereportgroups-post" } }, "/config/sim/v2/setup/updateReportGroups":{ "post":{ "tags":[ "v2/Setup/Report Groups" ], "summary":"Update Report Groups", "description":"Updates the Report Groups.", "operationId":"updateReportGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ReportGroupCUDRequestv2" } ], "responses":{ "200":{ "description":"Report Group Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Report Group", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-updateReportGroups-post", "x-filename-id":"config-sim-v2-setup-updatereportgroups-post" } }, "/config/sim/v1/setup/deleteReportGroups":{ "post":{ "tags":[ "v1/Setup/Report Groups" ], "summary":"Delete Report Groups", "description":"Deletes the Report Groups object.", "operationId":"deleteReportGroups", "parameters":[ { "$ref":"#/parameters/body.ReportGroupResponse" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-setup-deleteReportGroups-post", "x-filename-id":"config-sim-v1-setup-deletereportgroups-post" } }, "/config/sim/v2/setup/deleteReportGroups":{ "post":{ "tags":[ "v2/Setup/Report Groups" ], "summary":"Delete Report Groups", "description":"Deletes the Report Groups object.", "operationId":"deleteReportGroupsv2", "parameters":[ { "$ref":"#/parameters/body.ReportGroupResponse" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteReportGroups-post", "x-filename-id":"config-sim-v2-setup-deletereportgroups-post" } }, "/config/sim/v1/sales/discounts/getawardgroups":{ "post":{ "tags":[ "v1/Sales/Discounts/Discount Award Groups" ], "summary":"Get Discount Award Groups", "description":"Gets all the Discount Award Groups", "operationId":"getDiscountAwardGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountAwardGroupsGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Discount Award Groups.", "schema":{ "$ref":"#/definitions/DiscountAwardGrpsGetResponsev1" } } }, "x-internal-id":"config-sim-v1-sales-discounts-getawardgroups-post", "x-filename-id":"config-sim-v1-sales-discounts-getawardgroups-post" } }, "/config/sim/v2/sales/discounts/getAwardGroups":{ "post":{ "tags":[ "v2/Sales/Discounts/Discount Award Groups" ], "summary":"Get Discount Award Groups", "description":"Gets all the Discount Award Groups", "operationId":"getDiscountAwardGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountAwardGroupsGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Discount Award Groups.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Discount Award Group objects of the organization.", "items":{ "$ref":"#/definitions/DiscountAwardGrpsResponsev2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-sales-discounts-getAwardGroups-post", "x-filename-id":"config-sim-v2-sales-discounts-getawardgroups-post" } }, "/config/sim/v1/sales/discounts/awardgroups":{ "post":{ "tags":[ "v1/Sales/Discounts/Discount Award Groups" ], "summary":"Add Discount Award Groups", "description":"Add the Discount award group object to a specified hierarchy unit .", "operationId":"addDiscountAwardGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountAwardGrpsCURequestBody" } ], "responses":{ "200":{ "description":"Discount award group Added.", "schema":{ "$ref":"#/definitions/DiscountAwardGrpsResponse" } } }, "x-internal-id":"config-sim-v1-sales-discounts-awardgroups-post", "x-filename-id":"config-sim-v1-sales-discounts-awardgroups-post" } }, "/config/sim/v2/sales/discounts/awardGroups":{ "post":{ "tags":[ "v2/Sales/Discounts/Discount Award Groups" ], "summary":"Add Discount Award Groups", "description":"Add the Discount award group object to a specified hierarchy unit .", "operationId":"addDiscountAwardGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountAwardGrpsCURequestBody" } ], "responses":{ "200":{ "description":"Discount award group Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique Hierarchy Unit Value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the discount.", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"ObjectNumber of Effectivity Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence Number of the discount award group", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-discounts-awardGroups-post", "x-filename-id":"config-sim-v2-sales-discounts-awardgroups-post" } }, "/config/sim/v1/sales/discounts/updateawardgroups":{ "post":{ "tags":[ "v1/Sales/Discounts/Discount Award Groups" ], "summary":"Update Discount Award Groups", "description":"Updates the Discount Award Group. If Discount Award Group is not found, it creates a new Discount Award Group", "operationId":"updateDiscountAwardGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountAwardGrpsCURequestBody" } ], "responses":{ "200":{ "description":"Discount award group Updated or Added.", "schema":{ "$ref":"#/definitions/DiscountAwardGrpsResponse" } } }, "x-internal-id":"config-sim-v1-sales-discounts-updateawardgroups-post", "x-filename-id":"config-sim-v1-sales-discounts-updateawardgroups-post" } }, "/config/sim/v2/sales/discounts/updateAwardGroups":{ "post":{ "tags":[ "v2/Sales/Discounts/Discount Award Groups" ], "summary":"Update Discount Award Groups", "description":"Updates the Discount Award Group.", "operationId":"updateDiscountAwardGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountAwardGrpsCURequestBody" } ], "responses":{ "200":{ "description":"Discount award group Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique Hierarchy Unit Value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the discount.", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"ObjectNumber of Effectivity Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence Number of the discount award group", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-discounts-updateAwardGroups-post", "x-filename-id":"config-sim-v2-sales-discounts-updateawardgroups-post" } }, "/config/sim/v1/sales/discounts/deleteawardgroups":{ "post":{ "tags":[ "v1/Sales/Discounts/Discount Award Groups" ], "summary":"Delete Discount Award Groups", "description":"Deletes the Discount Award Group object.", "operationId":"deleteDiscountAwardGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountAwardGrpsDeleteRequestBody" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-sales-discounts-deleteawardgroups-post", "x-filename-id":"config-sim-v1-sales-discounts-deleteawardgroups-post" } }, "/config/sim/v2/sales/discounts/deleteAwardGroups":{ "post":{ "tags":[ "v2/Sales/Discounts/Discount Award Groups" ], "summary":"Delete Discount Award Groups", "description":"Deletes the Discount Award Group object.", "operationId":"deleteDiscountAwardGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountAwardGrpsDeleteRequestBody" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-sales-discounts-deleteAwardGroups-post", "x-filename-id":"config-sim-v2-sales-discounts-deleteawardgroups-post" } }, "/config/sim/v1/menuItems/getBarcodes":{ "post":{ "tags":[ "v1/Menu Items/Barcodes" ], "summary":"Get Barcodes", "description":"Gets a list of all the Barcodes for the specified hierarchy", "operationId":"getBarcodes", "parameters":[ { "$ref":"#/parameters/body.BarcodesGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Barcodes.", "schema":{ "$ref":"#/definitions/BarCodeGetResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-getBarcodes-post", "x-filename-id":"config-sim-v1-menuitems-getbarcodes-post" } }, "/config/sim/v2/menuItems/getBarcodes":{ "post":{ "tags":[ "v2/Menu Items/Barcodes" ], "summary":"Get Barcodes", "description":"Gets a list of all the Barcodes for the specified hierarchy", "operationId":"getBarcodesv2", "parameters":[ { "$ref":"#/parameters/body.BarcodesGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Barcodes.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Bracode objects of the organization.", "items":{ "$ref":"#/definitions/BarCodeResourceObject" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getBarcodes-post", "x-filename-id":"config-sim-v2-menuitems-getbarcodes-post" } }, "/config/sim/v1/menuItems/barcodes":{ "post":{ "tags":[ "v1/Menu Items/Barcodes" ], "summary":"Add Barcodes", "description":"Add a Barcode", "operationId":"addBarcodes", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.BarcodeCUDRequestBody" } ], "responses":{ "200":{ "description":"Barcode Added.", "schema":{ "$ref":"#/definitions/BarCodeResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-barcodes-post", "x-filename-id":"config-sim-v1-menuitems-barcodes-post" } }, "/config/sim/v2/menuItems/barcodes":{ "post":{ "tags":[ "v2/Menu Items/Barcodes" ], "summary":"Add Barcodes", "description":"Add a Barcode", "operationId":"addBarcodesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.BarcodeCUDRequestBody" } ], "responses":{ "200":{ "description":"Barcode Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy location where the barcode is being added" }, "objectNum":{ "type":"integer", "example":101, "description":"Barcode record object number" } }, "description":"Model for Barcode Response object" } } }, "x-internal-id":"config-sim-v2-menuItems-barcodes-post", "x-filename-id":"config-sim-v2-menuitems-barcodes-post" } }, "/config/sim/v1/menuItems/updateBarcodes":{ "post":{ "tags":[ "v1/Menu Items/Barcodes" ], "summary":"Update Barcodes", "description":"Updates Barcode", "operationId":"updateBarcodes", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.BarcodeCUDRequestBody" } ], "responses":{ "200":{ "description":"Barcode Updated.", "schema":{ "$ref":"#/definitions/BarCodeResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-updateBarcodes-post", "x-filename-id":"config-sim-v1-menuitems-updatebarcodes-post" } }, "/config/sim/v2/menuItems/updateBarcodes":{ "post":{ "tags":[ "v2/Menu Items/Barcodes" ], "summary":"Update Barcodes", "description":"Updates Barcode", "operationId":"updateBarcodesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.BarcodeCUDRequestBody" } ], "responses":{ "200":{ "description":"Barcode Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy location where the barcode is being added" }, "objectNum":{ "type":"integer", "example":101, "description":"Barcode record object number" } }, "description":"Model for Barcode Response object" } } }, "x-internal-id":"config-sim-v2-menuItems-updateBarcodes-post", "x-filename-id":"config-sim-v2-menuitems-updatebarcodes-post" } }, "/config/sim/v1/menuItems/deleteBarcodes":{ "post":{ "tags":[ "v1/Menu Items/Barcodes" ], "summary":"Delete Barcodes", "description":"Deletes Barcodes from the specified hierarchy unit", "operationId":"deleteBarcodes", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.BarcodeDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/BarCodeDeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-deleteBarcodes-post", "x-filename-id":"config-sim-v1-menuitems-deletebarcodes-post" } }, "/config/sim/v2/menuItems/deleteBarcodes":{ "post":{ "tags":[ "v2/Menu Items/Barcodes" ], "summary":"Delete Barcodes", "description":"Deletes Barcodes from the specified hierarchy unit", "operationId":"deleteBarcodesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.BarcodeDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteBarcodes-post", "x-filename-id":"config-sim-v2-menuitems-deletebarcodes-post" } }, "/config/sim/v1/menuItems/bulkInsertBarcodes":{ "post":{ "tags":[ "v1/Menu Items/Barcodes" ], "summary":"Bulk Insert Barcodes", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertBarcodes", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertBarcodeRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v1-menuItems-bulkInsertBarcodes-post", "x-filename-id":"config-sim-v1-menuitems-bulkinsertbarcodes-post" } }, "/config/sim/v2/menuItems/bulkInsertBarcodes":{ "post":{ "tags":[ "v2/Menu Items/Barcodes" ], "summary":"Bulk Insert Barcodes", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertBarcodesv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertBarcodeRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-bulkInsertBarcodes-post", "x-filename-id":"config-sim-v2-menuitems-bulkinsertbarcodes-post" } }, "/config/sim/v2/menuItems/bulkUpdateBarcodes":{ "post":{ "tags":[ "v2/Menu Items/Barcodes" ], "summary":"Bulk Update Barcodes", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkUpdateBarcodesv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertBarcodeRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-bulkUpdateBarcodes-post", "x-filename-id":"config-sim-v2-menuitems-bulkupdatebarcodes-post" } }, "/config/sim/v1/sales/gettaxrates":{ "post":{ "tags":[ "v1/Sales/Taxes/Tax Rates" ], "summary":"Get Tax Rates", "description":"Gets all the tax rates.", "operationId":"getTaxRates", "parameters":[ { "$ref":"#/parameters/body.TaxRatesGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of tax rate entities.", "schema":{ "$ref":"#/definitions/TaxGetResponsev1" } } }, "x-internal-id":"config-sim-v1-sales-gettaxrates-post", "x-filename-id":"config-sim-v1-sales-gettaxrates-post" } }, "/config/sim/v2/sales/getTaxRates":{ "post":{ "tags":[ "v2/Sales/Taxes/Tax Rates" ], "summary":"Get Tax Rates", "description":"Gets all the tax rates.", "operationId":"getTaxRatesv2", "parameters":[ { "$ref":"#/parameters/body.TaxRatesGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of tax rate entities.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Tax objects of the organization.", "items":{ "$ref":"#/definitions/TaxResponsev2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-sales-getTaxRates-post", "x-filename-id":"config-sim-v2-sales-gettaxrates-post" } }, "/config/sim/v1/sales/taxrates":{ "post":{ "tags":[ "v1/Sales/Taxes/Tax Rates" ], "summary":"Add Tax Rates", "description":"Add the tax to the specified organization.", "operationId":"addTaxRates", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxCURequestBody" } ], "responses":{ "200":{ "description":"Tax Rate Added.", "schema":{ "$ref":"#/definitions/TaxResponse" } } }, "x-internal-id":"config-sim-v1-sales-taxrates-post", "x-filename-id":"config-sim-v1-sales-taxrates-post" } }, "/config/sim/v2/sales/taxRates":{ "post":{ "tags":[ "v2/Sales/Taxes/Tax Rates" ], "summary":"Add Tax Rates", "description":"Add the tax to the specified organization.", "operationId":"addTaxRatesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxCURequestBodyv2" } ], "responses":{ "200":{ "description":"Tax Rate Added.", "schema":{ "description":"Model for the response", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the tax rate", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"Object number of the effectivity group associated with the tax rate", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-taxRates-post", "x-filename-id":"config-sim-v2-sales-taxrates-post" } }, "/config/sim/v1/sales/updatetaxrates":{ "post":{ "tags":[ "v1/Sales/Taxes/Tax Rates" ], "summary":"Update Tax Rates", "description":"Updates the tax. If tax is not found, it creates a new tax.", "operationId":"updateTaxRates", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxCURequestBody" } ], "responses":{ "200":{ "description":"Tax Rate Updated or Added.", "schema":{ "$ref":"#/definitions/TaxResponse" } } }, "x-internal-id":"config-sim-v1-sales-updatetaxrates-post", "x-filename-id":"config-sim-v1-sales-updatetaxrates-post" } }, "/config/sim/v2/sales/updateTaxRates":{ "post":{ "tags":[ "v2/Sales/Taxes/Tax Rates" ], "summary":"Update Tax Rates", "description":"Updates the tax.", "operationId":"updateTaxRatesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxCURequestBodyv2" } ], "responses":{ "200":{ "description":"Tax Rate Updated.", "schema":{ "description":"Model for the response", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the tax rate", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"Object number of the effectivity group associated with the tax rate", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-updateTaxRates-post", "x-filename-id":"config-sim-v2-sales-updatetaxrates-post" } }, "/config/sim/v1/sales/deletetaxrates":{ "post":{ "tags":[ "v1/Sales/Taxes/Tax Rates" ], "summary":"Delete Tax Rates", "description":"Deletes the tax object", "operationId":"deleteTaxRates", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-sales-deletetaxrates-post", "x-filename-id":"config-sim-v1-sales-deletetaxrates-post" } }, "/config/sim/v2/sales/deleteTaxRates":{ "post":{ "tags":[ "v2/Sales/Taxes/Tax Rates" ], "summary":"Delete Tax Rates", "description":"Deletes the tax object", "operationId":"deleteTaxRatesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-sales-deleteTaxRates-post", "x-filename-id":"config-sim-v2-sales-deletetaxrates-post" } }, "/config/sim/v1/sales/gettaxparameters":{ "post":{ "tags":[ "v1/Sales/Tax Parameters" ], "summary":"Get Tax Parameters", "description":"Gets all the tax parameters", "operationId":"getTaxParameters", "parameters":[ { "$ref":"#/parameters/body.TaxParametersGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Tax parameters.", "schema":{ "$ref":"#/definitions/TaxParametersGetResponsev1" } } }, "x-internal-id":"config-sim-v1-sales-gettaxparameters-post", "x-filename-id":"config-sim-v1-sales-gettaxparameters-post" } }, "/config/sim/v2/sales/getTaxParameters":{ "post":{ "tags":[ "v2/Sales/Tax Parameters" ], "summary":"Get Tax Parameters", "description":"Gets all the tax parameters", "operationId":"getTaxParametersv2", "parameters":[ { "$ref":"#/parameters/body.TaxParametersGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Tax parameters.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Tax Parameters", "items":{ "$ref":"#/definitions/TaxParametersv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-sales-getTaxParameters-post", "x-filename-id":"config-sim-v2-sales-gettaxparameters-post" } }, "/config/sim/v1/sales/taxparameters":{ "post":{ "tags":[ "v1/Sales/Tax Parameters" ], "summary":"Add Tax Parameters", "description":"Add Tax Parameter", "operationId":"addTaxParameters", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxParametersCURequestBody" } ], "responses":{ "200":{ "description":"Tax Parameter Added.", "schema":{ "$ref":"#/definitions/TaxParameterResponse" } } }, "x-internal-id":"config-sim-v1-sales-taxparameters-post", "x-filename-id":"config-sim-v1-sales-taxparameters-post" } }, "/config/sim/v2/sales/taxParameters":{ "post":{ "tags":[ "v2/Sales/Tax Parameters" ], "summary":"Add Tax Parameters", "description":"Add Tax Parameter", "operationId":"addTaxParametersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxParametersCURequestBody" } ], "responses":{ "200":{ "description":"Tax Parameter Added.", "schema":{ "description":"Model for the tax Parameter response", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-taxParameters-post", "x-filename-id":"config-sim-v2-sales-taxparameters-post" } }, "/config/sim/v1/sales/updatetaxparameters":{ "post":{ "tags":[ "v1/Sales/Tax Parameters" ], "summary":"Update Tax Parameters", "description":"Updates the tax parameter. If tax parameter is not found , it creates a new tax parameter.", "operationId":"updateTaxParameters", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxParametersCURequestBody" } ], "responses":{ "200":{ "description":"Tax Parameter Updated or Added.", "schema":{ "$ref":"#/definitions/TaxParameterResponse" } } }, "x-internal-id":"config-sim-v1-sales-updatetaxparameters-post", "x-filename-id":"config-sim-v1-sales-updatetaxparameters-post" } }, "/config/sim/v2/sales/updateTaxParameters":{ "post":{ "tags":[ "v2/Sales/Tax Parameters" ], "summary":"Update Tax Parameters", "description":"Updates the tax parameter", "operationId":"updateTaxParametersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxParametersCURequestBody" } ], "responses":{ "200":{ "description":"Tax Parameter Updated.", "schema":{ "description":"Model for the tax Parameter response", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-updateTaxParameters-post", "x-filename-id":"config-sim-v2-sales-updatetaxparameters-post" } }, "/config/sim/v1/sales/deletetaxparameters":{ "post":{ "tags":[ "v1/Sales/Tax Parameters" ], "summary":"Delete Tax Parameters", "description":"Deletes the tax parameter", "operationId":"deleteTaxParameters", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxParameterResponse" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-sales-deletetaxparameters-post", "x-filename-id":"config-sim-v1-sales-deletetaxparameters-post" } }, "/config/sim/v2/sales/deleteTaxParameters":{ "post":{ "tags":[ "v2/Sales/Tax Parameters" ], "summary":"Delete Tax Parameters", "description":"Deletes the tax parameter", "operationId":"deleteTaxParametersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxParameterResponse" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-sales-deleteTaxParameters-post", "x-filename-id":"config-sim-v2-sales-deletetaxparameters-post" } }, "/config/sim/v1/sales/gettaxclasses":{ "post":{ "tags":[ "v1/Sales/Tax Classes" ], "summary":"Get Tax Classes", "description":"Gets all the tax classes", "operationId":"getTaxClasses", "parameters":[ { "$ref":"#/parameters/body.TaxClassesGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Tax class entities.", "schema":{ "$ref":"#/definitions/TaxClassGetResponsev1" } } }, "x-internal-id":"config-sim-v1-sales-gettaxclasses-post", "x-filename-id":"config-sim-v1-sales-gettaxclasses-post" } }, "/config/sim/v2/sales/getTaxClasses":{ "post":{ "tags":[ "v2/Sales/Tax Classes" ], "summary":"Get Tax Classes", "description":"Gets all the tax classes", "operationId":"getTaxClassesv2", "parameters":[ { "$ref":"#/parameters/body.TaxClassesGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Tax class entities.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Tax Class objects of the organization.", "items":{ "$ref":"#/definitions/TaxClassv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-sales-getTaxClasses-post", "x-filename-id":"config-sim-v2-sales-gettaxclasses-post" } }, "/config/sim/v1/sales/taxclasses":{ "post":{ "tags":[ "v1/Sales/Tax Classes" ], "summary":"Add Tax Classes", "description":"Add the Tax Class to a specified organization.", "operationId":"addTaxClasses", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxClassCURequestBody" } ], "responses":{ "200":{ "description":"Tax Class Added.", "schema":{ "$ref":"#/definitions/TaxClassResponse" } } }, "x-internal-id":"config-sim-v1-sales-taxclasses-post", "x-filename-id":"config-sim-v1-sales-taxclasses-post" } }, "/config/sim/v2/sales/taxClasses":{ "post":{ "tags":[ "v2/Sales/Tax Classes" ], "summary":"Add Tax Classes", "description":"Add the Tax Class to a specified organization.", "operationId":"addTaxClassesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxClassCURequestBodyv2" } ], "responses":{ "200":{ "description":"Tax Class Added.", "schema":{ "description":"Model for the response", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the tax class", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-taxClasses-post", "x-filename-id":"config-sim-v2-sales-taxclasses-post" } }, "/config/sim/v1/sales/updatetaxclasses":{ "post":{ "tags":[ "v1/Sales/Tax Classes" ], "summary":"Update Tax Classes", "description":"Updates the tax class. If tax class is not found, it creates a new tax class.", "operationId":"updateTaxClasses", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxClassCURequestBody" } ], "responses":{ "200":{ "description":"Tax Class Updated or Added.", "schema":{ "$ref":"#/definitions/TaxClassResponse" } } }, "x-internal-id":"config-sim-v1-sales-updatetaxclasses-post", "x-filename-id":"config-sim-v1-sales-updatetaxclasses-post" } }, "/config/sim/v2/sales/updateTaxClasses":{ "post":{ "tags":[ "v2/Sales/Tax Classes" ], "summary":"Update Tax Classes", "description":"Updates the tax class.", "operationId":"updateTaxClassesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TaxClassCURequestBodyv2" } ], "responses":{ "200":{ "description":"Tax Class Updated.", "schema":{ "description":"Model for the response", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the tax class", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-updateTaxClasses-post", "x-filename-id":"config-sim-v2-sales-updatetaxclasses-post" } }, "/config/sim/v1/sales/deletetaxclasses":{ "post":{ "tags":[ "v1/Sales/Tax Classes" ], "summary":"Delete Tax Classes", "description":"Deletes the tax class object", "operationId":"deleteTaxClasses", "parameters":[ { "$ref":"#/parameters/body.TaxResponse" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-sales-deletetaxclasses-post", "x-filename-id":"config-sim-v1-sales-deletetaxclasses-post" } }, "/config/sim/v2/sales/deleteTaxClasses":{ "post":{ "tags":[ "v2/Sales/Tax Classes" ], "summary":"Delete Tax Classes", "description":"Deletes the tax class object", "operationId":"deleteTaxClassesv2", "parameters":[ { "$ref":"#/parameters/body.TaxResponse" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-sales-deleteTaxClasses-post", "x-filename-id":"config-sim-v2-sales-deletetaxclasses-post" } }, "/config/sim/v2/menuItems/getComboSideGroupsLite":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Groups Lite" ], "summary":"Get Combo Side Groups Lite", "description":"Gets all the Combo Side Groups", "operationId":"getComboSideGroupsLite", "parameters":[ { "$ref":"#/parameters/body.ComboSideGroupsLiteGetParameters" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Combo Side Groups", "items":{ "$ref":"#/definitions/ComboSideGroupsLite" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getComboSideGroupsLite-post", "x-filename-id":"config-sim-v2-menuitems-getcombosidegroupslite-post" } }, "/config/sim/v2/menuItems/comboSideGroupsLite":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Groups Lite" ], "summary":"Add Combo Side Groups Lite", "description":"Adds a Combo Side Group", "operationId":"createComboSideGroupsLite", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboSideGroupsLiteInsertRequest" } ], "responses":{ "200":{ "description":"Combo Side Group Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." }, "objectNum":{ "type":"integer", "example":2, "description":"Object number of the combo side group." }, "comboMealGroupId":{ "type":"integer", "example":2, "description":"Unique ID of combo side group." } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroupsLite-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroupslite-post" } }, "/config/sim/v2/menuItems/updateComboSideGroupsLite":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Groups Lite" ], "summary":"Update Combo Side Groups Lite", "description":"Updates an existing Combo Side Group", "operationId":"updateComboSideGroupsLite", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboSideGroupsLiteUpdateRequest" } ], "responses":{ "200":{ "description":"Combo Side Group Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." }, "objectNum":{ "type":"integer", "example":2, "description":"Object number of the combo side group." }, "comboMealGroupId":{ "type":"integer", "example":2, "description":"Unique ID of combo side group. item" } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateComboSideGroupsLite-post", "x-filename-id":"config-sim-v2-menuitems-updatecombosidegroupslite-post" } }, "/config/sim/v2/menuItems/deleteComboSideGroupsLite":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Groups Lite" ], "summary":"Delete Side Groups Lite", "description":"Deletes a Combo Side Group", "operationId":"deleteComboSideGroupsLite", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboSideGroupsLiteDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteComboSideGroupsLite-post", "x-filename-id":"config-sim-v2-menuitems-deletecombosidegroupslite-post" } }, "/config/sim/v2/menuItems/getComboMealsLite":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meals Lite" ], "summary":"Get Combo Meals Lite", "description":"Gets all the Combo Meals configured without its associated sides and prices.", "operationId":"getComboMealsLite", "parameters":[ { "$ref":"#/parameters/body.ComboMealsLiteGetParameters" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Combo Meal records.", "items":{ "$ref":"#/definitions/ComboMealsLite" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getComboMealsLite-post", "x-filename-id":"config-sim-v2-menuitems-getcombomealslite-post" } }, "/config/sim/v2/menuItems/comboMealsLite":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meals Lite" ], "summary":"Add Combo Meals Lite", "description":"Adds the Combo Meal.", "operationId":"addComboMealsLite", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealsLiteCURequestBody" } ], "responses":{ "200":{ "description":"Combo Meal Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Combo Meal" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboMealsLite-post", "x-filename-id":"config-sim-v2-menuitems-combomealslite-post" } }, "/config/sim/v2/menuItems/updateComboMealsLite":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meals Lite" ], "summary":"Update Combo Meals Lite", "description":"Updates the Combo Meal.", "operationId":"updateComboMealsLite", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealsLiteCURequestBody" } ], "responses":{ "200":{ "description":"Combo Meal Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Combo Meal" } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateComboMealsLite-post", "x-filename-id":"config-sim-v2-menuitems-updatecombomealslite-post" } }, "/config/sim/v2/menuItems/deleteComboMealsLite":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meals Lite" ], "summary":"Delete Combo Meals Lite", "description":"Deletes the Combo Meal along with associated sides and prices.", "operationId":"deleteComboMealsLite", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealsLiteDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteComboMealsLite-post", "x-filename-id":"config-sim-v2-menuitems-deletecombomealslite-post" } }, "/config/sim/v1/hierarchy/getHierarchy":{ "post":{ "tags":[ "v1/Hierarchy/Hierarchy" ], "summary":"Get Hierarchies", "description":"Gets a list of hierarchies in a given organization", "operationId":"getHierarchy", "parameters":[ { "$ref":"#/parameters/body.HierarchyGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Hierarchies.", "schema":{ "$ref":"#/definitions/HierarchyGetResponsev1" } } }, "x-internal-id":"config-sim-v1-hierarchy-getHierarchy-post", "x-filename-id":"config-sim-v1-hierarchy-gethierarchy-post" } }, "/config/sim/v2/hierarchy/getHierarchy":{ "post":{ "tags":[ "v2/Hierarchy/Hierarchy" ], "summary":"Get Hierarchies", "description":"Gets a list of hierarchies in a given organization", "operationId":"getHierarchyv2", "parameters":[ { "$ref":"#/parameters/body.HierarchyGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Hierarchies.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":1, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Hierarchy objects of the organization.", "items":{ "$ref":"#/definitions/Hierarchyv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-getHierarchy-post", "x-filename-id":"config-sim-v2-hierarchy-gethierarchy-post" } }, "/config/sim/v2/hierarchy/getHierarchyNodes":{ "post":{ "tags":[ "v2/Hierarchy/Hierarchy" ], "summary":"Get Hierarchy Nodes", "description":"Get Hierarchy Nodes", "operationId":"getHierarchyNodes", "parameters":[ { "$ref":"#/parameters/body.HierarchyGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Hierarchy Nodes.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":9, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":false, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Hierarchy Node records.", "items":{ "$ref":"#/definitions/HierarchyNode" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-getHierarchyNodes-post", "x-filename-id":"config-sim-v2-hierarchy-gethierarchynodes-post" } }, "/content/sim/v1/setup/getCustomContent":{ "post":{ "tags":[ "v1/Setup/Custom Content" ], "summary":"Get Custom Content", "description":"Gets all the custom content", "operationId":"getCustomContent", "parameters":[ { "$ref":"#/parameters/body.CustomContentGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Custom Content objects", "schema":{ "$ref":"#/definitions/CustomContentGetResponsev1" } } }, "x-internal-id":"content-sim-v1-setup-getCustomContent-post", "x-filename-id":"content-sim-v1-setup-getcustomcontent-post" } }, "/content/sim/v2/setup/getCustomContent":{ "post":{ "tags":[ "v2/Setup/Custom Content" ], "summary":"Get Custom Content", "description":"Gets all the custom content", "operationId":"getCustomContentv2", "parameters":[ { "$ref":"#/parameters/body.CustomContentGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Custom Content objects", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Custom Content objects of the organization.", "items":{ "$ref":"#/definitions/CustomContentv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"content-sim-v2-setup-getCustomContent-post", "x-filename-id":"content-sim-v2-setup-getcustomcontent-post" } }, "/content/sim/v1/setup/customContent":{ "post":{ "tags":[ "v1/Setup/Custom Content" ], "summary":"Add Custom Content", "description":"Add the custom content to the specified organization.", "operationId":"addCustomContent", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CustomContentInsertRequest" } ], "responses":{ "200":{ "description":"Custom content Added.", "schema":{ "$ref":"#/definitions/CustomContentResponse" } } }, "x-internal-id":"content-sim-v1-setup-customContent-post", "x-filename-id":"content-sim-v1-setup-customcontent-post" } }, "/content/sim/v2/setup/customContent":{ "post":{ "tags":[ "v2/Setup/Custom Content" ], "summary":"Add Custom Content", "description":"Add the custom content to the specified organization.", "operationId":"addCustomContentv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CustomContentInsertRequestv2" } ], "responses":{ "200":{ "description":"Custom content Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." }, "id":{ "type":"integer", "example":1, "description":"Unique reference of the content" } } } } }, "x-internal-id":"content-sim-v2-setup-customContent-post", "x-filename-id":"content-sim-v2-setup-customcontent-post" } }, "/content/sim/v1/setup/updateCustomContent":{ "post":{ "tags":[ "v1/Setup/Custom Content" ], "summary":"Update Custom Content", "description":"Updates the custom content. If content is not found, it add a new custom content.", "operationId":"updateCustomContent", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.UpdateCustomContent" } ], "responses":{ "200":{ "description":"Custom content Updated or Added.", "schema":{ "$ref":"#/definitions/CustomContentResponse" } } }, "x-internal-id":"content-sim-v1-setup-updateCustomContent-post", "x-filename-id":"content-sim-v1-setup-updatecustomcontent-post" } }, "/content/sim/v2/setup/updateCustomContent":{ "post":{ "tags":[ "v2/Setup/Custom Content" ], "summary":"Update Custom Content", "description":"Updates the custom content.", "operationId":"updateCustomContentv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.UpdateCustomContentv2" } ], "responses":{ "200":{ "description":"Custom content Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." }, "id":{ "type":"integer", "example":1, "description":"Unique reference of the content" } } } } }, "x-internal-id":"content-sim-v2-setup-updateCustomContent-post", "x-filename-id":"content-sim-v2-setup-updatecustomcontent-post" } }, "/content/sim/v1/setup/deleteCustomContent":{ "post":{ "tags":[ "v1/Setup/Custom Content" ], "summary":"Delete Custom Content", "description":"Deletes the custom content object.", "operationId":"deleteCustomContent", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CustomContentDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"content-sim-v1-setup-deleteCustomContent-post", "x-filename-id":"content-sim-v1-setup-deletecustomcontent-post" } }, "/content/sim/v2/setup/deleteCustomContent":{ "post":{ "tags":[ "v2/Setup/Custom Content" ], "summary":"Delete Custom Content", "description":"Deletes the custom content object.", "operationId":"deleteCustomContentv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CustomContentDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"content-sim-v2-setup-deleteCustomContent-post", "x-filename-id":"content-sim-v2-setup-deletecustomcontent-post" } }, "/content/sim/v1/setup/downloadCustomContent":{ "post":{ "tags":[ "v1/Setup/Custom Content" ], "summary":"Download Custom Content", "description":"Downloads the content file for the specified object in the specified organization.", "operationId":"downloadCustomContent", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CustomContentDownloadRequest" } ], "responses":{ "200":{ "description":"Download the file as a octet stream", "schema":{ "type":"string", "format":"binary" } } }, "x-internal-id":"content-sim-v1-setup-downloadCustomContent-post", "x-filename-id":"content-sim-v1-setup-downloadcustomcontent-post" } }, "/content/sim/v2/setup/downloadCustomContent":{ "post":{ "tags":[ "v2/Setup/Custom Content" ], "summary":"Download Custom Content", "description":"Downloads the content file for the specified object in the specified organization.", "operationId":"downloadCustomContentv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CustomContentDownloadRequest" } ], "responses":{ "200":{ "description":"Download the file as a octet stream", "schema":{ "type":"string", "format":"binary" } } }, "x-internal-id":"content-sim-v2-setup-downloadCustomContent-post", "x-filename-id":"content-sim-v2-setup-downloadcustomcontent-post" } }, "/config/sim/v1/sales/discounts/gettriggergroups":{ "post":{ "tags":[ "v1/Sales/Discounts/Discount Trigger Groups" ], "summary":"Get Discount Trigger Groups", "description":"Gets all the trigger groups for the specified Discount configured for the specified", "operationId":"getDiscountTriggerGroups", "parameters":[ { "$ref":"#/parameters/body.DiscountTriggerGroupsGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of DiscountTriggerGrps entities in an organization.", "schema":{ "$ref":"#/definitions/DiscountTriggerGrpsGetResponsev1" } } }, "x-internal-id":"config-sim-v1-sales-discounts-gettriggergroups-post", "x-filename-id":"config-sim-v1-sales-discounts-gettriggergroups-post" } }, "/config/sim/v2/sales/discounts/getTriggerGroups":{ "post":{ "tags":[ "v2/Sales/Discounts/Discount Trigger Groups" ], "summary":"Get Discount Trigger Groups", "description":"Gets all the trigger groups for the specified Discount configured for the specified", "operationId":"getDiscountTriggerGroupsv2", "parameters":[ { "$ref":"#/parameters/body.DiscountTriggerGroupsGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Discount Trigger Groups.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Discount Trigger Group objects of the organization.", "items":{ "$ref":"#/definitions/DiscountTriggerGroupv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-sales-discounts-getTriggerGroups-post", "x-filename-id":"config-sim-v2-sales-discounts-gettriggergroups-post" } }, "/config/sim/v1/sales/discounts/triggergroups":{ "post":{ "tags":[ "v1/Sales/Discounts/Discount Trigger Groups" ], "summary":"Add Discount Trigger Groups", "description":"Adds a Discount trigger group.", "operationId":"addDiscountTriggerGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountTriggerGrpsCURequestBody" } ], "responses":{ "200":{ "description":"Discount trigger group Added.", "schema":{ "$ref":"#/definitions/DiscountTriggerGrpsResponse" } } }, "x-internal-id":"config-sim-v1-sales-discounts-triggergroups-post", "x-filename-id":"config-sim-v1-sales-discounts-triggergroups-post" } }, "/config/sim/v2/sales/discounts/triggerGroups":{ "post":{ "tags":[ "v2/Sales/Discounts/Discount Trigger Groups" ], "summary":"Add Discount Trigger Groups", "description":"Adds a Discount trigger group.", "operationId":"addDiscountTriggerGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountTriggerGrpsCURequestBody" } ], "responses":{ "200":{ "description":"Discount trigger group Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique Hierarchy Unit Value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the Discount.", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"ObjectNumber of Effectivity Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence Number of the discount trigger group", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-discounts-triggerGroups-post", "x-filename-id":"config-sim-v2-sales-discounts-triggergroups-post" } }, "/config/sim/v1/sales/discounts/updatetriggergroups":{ "post":{ "tags":[ "v1/Sales/Discounts/Discount Trigger Groups" ], "summary":"Update Discount Trigger Groups", "description":"Updates the Discount Trigger Group. If Discount Trigger Group is not found, it creates a new Discount Trigger Group", "operationId":"updateDiscountTriggerGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountTriggerGrpsCURequestBody" } ], "responses":{ "200":{ "description":"Discount trigger group Updated or Added.", "schema":{ "$ref":"#/definitions/DiscountTriggerGrpsResponse" } } }, "x-internal-id":"config-sim-v1-sales-discounts-updatetriggergroups-post", "x-filename-id":"config-sim-v1-sales-discounts-updatetriggergroups-post" } }, "/config/sim/v2/sales/discounts/updateTriggerGroups":{ "post":{ "tags":[ "v2/Sales/Discounts/Discount Trigger Groups" ], "summary":"Update Discount Trigger Groups", "description":"Updates the Discount Trigger Group.", "operationId":"updateDiscountTriggerGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountTriggerGrpsCURequestBody" } ], "responses":{ "200":{ "description":"Discount trigger group Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique Hierarchy Unit Value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the discount.", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"ObjectNumber of Effectivity Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence Number of the discount trigger group", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-discounts-updateTriggerGroups-post", "x-filename-id":"config-sim-v2-sales-discounts-updatetriggergroups-post" } }, "/config/sim/v1/sales/discounts/deletetriggergroups":{ "post":{ "tags":[ "v1/Sales/Discounts/Discount Trigger Groups" ], "summary":"Delete Discount Trigger Groups", "description":"Deletes the Discount Trigger Group object.", "operationId":"deleteDiscountTriggerGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountTriggerGrpsDeleteRequestBody" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-sales-discounts-deletetriggergroups-post", "x-filename-id":"config-sim-v1-sales-discounts-deletetriggergroups-post" } }, "/config/sim/v2/sales/discounts/deleteTriggerGroups":{ "post":{ "tags":[ "v2/Sales/Discounts/Discount Trigger Groups" ], "summary":"Delete Discount Trigger Groups", "description":"Deletes the Discount Trigger Group object.", "operationId":"deleteDiscountTriggerGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountTriggerGrpsDeleteRequestBody" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-sales-discounts-deleteTriggerGroups-post", "x-filename-id":"config-sim-v2-sales-discounts-deletetriggergroups-post" } }, "/config/sim/v1/menuitems/getMenuItems":{ "post":{ "tags":[ "v1/Menu Items/Menu Items" ], "summary":"Get Menu Items", "description":"Gets all the Menu Items configured", "operationId":"getMenuItems", "parameters":[ { "$ref":"#/parameters/body.MenuItemsGetParameters" } ], "responses":{ "200":{ "description":"A collection of Menu Items in organization.", "schema":{ "$ref":"#/definitions/MenuItemv1GetResponse" } } }, "x-internal-id":"config-sim-v1-menuitems-getMenuItems-post", "x-filename-id":"config-sim-v1-menuitems-getmenuitems-post" } }, "/content/sim/v1/setup/screenlookups/getconsumercontent":{ "post":{ "tags":[ "v1/Setup/Screen Look Ups/Screen Look Up Consumer Facing Content" ], "summary":"Get SLU Consumer Facing Content", "description":"Gets a list of SLU Consumer Facing Content.", "operationId":"getSLUConsumerFacingContent", "parameters":[ { "$ref":"#/parameters/body.SLUConsumerFacingContentGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of SLU Consumer Facing Content entities.", "schema":{ "$ref":"#/definitions/SLUConsumerFacingContentGetResponsev1" } } }, "x-internal-id":"content-sim-v1-setup-screenlookups-getconsumercontent-post", "x-filename-id":"content-sim-v1-setup-screenlookups-getconsumercontent-post" } }, "/content/sim/v2/setup/screenLookups/getConsumerContent":{ "post":{ "tags":[ "v2/Setup/Screen Look Ups/Screen Look Up Consumer Facing Content" ], "summary":"Get SLU Consumer Facing Content", "description":"Gets a list of SLU Consumer Facing Content.", "operationId":"getSLUConsumerFacingContentv2", "parameters":[ { "$ref":"#/parameters/body.SLUConsumerFacingContentGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of SLU Consumer Facing Content entities.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of SLU Consumer Facing Content objects of the organization.", "items":{ "$ref":"#/definitions/SLUConsumerFacingContentv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"content-sim-v2-setup-screenLookups-getConsumerContent-post", "x-filename-id":"content-sim-v2-setup-screenlookups-getconsumercontent-post" } }, "/content/sim/v1/setup/screenlookups/consumercontent":{ "post":{ "tags":[ "v1/Setup/Screen Look Ups/Screen Look Up Consumer Facing Content" ], "summary":"Add SLU Consumer Facing Content", "description":"Add the SLU Consumer Facing Content to a specified hierarchy unit .", "operationId":"AddSLUConsumerFacingContent", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SLUConsumerFacingContentCURequest" } ], "responses":{ "200":{ "description":"SLU Consumer Facing Content Added.", "schema":{ "$ref":"#/definitions/ContentResponse" } } }, "x-internal-id":"content-sim-v1-setup-screenlookups-consumercontent-post", "x-filename-id":"content-sim-v1-setup-screenlookups-consumercontent-post" } }, "/content/sim/v2/setup/screenLookups/consumerContent":{ "post":{ "tags":[ "v2/Setup/Screen Look Ups/Screen Look Up Consumer Facing Content" ], "summary":"Add SLU Consumer Facing Content", "description":"Add the SLU Consumer Facing Content to a specified hierarchy unit .", "operationId":"AddSLUConsumerFacingContentv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SLUConsumerFacingContentCURequest" } ], "responses":{ "200":{ "description":"SLU Consumer Facing Content Added.", "schema":{ "description":"Response object for Content related Objects", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the SLU", "type":"integer", "example":1 }, "imageIndex":{ "description":"Image number of the SLU", "type":"integer", "example":1 }, "url":{ "description":"Object storage url of the uploaded image, can be used for downloading the uploaded image.", "type":"string", "example":"https://objectstorage.oracle.com/xyz.jpg" } } } } }, "x-internal-id":"content-sim-v2-setup-screenLookups-consumerContent-post", "x-filename-id":"content-sim-v2-setup-screenlookups-consumercontent-post" } }, "/content/sim/v1/setup/screenlookups/updateconsumercontent":{ "post":{ "tags":[ "v1/Setup/Screen Look Ups/Screen Look Up Consumer Facing Content" ], "summary":"Update SLU Consumer Facing Content", "description":"Updates the SLU Consumer Facing Content. If SLU Consumer Facing Content is not found it creates a new entry for SLU Consumer Facing Content.", "operationId":"updateSLUConsumerFacingContent", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SLUConsumerFacingContentCURequest" } ], "responses":{ "200":{ "description":"SLU Consumer Facing Content Updated or Added.", "schema":{ "$ref":"#/definitions/ContentResponse" } } }, "x-internal-id":"content-sim-v1-setup-screenlookups-updateconsumercontent-post", "x-filename-id":"content-sim-v1-setup-screenlookups-updateconsumercontent-post" } }, "/content/sim/v2/setup/screenLookups/updateConsumerContent":{ "post":{ "tags":[ "v2/Setup/Screen Look Ups/Screen Look Up Consumer Facing Content" ], "summary":"Update SLU Consumer Facing Content", "description":"Updates the SLU Consumer Facing Content.", "operationId":"updateSLUConsumerFacingContentv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SLUConsumerFacingContentCURequest" } ], "responses":{ "200":{ "description":"SLU Consumer Facing Content Updated.", "schema":{ "description":"Response object for Content related Objects", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the SLU", "type":"integer", "example":1 }, "imageIndex":{ "description":"Image number of the SLU", "type":"integer", "example":1 }, "url":{ "description":"Object storage url of the uploaded image, can be used for downloading the uploaded image.", "type":"string", "example":"https://objectstorage.oracle.com/xyz.jpg" } } } } }, "x-internal-id":"content-sim-v2-setup-screenLookups-updateConsumerContent-post", "x-filename-id":"content-sim-v2-setup-screenlookups-updateconsumercontent-post" } }, "/content/sim/v1/setup/screenlookups/deleteconsumercontent":{ "post":{ "tags":[ "v1/Setup/Screen Look Ups/Screen Look Up Consumer Facing Content" ], "summary":"Delete SLU Consumer Facing Content", "description":"Deletes the SLU Consumer Facing Content object.", "operationId":"deleteSLUConsumerFacingContent", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SLUConsumerFacingContentDelete" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"content-sim-v1-setup-screenlookups-deleteconsumercontent-post", "x-filename-id":"content-sim-v1-setup-screenlookups-deleteconsumercontent-post" } }, "/content/sim/v2/setup/screenLookups/deleteConsumerContent":{ "post":{ "tags":[ "v2/Setup/Screen Look Ups/Screen Look Up Consumer Facing Content" ], "summary":"Delete SLU Consumer Facing Content", "description":"Deletes the SLU Consumer Facing Content object.", "operationId":"deleteSLUConsumerFacingContentv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SLUConsumerFacingContentDelete" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"content-sim-v2-setup-screenLookups-deleteConsumerContent-post", "x-filename-id":"content-sim-v2-setup-screenlookups-deleteconsumercontent-post" } }, "/content/sim/v1/setup/screenlookups/downloadconsumercontent":{ "post":{ "tags":[ "v1/Setup/Screen Look Ups/Screen Look Up Consumer Facing Content" ], "summary":"Download SLU Consumer Facing Content", "description":"Downloads the SLU Consumer Facing Content object.", "operationId":"downloadSLUConsumerFacingContent", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SLUConsumerFacingContentDelete" } ], "responses":{ "200":{ "description":"Download the file as a octet stream", "schema":{ "type":"string", "format":"binary" } } }, "x-internal-id":"content-sim-v1-setup-screenlookups-downloadconsumercontent-post", "x-filename-id":"content-sim-v1-setup-screenlookups-downloadconsumercontent-post" } }, "/content/sim/v2/setup/screenLookups/downloadConsumerContent":{ "post":{ "tags":[ "v2/Setup/Screen Look Ups/Screen Look Up Consumer Facing Content" ], "summary":"Download SLU Consumer Facing Content", "description":"Downloads the SLU Consumer Facing Content object.", "operationId":"downloadSLUConsumerFacingContentv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SLUConsumerFacingContentDelete" } ], "responses":{ "200":{ "description":"Download the file as a octet stream", "schema":{ "type":"string", "format":"binary" } } }, "x-internal-id":"content-sim-v2-setup-screenLookups-downloadConsumerContent-post", "x-filename-id":"content-sim-v2-setup-screenlookups-downloadconsumercontent-post" } }, "/content/sim/v1/menuitems/menuitemdefinition/getConsumerContent":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Definitions/Menu Item Definition Consumer Facing Content" ], "summary":"Get Menu Item Defintion Consumer Facing Content", "description":"Gets a list of Menu Item Consumer Facing Content.", "operationId":"getMenuItemConsumerFacingContent", "parameters":[ { "$ref":"#/parameters/body.MenuItemDefinitionConsumerFacingContentGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Menu Item Consumer Facing Content.", "schema":{ "$ref":"#/definitions/MenuItemConsumerFacingContentGetResponsev1" } } }, "x-internal-id":"content-sim-v1-menuitems-menuitemdefinition-getConsumerContent-post", "x-filename-id":"content-sim-v1-menuitems-menuitemdefinition-getconsumercontent-post" } }, "/content/sim/v2/menuItems/menuItemDefinition/getConsumerContent":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Definitions/Menu Item Definition Consumer Facing Content" ], "summary":"Get Menu Item Defintion Consumer Facing Content", "description":"Gets a list of Menu Item Consumer Facing Content.", "operationId":"getMenuItemConsumerFacingContentv2", "parameters":[ { "$ref":"#/parameters/body.MenuItemDefinitionConsumerFacingContentGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Menu Item Consumer Facing Content.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Definition Consumer Facing Content objects of the organization.", "items":{ "$ref":"#/definitions/MenuItemConsumerFacingContentv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"content-sim-v2-menuItems-menuItemDefinition-getConsumerContent-post", "x-filename-id":"content-sim-v2-menuitems-menuitemdefinition-getconsumercontent-post" } }, "/content/sim/v1/menuitems/menuitemdefinition/consumerContent":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Definitions/Menu Item Definition Consumer Facing Content" ], "summary":"Add Menu Item Definition Consumer Facing Content", "description":"Add the Menu Item Consumer Facing Content to a specified hierarchy unit .", "operationId":"addMenuItemConsumerFacingContent", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemConsumerFacingContentCUDRequestBody" } ], "responses":{ "200":{ "description":"Menu Item Consumer Facing Content Added.", "schema":{ "$ref":"#/definitions/MenuItemConsumerFacingContentResponse" } } }, "x-internal-id":"content-sim-v1-menuitems-menuitemdefinition-consumerContent-post", "x-filename-id":"content-sim-v1-menuitems-menuitemdefinition-consumercontent-post" } }, "/content/sim/v2/menuItems/menuItemDefinition/consumerContent":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Definitions/Menu Item Definition Consumer Facing Content" ], "summary":"Add Menu Item Definition Consumer Facing Content", "description":"Add the Menu Item Consumer Facing Content to a specified hierarchy unit .", "operationId":"addMenuItemConsumerFacingContentv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemConsumerFacingContentCUDRequestBody" } ], "responses":{ "200":{ "description":"Menu Item Consumer Facing Content Added.", "schema":{ "description":"Response object for Content related Objects", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the menu item", "type":"integer", "example":1 }, "imageIndex":{ "description":"Image number of the menu item", "type":"integer", "example":1 }, "url":{ "description":"Object storage url of the uploaded image, can be used for downloading the uploaded image.", "type":"string", "example":"https://objectstorage.oracle.com/xyz.jpg" } } } } }, "x-internal-id":"content-sim-v2-menuItems-menuItemDefinition-consumerContent-post", "x-filename-id":"content-sim-v2-menuitems-menuitemdefinition-consumercontent-post" } }, "/content/sim/v1/menuitems/menuitemdefinition/updateConsumerContent":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Definitions/Menu Item Definition Consumer Facing Content" ], "summary":"Update Menu Item Definition Consumer Facing Content", "description":"Updates the Menu Item Consumer Facing Content. If Menu Item Consumer Facing Content is not found it creates a new entry for Menu Item Consumer Facing Content.", "operationId":"updateMenuItemConsumerFacingContent", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemConsumerFacingContentCUDRequestBody" } ], "responses":{ "200":{ "description":"Menu Item Consumer Facing Content Updated or Added.", "schema":{ "$ref":"#/definitions/MenuItemConsumerFacingContentResponse" } } }, "x-internal-id":"content-sim-v1-menuitems-menuitemdefinition-updateConsumerContent-post", "x-filename-id":"content-sim-v1-menuitems-menuitemdefinition-updateconsumercontent-post" } }, "/content/sim/v2/menuItems/menuItemDefinition/updateConsumerContent":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Definitions/Menu Item Definition Consumer Facing Content" ], "summary":"Update Menu Item Definition Consumer Facing Content", "description":"Updates the Menu Item Consumer Facing Content.", "operationId":"updateMenuItemConsumerFacingContentv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemConsumerFacingContentCUDRequestBody" } ], "responses":{ "200":{ "description":"Menu Item Consumer Facing Content Updated.", "schema":{ "description":"Response object for Content related Objects", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the menu item", "type":"integer", "example":1 }, "imageIndex":{ "description":"Image number of the menu item", "type":"integer", "example":1 }, "url":{ "description":"Object storage url of the uploaded image, can be used for downloading the uploaded image.", "type":"string", "example":"https://objectstorage.oracle.com/xyz.jpg" } } } } }, "x-internal-id":"content-sim-v2-menuItems-menuItemDefinition-updateConsumerContent-post", "x-filename-id":"content-sim-v2-menuitems-menuitemdefinition-updateconsumercontent-post" } }, "/content/sim/v1/menuitems/menuitemdefinition/deleteConsumerContent":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Definitions/Menu Item Definition Consumer Facing Content" ], "summary":"Delete Menu Item Definition Consumer Facing Content", "description":"Deletes the Menu Item Consumer Facing Content object.", "operationId":"deleteMenuItemConsumerFacingContent", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemConsumerFacingContentDelete" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"content-sim-v1-menuitems-menuitemdefinition-deleteConsumerContent-post", "x-filename-id":"content-sim-v1-menuitems-menuitemdefinition-deleteconsumercontent-post" } }, "/content/sim/v2/menuItems/menuItemDefinition/deleteConsumerContent":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Definitions/Menu Item Definition Consumer Facing Content" ], "summary":"Delete Menu Item Definition Consumer Facing Content", "description":"Deletes the Menu Item Consumer Facing Content object.", "operationId":"deleteMenuItemConsumerFacingContentv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemConsumerFacingContentDelete" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"content-sim-v2-menuItems-menuItemDefinition-deleteConsumerContent-post", "x-filename-id":"content-sim-v2-menuitems-menuitemdefinition-deleteconsumercontent-post" } }, "/content/sim/v1/menuitems/menuitemdefinition/downloadConsumerContent":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Definitions/Menu Item Definition Consumer Facing Content" ], "summary":"Download Menu Item Definition Consumer Facing Content", "description":"Downloads the Menu Item Consumer Facing Content object.", "operationId":"downloadMenuItemConsumerFacingContent", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemConsumerFacingContentDelete" } ], "responses":{ "200":{ "description":"Download the file as a octet stream", "schema":{ "type":"string", "format":"binary" } } }, "x-internal-id":"content-sim-v1-menuitems-menuitemdefinition-downloadConsumerContent-post", "x-filename-id":"content-sim-v1-menuitems-menuitemdefinition-downloadconsumercontent-post" } }, "/content/sim/v2/menuItems/menuItemDefinition/downloadConsumerContent":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Definitions/Menu Item Definition Consumer Facing Content" ], "summary":"Download Menu Item Definition Consumer Facing Content", "description":"Downloads the Menu Item Consumer Facing Content object.", "operationId":"downloadMenuItemConsumerFacingContentv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemConsumerFacingContentDelete" } ], "responses":{ "200":{ "description":"Download the file as a octet stream", "schema":{ "type":"string", "format":"binary" } } }, "x-internal-id":"content-sim-v2-menuItems-menuItemDefinition-downloadConsumerContent-post", "x-filename-id":"content-sim-v2-menuitems-menuitemdefinition-downloadconsumercontent-post" } }, "/config/sim/v1/employees/employees2":{ "post":{ "tags":[ "v1/Employees/Employees2" ], "summary":"Add basic employees", "description":"Add the basic employee object to a specified hierarchy unit of specified organization.", "operationId":"addEmployees2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.Employee2.Insert" } ], "responses":{ "200":{ "description":"Employee Added.", "schema":{ "$ref":"#/definitions/Employee2Response" } } }, "x-internal-id":"config-sim-v1-employees-employees2-post", "x-filename-id":"config-sim-v1-employees-employees2-post" } }, "/config/sim/v2/employees/employees2":{ "post":{ "tags":[ "v2/Employees/Employees2" ], "summary":"Add basic employees", "description":"Add the basic employee object to a specified hierarchy unit of specified organization.", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.Employee2.Insert" } ], "responses":{ "200":{ "description":"Employee Added.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" } } } } }, "x-internal-id":"config-sim-v2-employees-employees2-post", "x-filename-id":"config-sim-v2-employees-employees2-post" } }, "/config/sim/v1/employees/preDeleteCheckEmployees2":{ "post":{ "tags":[ "v1/Employees/Employees2" ], "summary":"Pre-Delete basic employees", "description":"Checks the existence of references to the object in the database.", "operationId":"preDeleteCheckEmployees2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.Delete2Request.Required" } ], "responses":{ "200":{ "description":"Dependency check Response", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"Dependency exists/Dependency does not exist" } } } } }, "x-internal-id":"config-sim-v1-employees-preDeleteCheckEmployees2-post", "x-filename-id":"config-sim-v1-employees-predeletecheckemployees2-post" } }, "/config/sim/v2/employees/preDeleteCheckEmployees2":{ "post":{ "tags":[ "v2/Employees/Employees2" ], "summary":"Pre-Delete basic employees", "description":"Checks the existence of references to the object in the database.", "operationId":"preDeleteCheckEmployees2v2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.Delete2Request.Required" } ], "responses":{ "200":{ "description":"Dependency check Response", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"Dependency exists/Dependency does not exist" } } } } }, "x-internal-id":"config-sim-v2-employees-preDeleteCheckEmployees2-post", "x-filename-id":"config-sim-v2-employees-predeletecheckemployees2-post" } }, "/config/sim/v1/employees/deleteEmployees2":{ "post":{ "tags":[ "v1/Employees/Employees2" ], "summary":"Delete basic employees", "description":"Deletes Employees", "operationId":"deleteEmployees2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.Delete2Request.Required" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-employees-deleteEmployees2-post", "x-filename-id":"config-sim-v1-employees-deleteemployees2-post" } }, "/config/sim/v2/employees/deleteEmployees2":{ "post":{ "tags":[ "v2/Employees/Employees2" ], "summary":"Delete basic employees", "description":"Deletes Employees", "operationId":"deleteEmployees2v2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.Delete2Request.Required" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-employees-deleteEmployees2-post", "x-filename-id":"config-sim-v2-employees-deleteemployees2-post" } }, "/config/sim/v1/employees/getEmployees2":{ "post":{ "tags":[ "v1/Employees/Employees2" ], "summary":"Get basic employees", "description":"Gets all the basic employees information", "operationId":"getEmployees2", "parameters":[ { "$ref":"#/parameters/body.Employees2GetParametersv1" } ], "responses":{ "200":{ "description":"A collection of employees.", "schema":{ "$ref":"#/definitions/Employee2GetResponse" } } }, "x-internal-id":"config-sim-v1-employees-getEmployees2-post", "x-filename-id":"config-sim-v1-employees-getemployees2-post" } }, "/config/sim/v2/employees/getEmployees2":{ "post":{ "tags":[ "v2/Employees/Employees2" ], "summary":"Get basic employees", "description":"Gets all the basic employees information", "operationId":"getEmployees2v2", "parameters":[ { "$ref":"#/parameters/body.Employees2GetParametersv2" } ], "responses":{ "200":{ "description":"A collection of employees.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of basic employee objects of the organization.", "items":{ "$ref":"#/definitions/Employee2v2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-employees-getEmployees2-post", "x-filename-id":"config-sim-v2-employees-getemployees2-post" } }, "/config/sim/v1/employees/updateEmployees2":{ "post":{ "tags":[ "v1/Employees/Employees2" ], "summary":"Update basic employees", "description":"Updates the basic Employee. If Employee is not found is not found, it creates a new Employee.", "operationId":"updateEmployees2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.Employee2.Update" } ], "responses":{ "200":{ "description":"Employee Updated or Created.", "schema":{ "$ref":"#/definitions/Employee2Response" } } }, "x-internal-id":"config-sim-v1-employees-updateEmployees2-post", "x-filename-id":"config-sim-v1-employees-updateemployees2-post" } }, "/config/sim/v2/employees/updateEmployees2":{ "post":{ "tags":[ "v2/Employees/Employees2" ], "summary":"Update basic employees", "description":"Updates the basic Employee.", "operationId":"updateEmployees2v2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.Employee2.Update" } ], "responses":{ "200":{ "description":"Employee Updated or Created.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" } } } } }, "x-internal-id":"config-sim-v2-employees-updateEmployees2-post", "x-filename-id":"config-sim-v2-employees-updateemployees2-post" } }, "/config/sim/v1/menuItems/getMajorGroups":{ "post":{ "tags":[ "v1/Menu Items/Major Groups" ], "summary":"Get Major Groups", "description":"Gets all the Major Groups for a given organization", "operationId":"getMajorGroups", "parameters":[ { "$ref":"#/parameters/body.MajorGroupsGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Major Groups.", "schema":{ "$ref":"#/definitions/MajorGroupGetResponsev1" } } }, "x-internal-id":"config-sim-v1-menuItems-getMajorGroups-post", "x-filename-id":"config-sim-v1-menuitems-getmajorgroups-post" } }, "/config/sim/v2/menuItems/getMajorGroups":{ "post":{ "tags":[ "v2/Menu Items/Major Groups" ], "summary":"Get Major Groups", "description":"Gets all the Major Groups for a given organization", "operationId":"getMajorGroupsv2", "parameters":[ { "$ref":"#/parameters/body.MajorGroupsGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Major Groups.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Major Group objects of the organization.", "items":{ "$ref":"#/definitions/MajorGroupv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getMajorGroups-post", "x-filename-id":"config-sim-v2-menuitems-getmajorgroups-post" } }, "/config/sim/v1/menuItems/majorGroups":{ "post":{ "tags":[ "v1/Menu Items/Major Groups" ], "summary":"Add Major Groups", "description":"

    Add the Major Group object to a specified hierarchy unit

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.4 Starting with the API release 23.4, Insert operation for Major Groups is allowed only at Enterprise.
    \n", "operationId":"insertMajorGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MajorGroupCUDRequestBody" } ], "responses":{ "200":{ "description":"Major Groups Added.", "schema":{ "$ref":"#/definitions/MajorGroupResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-majorGroups-post", "x-filename-id":"config-sim-v1-menuitems-majorgroups-post" } }, "/config/sim/v2/menuItems/majorGroups":{ "post":{ "tags":[ "v2/Menu Items/Major Groups" ], "summary":"Add Major Groups", "description":"Add the Major Group object to a specified hierarchy unit", "operationId":"insertMajorGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MajorGroupCUDRequestBodyv2" } ], "responses":{ "200":{ "description":"Major Groups Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the major group" } } } } }, "x-internal-id":"config-sim-v2-menuItems-majorGroups-post", "x-filename-id":"config-sim-v2-menuitems-majorgroups-post" } }, "/config/sim/v1/menuItems/updateMajorGroups":{ "post":{ "tags":[ "v1/Menu Items/Major Groups" ], "summary":"Update Major Groups", "description":"

    Updates the Major Group. If not found, it creates a new major group.

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.4 Starting with the API release 23.4, Update operation for Major Groups is allowed only at Enterprise.
    \n", "operationId":"updateMajorGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MajorGroupCUDRequestBody" } ], "responses":{ "200":{ "description":"Major Groups Updated or Added.", "schema":{ "$ref":"#/definitions/MajorGroupResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-updateMajorGroups-post", "x-filename-id":"config-sim-v1-menuitems-updatemajorgroups-post" } }, "/config/sim/v2/menuItems/updateMajorGroups":{ "post":{ "tags":[ "v2/Menu Items/Major Groups" ], "summary":"Update Major Groups", "description":"Updates the Major Group.", "operationId":"updateMajorGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MajorGroupCUDRequestBodyv2" } ], "responses":{ "200":{ "description":"Major Groups Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the major group" } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateMajorGroups-post", "x-filename-id":"config-sim-v2-menuitems-updatemajorgroups-post" } }, "/config/sim/v1/menuItems/deleteMajorGroups":{ "post":{ "tags":[ "v1/Menu Items/Major Groups" ], "summary":"Delete Major Groups", "description":"Deletes Major Groups", "operationId":"deleteMajorGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MajorGroupDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/MajorGroupDeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-deleteMajorGroups-post", "x-filename-id":"config-sim-v1-menuitems-deletemajorgroups-post" } }, "/config/sim/v2/menuItems/deleteMajorGroups":{ "post":{ "tags":[ "v2/Menu Items/Major Groups" ], "summary":"Delete Major Groups", "description":"Deletes Major Groups", "operationId":"deleteMajorGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MajorGroupDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteMajorGroups-post", "x-filename-id":"config-sim-v2-menuitems-deletemajorgroups-post" } }, "/config/sim/v1/setup/getAutoMenuLevels":{ "post":{ "tags":[ "v1/Setup/Auto Menu Levels" ], "summary":"Get Auto Menu Levels", "description":"Gets a list of all the auto menu levels", "operationId":"getAutoMenuLevels", "parameters":[ { "$ref":"#/parameters/body.AutoMenuLevelsGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Auto Menu Levels.", "schema":{ "$ref":"#/definitions/AutoMenuLevelGetResponsev1" } } }, "x-internal-id":"config-sim-v1-setup-getAutoMenuLevels-post", "x-filename-id":"config-sim-v1-setup-getautomenulevels-post" } }, "/config/sim/v2/setup/getAutoMenuLevels":{ "post":{ "tags":[ "v2/Setup/Auto Menu Levels" ], "summary":"Get Auto Menu Levels", "description":"Gets a list of all the auto menu levels", "operationId":"getAutoMenuLevelsv2", "parameters":[ { "$ref":"#/parameters/body.AutoMenuLevelsGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Auto Menu Levels.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Auto Menu Level objects of the organization.", "items":{ "$ref":"#/definitions/AutoMenuLevelv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getAutoMenuLevels-post", "x-filename-id":"config-sim-v2-setup-getautomenulevels-post" } }, "/config/sim/v1/setup/autoMenuLevels":{ "post":{ "tags":[ "v1/Setup/Auto Menu Levels" ], "summary":"Add Auto Menu Levels", "description":"Add an Auto Menu Level unit of specified organization", "operationId":"addAutoMenuLevels", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.AutoMenuLevelCUDRequest" } ], "responses":{ "200":{ "description":"Auto Menu Level Added.", "schema":{ "$ref":"#/definitions/AutoMenuLevelResponse" } } }, "x-internal-id":"config-sim-v1-setup-autoMenuLevels-post", "x-filename-id":"config-sim-v1-setup-automenulevels-post" } }, "/config/sim/v2/setup/autoMenuLevels":{ "post":{ "tags":[ "v2/Setup/Auto Menu Levels" ], "summary":"Add Auto Menu Levels", "description":"Add an Auto Menu Level unit of specified organization", "operationId":"addAutoMenuLevelsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.AutoMenuLevelCUDRequest" } ], "responses":{ "200":{ "description":"Auto Menu Level Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "index":{ "type":"integer", "example":1, "description":"Object number of the auto menu level" } } } } }, "x-internal-id":"config-sim-v2-setup-autoMenuLevels-post", "x-filename-id":"config-sim-v2-setup-automenulevels-post" } }, "/config/sim/v1/setup/updateAutoMenuLevels":{ "post":{ "tags":[ "v1/Setup/Auto Menu Levels" ], "summary":"Update Auto Menu Levels", "description":"Updates auto menu level unit of specified organization", "operationId":"updateAutoMenuLevels", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.AutoMenuLevelCUDRequest" } ], "responses":{ "200":{ "description":"Auto Menu Level Updated or Added.", "schema":{ "$ref":"#/definitions/AutoMenuLevelResponse" } } }, "x-internal-id":"config-sim-v1-setup-updateAutoMenuLevels-post", "x-filename-id":"config-sim-v1-setup-updateautomenulevels-post" } }, "/config/sim/v2/setup/updateAutoMenuLevels":{ "post":{ "tags":[ "v2/Setup/Auto Menu Levels" ], "summary":"Update Auto Menu Levels", "description":"Updates auto menu level unit of specified organization", "operationId":"updateAutoMenuLevelsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.AutoMenuLevelCUDRequest" } ], "responses":{ "200":{ "description":"Auto Menu Level Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "index":{ "type":"integer", "example":1, "description":"Object number of the auto menu level" } } } } }, "x-internal-id":"config-sim-v2-setup-updateAutoMenuLevels-post", "x-filename-id":"config-sim-v2-setup-updateautomenulevels-post" } }, "/config/sim/v1/setup/deleteAutoMenuLevels":{ "post":{ "tags":[ "v1/Setup/Auto Menu Levels" ], "summary":"Delete Auto Menu Levels", "description":"Deletes an auto menu level unit of specified organization", "operationId":"deleteAutoMenuLevels", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.AutoMenuLevelDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/DeleteResponse" } } }, "x-internal-id":"config-sim-v1-setup-deleteAutoMenuLevels-post", "x-filename-id":"config-sim-v1-setup-deleteautomenulevels-post" } }, "/config/sim/v2/setup/deleteAutoMenuLevels":{ "post":{ "tags":[ "v2/Setup/Auto Menu Levels" ], "summary":"Delete Auto Menu Levels", "description":"Deletes an auto menu level unit of specified organization", "operationId":"deleteAutoMenuLevelsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.AutoMenuLevelDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteAutoMenuLevels-post", "x-filename-id":"config-sim-v2-setup-deleteautomenulevels-post" } }, "/config/sim/v1/menuitems/combosidegroups/getsidegroupitemprices":{ "post":{ "tags":[ "v1/Menu Items/Combo Side Groups/Combo Side Group Item Prices" ], "summary":"Get Combo Side Group Item Prices", "description":"Gets a list of all the prices of a combo meal group item for the specified organization", "operationId":"getComboGroupItemPrice", "parameters":[ { "$ref":"#/parameters/body.ComboSideGroupItemPricesGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Combo Meal Group Item Prices.", "schema":{ "$ref":"#/definitions/ComboGroupItemPriceGetResponsev1" } } }, "x-internal-id":"config-sim-v1-menuitems-combosidegroups-getsidegroupitemprices-post", "x-filename-id":"config-sim-v1-menuitems-combosidegroups-getsidegroupitemprices-post" } }, "/config/sim/v2/menuItems/comboSideGroups/getSideGroupItemPrices":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Group Item Prices" ], "summary":"Get Combo Side Group Item Prices", "description":"Gets a list of all the prices of a combo meal group item for the specified organization", "operationId":"getComboGroupItemPricev2", "parameters":[ { "$ref":"#/parameters/body.ComboSideGroupItemPricesGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Combo Meal Group Item Prices.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Combo Group Item Price objects of the organization.", "items":{ "$ref":"#/definitions/ComboSideGroupItemPricev2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroups-getSideGroupItemPrices-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroups-getsidegroupitemprices-post" } }, "/config/sim/v1/menuitems/combosidegroups/sidegroupitemprices":{ "post":{ "tags":[ "v1/Menu Items/Combo Side Groups/Combo Side Group Item Prices" ], "summary":"Add Combo Side Group Item Prices", "description":"Add the Combo Meal Group Item Price object to a combo meal group of the specified hierarchy unit .", "operationId":"AddComboGroupItemPrice", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboGroupItemPriceInsertRequest" } ], "responses":{ "200":{ "description":"Combo Group Item Price Added.", "schema":{ "$ref":"#/definitions/ComboGroupItemPriceResponse" } } }, "x-internal-id":"config-sim-v1-menuitems-combosidegroups-sidegroupitemprices-post", "x-filename-id":"config-sim-v1-menuitems-combosidegroups-sidegroupitemprices-post" } }, "/config/sim/v2/menuItems/comboSideGroups/sideGroupItemPrices":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Group Item Prices" ], "summary":"Add Combo Side Group Item Prices", "description":"Add the Combo Meal Group Item Price object to a combo meal group of the specified hierarchy unit .", "operationId":"AddComboGroupItemPricev2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboGroupItemPriceInsertRequestV2" } ], "responses":{ "200":{ "description":"Combo Group Item Price Addded.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" }, "comboMealGroupItemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroups-sideGroupItemPrices-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroups-sidegroupitemprices-post" } }, "/config/sim/v1/menuitems/combosidegroups/updatesidegroupitemprices":{ "post":{ "tags":[ "v1/Menu Items/Combo Side Groups/Combo Side Group Item Prices" ], "summary":"Update Combo Side Group Item Prices", "description":"Updates the Combo Meal Group Item Price. If Combo Meal Group Item Price is not found, it creates a new Combo Meal Group Item Price.", "operationId":"updateComboGroupItemPrice", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboGroupItemPriceUpdateRequest" } ], "responses":{ "200":{ "description":"Combo Group Item Price Updated or Added.", "schema":{ "$ref":"#/definitions/ComboGroupItemPriceResponse" } } }, "x-internal-id":"config-sim-v1-menuitems-combosidegroups-updatesidegroupitemprices-post", "x-filename-id":"config-sim-v1-menuitems-combosidegroups-updatesidegroupitemprices-post" } }, "/config/sim/v2/menuItems/comboSideGroups/updateSideGroupItemPrices":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Group Item Prices" ], "summary":"Update Combo Side Group Item Prices", "description":"Updates the Combo Meal Group Item Price.", "operationId":"updateComboGroupItemPricev2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboGroupItemPriceUpdateRequestV2" } ], "responses":{ "200":{ "description":"Combo Group Item Price Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" }, "comboMealGroupItemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroups-updateSideGroupItemPrices-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroups-updatesidegroupitemprices-post" } }, "/config/sim/v1/menuitems/combosidegroups/deletesidegroupitemprices":{ "post":{ "tags":[ "v1/Menu Items/Combo Side Groups/Combo Side Group Item Prices" ], "summary":"Delete Combo Side Group Item Prices", "description":"Deletes a price from a combo meal group item.", "operationId":"DeleteComboGroupItemPrice", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboGroupItemPriceDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "$ref":"#/definitions/ComboGroupItemPriceDeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuitems-combosidegroups-deletesidegroupitemprices-post", "x-filename-id":"config-sim-v1-menuitems-combosidegroups-deletesidegroupitemprices-post" } }, "/config/sim/v2/menuItems/comboSideGroups/deleteSideGroupItemPrices":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Group Item Prices" ], "summary":"Delete Combo Side Group Item Prices", "description":"Deletes a price from a combo meal group item.", "operationId":"DeleteComboGroupItemPricev2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboGroupItemPriceDeleteRequestV2" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroups-deleteSideGroupItemPrices-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroups-deletesidegroupitemprices-post" } }, "/config/sim/v2/menuItems/comboSideGroups/bulkInsertSideGroupItemPrices":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Group Item Prices" ], "summary":"Bulk Insert Combo Side Group Item Prices", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertComboSideGroupItemPricesv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertComboSideGroupItemPriceRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request.", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroups-bulkInsertSideGroupItemPrices-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroups-bulkinsertsidegroupitemprices-post" } }, "/config/sim/v2/menuItems/comboSideGroups/bulkUpdateSideGroupItemPrices":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Group Item Prices" ], "summary":"Bulk Update Combo Side Group Item Prices", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkUpdateComboSideGroupItemPricesv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkUpdateComboSideGroupItemPriceRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroups-bulkUpdateSideGroupItemPrices-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroups-bulkupdatesidegroupitemprices-post" } }, "/config/sim/v1/menuItems/combomeals/getmealsidegroupprices":{ "post":{ "tags":[ "v1/Menu Items/Combo Meals/Combo Meal Side Group Prices" ], "summary":"Get Combo Meal Side Group Prices", "description":"Gets a list of all the prices of a side in a combo meal for the specified organization", "operationId":"getComboMealPrices", "parameters":[ { "$ref":"#/parameters/body.ComboMealSideGroupPricesGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Combomeal Side Group Prices.", "schema":{ "$ref":"#/definitions/ComboMealPriceGetResponsev1" } } }, "x-internal-id":"config-sim-v1-menuItems-combomeals-getmealsidegroupprices-post", "x-filename-id":"config-sim-v1-menuitems-combomeals-getmealsidegroupprices-post" } }, "/config/sim/v2/menuItems/comboMeals/getMealSideGroupPrices":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meal Side Group Prices" ], "summary":"Get Combo Meal Side Group Prices", "description":"Gets a list of all the prices of a side in a combo meal for the specified organization", "operationId":"getComboMealPricesv2", "parameters":[ { "$ref":"#/parameters/body.ComboMealSideGroupPricesGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Combomeal Side Group Prices.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Combo Meal Side Group Price objects of the organization.", "items":{ "$ref":"#/definitions/ComboMealPricev2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboMeals-getMealSideGroupPrices-post", "x-filename-id":"config-sim-v2-menuitems-combomeals-getmealsidegroupprices-post" } }, "/config/sim/v1/menuItems/combomeals/mealsidegroupprices":{ "post":{ "tags":[ "v1/Menu Items/Combo Meals/Combo Meal Side Group Prices" ], "summary":"Add Combo Meal Side Group Prices", "description":"Add a price for a side of a Combo Meal unit", "operationId":"addComboMealPrices", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealPriceInsertRequest" } ], "responses":{ "200":{ "description":"Combo Meal Side Group Price Added.", "schema":{ "$ref":"#/definitions/ComboMealPriceResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-combomeals-mealsidegroupprices-post", "x-filename-id":"config-sim-v1-menuitems-combomeals-mealsidegroupprices-post" } }, "/config/sim/v2/menuItems/comboMeals/mealSideGroupPrices":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meal Side Group Prices" ], "summary":"Add Combo Meal Side Group Prices", "description":"Add a price for a side of a Combo Meal unit", "operationId":"addComboMealPricesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealPriceInsertRequest" } ], "responses":{ "200":{ "description":"Combo Meal Side Group Price Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal" }, "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side" }, "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboMeals-mealSideGroupPrices-post", "x-filename-id":"config-sim-v2-menuitems-combomeals-mealsidegroupprices-post" } }, "/config/sim/v1/menuItems/combomeals/updatemealsidegroupprices":{ "post":{ "tags":[ "v1/Menu Items/Combo Meals/Combo Meal Side Group Prices" ], "summary":"Update Combo Meal Side Group Prices", "description":"Updates a price for a side of a Combo Meal unit ", "operationId":"updateComboMealPrices", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealPriceUpdateRequest" } ], "responses":{ "200":{ "description":"Combo Meal Side Group Price Updated or Added.", "schema":{ "$ref":"#/definitions/ComboMealPriceResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-combomeals-updatemealsidegroupprices-post", "x-filename-id":"config-sim-v1-menuitems-combomeals-updatemealsidegroupprices-post" } }, "/config/sim/v2/menuItems/comboMeals/updateMealSideGroupPrices":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meal Side Group Prices" ], "summary":"Update Combo Meal Side Group Prices", "description":"Updates a price for a side of a Combo Meal unit ", "operationId":"updateComboMealPricesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealPriceUpdateRequest" } ], "responses":{ "200":{ "description":"Combo Meal Side Group Price Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal" }, "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side" }, "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboMeals-updateMealSideGroupPrices-post", "x-filename-id":"config-sim-v2-menuitems-combomeals-updatemealsidegroupprices-post" } }, "/config/sim/v1/menuItems/combomeals/deletemealsidegroupprices":{ "post":{ "tags":[ "v1/Menu Items/Combo Meals/Combo Meal Side Group Prices" ], "summary":"Delete Combo Meal Side Group Prices", "description":"Deletes a price for a side of a Combo Meal", "operationId":"deleteComboMealPrices", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealPriceDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/ComboMealPriceDeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-combomeals-deletemealsidegroupprices-post", "x-filename-id":"config-sim-v1-menuitems-combomeals-deletemealsidegroupprices-post" } }, "/config/sim/v2/menuItems/comboMeals/deleteMealSideGroupPrices":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meal Side Group Prices" ], "summary":"Delete Combo Meal Side Group Prices", "description":"Deletes a price for a side of a Combo Meal", "operationId":"deleteComboMealPricesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealPriceDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboMeals-deleteMealSideGroupPrices-post", "x-filename-id":"config-sim-v2-menuitems-combomeals-deletemealsidegroupprices-post" } }, "/config/sim/v1/menuitems/getcombomeals":{ "post":{ "tags":[ "v1/Menu Items/Combo Meals/Combo Meals" ], "summary":"Get Combo Meals", "description":"Gets all the Combo Meals configured", "operationId":"getComboMeals", "parameters":[ { "in":"body", "name":"Request body", "description":"A request body", "required":false, "schema":{ "$ref":"#/definitions/ComboMealsGetParametersv1" } } ], "responses":{ "200":{ "description":"A collection of Combo Meals.", "schema":{ "$ref":"#/definitions/ComboMealsv1GetResponse" } } }, "x-internal-id":"config-sim-v1-menuitems-getcombomeals-post", "x-filename-id":"config-sim-v1-menuitems-getcombomeals-post" } }, "/config/sim/v2/menuItems/getComboMeals":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meals" ], "summary":"Get Combo Meals", "description":"Gets all the Combo Meals configured", "operationId":"getComboMealsv2", "parameters":[ { "$ref":"#/parameters/body.ComboMealsGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Combo Meals.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Combo Meals objects of the organization.", "items":{ "$ref":"#/definitions/ComboMealsResourceObjectv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getComboMeals-post", "x-filename-id":"config-sim-v2-menuitems-getcombomeals-post" } }, "/config/sim/v1/menuitems/combomeals":{ "post":{ "tags":[ "v1/Menu Items/Combo Meals/Combo Meals" ], "summary":"Add Combo Meals", "description":"Add the Combo Meal object to a specified hierarchy unit of specified organization.", "operationId":"addComboMeals", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "in":"body", "name":"Request body", "required":true, "schema":{ "$ref":"#/definitions/ComboMealsResourceObjectCUDRequestBody" } } ], "responses":{ "200":{ "description":"Combo Meal Added.", "schema":{ "$ref":"#/definitions/ComboMealsResponse" } } }, "x-internal-id":"config-sim-v1-menuitems-combomeals-post", "x-filename-id":"config-sim-v1-menuitems-combomeals-post" } }, "/config/sim/v2/menuItems/comboMeals":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meals" ], "summary":"Add Combo Meals", "description":"Add the Combo Meal object to a specified hierarchy unit of specified organization.", "operationId":"addComboMealsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealsResourceObjectCUDRequestBodyv2" } ], "responses":{ "200":{ "description":"Combo Meal Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Combo Meal" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboMeals-post", "x-filename-id":"config-sim-v2-menuitems-combomeals-post" } }, "/config/sim/v1/menuitems/updatecombomeals":{ "post":{ "tags":[ "v1/Menu Items/Combo Meals/Combo Meals" ], "summary":"Update Combo Meals", "description":"Updates the Combo Meal. If Combo Meal is not found, it creates a new Combo Meal.", "operationId":"updateComboMeals", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "in":"body", "name":"Request body", "required":true, "schema":{ "$ref":"#/definitions/ComboMealsResourceObjectCUDRequestBody" } } ], "responses":{ "200":{ "description":"Combo Meal Updated or Added.", "schema":{ "$ref":"#/definitions/ComboMealsResponse" } } }, "x-internal-id":"config-sim-v1-menuitems-updatecombomeals-post", "x-filename-id":"config-sim-v1-menuitems-updatecombomeals-post" } }, "/config/sim/v2/menuItems/updateComboMeals":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meals" ], "summary":"Update Combo Meals", "description":"Updates the Combo Meal.", "operationId":"updateComboMealsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealsResourceObjectCUDRequestBodyv2" } ], "responses":{ "200":{ "description":"Combo Meal Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Combo Meal" } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateComboMeals-post", "x-filename-id":"config-sim-v2-menuitems-updatecombomeals-post" } }, "/config/sim/v1/menuitems/deletecombomeals":{ "post":{ "tags":[ "v1/Menu Items/Combo Meals/Combo Meals" ], "summary":"Delete Combo Meals", "description":"Deletes the Combo Meal object.", "operationId":"deleteComboMeals", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealsDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "$ref":"#/definitions/ComboMealsDeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuitems-deletecombomeals-post", "x-filename-id":"config-sim-v1-menuitems-deletecombomeals-post" } }, "/config/sim/v2/menuItems/deleteComboMeals":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meals" ], "summary":"Delete Combo Meals", "description":"Deletes the Combo Meal object.", "operationId":"deleteComboMealsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealsDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteComboMeals-post", "x-filename-id":"config-sim-v2-menuitems-deletecombomeals-post" } }, "/config/sim/v1/menuitems/predeletecheckcombomeals":{ "post":{ "tags":[ "v1/Menu Items/Combo Meals/Combo Meals" ], "summary":"Pre-Delete Check Combo Meals", "description":"Checks the existence of references to a Combo Meal in the database.", "operationId":"preDeleteCheckComboMeals", "parameters":[ { "$ref":"#/parameters/body.ComboMealsDeleteRequest" } ], "responses":{ "200":{ "description":"Dependency check Response. The values of \"response\" can either be \"Dependency exist.\" or \"Dependency does not exist.\"", "schema":{ "$ref":"#/definitions/ComboMealPre-DeleteCheckResponse" } } }, "x-internal-id":"config-sim-v1-menuitems-predeletecheckcombomeals-post", "x-filename-id":"config-sim-v1-menuitems-predeletecheckcombomeals-post" } }, "/config/sim/v2/menuItems/preDeleteCheckComboMeals":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meals" ], "summary":"Pre-Delete Check Combo Meals", "description":"Checks the existence of references to a Combo Meal in the database.", "operationId":"preDeleteCheckComboMealsv2", "parameters":[ { "$ref":"#/parameters/body.ComboMealsDeleteRequest" } ], "responses":{ "200":{ "description":"Dependency check Response. The values of \"response\" can either be \"Dependency exist.\" or \"Dependency does not exist.\"", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"Dependency exists/Dependency does not exist", "description":"Indicates existence of references to the object in the database." } } } } }, "x-internal-id":"config-sim-v2-menuItems-preDeleteCheckComboMeals-post", "x-filename-id":"config-sim-v2-menuitems-predeletecheckcombomeals-post" } }, "/config/sim/v1/menuitems/bulkinsertcombomeals":{ "post":{ "tags":[ "v1/Menu Items/Combo Meals/Combo Meals" ], "summary":"Bulk Insert Combo Meals", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertComboMeals", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertComboMealRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v1-menuitems-bulkinsertcombomeals-post", "x-filename-id":"config-sim-v1-menuitems-bulkinsertcombomeals-post" } }, "/config/sim/v2/menuItems/bulkInsertComboMeals":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meals" ], "summary":"Bulk Insert Combo Meals", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertComboMealsv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertComboMealRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request.", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-bulkInsertComboMeals-post", "x-filename-id":"config-sim-v2-menuitems-bulkinsertcombomeals-post" } }, "/config/sim/v2/menuItems/bulkUpdateComboMeals":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meals" ], "summary":"Bulk Update Combo Meals", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkUpdateComboMealsv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkUpdateComboMealRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request.", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-bulkUpdateComboMeals-post", "x-filename-id":"config-sim-v2-menuitems-bulkupdatecombomeals-post" } }, "/config/sim/v1/devices/getKitchenDisplays":{ "post":{ "tags":[ "v1/Devices/Kitchen Display Clients" ], "summary":"Get Kitchen Display Clients", "description":"Gets all the KDS Displays", "operationId":"getKDSDisplays", "consumes":[ "application/json" ], "parameters":[ { "$ref":"#/parameters/body.KitchenDisplayClientsGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Kitchen Display Clients.", "schema":{ "$ref":"#/definitions/KDSDisplaysGetResponsev1" } } }, "x-internal-id":"config-sim-v1-devices-getKitchenDisplays-post", "x-filename-id":"config-sim-v1-devices-getkitchendisplays-post" } }, "/config/sim/v2/devices/getKitchenDisplays":{ "post":{ "tags":[ "v2/Devices/Kitchen Display Clients" ], "summary":"Get Kitchen Display Clients", "description":"Gets all the KDS Displays", "operationId":"getKDSDisplaysv2", "consumes":[ "application/json" ], "parameters":[ { "$ref":"#/parameters/body.KitchenDisplayClientsGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Kitchen Display Clients", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Kitchen Display Client objects of the organization.", "items":{ "$ref":"#/definitions/KitchenDisplayClientsv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-devices-getKitchenDisplays-post", "x-filename-id":"config-sim-v2-devices-getkitchendisplays-post" } }, "/config/sim/v1/devices/KitchenDisplays":{ "post":{ "tags":[ "v1/Devices/Kitchen Display Clients" ], "summary":"Add Kitchen Display Clients", "description":"Add the KDS Displays object to a specified hierarchy unit of the specified organization.", "operationId":"addKDSDisplays", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.KDSDisplaysCUDRequest" } ], "responses":{ "200":{ "description":"The Kitchen Display Client added.", "schema":{ "$ref":"#/definitions/KDS" } } }, "x-internal-id":"config-sim-v1-devices-KitchenDisplays-post", "x-filename-id":"config-sim-v1-devices-kitchendisplays-post" } }, "/config/sim/v2/devices/kitchenDisplays":{ "post":{ "tags":[ "v2/Devices/Kitchen Display Clients" ], "summary":"Add Kitchen Display Clients", "description":"Add the KDS Displays object to a specified hierarchy unit of the specified organization.", "operationId":"addKDSDisplaysv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.KDSDisplaysCUDRequestv2" } ], "responses":{ "200":{ "description":"The Kitchen Display Client added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "objectNum":{ "description":"Object number of the Kitchen Display Client.", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-devices-kitchenDisplays-post", "x-filename-id":"config-sim-v2-devices-kitchendisplays-post" } }, "/config/sim/v1/devices/updateKitchenDisplays":{ "post":{ "tags":[ "v1/Devices/Kitchen Display Clients" ], "summary":"Update Kitchen Display Clients", "description":"Updates the KDS Displays. If KDS Displays is not found, it creates a new KDS Displays.", "operationId":"updateKDSDisplays", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.KDSDisplaysCUDRequest" } ], "responses":{ "200":{ "description":"The Kitchen Display Client updated/added", "schema":{ "$ref":"#/definitions/KDS" } } }, "x-internal-id":"config-sim-v1-devices-updateKitchenDisplays-post", "x-filename-id":"config-sim-v1-devices-updatekitchendisplays-post" } }, "/config/sim/v2/devices/updateKitchenDisplays":{ "post":{ "tags":[ "v2/Devices/Kitchen Display Clients" ], "summary":"Update Kitchen Display Clients", "description":"Updates the KDS Displays.", "operationId":"updateKDSDisplaysv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.KDSDisplaysCUDRequestv2" } ], "responses":{ "200":{ "description":"The Kitchen Display Client updated/added", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "objectNum":{ "description":"Object number of the Kitchen Display Client.", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-devices-updateKitchenDisplays-post", "x-filename-id":"config-sim-v2-devices-updatekitchendisplays-post" } }, "/config/sim/v1/devices/deleteKitchenDisplays":{ "post":{ "tags":[ "v1/Devices/Kitchen Display Clients" ], "summary":"Delete Kitchen Display Clients", "description":"Deletes the KDS Displays object.", "operationId":"deleteKDSDisplays", "parameters":[ { "$ref":"#/parameters/body.KDS" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-devices-deleteKitchenDisplays-post", "x-filename-id":"config-sim-v1-devices-deletekitchendisplays-post" } }, "/config/sim/v2/devices/deleteKitchenDisplays":{ "post":{ "tags":[ "v2/Devices/Kitchen Display Clients" ], "summary":"Delete Kitchen Display Clients", "description":"Deletes the KDS Displays object.", "operationId":"deleteKDSDisplaysv2", "parameters":[ { "$ref":"#/parameters/body.KDS" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-devices-deleteKitchenDisplays-post", "x-filename-id":"config-sim-v2-devices-deletekitchendisplays-post" } }, "/config/sim/v1/devices/getOrderDevices":{ "post":{ "tags":[ "v1/Devices/Order Devices" ], "summary":"Get Order Devices", "description":"Gets all the Order Devices configured", "operationId":"getOrderDevices", "parameters":[ { "$ref":"#/parameters/body.OrderDevicesGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Order Devices.", "schema":{ "$ref":"#/definitions/OrderDevicesGetResponsev1" } } }, "x-internal-id":"config-sim-v1-devices-getOrderDevices-post", "x-filename-id":"config-sim-v1-devices-getorderdevices-post" } }, "/config/sim/v2/devices/getOrderDevices":{ "post":{ "tags":[ "v2/Devices/Order Devices" ], "summary":"Get Order Devices", "description":"Gets all the Order Devices configured", "operationId":"getOrderDevicesv2", "parameters":[ { "$ref":"#/parameters/body.OrderDevicesGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Order Devices.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Order Devices objects of the organization.", "items":{ "$ref":"#/definitions/OrderDevicesv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-devices-getOrderDevices-post", "x-filename-id":"config-sim-v2-devices-getorderdevices-post" } }, "/config/sim/v1/devices/updateOrderDevices":{ "post":{ "tags":[ "v1/Devices/Order Devices" ], "summary":"Update Order Devices", "description":"Updates an order devices record for the current organization.", "operationId":"updateOrderDevices", "parameters":[ { "$ref":"#/parameters/body.OrderDeviceCUDRequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Order Device updated or added.", "schema":{ "$ref":"#/definitions/OrderDevice" } } }, "x-internal-id":"config-sim-v1-devices-updateOrderDevices-post", "x-filename-id":"config-sim-v1-devices-updateorderdevices-post" } }, "/config/sim/v2/devices/updateOrderDevices":{ "post":{ "tags":[ "v2/Devices/Order Devices" ], "summary":"Update Order Devices", "description":"Updates an order devices record for the current organization.", "operationId":"updateOrderDevicesv2", "parameters":[ { "$ref":"#/parameters/body.OrderDeviceCUDRequestv2" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Order Device updated .", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the printer", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-devices-updateOrderDevices-post", "x-filename-id":"config-sim-v2-devices-updateorderdevices-post" } }, "/config/sim/v1/employees/getCashiers":{ "post":{ "tags":[ "v1/Employees/Cashiers" ], "summary":"Get Cashiers", "description":"Get all the cashiers.", "operationId":"getCashiers", "parameters":[ { "$ref":"#/parameters/body.CashiersGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Cashiers objects.", "schema":{ "$ref":"#/definitions/CashiersGetResponseV1" } } }, "x-internal-id":"config-sim-v1-employees-getCashiers-post", "x-filename-id":"config-sim-v1-employees-getcashiers-post" } }, "/config/sim/v2/employees/getCashiers":{ "post":{ "tags":[ "v2/Employees/Cashiers" ], "summary":"Get Cashiers", "description":"Get all the cashiers.", "operationId":"getCashiersv2", "parameters":[ { "$ref":"#/parameters/body.CashiersGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Cashiers objects.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Cashier objects.", "items":{ "$ref":"#/definitions/Cashiersv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-employees-getCashiers-post", "x-filename-id":"config-sim-v2-employees-getcashiers-post" } }, "/config/sim/v1/employees/cashiers":{ "post":{ "tags":[ "v1/Employees/Cashiers" ], "summary":"Add Cashiers", "description":"Insert Cashiers.", "operationId":"createCashiers", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUCashiersRequest" } ], "responses":{ "200":{ "description":"Cashiers object Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit id of the revenue center.", "example":1 }, "objectNum":{ "description":"Object number of the cashiers", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v1-employees-cashiers-post", "x-filename-id":"config-sim-v1-employees-cashiers-post" } }, "/config/sim/v2/employees/cashiers":{ "post":{ "tags":[ "v2/Employees/Cashiers" ], "summary":"Add Cashiers", "description":"Insert Cashiers.", "operationId":"createCashiersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUCashiersRequestv2" } ], "responses":{ "200":{ "description":"Cashiers object Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit id of the revenue center.", "example":1 }, "objectNum":{ "description":"Object number of the cashiers", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-employees-cashiers-post", "x-filename-id":"config-sim-v2-employees-cashiers-post" } }, "/config/sim/v1/employees/updateCashiers":{ "post":{ "tags":[ "v1/Employees/Cashiers" ], "summary":"Update Cashiers", "description":"Updates cashiers. If cashiers is not found, it creates new cashiers.", "operationId":"updateCashiers", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUCashiersRequest" } ], "responses":{ "200":{ "description":"Cashiers object Updated or Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit id of the revenue center.", "example":1 }, "objectNum":{ "description":"Object number of the cashiers", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v1-employees-updateCashiers-post", "x-filename-id":"config-sim-v1-employees-updatecashiers-post" } }, "/config/sim/v2/employees/updateCashiers":{ "post":{ "tags":[ "v2/Employees/Cashiers" ], "summary":"Update Cashiers", "description":"Updates cashiers.", "operationId":"updateCashiersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUCashiersRequestv2" } ], "responses":{ "200":{ "description":"Cashiers object Updated .", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit id of the revenue center.", "example":1 }, "objectNum":{ "description":"Object number of the cashiers", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-employees-updateCashiers-post", "x-filename-id":"config-sim-v2-employees-updatecashiers-post" } }, "/config/sim/v1/employees/deleteCashiers":{ "post":{ "tags":[ "v1/Employees/Cashiers" ], "summary":"Delete Cashiers", "description":"Deletes cashiers object.", "operationId":"deleteCashiers", "parameters":[ { "$ref":"#/parameters/body.DeleteCashiersRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-employees-deleteCashiers-post", "x-filename-id":"config-sim-v1-employees-deletecashiers-post" } }, "/config/sim/v2/employees/deleteCashiers":{ "post":{ "tags":[ "v2/Employees/Cashiers" ], "summary":"Delete Cashiers", "description":"Deletes cashiers object.", "operationId":"deleteCashiersv2", "parameters":[ { "$ref":"#/parameters/body.DeleteCashiersRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-employees-deleteCashiers-post", "x-filename-id":"config-sim-v2-employees-deletecashiers-post" } }, "/config/sim/v1/setup/getpaymentdriverconfiguration":{ "post":{ "tags":[ "v1/Setup/Payment Drivers/Payment Driver Configurations" ], "summary":"Get Payment Driver Configuration", "description":"Gets the configuration of all the payment drivers.", "operationId":"getPaymentDriverConfigurations", "parameters":[ { "$ref":"#/parameters/body.PaymentDriverConfigurationsGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Payment Drivers Configurations", "schema":{ "$ref":"#/definitions/PaymentDriverConfigGetResponsev1" } } }, "x-internal-id":"config-sim-v1-setup-getpaymentdriverconfiguration-post", "x-filename-id":"config-sim-v1-setup-getpaymentdriverconfiguration-post" } }, "/config/sim/v2/setup/getPaymentDriverConfiguration":{ "post":{ "tags":[ "v2/Setup/Payment Drivers/Payment Driver Configurations" ], "summary":"Get Payment Driver Configuration", "description":"Gets the configuration of all the payment drivers.", "operationId":"getPaymentDriverConfigurationsv2", "parameters":[ { "$ref":"#/parameters/body.PaymentDriverConfigurationsGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Payment Drivers Configurations", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Payment Driver Config objects of the organization.", "items":{ "$ref":"#/definitions/PaymentDriverConfigurationv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getPaymentDriverConfiguration-post", "x-filename-id":"config-sim-v2-setup-getpaymentdriverconfiguration-post" } }, "/config/sim/v1/setup/updatepaymentdriverconfiguration":{ "post":{ "tags":[ "v1/Setup/Payment Drivers/Payment Driver Configurations" ], "summary":"Update Payment Driver Configuration", "description":"Updates the configuration for the payment driver.", "operationId":"updatePaymentDriverConfigurations", "parameters":[ { "$ref":"#/parameters/body.PaymentDriverConfigCUDRequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Payment Driver Configuration Updated.", "schema":{ "$ref":"#/definitions/PaymentDriverConfigResponse" } } }, "x-internal-id":"config-sim-v1-setup-updatepaymentdriverconfiguration-post", "x-filename-id":"config-sim-v1-setup-updatepaymentdriverconfiguration-post" } }, "/config/sim/v2/setup/updatePaymentDriverConfiguration":{ "post":{ "tags":[ "v2/Setup/Payment Drivers/Payment Driver Configurations" ], "summary":"Update Payment Driver Configuration", "description":"Updates the configuration for the payment driver.", "operationId":"updatePaymentDriverConfigurationsv2", "parameters":[ { "$ref":"#/parameters/body.PaymentDriverConfigCUDRequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Payment Driver Configuration Updated.", "schema":{ "description":"Model for a Payment Driver Configuration Response Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1034 }, "objectNum":{ "description":"Object number of the Payment Driver", "type":"integer", "example":20 } } } } }, "x-internal-id":"config-sim-v2-setup-updatePaymentDriverConfiguration-post", "x-filename-id":"config-sim-v2-setup-updatepaymentdriverconfiguration-post" } }, "/config/sim/v1/setup/geteffectivitygroups":{ "post":{ "tags":[ "v1/Setup/Effectivity Groups/Effectivity Groups" ], "summary":"Get Effectivity Groups", "description":"Gets all the Effectivity Groups configured", "operationId":"getEffectivityGroups", "parameters":[ { "$ref":"#/parameters/body.EffectivityGroupsGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Effectivity Groups.", "schema":{ "$ref":"#/definitions/EffectivityGroupsGetResponsev1" } } }, "x-internal-id":"config-sim-v1-setup-geteffectivitygroups-post", "x-filename-id":"config-sim-v1-setup-geteffectivitygroups-post" } }, "/config/sim/v2/setup/getEffectivityGroups":{ "post":{ "tags":[ "v2/Setup/Effectivity Groups/Effectivity Groups" ], "summary":"Get Effectivity Groups", "description":"Gets all the Effectivity Groups configured", "operationId":"getEffectivityGroupsv2", "parameters":[ { "$ref":"#/parameters/body.EffectivityGroupsGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Effectivity Groups.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Effectivity Group objects of the organization.", "items":{ "$ref":"#/definitions/EffectivityGroupv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getEffectivityGroups-post", "x-filename-id":"config-sim-v2-setup-geteffectivitygroups-post" } }, "/config/sim/v1/setup/effectivitygroups":{ "post":{ "tags":[ "v1/Setup/Effectivity Groups/Effectivity Groups" ], "summary":"Add Effectivity Groups", "description":"Add an Effectivity Groups record for the current organization.", "operationId":"addEffectivityGroups", "parameters":[ { "$ref":"#/parameters/body.EffectivityGroupsCUDRequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Effectivity Group Added", "schema":{ "$ref":"#/definitions/EffGroupCUResponse" } } }, "x-internal-id":"config-sim-v1-setup-effectivitygroups-post", "x-filename-id":"config-sim-v1-setup-effectivitygroups-post" } }, "/config/sim/v2/setup/effectivityGroups":{ "post":{ "tags":[ "v2/Setup/Effectivity Groups/Effectivity Groups" ], "summary":"Add Effectivity Groups", "description":"Add an Effectivity Groups record for the current organization.", "operationId":"addEffectivityGroupsv2", "parameters":[ { "$ref":"#/parameters/body.EffectivityGroupsCUDRequestv2" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Effectivity Group Added", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the effectivity group", "type":"integer", "example":1 }, "changeSetId":{ "description":"The unique reference of the effectivity group.", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-effectivityGroups-post", "x-filename-id":"config-sim-v2-setup-effectivitygroups-post" } }, "/config/sim/v1/setup/updateeffectivitygroups":{ "post":{ "tags":[ "v1/Setup/Effectivity Groups/Effectivity Groups" ], "summary":"Update Effectivity Groups", "description":"Updates a Effectivity Groups record for the current organization.", "operationId":"updateEffectivityGroups", "parameters":[ { "$ref":"#/parameters/body.EffectivityGroupsCUDRequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Effectivity Group Updated or Added.", "schema":{ "$ref":"#/definitions/EffGroupCUResponse" } } }, "x-internal-id":"config-sim-v1-setup-updateeffectivitygroups-post", "x-filename-id":"config-sim-v1-setup-updateeffectivitygroups-post" } }, "/config/sim/v2/setup/updateEffectivityGroups":{ "post":{ "tags":[ "v2/Setup/Effectivity Groups/Effectivity Groups" ], "summary":"Update Effectivity Groups", "description":"Updates a Effectivity Groups record for the current organization.", "operationId":"updateEffectivityGroupsv2", "parameters":[ { "$ref":"#/parameters/body.EffectivityGroupsCUDRequestv2" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Effectivity Group Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the effectivity group", "type":"integer", "example":1 }, "changeSetId":{ "description":"The unique reference of the effectivity group.", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-updateEffectivityGroups-post", "x-filename-id":"config-sim-v2-setup-updateeffectivitygroups-post" } }, "/config/sim/v1/setup/deleteeffectivitygroups":{ "post":{ "tags":[ "v1/Setup/Effectivity Groups/Effectivity Groups" ], "summary":"Delete Effectivity Groups", "description":"Deletes the Effectivity Group.", "operationId":"deleteEffectivityGroups", "parameters":[ { "$ref":"#/parameters/body.EffGroupDeleteRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-setup-deleteeffectivitygroups-post", "x-filename-id":"config-sim-v1-setup-deleteeffectivitygroups-post" } }, "/config/sim/v2/setup/deleteEffectivityGroups":{ "post":{ "tags":[ "v2/Setup/Effectivity Groups/Effectivity Groups" ], "summary":"Delete Effectivity Groups", "description":"Deletes the Effectivity Group.", "operationId":"deleteEffectivityGroupsv2", "parameters":[ { "$ref":"#/parameters/body.EffGroupDeleteRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteEffectivityGroups-post", "x-filename-id":"config-sim-v2-setup-deleteeffectivitygroups-post" } }, "/config/sim/v2/setup/bulkInsertEffectivityGroups":{ "post":{ "tags":[ "v2/Setup/Effectivity Groups/Effectivity Groups" ], "summary":"Bulk Insert Effectivity Groups", "description":"This endpoint is available from Simphony 19.9 and above. Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertEffectivityGroupsv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertEffectivityGroupsRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request.", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-setup-bulkInsertEffectivityGroups-post", "x-filename-id":"config-sim-v2-setup-bulkinserteffectivitygroups-post" } }, "/config/sim/v2/setup/bulkUpdateEffectivityGroups":{ "post":{ "tags":[ "v2/Setup/Effectivity Groups/Effectivity Groups" ], "summary":"Bulk Update Effectivity Groups", "description":"This endpoint is available from Simphony 19.9 and above. Refer to the Bulk Processing chapter for more details.", "operationId":"bulkUpdateEffectivityGroupsv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkUpdateEffectivityGroupsRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request.", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-setup-bulkUpdateEffectivityGroups-post", "x-filename-id":"config-sim-v2-setup-bulkupdateeffectivitygroups-post" } }, "/config/sim/v1/setup/currencies":{ "post":{ "tags":[ "v1/Setup/Currencies" ], "summary":"Add Currencies", "description":"Add the Currency to the specified organization.", "operationId":"addCurrencies", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUDCurrencyRequest" } ], "responses":{ "200":{ "description":"Currency Added.", "schema":{ "$ref":"#/definitions/CUResponseBody" } } }, "x-internal-id":"config-sim-v1-setup-currencies-post", "x-filename-id":"config-sim-v1-setup-currencies-post" } }, "/config/sim/v2/setup/currencies":{ "post":{ "tags":[ "v2/Setup/Currencies" ], "summary":"Add Currencies", "description":"Add the Currency to the specified organization.", "operationId":"addCurrenciesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUDCurrencyRequestv2" } ], "responses":{ "200":{ "description":"Currency Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Currency", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-currencies-post", "x-filename-id":"config-sim-v2-setup-currencies-post" } }, "/config/sim/v1/setup/deleteCurrencies":{ "post":{ "tags":[ "v1/Setup/Currencies" ], "summary":"Delete Currencies", "description":"Deletes the currency object.", "operationId":"deleteCurrencies", "parameters":[ { "$ref":"#/parameters/body.DeleteRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-setup-deleteCurrencies-post", "x-filename-id":"config-sim-v1-setup-deletecurrencies-post" } }, "/config/sim/v2/setup/deleteCurrencies":{ "post":{ "tags":[ "v2/Setup/Currencies" ], "summary":"Delete Currencies", "description":"Deletes the currency object.", "operationId":"deleteCurrenciesv2", "parameters":[ { "$ref":"#/parameters/body.DeleteRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteCurrencies-post", "x-filename-id":"config-sim-v2-setup-deletecurrencies-post" } }, "/config/sim/v1/setup/getCurrencies":{ "post":{ "tags":[ "v1/Setup/Currencies" ], "summary":"Get Currencies", "description":"Gets all the currencies", "operationId":"getCurrencies", "parameters":[ { "$ref":"#/parameters/body.CurrencyGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Currencies.", "schema":{ "$ref":"#/definitions/Currencyv1GetResponse" } } }, "x-internal-id":"config-sim-v1-setup-getCurrencies-post", "x-filename-id":"config-sim-v1-setup-getcurrencies-post" } }, "/config/sim/v2/setup/getCurrencies":{ "post":{ "tags":[ "v2/Setup/Currencies" ], "summary":"Get Currencies", "description":"Gets all the currencies", "operationId":"getCurrenciesv2", "parameters":[ { "$ref":"#/parameters/body.CurrencyGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Currencies.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Currency objects of the organization.", "items":{ "$ref":"#/definitions/Currencyv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getCurrencies-post", "x-filename-id":"config-sim-v2-setup-getcurrencies-post" } }, "/config/sim/v1/setup/updateCurrencies":{ "post":{ "tags":[ "v1/Setup/Currencies" ], "summary":"Update Currencies", "description":"Updates the currency. If currency is not found, it creates a new currency.", "operationId":"updateCurrencies", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUDCurrencyRequest" } ], "responses":{ "200":{ "description":"Currency Updated or Added.", "schema":{ "$ref":"#/definitions/CUResponseBody" } } }, "x-internal-id":"config-sim-v1-setup-updateCurrencies-post", "x-filename-id":"config-sim-v1-setup-updatecurrencies-post" } }, "/config/sim/v2/setup/updateCurrencies":{ "post":{ "tags":[ "v2/Setup/Currencies" ], "summary":"Update Currencies", "description":"Updates the currency.", "operationId":"updateCurrenciesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUDCurrencyRequestv2" } ], "responses":{ "200":{ "description":"Currency Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Currency", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-updateCurrencies-post", "x-filename-id":"config-sim-v2-setup-updatecurrencies-post" } }, "/config/sim/v1/setup/getcurrencyparameters":{ "post":{ "tags":[ "v1/Setup/Currency Parameters" ], "summary":"Get Currency Parameters", "description":"Gets all the currencies.", "operationId":"getCurrencyParameters", "parameters":[ { "$ref":"#/parameters/body.CurrencyParametersGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Currency Parameters", "schema":{ "$ref":"#/definitions/CurrencyParameterv1GetResponse" } } }, "x-internal-id":"config-sim-v1-setup-getcurrencyparameters-post", "x-filename-id":"config-sim-v1-setup-getcurrencyparameters-post" } }, "/config/sim/v2/setup/getCurrencyParameters":{ "post":{ "tags":[ "v2/Setup/Currency Parameters" ], "summary":"Get Currency Parameters", "description":"Gets all the currency parameters.", "operationId":"getCurrencyParametersv2", "parameters":[ { "$ref":"#/parameters/body.CurrencyParametersGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Currency Parameters", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Currency Parameter objects of the organization.", "items":{ "$ref":"#/definitions/CurrencyParameterv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getCurrencyParameters-post", "x-filename-id":"config-sim-v2-setup-getcurrencyparameters-post" } }, "/config/sim/v1/setup/currencyparameters":{ "post":{ "tags":[ "v1/Setup/Currency Parameters" ], "summary":"Add Currency Parameters", "description":"Add the Currency Parameter to the specified organization.", "operationId":"addCurrencyParameters", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUDCurrencyParameterRequest" } ], "responses":{ "200":{ "description":"Currency Parameter Added.", "schema":{ "$ref":"#/definitions/CurrencyParamterCUResponseBody" } } }, "x-internal-id":"config-sim-v1-setup-currencyparameters-post", "x-filename-id":"config-sim-v1-setup-currencyparameters-post" } }, "/config/sim/v2/setup/currencyParameters":{ "post":{ "tags":[ "v2/Setup/Currency Parameters" ], "summary":"Add Currency Parameters", "description":"Add the Currency Parameter to the specified organization.", "operationId":"addCurrencyParametersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUDCurrencyParameterRequest" } ], "responses":{ "200":{ "description":"Currency Parameter Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "baseCurrObjNum":{ "description":"Object number of the Currency", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-currencyParameters-post", "x-filename-id":"config-sim-v2-setup-currencyparameters-post" } }, "/config/sim/v1/setup/updatecurrencyparameters":{ "post":{ "tags":[ "v1/Setup/Currency Parameters" ], "summary":"Update Currency Parameters", "description":"Updates the currency parameter. If the currency parameter is not found, it creates a new currency parameter.", "operationId":"updateCurrencyParameters", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUDCurrencyParameterRequest" } ], "responses":{ "200":{ "description":"Currency Parameter Updated or Added.", "schema":{ "$ref":"#/definitions/CurrencyParamterCUResponseBody" } } }, "x-internal-id":"config-sim-v1-setup-updatecurrencyparameters-post", "x-filename-id":"config-sim-v1-setup-updatecurrencyparameters-post" } }, "/config/sim/v2/setup/updateCurrencyParameters":{ "post":{ "tags":[ "v2/Setup/Currency Parameters" ], "summary":"Update Currency Parameters", "description":"Updates the currency parameter.", "operationId":"updateCurrencyParametersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CUDCurrencyParameterRequest" } ], "responses":{ "200":{ "description":"Currency Parameter Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "baseCurrObjNum":{ "description":"Object number of the Currency.", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-updateCurrencyParameters-post", "x-filename-id":"config-sim-v2-setup-updatecurrencyparameters-post" } }, "/config/sim/v1/setup/deletecurrencyparameters":{ "post":{ "tags":[ "v1/Setup/Currency Parameters" ], "summary":"Delete Currency Parameters", "description":"Deletes the currency parameter object.", "operationId":"deleteCurrencyParameters", "parameters":[ { "$ref":"#/parameters/body.DeleteCurrrencyParameterRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-setup-deletecurrencyparameters-post", "x-filename-id":"config-sim-v1-setup-deletecurrencyparameters-post" } }, "/config/sim/v2/setup/deleteCurrencyParameters":{ "post":{ "tags":[ "v2/Setup/Currency Parameters" ], "summary":"Delete Currency Parameters", "description":"Deletes the currency parameter object.", "operationId":"deleteCurrencyParametersv2", "parameters":[ { "$ref":"#/parameters/body.DeleteCurrrencyParameterRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteCurrencyParameters-post", "x-filename-id":"config-sim-v2-setup-deletecurrencyparameters-post" } }, "/config/sim/v1/setup/effectivitygroups/getEnableEffectivityGroups":{ "post":{ "tags":[ "v1/Setup/Effectivity Groups/Enable Effectivity Groups" ], "summary":"Get Enable Effectivity Groups", "description":"Gets all the enable effectivity group records.", "operationId":"getEnableEffectivityGroups", "parameters":[ { "$ref":"#/parameters/body.EnableEffectivityGroupsGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Enable Effectivity groups.", "schema":{ "$ref":"#/definitions/EnableEffGroupsGetResponse" } } }, "x-internal-id":"config-sim-v1-setup-effectivitygroups-getEnableEffectivityGroups-post", "x-filename-id":"config-sim-v1-setup-effectivitygroups-getenableeffectivitygroups-post" } }, "/config/sim/v2/setup/effectivityGroups/getEnableEffectivityGroups":{ "post":{ "tags":[ "v2/Setup/Effectivity Groups/Enable Effectivity Groups" ], "summary":"Get Enable Effectivity Groups", "description":"Gets all the enable effectivity group records.", "operationId":"getEnableEffectivityGroupsv2", "parameters":[ { "$ref":"#/parameters/body.EnableEffectivityGroupsGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Enable Effectivity groups.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of enable effectivity groups record of the organization.", "items":{ "$ref":"#/definitions/EnableEffectivityGroupv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-effectivityGroups-getEnableEffectivityGroups-post", "x-filename-id":"config-sim-v2-setup-effectivitygroups-getenableeffectivitygroups-post" } }, "/config/sim/v1/setup/effectivityGroups/enableEffectivityGroups":{ "post":{ "tags":[ "v1/Setup/Effectivity Groups/Enable Effectivity Groups" ], "summary":"Add Enable Effectivity Groups", "description":"Add an enable effectivity group record for the current organization.", "operationId":"addEnableEffectivityGroups", "parameters":[ { "$ref":"#/parameters/body.EnableEffGroupsCURequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Enable Effectivity Group Added.", "schema":{ "$ref":"#/definitions/EnableEffGroupsCUResponseBody" } } }, "x-internal-id":"config-sim-v1-setup-effectivityGroups-enableEffectivityGroups-post", "x-filename-id":"config-sim-v1-setup-effectivitygroups-enableeffectivitygroups-post" } }, "/config/sim/v2/setup/effectivityGroups/enableEffectivityGroups":{ "post":{ "tags":[ "v2/Setup/Effectivity Groups/Enable Effectivity Groups" ], "summary":"Add Enable Effectivity Groups", "description":"Add an enable effectivity group record for the current organization.", "operationId":"addEnableEffectivityGroupsv2", "parameters":[ { "$ref":"#/parameters/body.EnableEffGroupsCURequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Enable Effectivity Group Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"hierUnitId of property where the record is inherited", "type":"integer", "example":1 }, "changeSetId":{ "description":"Unique reference of the inherited effectivity group.", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-effectivityGroups-enableEffectivityGroups-post", "x-filename-id":"config-sim-v2-setup-effectivitygroups-enableeffectivitygroups-post" } }, "/config/sim/v1/setup/effectivityGroups/updateEnableEffectivityGroups":{ "post":{ "tags":[ "v1/Setup/Effectivity Groups/Enable Effectivity Groups" ], "summary":"Update Enable Effectivity Groups", "description":"Updates the enableEffectivityGroup flag for given hierUnitId and changeSetId. If no record is found, it creates a new record.", "operationId":"updateEnableEffectivityGroups", "parameters":[ { "$ref":"#/parameters/body.EnableEffGroupsCURequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Enable Effectivity Group Updated or Added.", "schema":{ "$ref":"#/definitions/EnableEffGroupsCUResponseBody" } } }, "x-internal-id":"config-sim-v1-setup-effectivityGroups-updateEnableEffectivityGroups-post", "x-filename-id":"config-sim-v1-setup-effectivitygroups-updateenableeffectivitygroups-post" } }, "/config/sim/v2/setup/effectivityGroups/updateEnableEffectivityGroups":{ "post":{ "tags":[ "v2/Setup/Effectivity Groups/Enable Effectivity Groups" ], "summary":"Update Enable Effectivity Groups", "description":"Updates the enableEffectivityGroup flag for given hierUnitId and changeSetId.", "operationId":"updateEnableEffectivityGroupsv2", "parameters":[ { "$ref":"#/parameters/body.EnableEffGroupsCURequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Enable Effectivity Group Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"hierUnitId of property where the record is inherited", "type":"integer", "example":1 }, "changeSetId":{ "description":"Unique reference of the inherited effectivity group.", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-effectivityGroups-updateEnableEffectivityGroups-post", "x-filename-id":"config-sim-v2-setup-effectivitygroups-updateenableeffectivitygroups-post" } }, "/config/sim/v1/setup/effectivityGroups/deleteEnableEffectivityGroups":{ "post":{ "tags":[ "v1/Setup/Effectivity Groups/Enable Effectivity Groups" ], "summary":"Delete Enable Effectivity Groups", "description":"Deletes Enable Effectivity Group record for given hierUnitid and changeSetId", "operationId":"deleteEnableEffectivityGroups", "parameters":[ { "$ref":"#/parameters/body.EnableEffGroupsDeleteRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-setup-effectivityGroups-deleteEnableEffectivityGroups-post", "x-filename-id":"config-sim-v1-setup-effectivitygroups-deleteenableeffectivitygroups-post" } }, "/config/sim/v2/setup/effectivityGroups/deleteEnableEffectivityGroups":{ "post":{ "tags":[ "v2/Setup/Effectivity Groups/Enable Effectivity Groups" ], "summary":"Delete Enable Effectivity Groups", "description":"Deletes Enable Effectivity Group record for given hierUnitid and changeSetId", "operationId":"deleteEnableEffectivityGroupsv2", "parameters":[ { "$ref":"#/parameters/body.EnableEffGroupsDeleteRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-effectivityGroups-deleteEnableEffectivityGroups-post", "x-filename-id":"config-sim-v2-setup-effectivitygroups-deleteenableeffectivitygroups-post" } }, "/config/sim/v1/menuItems/getMenuItemClasses":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Class" ], "summary":"Get Menu Item Classes", "description":"Gets all the Menu Item Classes, it is recommended to use Menu Item Classes 2 instead of Menu Item Class.", "operationId":"getMenuItemClasses", "parameters":[ { "$ref":"#/parameters/body.MenuItemClassesGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Menu Item Classes.", "schema":{ "$ref":"#/definitions/MenuItemClassGetResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-getMenuItemClasses-post", "x-filename-id":"config-sim-v1-menuitems-getmenuitemclasses-post" } }, "/config/sim/v2/menuItems/getMenuItemClasses":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Class" ], "summary":"Get Menu Item Classes", "description":"Gets all the Menu Item Classes, it is recommended to use Menu Item Classes 2 instead of Menu Item Class.", "operationId":"getMenuItemClassesV2", "parameters":[ { "$ref":"#/parameters/body.MenuItemClassesGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Menu Item Classes.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Class objects of the organization.", "items":{ "$ref":"#/definitions/MenuItemClassV2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getMenuItemClasses-post", "x-filename-id":"config-sim-v2-menuitems-getmenuitemclasses-post" } }, "/config/sim/v1/menuItems/menuItemClasses":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Class" ], "summary":"Add Menu Item Classes", "description":"Adds Menu Item Classes, it is recommended to use Menu Item Classes 2 instead of Menu Item Class.", "operationId":"addMenuItemClasses", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemClassCUDRequest" } ], "responses":{ "200":{ "description":"Menu Item Class Added.", "schema":{ "$ref":"#/definitions/MenuItemClassResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-menuItemClasses-post", "x-filename-id":"config-sim-v1-menuitems-menuitemclasses-post" } }, "/config/sim/v2/menuItems/menuItemClasses":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Class" ], "summary":"Add Menu Item Classes", "description":"Adds Menu Item Classes, it is recommended to use Menu Item Classes 2 instead of Menu Item Class.", "operationId":"addMenuItemClassesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemClassCUDRequestv2" } ], "responses":{ "200":{ "description":"Menu Item Class Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Menu Item Class" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemClasses-post", "x-filename-id":"config-sim-v2-menuitems-menuitemclasses-post" } }, "/config/sim/v1/menuItems/updateMenuItemClasses":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Class" ], "summary":"Update Menu Item Classes", "description":"Updates Menu Item Classes, it is recommended to use Menu Item Classes 2 instead of Menu Item Class. If No Menu Item Class is found, it creates a new Menu Item Class.", "operationId":"updateMenuItemClasses", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemClassCUDRequest" } ], "responses":{ "200":{ "description":"Menu Item Class Updated or Added.", "schema":{ "$ref":"#/definitions/MenuItemClassResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-updateMenuItemClasses-post", "x-filename-id":"config-sim-v1-menuitems-updatemenuitemclasses-post" } }, "/config/sim/v2/menuItems/updateMenuItemClasses":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Class" ], "summary":"Update Menu Item Classes", "description":"Updates Menu Item Classes, it is recommended to use Menu Item Classes 2 instead of Menu Item Class.", "operationId":"updateMenuItemClassesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemClassCUDRequestv2" } ], "responses":{ "200":{ "description":"Menu Item Class Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Menu Item Class" } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateMenuItemClasses-post", "x-filename-id":"config-sim-v2-menuitems-updatemenuitemclasses-post" } }, "/config/sim/v1/menuItems/deleteMenuItemClasses":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Class" ], "summary":"Delete Menu Item Classes", "description":"Deletes Menu Item Classes, it is recommended to use Menu Item Classes 2 instead of Menu Item Class.", "operationId":"deleteMenuItemClasses", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemClassDeleteRequest.Required" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/DeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-deleteMenuItemClasses-post", "x-filename-id":"config-sim-v1-menuitems-deletemenuitemclasses-post" } }, "/config/sim/v2/menuItems/deleteMenuItemClasses":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Class" ], "summary":"Delete Menu Item Classes", "description":"Deletes Menu Item Classes, it is recommended to use Menu Item Classes 2 instead of Menu Item Class.", "operationId":"deleteMenuItemClassesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemClassDeleteRequest.Required" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteMenuItemClasses-post", "x-filename-id":"config-sim-v2-menuitems-deletemenuitemclasses-post" } }, "/config/sim/v1/menuItems/getcombosidegroups":{ "post":{ "tags":[ "v1/Menu Items/Combo Side Groups/Combo Side Groups" ], "summary":"Get Combo Side Groups", "description":"Gets all the Combo Meals Groups configured for the specified organization.", "operationId":"getGroups", "parameters":[ { "$ref":"#/parameters/body.ComboSideGroupsGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Combo Side Groups.", "schema":{ "$ref":"#/definitions/ComboMealGroupv1GetResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-getcombosidegroups-post", "x-filename-id":"config-sim-v1-menuitems-getcombosidegroups-post" } }, "/config/sim/v2/menuItems/getComboSideGroups":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Groups" ], "summary":"Get Combo Side Groups", "description":"Gets all the Combo Meals Groups configured for the specified organization.", "operationId":"getGroupsv2", "parameters":[ { "$ref":"#/parameters/body.ComboSideGroupsGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Combo Side Groups.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Combo Meal Group objects of the organization.", "items":{ "$ref":"#/definitions/ComboSideGroupv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getComboSideGroups-post", "x-filename-id":"config-sim-v2-menuitems-getcombosidegroups-post" } }, "/config/sim/v1/menuItems/combosidegroups":{ "post":{ "tags":[ "v1/Menu Items/Combo Side Groups/Combo Side Groups" ], "summary":"Add Combo Side Groups", "description":"Add the Combo Meal group object to a specified hierarchy unit of specified organization.", "operationId":"addComboMealGroup", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "in":"body", "name":"Request body", "required":true, "schema":{ "$ref":"#/definitions/ComboMealGroupCUDRequestBody" } } ], "responses":{ "200":{ "description":"Combo Side Group Added.", "schema":{ "$ref":"#/definitions/ComboMealsGroupResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-combosidegroups-post", "x-filename-id":"config-sim-v1-menuitems-combosidegroups-post" } }, "/config/sim/v2/menuItems/comboSideGroups":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Groups" ], "summary":"Add Combo Side Groups", "description":"Add the Combo Meal group object to a specified hierarchy unit of specified organization.", "operationId":"addComboMealGroupv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealGroupCUDRequestBodyv2" } ], "responses":{ "200":{ "description":"Combo Side Group Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Combo Meal" }, "comboMealGroupId":{ "type":"integer", "example":2, "description":"Unique ID of Combo Meal Group" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroups-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroups-post" } }, "/config/sim/v1/menuItems/updatecombosidegroups":{ "post":{ "tags":[ "v1/Menu Items/Combo Side Groups/Combo Side Groups" ], "summary":"Update Combo Side Groups", "description":"Updates the Combo Meal Group. If Combo MealGroup is not found, it creates a new Combo Meal Group.", "operationId":"updateComboMealGroup", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "in":"body", "name":"Request body", "required":true, "schema":{ "$ref":"#/definitions/ComboMealGroupCUDRequestBody" } } ], "responses":{ "200":{ "description":"Combo Side Group Updated or Added.", "schema":{ "$ref":"#/definitions/ComboMealsGroupResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-updatecombosidegroups-post", "x-filename-id":"config-sim-v1-menuitems-updatecombosidegroups-post" } }, "/config/sim/v2/menuItems/updateComboSideGroups":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Groups" ], "summary":"Update Combo Side Groups", "description":"Updates the Combo Meal Group.", "operationId":"updateComboMealGroupv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealGroupUpdateRequestBodyv2" } ], "responses":{ "200":{ "description":"Combo Side Group Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Combo Meal" }, "comboMealGroupId":{ "type":"integer", "example":2, "description":"Unique ID of Combo Meal Group" } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateComboSideGroups-post", "x-filename-id":"config-sim-v2-menuitems-updatecombosidegroups-post" } }, "/config/sim/v1/menuItems/deletecombosidegroups":{ "post":{ "tags":[ "v1/Menu Items/Combo Side Groups/Combo Side Groups" ], "summary":"Delete Combo Side Groups", "description":"Deletes the Combo Meal Group object.", "operationId":"deleteComboMealGroup", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboSideGroupsDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "$ref":"#/definitions/ComboMealGroupDeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-deletecombosidegroups-post", "x-filename-id":"config-sim-v1-menuitems-deletecombosidegroups-post" } }, "/config/sim/v2/menuItems/deleteComboSideGroups":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Groups" ], "summary":"Delete Combo Side Groups", "description":"Deletes a Combo Side Group.", "operationId":"deleteComboMealGroupv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboSideGroupsDeleteRequestV2" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteComboSideGroups-post", "x-filename-id":"config-sim-v2-menuitems-deletecombosidegroups-post" } }, "/config/sim/v1/menuItems/bulkinsertcombosidegroups":{ "post":{ "tags":[ "v1/Menu Items/Combo Side Groups/Combo Side Groups" ], "summary":"Bulk Insert Combo Side Groups", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertComboSideGroups", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertComboSideGroupRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v1-menuItems-bulkinsertcombosidegroups-post", "x-filename-id":"config-sim-v1-menuitems-bulkinsertcombosidegroups-post" } }, "/config/sim/v2/menuItems/bulkInsertComboSideGroups":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Groups" ], "summary":"Bulk Insert Combo Side Groups", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertComboSideGroupsv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertComboSideGroupRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-bulkInsertComboSideGroups-post", "x-filename-id":"config-sim-v2-menuitems-bulkinsertcombosidegroups-post" } }, "/config/sim/v2/menuItems/bulkUpdateComboSideGroups":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Groups" ], "summary":"Bulk Update Combo Side Groups", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkUpdateComboSideGroupsv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkUpdateComboSideGroupRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-bulkUpdateComboSideGroups-post", "x-filename-id":"config-sim-v2-menuitems-bulkupdatecombosidegroups-post" } }, "/config/sim/v1/menuItems/combomeals/getmealsidegroups":{ "post":{ "tags":[ "v1/Menu Items/Combo Meals/Combo Meal Side Groups" ], "summary":"Get Combo Meal Side Groups", "description":"Gets all the Combo Meal sides of a combo meal for the specified organization", "operationId":"getComboMealSideGroups", "parameters":[ { "in":"body", "name":"Request body", "description":"A request body", "required":true, "schema":{ "$ref":"#/definitions/ComboMealsSideGroupsGetParametersv1" } } ], "responses":{ "200":{ "description":"A Collection of Combo Meal Side Groups.", "schema":{ "$ref":"#/definitions/ComboMealSideGetResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-combomeals-getmealsidegroups-post", "x-filename-id":"config-sim-v1-menuitems-combomeals-getmealsidegroups-post" } }, "/config/sim/v2/menuItems/comboMeals/getMealSideGroups":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meal Side Groups" ], "summary":"Get Combo Meal Side Groups", "description":"Gets all the Combo Meal sides of a combo meal for the specified organization", "operationId":"getComboMealSideGroupsv2", "parameters":[ { "$ref":"#/parameters/body.ComboMealsSideGroupsGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Combo Meal Side Groups.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Combo Meal Side objects of the organization.", "items":{ "$ref":"#/definitions/ComboMealSideResourceObjectv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboMeals-getMealSideGroups-post", "x-filename-id":"config-sim-v2-menuitems-combomeals-getmealsidegroups-post" } }, "/config/sim/v1/menuItems/combomeals/mealsidegroups":{ "post":{ "tags":[ "v1/Menu Items/Combo Meals/Combo Meal Side Groups" ], "summary":"Add Combo Meal Side Groups", "description":"Add the Combo Meal Side object to a combo meal of the specified hierarchy unit .", "operationId":"addComboMealSideGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealsSideGroupsInsertRequestBody" } ], "responses":{ "200":{ "description":"Combo Meal Side Group Added.", "schema":{ "$ref":"#/definitions/ComboMealSideResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-combomeals-mealsidegroups-post", "x-filename-id":"config-sim-v1-menuitems-combomeals-mealsidegroups-post" } }, "/config/sim/v2/menuItems/comboMeals/mealSideGroups":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meal Side Groups" ], "summary":"Add Combo Meal Side Groups", "description":"Add the Combo Meal Side object to a combo meal of the specified hierarchy unit .", "operationId":"addComboMealSideGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealsSideGroupsInsertRequestBody" } ], "responses":{ "200":{ "description":"Combo Meal Side Group Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "comboMealObjNum":{ "type":"integer", "example":2, "description":"Unique reference of the Combo Meal." }, "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side." } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboMeals-mealSideGroups-post", "x-filename-id":"config-sim-v2-menuitems-combomeals-mealsidegroups-post" } }, "/config/sim/v1/menuItems/combomeals/updatemealsidegroups":{ "post":{ "tags":[ "v1/Menu Items/Combo Meals/Combo Meal Side Groups" ], "summary":"Update Combo Meal Side Groups", "description":"Updates the Combo Meal Side. If Combo Meal Side is not found, it creates a new Combo Meal Side.", "operationId":"updateComboMealSideGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealsSideGroupsUpdateRequestBody" } ], "responses":{ "200":{ "description":"Combo Meal Side Group Updated or Added.", "schema":{ "$ref":"#/definitions/ComboMealSideResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-combomeals-updatemealsidegroups-post", "x-filename-id":"config-sim-v1-menuitems-combomeals-updatemealsidegroups-post" } }, "/config/sim/v2/menuItems/comboMeals/updateMealSideGroups":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meal Side Groups" ], "summary":"Update Combo Meal Side Groups", "description":"Updates the Combo Meal Side.", "operationId":"updateComboMealSideGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealsSideGroupsUpdateRequestBody" } ], "responses":{ "200":{ "description":"Combo Meal Side Group Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "comboMealObjNum":{ "type":"integer", "example":2, "description":"Unique reference of the Combo Meal." }, "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side." } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboMeals-updateMealSideGroups-post", "x-filename-id":"config-sim-v2-menuitems-combomeals-updatemealsidegroups-post" } }, "/config/sim/v1/menuItems/combomeals/deletemealsidegroups":{ "post":{ "tags":[ "v1/Menu Items/Combo Meals/Combo Meal Side Groups" ], "summary":"Delete Combo Meal Side Groups", "description":"Deletes the Combo Meal Side object from a combo meal for the specified organization.", "operationId":"deleteComboMealSideGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealsSideGroupsDeleteRequestBody" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "$ref":"#/definitions/ComboMealSideDeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-combomeals-deletemealsidegroups-post", "x-filename-id":"config-sim-v1-menuitems-combomeals-deletemealsidegroups-post" } }, "/config/sim/v2/menuItems/comboMeals/deleteMealSideGroups":{ "post":{ "tags":[ "v2/Menu Items/Combo Meals/Combo Meal Side Groups" ], "summary":"Delete Combo Meal Side Groups", "description":"Deletes the Combo Meal Side object from a combo meal for the specified organization.", "operationId":"deleteComboMealSideGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboMealsSideGroupsDeleteRequestBody" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboMeals-deleteMealSideGroups-post", "x-filename-id":"config-sim-v2-menuitems-combomeals-deletemealsidegroups-post" } }, "/config/sim/v1/menuItems/combosidegroups/getsidegroupitems":{ "post":{ "tags":[ "v1/Menu Items/Combo Side Groups/Combo Side Group Item" ], "summary":"Get Combo Side Group Items", "description":"Gets a list of all the items of a combo meal group for the specified organization", "operationId":"getComboGroupItem", "parameters":[ { "$ref":"#/parameters/body.ComboSideGroupItemsGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Combo Side Group Items.", "schema":{ "$ref":"#/definitions/ComboGroupItemGetResponsev1" } } }, "x-internal-id":"config-sim-v1-menuItems-combosidegroups-getsidegroupitems-post", "x-filename-id":"config-sim-v1-menuitems-combosidegroups-getsidegroupitems-post" } }, "/config/sim/v2/menuItems/comboSideGroups/getSideGroupItems":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Group Item" ], "summary":"Get Combo Side Group Items", "description":"Gets a list of all the items of a combo meal group for the specified organization", "operationId":"getComboGroupItemv2", "parameters":[ { "$ref":"#/parameters/body.ComboSideGroupItemsGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Combo Side Group Items.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Combo Group Item objects of the organization.", "items":{ "$ref":"#/definitions/ComboSideGroupItemv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroups-getSideGroupItems-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroups-getsidegroupitems-post" } }, "/config/sim/v1/menuItems/combosidegroups/sidegroupitems":{ "post":{ "tags":[ "v1/Menu Items/Combo Side Groups/Combo Side Group Item" ], "summary":"Add Combo Side Group Items", "description":"Add the Combo Meal Group Item object to a combo meal group of the specified hierarchy unit ", "operationId":"AddComboGroupItem", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboGroupItemCUDRequest" } ], "responses":{ "200":{ "description":"Combo Side Group Item Added.", "schema":{ "$ref":"#/definitions/ComboGroupItemResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-combosidegroups-sidegroupitems-post", "x-filename-id":"config-sim-v1-menuitems-combosidegroups-sidegroupitems-post" } }, "/config/sim/v2/menuItems/comboSideGroups/sideGroupItems":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Group Item" ], "summary":"Add Combo Side Group Items", "description":"Add the Combo Meal Group Item object to a combo meal group of the specified hierarchy unit ", "operationId":"AddComboGroupItemv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboGroupItemCUDRequestV2" } ], "responses":{ "200":{ "description":"Combo Side Group Item Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" }, "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroups-sideGroupItems-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroups-sidegroupitems-post" } }, "/config/sim/v1/menuItems/combosidegroups/updatesidegroupitems":{ "post":{ "tags":[ "v1/Menu Items/Combo Side Groups/Combo Side Group Item" ], "summary":"Update Combo Side Group Items", "description":"Updates the Combo Meal Group Item. If Combo Meal Group Item is not found, it creates a new Combo Meal Group Item.", "operationId":"updateComboGroupItem", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboGroupItemCUDRequest" } ], "responses":{ "200":{ "description":"Combo Side Group Item Updated or Added.", "schema":{ "$ref":"#/definitions/ComboGroupItemResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-combosidegroups-updatesidegroupitems-post", "x-filename-id":"config-sim-v1-menuitems-combosidegroups-updatesidegroupitems-post" } }, "/config/sim/v2/menuItems/comboSideGroups/updateSideGroupItems":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Group Item" ], "summary":"Update Combo Side Group Items", "description":"Updates the Combo Meal Group Item.", "operationId":"updateComboGroupItemv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboGroupItemCUDRequestV2" } ], "responses":{ "200":{ "description":"Combo Side Group Item Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" }, "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroups-updateSideGroupItems-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroups-updatesidegroupitems-post" } }, "/config/sim/v1/menuItems/combosidegroups/deletesidegroupitems":{ "post":{ "tags":[ "v1/Menu Items/Combo Side Groups/Combo Side Group Item" ], "summary":"Delete Combo Side Group Items", "description":"Deletes the Combo Meal Group Item object from a combo meal group for the specified organization.", "operationId":"DeleteComboGroupItem", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboGroupItemDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "$ref":"#/definitions/ComboGroupItemDeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-combosidegroups-deletesidegroupitems-post", "x-filename-id":"config-sim-v1-menuitems-combosidegroups-deletesidegroupitems-post" } }, "/config/sim/v2/menuItems/comboSideGroups/deleteSideGroupItems":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Group Item" ], "summary":"Delete Combo Side Group Items", "description":"Deletes the Combo Meal Group Item object from a combo meal group for the specified organization.", "operationId":"DeleteComboGroupItemv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboGroupItemDeleteRequestV2" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroups-deleteSideGroupItems-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroups-deletesidegroupitems-post" } }, "/config/sim/v1/menuItems/combosidegroups/bulkinsertsidegroupitems":{ "post":{ "tags":[ "v1/Menu Items/Combo Side Groups/Combo Side Group Item" ], "summary":"Bulk Insert Combo Side Group Items", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertComboSideGroupItems", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertComboSideGroupItemRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v1-menuItems-combosidegroups-bulkinsertsidegroupitems-post", "x-filename-id":"config-sim-v1-menuitems-combosidegroups-bulkinsertsidegroupitems-post" } }, "/config/sim/v2/menuItems/comboSideGroups/bulkInsertSideGroupItems":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Group Item" ], "summary":"Bulk Insert Combo Side Group Items", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertComboSideGroupItemsv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertComboSideGroupItemRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroups-bulkInsertSideGroupItems-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroups-bulkinsertsidegroupitems-post" } }, "/config/sim/v2/menuItems/comboSideGroups/bulkUpdateSideGroupItems":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Group Item" ], "summary":"Bulk Update Combo Side Group Items", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkUpdateComboSideGroupItemsv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkUpdateComboSideGroupItemRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroups-bulkUpdateSideGroupItems-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroups-bulkupdatesidegroupitems-post" } }, "/config/sim/v1/menuItems/getcondimentgroups":{ "post":{ "tags":[ "v1/Menu Items/Condiment Groups" ], "summary":"Get Condiment Groups", "description":"Gets all the Condiment Groups", "operationId":"getCondimentGroups", "parameters":[ { "$ref":"#/parameters/body.CondimentGroupsGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Condiment Groups", "schema":{ "$ref":"#/definitions/CondimentGroupGetResponseV1" } } }, "x-internal-id":"config-sim-v1-menuItems-getcondimentgroups-post", "x-filename-id":"config-sim-v1-menuitems-getcondimentgroups-post" } }, "/config/sim/v2/menuItems/getCondimentGroups":{ "post":{ "tags":[ "v2/Menu Items/Condiment Groups" ], "summary":"Get Condiment Groups", "description":"Gets all the Condiment Groups", "operationId":"getCondimentGroupsV2", "parameters":[ { "$ref":"#/parameters/body.CondimentGroupsGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Condiment Groups", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Condiment Group objects.", "items":{ "$ref":"#/definitions/CondimentGroupV2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getCondimentGroups-post", "x-filename-id":"config-sim-v2-menuitems-getcondimentgroups-post" } }, "/config/sim/v1/menuItems/condimentgroups":{ "post":{ "tags":[ "v1/Menu Items/Condiment Groups" ], "summary":"Add Condiment Groups", "description":"Adds a Condiment Group", "operationId":"addCondimentGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentGroupCUDRequestBody" } ], "responses":{ "200":{ "description":"Condiment Group Added", "schema":{ "$ref":"#/definitions/CondimentGroupResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-condimentgroups-post", "x-filename-id":"config-sim-v1-menuitems-condimentgroups-post" } }, "/config/sim/v2/menuItems/condimentGroups":{ "post":{ "tags":[ "v2/Menu Items/Condiment Groups" ], "summary":"Add Condiment Groups", "description":"Adds a Condiment Group", "operationId":"addCondimentGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentGroupCUDRequestBodyv2" } ], "responses":{ "200":{ "description":"Condiment Group Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment group" } } } } }, "x-internal-id":"config-sim-v2-menuItems-condimentGroups-post", "x-filename-id":"config-sim-v2-menuitems-condimentgroups-post" } }, "/config/sim/v1/menuItems/updatecondimentgroups":{ "post":{ "tags":[ "v1/Menu Items/Condiment Groups" ], "summary":"Update Condiment Groups", "description":"Updates a Condiment Group.", "operationId":"updateCondimentGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentGroupCUDRequestBody" } ], "responses":{ "200":{ "description":"Condiment Group Updated.", "schema":{ "$ref":"#/definitions/CondimentGroupResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-updatecondimentgroups-post", "x-filename-id":"config-sim-v1-menuitems-updatecondimentgroups-post" } }, "/config/sim/v2/menuItems/updateCondimentGroups":{ "post":{ "tags":[ "v2/Menu Items/Condiment Groups" ], "summary":"Update Condiment Groups", "description":"Updates a Condiment Group.", "operationId":"updateCondimentGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentGroupCUDRequestBodyv2" } ], "responses":{ "200":{ "description":"Condiment Group Updated", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment group" } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateCondimentGroups-post", "x-filename-id":"config-sim-v2-menuitems-updatecondimentgroups-post" } }, "/config/sim/v1/menuItems/deletecondimentgroups":{ "post":{ "tags":[ "v1/Menu Items/Condiment Groups" ], "summary":"Delete Condiment Groups", "description":"Deletes a Condiment Group.", "operationId":"deleteCondimentGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentGroupDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/CondimentGroupDeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-deletecondimentgroups-post", "x-filename-id":"config-sim-v1-menuitems-deletecondimentgroups-post" } }, "/config/sim/v2/menuItems/deleteCondimentGroups":{ "post":{ "tags":[ "v2/Menu Items/Condiment Groups" ], "summary":"Delete Condiment Groups", "description":"Deletes a Condiment Group.", "operationId":"deleteCondimentGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentGroupDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteCondimentGroups-post", "x-filename-id":"config-sim-v2-menuitems-deletecondimentgroups-post" } }, "/config/sim/v1/menuItems/getcondimentsets":{ "post":{ "tags":[ "v1/Menu Items/Condiment Sets" ], "summary":"Get Condiment Sets", "description":"Gets all the condiment sets", "operationId":"getCondimentSets", "parameters":[ { "$ref":"#/parameters/body.CondimentSetsGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Condiment Sets", "schema":{ "$ref":"#/definitions/CondimentSetGetResponsev1" } } }, "x-internal-id":"config-sim-v1-menuItems-getcondimentsets-post", "x-filename-id":"config-sim-v1-menuitems-getcondimentsets-post" } }, "/config/sim/v2/menuItems/getCondimentSets":{ "post":{ "tags":[ "v2/Menu Items/Condiment Sets" ], "summary":"Get Condiment Sets", "description":"Gets all the condiment sets", "operationId":"getCondimentSetsv2", "parameters":[ { "$ref":"#/parameters/body.CondimentSetsGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Condiment Sets", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Condiment Set objects of the organization.", "items":{ "$ref":"#/definitions/CondimentSetsv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getCondimentSets-post", "x-filename-id":"config-sim-v2-menuitems-getcondimentsets-post" } }, "/config/sim/v1/menuItems/condimentsets":{ "post":{ "tags":[ "v1/Menu Items/Condiment Sets" ], "summary":"Add Condiment Sets", "description":"Add the condiment set object to a specified hierarchy unit of specified organization.", "operationId":"addCondimentSets", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentSetCUDRequestBody" } ], "responses":{ "200":{ "description":"Condiment Set Added.", "schema":{ "$ref":"#/definitions/CondimentSetResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-condimentsets-post", "x-filename-id":"config-sim-v1-menuitems-condimentsets-post" } }, "/config/sim/v2/menuItems/condimentSets":{ "post":{ "tags":[ "v2/Menu Items/Condiment Sets" ], "summary":"Add Condiment Sets", "description":"Add the condiment set object to a specified hierarchy unit of specified organization.", "operationId":"addCondimentSetsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentSetCUDRequestBodyv2" } ], "responses":{ "200":{ "description":"Condiment Set Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment set" } } } } }, "x-internal-id":"config-sim-v2-menuItems-condimentSets-post", "x-filename-id":"config-sim-v2-menuitems-condimentsets-post" } }, "/config/sim/v1/menuItems/updatecondimentsets":{ "post":{ "tags":[ "v1/Menu Items/Condiment Sets" ], "summary":"Update Condiment Sets", "description":"Updates the Condiment Set. If Condiment Set is not found , it creates a new condiment set .", "operationId":"updateCondimentSets", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentSetCUDRequestBody" } ], "responses":{ "200":{ "description":"Condiment Set Updated or Added.", "schema":{ "$ref":"#/definitions/CondimentSetResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-updatecondimentsets-post", "x-filename-id":"config-sim-v1-menuitems-updatecondimentsets-post" } }, "/config/sim/v2/menuItems/updateCondimentSets":{ "post":{ "tags":[ "v2/Menu Items/Condiment Sets" ], "summary":"Update Condiment Sets", "description":"Updates the Condiment Set. ", "operationId":"updateCondimentSetsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentSetCUDRequestBodyv2" } ], "responses":{ "200":{ "description":"Condiment Set Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment set" } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateCondimentSets-post", "x-filename-id":"config-sim-v2-menuitems-updatecondimentsets-post" } }, "/config/sim/v1/menuItems/deletecondimentsets":{ "post":{ "tags":[ "v1/Menu Items/Condiment Sets" ], "summary":"Delete Condiment Sets", "description":"Deletes the Condiment Set object.", "operationId":"deleteCondimentSets", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentSetDeleteRequest" } ], "responses":{ "200":{ "description":"Message depicting the number of records deleted.", "schema":{ "$ref":"#/definitions/CondimentSetDeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-deletecondimentsets-post", "x-filename-id":"config-sim-v1-menuitems-deletecondimentsets-post" } }, "/config/sim/v2/menuItems/deleteCondimentSets":{ "post":{ "tags":[ "v2/Menu Items/Condiment Sets" ], "summary":"Delete Condiment Sets", "description":"Deletes the Condiment Set object.", "operationId":"deleteCondimentSetsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentSetDeleteRequest" } ], "responses":{ "200":{ "description":"Message depicting the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteCondimentSets-post", "x-filename-id":"config-sim-v2-menuitems-deletecondimentsets-post" } }, "/config/sim/v1/menuItems/condimentsets/getItems":{ "post":{ "tags":[ "v1/Menu Items/Condiment Sets/Condiment Set Items" ], "summary":"Get Condiment Set Items", "description":"Gets all the condiment items for a condiment set for the specified organization", "operationId":"getCondimentSetItems", "parameters":[ { "$ref":"#/parameters/body.CondimentSetItemsGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Condiment items.", "schema":{ "$ref":"#/definitions/CondimentSetItemGetResponsev1" } } }, "x-internal-id":"config-sim-v1-menuItems-condimentsets-getItems-post", "x-filename-id":"config-sim-v1-menuitems-condimentsets-getitems-post" } }, "/config/sim/v2/menuItems/condimentSets/getItems":{ "post":{ "tags":[ "v2/Menu Items/Condiment Sets/Condiment Set Items" ], "summary":"Get Condiment Set Items", "description":"Gets all the condiment items for a condiment set for the specified organization", "operationId":"getCondimentSetItemsv2", "parameters":[ { "$ref":"#/parameters/body.CondimentSetItemsGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Condiment items.", "schema":{ "$ref":"#/definitions/CondimentSetItemGetResponsev2" } } }, "x-internal-id":"config-sim-v2-menuItems-condimentSets-getItems-post", "x-filename-id":"config-sim-v2-menuitems-condimentsets-getitems-post" } }, "/config/sim/v1/menuItems/condimentsets/items":{ "post":{ "tags":[ "v1/Menu Items/Condiment Sets/Condiment Set Items" ], "summary":"Add Condiment Set Items", "description":"Add the condiment item to a condiment set object to a specified hierarchy unit .", "operationId":"AddCondimentSetItems", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentSetItemInsertRequestBody" } ], "responses":{ "200":{ "description":"Condiment Set Item Added.", "schema":{ "$ref":"#/definitions/CondimentSetItemResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-condimentsets-items-post", "x-filename-id":"config-sim-v1-menuitems-condimentsets-items-post" } }, "/config/sim/v2/menuItems/condimentSets/items":{ "post":{ "tags":[ "v2/Menu Items/Condiment Sets/Condiment Set Items" ], "summary":"Add Condiment Set Items", "description":"Add the condiment item to a condiment set object to a specified hierarchy unit .", "operationId":"AddCondimentSetItemsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentSetItemInsertRequestBody" } ], "responses":{ "200":{ "description":"Condiment Set Item Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment set" }, "condimentItemNum":{ "type":"integer", "example":1, "description":"Sequence number of the condiment item" } } } } }, "x-internal-id":"config-sim-v2-menuItems-condimentSets-items-post", "x-filename-id":"config-sim-v2-menuitems-condimentsets-items-post" } }, "/config/sim/v1/menuItems/condimentsets/updateItems":{ "post":{ "tags":[ "v1/Menu Items/Condiment Sets/Condiment Set Items" ], "summary":"Update Condiment Set Items", "description":"Updates the Condiment Set Item. If Condiment Set Item is not found, it creates a new condiment set item.", "operationId":"updateCondimentSetItems", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentSetItemUpdateRequestBody" } ], "responses":{ "200":{ "description":"Condiment Set Item Updated or Added.", "schema":{ "$ref":"#/definitions/CondimentSetItemResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-condimentsets-updateItems-post", "x-filename-id":"config-sim-v1-menuitems-condimentsets-updateitems-post" } }, "/config/sim/v2/menuItems/condimentSets/updateItems":{ "post":{ "tags":[ "v2/Menu Items/Condiment Sets/Condiment Set Items" ], "summary":"Update Condiment Set Items", "description":"Updates the Condiment Set Item. ", "operationId":"updateCondimentSetItemsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentSetItemUpdateRequestBody" } ], "responses":{ "200":{ "description":"Condiment Set Item Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment set" }, "condimentItemNum":{ "type":"integer", "example":1, "description":"Sequence number of the condiment item" } } } } }, "x-internal-id":"config-sim-v2-menuItems-condimentSets-updateItems-post", "x-filename-id":"config-sim-v2-menuitems-condimentsets-updateitems-post" } }, "/config/sim/v1/menuItems/condimentsets/deleteItems":{ "post":{ "tags":[ "v1/Menu Items/Condiment Sets/Condiment Set Items" ], "summary":"Delete Condiment Set Items", "description":"Deletes the Condiment Set Item object.", "operationId":"deleteCondimentSetItems", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentSetItemDeleteRequest" } ], "responses":{ "200":{ "description":"Message depicting the number of records deleted.", "schema":{ "$ref":"#/definitions/CondimentSetItemDeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-condimentsets-deleteItems-post", "x-filename-id":"config-sim-v1-menuitems-condimentsets-deleteitems-post" } }, "/config/sim/v2/menuItems/condimentSets/deleteItems":{ "post":{ "tags":[ "v2/Menu Items/Condiment Sets/Condiment Set Items" ], "summary":"Delete Condiment Set Items", "description":"Deletes the Condiment Set Item object.", "operationId":"deleteCondimentSetItemsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.CondimentSetItemDeleteRequest" } ], "responses":{ "200":{ "description":"Message depicting the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-condimentSets-deleteItems-post", "x-filename-id":"config-sim-v2-menuitems-condimentsets-deleteitems-post" } }, "/config/sim/v1/sales/getservicechargeitemizers":{ "post":{ "tags":[ "v1/Sales/Service Charge Itemizers" ], "summary":"Get Service Charge Itemizers", "description":"Gets all the Service Charge Itemizers configured", "operationId":"getServiceChargeItemizers", "parameters":[ { "$ref":"#/parameters/body.ServiceChargeItemizersGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Service Charge Itemizers.", "schema":{ "$ref":"#/definitions/ServiceChargeItemizersGetResponsev1" } } }, "x-internal-id":"config-sim-v1-sales-getservicechargeitemizers-post", "x-filename-id":"config-sim-v1-sales-getservicechargeitemizers-post" } }, "/config/sim/v2/sales/getServiceChargeItemizers":{ "post":{ "tags":[ "v2/Sales/Service Charge Itemizers" ], "summary":"Get Service Charge Itemizers", "description":"Gets all the Service Charge Itemizers configured", "operationId":"getServiceChargeItemizersv2", "parameters":[ { "$ref":"#/parameters/body.ServiceChargeItemizersGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Service Charge Itemizers.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Service Charge Itemizer objects of the organization.", "items":{ "$ref":"#/definitions/ServiceChargeItemizerv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-sales-getServiceChargeItemizers-post", "x-filename-id":"config-sim-v2-sales-getservicechargeitemizers-post" } }, "/config/sim/v1/sales/servicechargeitemizers":{ "post":{ "tags":[ "v1/Sales/Service Charge Itemizers" ], "summary":"Add Service Charge Itemizers", "description":"Add the Service Charge Itemizer object to a specified hierarchy unit .", "operationId":"AddServiceChargeItemizers", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeItemizersCURequestBody" } ], "responses":{ "200":{ "description":"Service Charge Itemizer Added.", "schema":{ "$ref":"#/definitions/ServiceChargeItemizersResponse" } } }, "x-internal-id":"config-sim-v1-sales-servicechargeitemizers-post", "x-filename-id":"config-sim-v1-sales-servicechargeitemizers-post" } }, "/config/sim/v2/sales/serviceChargeItemizers":{ "post":{ "tags":[ "v2/Sales/Service Charge Itemizers" ], "summary":"Add Service Charge Itemizers", "description":"Add the Service Charge Itemizer object to a specified hierarchy unit .", "operationId":"AddServiceChargeItemizersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeItemizersCURequestBodyv2" } ], "responses":{ "200":{ "description":"Service Charge Itemizer Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "svcItmzrIndex":{ "description":"Object number of the Service Charge Itemizer", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-serviceChargeItemizers-post", "x-filename-id":"config-sim-v2-sales-servicechargeitemizers-post" } }, "/config/sim/v1/sales/updateservicechargeitemizers":{ "post":{ "tags":[ "v1/Sales/Service Charge Itemizers" ], "summary":"Update Service Charge Itemizers", "description":"Updates the Service Charge Itemizer. If Service Charge Itemizer is not found, it creates a new Service Charge Itemizer.", "operationId":"updateServiceChargeItemizers", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeItemizersCURequestBody" } ], "responses":{ "200":{ "description":"Service Charge Itemizer Updated or Added.", "schema":{ "$ref":"#/definitions/ServiceChargeItemizersResponse" } } }, "x-internal-id":"config-sim-v1-sales-updateservicechargeitemizers-post", "x-filename-id":"config-sim-v1-sales-updateservicechargeitemizers-post" } }, "/config/sim/v2/sales/updateServiceChargeItemizers":{ "post":{ "tags":[ "v2/Sales/Service Charge Itemizers" ], "summary":"Update Service Charge Itemizers", "description":"Updates the Service Charge Itemizer.", "operationId":"updateServiceChargeItemizersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeItemizersCURequestBodyv2" } ], "responses":{ "200":{ "description":"Service Charge Itemizer Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "svcItmzrIndex":{ "description":"Object number of the Service Charge Itemizer", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-updateServiceChargeItemizers-post", "x-filename-id":"config-sim-v2-sales-updateservicechargeitemizers-post" } }, "/config/sim/v1/sales/deleteservicechargeitemizers":{ "post":{ "tags":[ "v1/Sales/Service Charge Itemizers" ], "summary":"Delete Service Charge Itemizers", "description":"Deletes the Service Charge Itemizer object.", "operationId":"deleteServiceChargeItemizers", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeItemizersDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-sales-deleteservicechargeitemizers-post", "x-filename-id":"config-sim-v1-sales-deleteservicechargeitemizers-post" } }, "/config/sim/v2/sales/deleteServiceChargeItemizers":{ "post":{ "tags":[ "v2/Sales/Service Charge Itemizers" ], "summary":"Delete Service Charge Itemizers", "description":"Deletes the Service Charge Itemizer object.", "operationId":"deleteServiceChargeItemizersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeItemizersDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-sales-deleteServiceChargeItemizers-post", "x-filename-id":"config-sim-v2-sales-deleteservicechargeitemizers-post" } }, "/config/sim/v2/menuItems/getAllergenClasses":{ "post":{ "tags":[ "v2/Menu Items/Allergen Classes" ], "summary":"Get Allergen Classes", "description":"Gets all the Allergen Classes", "operationId":"getAllergenClasses", "parameters":[ { "$ref":"#/parameters/body.AllergenClassesGetParameters" } ], "responses":{ "200":{ "description":"A collection of Allergen Classes.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of records in the data set" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Number of records returned on this page." }, "items":{ "type":"array", "description":"Allergen Class records.", "items":{ "$ref":"#/definitions/AllergenClass" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"The maximum number of records returned on a page" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getAllergenClasses-post", "x-filename-id":"config-sim-v2-menuitems-getallergenclasses-post" } }, "/config/sim/v2/menuItems/allergenClasses":{ "post":{ "tags":[ "v2/Menu Items/Allergen Classes" ], "summary":"Add Allergen Classes", "description":"Adds the Allergen Class.", "operationId":"addAllergenClasses", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.AllergenClassesCURequest" } ], "responses":{ "200":{ "description":"Allergen Class Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Hier Unit Id of the Enterprise.", "type":"integer", "example":7 }, "objectNum":{ "type":"integer", "example":2, "description":"Object number of the Allergen Class." } } } } }, "x-internal-id":"config-sim-v2-menuItems-allergenClasses-post", "x-filename-id":"config-sim-v2-menuitems-allergenclasses-post" } }, "/config/sim/v2/menuItems/updateAllergenClasses":{ "post":{ "tags":[ "v2/Menu Items/Allergen Classes" ], "summary":"Update Allergen Classes", "description":"Updates the Allergen Class.", "operationId":"updateAllergenClasses", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.AllergenClassesCURequest" } ], "responses":{ "200":{ "description":"Allergen Class Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Hier Unit Id of the Enterprise.", "type":"integer", "example":7 }, "objectNum":{ "type":"integer", "example":2, "description":"Object number of the Allergen Class." } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateAllergenClasses-post", "x-filename-id":"config-sim-v2-menuitems-updateallergenclasses-post" } }, "/config/sim/v2/menuItems/deleteAllergenClasses":{ "post":{ "tags":[ "v2/Menu Items/Allergen Classes" ], "summary":"Delete Allergen Classes", "description":"Deletes the Allergen Class.", "operationId":"deleteAllergenClasses", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.AllergenClassesDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteAllergenClasses-post", "x-filename-id":"config-sim-v2-menuitems-deleteallergenclasses-post" } }, "/config/sim/v1/hierarchy/getLocationParameters":{ "post":{ "tags":[ "v1/Hierarchy/Locations/Location Parameters" ], "summary":"Get Location Parameters", "description":"Gets all the parameters for a location", "operationId":"getLocationParams", "parameters":[ { "$ref":"#/parameters/body.LocationParametersGetRequestBodyv1" } ], "responses":{ "200":{ "description":"A collection of Location Parameters.", "schema":{ "$ref":"#/definitions/LocationParametersGetResponse" } } }, "x-internal-id":"config-sim-v1-hierarchy-getLocationParameters-post", "x-filename-id":"config-sim-v1-hierarchy-getlocationparameters-post" } }, "/config/sim/v2/hierarchy/getLocationParameters":{ "post":{ "tags":[ "v2/Hierarchy/Locations/Location Parameters" ], "summary":"Get Location Parameters", "description":"Gets all the parameters for a location", "operationId":"getLocationParamsv2", "parameters":[ { "$ref":"#/parameters/body.LocationParametersGetRequestBodyv2" } ], "responses":{ "200":{ "description":"A collection of Location Parameters.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Location Parameters objects of the organization.", "items":{ "$ref":"#/definitions/LocationParametersv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-getLocationParameters-post", "x-filename-id":"config-sim-v2-hierarchy-getlocationparameters-post" } }, "/config/sim/v1/hierarchy/locationParameters":{ "post":{ "tags":[ "v1/Hierarchy/Locations/Location Parameters" ], "summary":"Add Location Parameters", "description":"Add the Location to the specified organization.", "operationId":"addLocationParams", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LocationParametersCUDRequestBody" } ], "responses":{ "200":{ "description":"Location Parameter Added.", "schema":{ "$ref":"#/definitions/LocationParametersResponse" } } }, "x-internal-id":"config-sim-v1-hierarchy-locationParameters-post", "x-filename-id":"config-sim-v1-hierarchy-locationparameters-post" } }, "/config/sim/v1/hierarchy/updateLocationParameters":{ "post":{ "tags":[ "v1/Hierarchy/Locations/Location Parameters" ], "summary":"Update Location Parameters", "description":"Updates the parameters for a location. If parameter is not found, it creates a new parameter record for the location.", "operationId":"updateLocationParams", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LocationParametersCUDRequestBody" } ], "responses":{ "200":{ "description":"Location Parameters Updated or Added.", "schema":{ "$ref":"#/definitions/LocationParametersResponse" } } }, "x-internal-id":"config-sim-v1-hierarchy-updateLocationParameters-post", "x-filename-id":"config-sim-v1-hierarchy-updatelocationparameters-post" } }, "/config/sim/v2/hierarchy/updateLocationParameters":{ "post":{ "tags":[ "v2/Hierarchy/Locations/Location Parameters" ], "summary":"Update Location Parameters", "description":"Updates the parameters for a location.", "operationId":"updateLocationParamsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LocationParametersUpdateRequestBodyv2" } ], "responses":{ "200":{ "description":"Location Parameters Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." } } } } }, "x-internal-id":"config-sim-v2-hierarchy-updateLocationParameters-post", "x-filename-id":"config-sim-v2-hierarchy-updatelocationparameters-post" } }, "/config/sim/v1/hierarchy/deleteLocationParameters":{ "post":{ "tags":[ "v1/Hierarchy/Locations/Location Parameters" ], "summary":"Delete Location Parameters", "description":"Deletes the location parameters object.", "operationId":"deleteLocationParams", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LocationParametersDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-hierarchy-deleteLocationParameters-post", "x-filename-id":"config-sim-v1-hierarchy-deletelocationparameters-post" } }, "/config/sim/v1/sales/getDiscounts":{ "post":{ "tags":[ "v1/Sales/Discounts/Discount" ], "summary":"Get Discounts", "description":"Gets all the Discounts configured", "operationId":"getDiscounts", "parameters":[ { "$ref":"#/parameters/body.DiscountsGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Discount entities.", "schema":{ "$ref":"#/definitions/Discountv1GetResponse" } } }, "x-internal-id":"config-sim-v1-sales-getDiscounts-post", "x-filename-id":"config-sim-v1-sales-getdiscounts-post" } }, "/config/sim/v2/sales/getDiscounts":{ "post":{ "tags":[ "v2/Sales/Discounts/Discount" ], "summary":"Get Discounts", "description":"Gets all the Discounts configured", "operationId":"getDiscountsv2", "parameters":[ { "$ref":"#/parameters/body.DiscountsGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Discount entities.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Discounts objects of the organization.", "items":{ "$ref":"#/definitions/Discountv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-sales-getDiscounts-post", "x-filename-id":"config-sim-v2-sales-getdiscounts-post" } }, "/config/sim/v1/sales/discounts":{ "post":{ "tags":[ "v1/Sales/Discounts/Discount" ], "summary":"Add Discounts", "description":"Add the Discount object to a specified hierarchy unit .", "operationId":"addDiscounts", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountCURequestBody" } ], "responses":{ "200":{ "description":"Discount entity Added.", "schema":{ "$ref":"#/definitions/DiscountResponse" } } }, "x-internal-id":"config-sim-v1-sales-discounts-post", "x-filename-id":"config-sim-v1-sales-discounts-post" } }, "/config/sim/v2/sales/discounts":{ "post":{ "tags":[ "v2/Sales/Discounts/Discount" ], "summary":"Add Discounts", "description":"Add the Discount object to a specified hierarchy unit .", "operationId":"addDiscountsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountCURequestBodyv2" } ], "responses":{ "200":{ "description":"Discount entity Added.", "schema":{ "type":"object", "properties":{ "effGrpObjNum":{ "description":"ObjectNumber of Effectivity Group", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the Discount.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique Hierarchy Unit Value", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-discounts-post", "x-filename-id":"config-sim-v2-sales-discounts-post" } }, "/config/sim/v1/sales/updateDiscounts":{ "post":{ "tags":[ "v1/Sales/Discounts/Discount" ], "summary":"Update Discounts", "description":"Updates the Discount. If Discount is not found, it creates a new Discount", "operationId":"updateDiscounts", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountCURequestBody" } ], "responses":{ "200":{ "description":"Discount entity Updated or Added.", "schema":{ "$ref":"#/definitions/DiscountResponse" } } }, "x-internal-id":"config-sim-v1-sales-updateDiscounts-post", "x-filename-id":"config-sim-v1-sales-updatediscounts-post" } }, "/config/sim/v2/sales/updateDiscounts":{ "post":{ "tags":[ "v2/Sales/Discounts/Discount" ], "summary":"Update Discounts", "description":"Updates the Discount.", "operationId":"updateDiscountsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountCURequestBodyv2" } ], "responses":{ "200":{ "description":"Discount entity Updated.", "schema":{ "type":"object", "properties":{ "effGrpObjNum":{ "description":"ObjectNumber of Effectivity Group", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the Discount.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique Hierarchy Unit Value", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-updateDiscounts-post", "x-filename-id":"config-sim-v2-sales-updatediscounts-post" } }, "/config/sim/v1/sales/deleteDiscounts":{ "post":{ "tags":[ "v1/Sales/Discounts/Discount" ], "summary":"Delete Discounts", "description":"Deletes the Discount object.", "operationId":"deleteDiscounts", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountDeleteRequestBody" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-sales-deleteDiscounts-post", "x-filename-id":"config-sim-v1-sales-deletediscounts-post" } }, "/config/sim/v2/sales/deleteDiscounts":{ "post":{ "tags":[ "v2/Sales/Discounts/Discount" ], "summary":"Delete Discounts", "description":"Deletes the Discount object.", "operationId":"deleteDiscountsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountDeleteRequestBody" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-sales-deleteDiscounts-post", "x-filename-id":"config-sim-v2-sales-deletediscounts-post" } }, "/config/sim/v1/menuItems/getFamilyGroups":{ "post":{ "tags":[ "v1/Menu Items/Family Groups" ], "summary":"Get Family Groups", "description":"Gets a list of Family Groups", "operationId":"getFamilyGroups", "parameters":[ { "$ref":"#/parameters/body.FamilyGroupsGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Family Group entities.", "schema":{ "$ref":"#/definitions/FamilyGroupv1GetResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-getFamilyGroups-post", "x-filename-id":"config-sim-v1-menuitems-getfamilygroups-post" } }, "/config/sim/v2/menuItems/getFamilyGroups":{ "post":{ "tags":[ "v2/Menu Items/Family Groups" ], "summary":"Get Family Groups", "description":"Gets a list of Family Groups", "operationId":"getFamilyGroupsv2", "parameters":[ { "$ref":"#/parameters/body.FamilyGroupsGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Family Group entities.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Family Groups objects of the organization.", "items":{ "$ref":"#/definitions/FamilyGroupv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getFamilyGroups-post", "x-filename-id":"config-sim-v2-menuitems-getfamilygroups-post" } }, "/config/sim/v1/menuItems/familyGroups":{ "post":{ "tags":[ "v1/Menu Items/Family Groups" ], "summary":"Add Family Groups", "description":"

    Add the Family Group object to a specified hierarchy unit.

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.4 Starting with the API release 23.4, Insert operation for Family Groups is allowed only at Enterprise.
    \n", "operationId":"addFamilyGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.FamilyGroupCUDRequestBody" } ], "responses":{ "200":{ "description":"Family Group Added.", "schema":{ "$ref":"#/definitions/FamilyGroupResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-familyGroups-post", "x-filename-id":"config-sim-v1-menuitems-familygroups-post" } }, "/config/sim/v2/menuItems/familyGroups":{ "post":{ "tags":[ "v2/Menu Items/Family Groups" ], "summary":"Add Family Groups", "description":"Add the Family Group object to a specified hierarchy unit.", "operationId":"addFamilyGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.FamilyGroupCUDRequestBodyv2" } ], "responses":{ "200":{ "description":"Family Group Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the family group" } } } } }, "x-internal-id":"config-sim-v2-menuItems-familyGroups-post", "x-filename-id":"config-sim-v2-menuitems-familygroups-post" } }, "/config/sim/v1/menuItems/updateFamilygroups":{ "post":{ "tags":[ "v1/Menu Items/Family Groups" ], "summary":"Update Family Groups", "description":"

    Updates the Family Group. If not found, it creates a new family group.

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.4 Starting with the API release 23.4, Update operation for Family Groups is allowed only at Enterprise.
    \n", "operationId":"updateFamilyGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.FamilyGroupCUDRequestBody" } ], "responses":{ "200":{ "description":"Family Group Updated or Added.", "schema":{ "$ref":"#/definitions/FamilyGroupResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-updateFamilygroups-post", "x-filename-id":"config-sim-v1-menuitems-updatefamilygroups-post" } }, "/config/sim/v2/menuItems/updateFamilyGroups":{ "post":{ "tags":[ "v2/Menu Items/Family Groups" ], "summary":"Update Family Groups", "description":"Updates the Family Group.", "operationId":"updateFamilyGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.FamilyGroupCUDRequestBodyv2" } ], "responses":{ "200":{ "description":"Family Group Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the family group" } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateFamilyGroups-post", "x-filename-id":"config-sim-v2-menuitems-updatefamilygroups-post" } }, "/config/sim/v1/menuItems/deleteFamilygroups":{ "post":{ "tags":[ "v1/Menu Items/Family Groups" ], "summary":"Delete Family Groups", "description":"Deletes Family Groups", "operationId":"deleteFamilyGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.FamilyGroupDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/DeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-deleteFamilygroups-post", "x-filename-id":"config-sim-v1-menuitems-deletefamilygroups-post" } }, "/config/sim/v2/menuItems/deleteFamilyGroups":{ "post":{ "tags":[ "v2/Menu Items/Family Groups" ], "summary":"Delete Family Groups", "description":"Deletes Family Groups", "operationId":"deleteFamilyGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.FamilyGroupDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteFamilyGroups-post", "x-filename-id":"config-sim-v2-menuitems-deletefamilygroups-post" } }, "/config/sim/v2/devices/deviceStatus/getDetails":{ "post":{ "tags":[ "v2/Devices/Device Status/Details" ], "summary":"Get Device Status Details", "description":"Gets detailed information on status of devices", "operationId":"getDeviceStatusDetails", "parameters":[ { "in":"body", "name":"Get Record Parameters", "required":true, "schema":{ "type":"object", "required":[ "serviceHostId" ], "properties":{ "serviceHostId":{ "description":"Unique service host reference", "type":"integer", "example":244 } } } } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "description":"Total number of records in the data set", "type":"integer", "example":100 }, "hasMore":{ "description":"Indicates whether there are additional pages of records", "type":"boolean", "example":true }, "count":{ "description":"Number of records returned on this page", "type":"integer", "example":10 }, "items":{ "description":"Device Status Details records", "type":"array", "items":{ "$ref":"#/definitions/DeviceStatusDetails" } } } } } }, "x-internal-id":"config-sim-v2-devices-deviceStatus-getDetails-post", "x-filename-id":"config-sim-v2-devices-devicestatus-getdetails-post" } }, "/config/sim/v1/setup/tags":{ "post":{ "tags":[ "v1/Setup/Tags and Dietary Labels" ], "summary":"Add Tags and Dietary Labels", "description":"Add Tags and Dietary Labels", "operationId":"createTagsAndDietaryLabels", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TagsInsertRequestBody" } ], "responses":{ "200":{ "description":"Tag object Added.", "schema":{ "$ref":"#/definitions/TagsResponse" } } }, "x-internal-id":"config-sim-v1-setup-tags-post", "x-filename-id":"config-sim-v1-setup-tags-post" } }, "/config/sim/v2/setup/tags":{ "post":{ "tags":[ "v2/Setup/Tags and Dietary Labels" ], "summary":"Add Tags and Dietary Labels", "description":"Add Tags and Dietary Labels", "operationId":"createTagsAndDietaryLabelsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TagsInsertRequestBody" } ], "responses":{ "200":{ "description":"Tag object Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique reference of the hierarchy unit where the Tag or the Dietary Label is configured. Only Enterprise hierUnitId is allowed.", "example":3599 }, "objectNum":{ "description":"Object Number of a Tag or a Dietary Label.", "type":"integer", "example":200 } } } } }, "x-internal-id":"config-sim-v2-setup-tags-post", "x-filename-id":"config-sim-v2-setup-tags-post" } }, "/config/sim/v1/setup/deleteTags":{ "post":{ "tags":[ "v1/Setup/Tags and Dietary Labels" ], "summary":"Delete Tags and Dietary Labels", "description":"Delete Tags and Dietary Labels", "operationId":"deleteTagsAndDietaryLabels", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TagsDeleteRequestBody" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-setup-deleteTags-post", "x-filename-id":"config-sim-v1-setup-deletetags-post" } }, "/config/sim/v2/setup/deleteTags":{ "post":{ "tags":[ "v2/Setup/Tags and Dietary Labels" ], "summary":"Delete Tags and Dietary Labels", "description":"Delete Tags and Dietary Labels", "operationId":"deleteTagsAndDietaryLabelsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TagsDeleteRequestBody" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteTags-post", "x-filename-id":"config-sim-v2-setup-deletetags-post" } }, "/config/sim/v1/setup/getTags":{ "post":{ "tags":[ "v1/Setup/Tags and Dietary Labels" ], "summary":"Get Tags and Dietary Labels", "description":"Get Tags and Dietary Labels", "operationId":"getTagsAndDietaryLabels", "parameters":[ { "$ref":"#/parameters/body.TagsGetParametersv1" } ], "responses":{ "200":{ "description":"Success", "schema":{ "$ref":"#/definitions/TagsGetResponse" } } }, "x-internal-id":"config-sim-v1-setup-getTags-post", "x-filename-id":"config-sim-v1-setup-gettags-post" } }, "/config/sim/v2/setup/getTags":{ "post":{ "tags":[ "v2/Setup/Tags and Dietary Labels" ], "summary":"Get Tags and Dietary Labels", "description":"Get Tags and Dietary Labels", "operationId":"getTagsAndDietaryLabelsv2", "parameters":[ { "$ref":"#/parameters/body.TagsGetParametersv2" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Tag objects.", "items":{ "$ref":"#/definitions/TagsGetResponseBody" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getTags-post", "x-filename-id":"config-sim-v2-setup-gettags-post" } }, "/config/sim/v1/setup/updateTags":{ "post":{ "tags":[ "v1/Setup/Tags and Dietary Labels" ], "summary":"Update Tags and Dietary Labels", "description":"Update Tags and Dietary Labels", "operationId":"updateTagsAndDietaryLabels", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TagsUpdateRequestBody" } ], "responses":{ "200":{ "description":"Tag object Updated or Added.", "schema":{ "$ref":"#/definitions/TagsResponse" } } }, "x-internal-id":"config-sim-v1-setup-updateTags-post", "x-filename-id":"config-sim-v1-setup-updatetags-post" } }, "/config/sim/v2/setup/updateTags":{ "post":{ "tags":[ "v2/Setup/Tags and Dietary Labels" ], "summary":"Update Tags and Dietary Labels", "description":"Update Tags and Dietary Labels", "operationId":"updateTagsAndDietaryLabelsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.TagsUpdateRequestBody" } ], "responses":{ "200":{ "description":"Tag object Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique reference of the hierarchy unit where the Tag or the Dietary Label is configured. Only Enterprise hierUnitId is allowed.", "example":3599 }, "objectNum":{ "description":"Object Number of a Tag or a Dietary Label", "type":"integer", "example":200 } } } } }, "x-internal-id":"config-sim-v2-setup-updateTags-post", "x-filename-id":"config-sim-v2-setup-updatetags-post" } }, "/config/sim/v1/setup/DataExtensions":{ "post":{ "tags":[ "v1/Setup/Data Extensions" ], "summary":"Add Data Extensions", "description":"Add Data Extensions", "operationId":"addDataExtensions", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DataExtensionResourceObject" } ], "responses":{ "200":{ "description":"Data Extension Added.", "schema":{ "$ref":"#/definitions/DataExtensionsResponse" } } }, "x-internal-id":"config-sim-v1-setup-DataExtensions-post", "x-filename-id":"config-sim-v1-setup-dataextensions-post" } }, "/config/sim/v2/setup/dataExtensions":{ "post":{ "tags":[ "v2/Setup/Data Extensions" ], "summary":"Add Data Extensions", "description":"Add Data Extensions", "operationId":"addDataExtensionsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DataExtensionResourceObjectv2" } ], "responses":{ "200":{ "description":"Data Extension Added.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object number of the data extension property" } } } } }, "x-internal-id":"config-sim-v2-setup-dataExtensions-post", "x-filename-id":"config-sim-v2-setup-dataextensions-post" } }, "/config/sim/v1/setup/deleteDataExtensions":{ "post":{ "tags":[ "v1/Setup/Data Extensions" ], "summary":"Delete Data Extensions", "description":"Delete Data Extensions", "operationId":"deleteDataExtensions", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DataExtensionDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/DataExtensionsDeleteResponse" } } }, "x-internal-id":"config-sim-v1-setup-deleteDataExtensions-post", "x-filename-id":"config-sim-v1-setup-deletedataextensions-post" } }, "/config/sim/v2/setup/deleteDataExtensions":{ "post":{ "tags":[ "v2/Setup/Data Extensions" ], "summary":"Delete Data Extensions", "description":"Delete Data Extensions", "operationId":"deleteDataExtensionsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DataExtensionDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteDataExtensions-post", "x-filename-id":"config-sim-v2-setup-deletedataextensions-post" } }, "/config/sim/v1/setup/getDataExtensions":{ "post":{ "tags":[ "v1/Setup/Data Extensions" ], "summary":"Get Data Extensions", "description":"Get Data Extensions", "operationId":"getDataExtensions", "parameters":[ { "$ref":"#/parameters/body.DataExtensionsGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of data extension objects.", "schema":{ "$ref":"#/definitions/DataExtensionsGetResponse" } } }, "x-internal-id":"config-sim-v1-setup-getDataExtensions-post", "x-filename-id":"config-sim-v1-setup-getdataextensions-post" } }, "/config/sim/v2/setup/getDataExtensions":{ "post":{ "tags":[ "v2/Setup/Data Extensions" ], "summary":"Get Data Extensions", "description":"Get Data Extensions", "operationId":"getDataExtensionsv2", "parameters":[ { "$ref":"#/parameters/body.DataExtensionsGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of data extension objects.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of data extension objects of the organization.", "items":{ "$ref":"#/definitions/DataExtensionsv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getDataExtensions-post", "x-filename-id":"config-sim-v2-setup-getdataextensions-post" } }, "/config/sim/v1/setup/updateDataExtensions":{ "post":{ "tags":[ "v1/Setup/Data Extensions" ], "summary":"Update Data Extensions", "description":"Update Data Extensions", "operationId":"updateDataExtensions", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DataExtensionResourceObject" } ], "responses":{ "200":{ "description":"Data Extension Updated or Added.", "schema":{ "$ref":"#/definitions/DataExtensionsResponse" } } }, "x-internal-id":"config-sim-v1-setup-updateDataExtensions-post", "x-filename-id":"config-sim-v1-setup-updatedataextensions-post" } }, "/config/sim/v2/setup/updateDataExtensions":{ "post":{ "tags":[ "v2/Setup/Data Extensions" ], "summary":"Update Data Extensions", "description":"Update Data Extensions", "operationId":"updateDataExtensionsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DataExtensionResourceObjectv2" } ], "responses":{ "200":{ "description":"Data Extension Updated.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object number of the data extension property" } } } } }, "x-internal-id":"config-sim-v2-setup-updateDataExtensions-post", "x-filename-id":"config-sim-v2-setup-updatedataextensions-post" } }, "/content/sim/v1/setup/getpaymentdrivers":{ "post":{ "tags":[ "v1/Setup/Payment Drivers/Payment Drivers" ], "summary":"Get Payment Drivers", "description":"Gets all the payment drivers", "operationId":"getPaymentDrivers", "parameters":[ { "$ref":"#/parameters/body.PaymentDriversGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Payment Drivers", "schema":{ "$ref":"#/definitions/PaymentDriverGetResponse" } } }, "x-internal-id":"content-sim-v1-setup-getpaymentdrivers-post", "x-filename-id":"content-sim-v1-setup-getpaymentdrivers-post" } }, "/content/sim/v2/setup/getPaymentDrivers":{ "post":{ "tags":[ "v2/Setup/Payment Drivers/Payment Drivers" ], "summary":"Get Payment Drivers", "description":"Gets all the payment drivers", "operationId":"getPaymentDriversv2", "parameters":[ { "$ref":"#/parameters/body.PaymentDriversGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Payment Drivers", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Payment Drivers objects of the organization.", "items":{ "$ref":"#/definitions/PaymentDriverv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"content-sim-v2-setup-getPaymentDrivers-post", "x-filename-id":"content-sim-v2-setup-getpaymentdrivers-post" } }, "/content/sim/v1/setup/paymentdrivers":{ "post":{ "tags":[ "v1/Setup/Payment Drivers/Payment Drivers" ], "summary":"Add Payment Drivers", "description":"Add the payment driver to the specified organization.", "operationId":"addPaymentDrivers", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PaymentDriverCURequest" } ], "responses":{ "200":{ "description":"Payment Driver Added.", "schema":{ "$ref":"#/definitions/PaymentDriverResponse" } } }, "x-internal-id":"content-sim-v1-setup-paymentdrivers-post", "x-filename-id":"content-sim-v1-setup-paymentdrivers-post" } }, "/content/sim/v2/setup/paymentDrivers":{ "post":{ "tags":[ "v2/Setup/Payment Drivers/Payment Drivers" ], "summary":"Add Payment Drivers", "description":"Add the payment driver to the specified organization.", "operationId":"addPaymentDriversv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PaymentDriverCURequestv2" } ], "responses":{ "200":{ "description":"Payment Driver Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the payment driver." } } } } }, "x-internal-id":"content-sim-v2-setup-paymentDrivers-post", "x-filename-id":"content-sim-v2-setup-paymentdrivers-post" } }, "/content/sim/v1/setup/updatepaymentdrivers":{ "post":{ "tags":[ "v1/Setup/Payment Drivers/Payment Drivers" ], "summary":"Update Payment Drivers", "description":"Updates the payment driver. If payment driver is not found, it add a new payment driver.", "operationId":"updatePaymentDrivers", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PaymentDriverCURequest" } ], "responses":{ "200":{ "description":"Payment Driver Updated or Added.", "schema":{ "$ref":"#/definitions/PaymentDriverResponse" } } }, "x-internal-id":"content-sim-v1-setup-updatepaymentdrivers-post", "x-filename-id":"content-sim-v1-setup-updatepaymentdrivers-post" } }, "/content/sim/v2/setup/updatePaymentDrivers":{ "post":{ "tags":[ "v2/Setup/Payment Drivers/Payment Drivers" ], "summary":"Update Payment Drivers", "description":"Updates the payment driver.", "operationId":"updatePaymentDriversv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PaymentDriverCURequestv2" } ], "responses":{ "200":{ "description":"Payment Driver Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the payment driver." } } } } }, "x-internal-id":"content-sim-v2-setup-updatePaymentDrivers-post", "x-filename-id":"content-sim-v2-setup-updatepaymentdrivers-post" } }, "/content/sim/v1/setup/deletepaymentdrivers":{ "post":{ "tags":[ "v1/Setup/Payment Drivers/Payment Drivers" ], "summary":"Delete Payment Drivers", "description":"Deletes the payment driver object.", "operationId":"deletePaymentDrivers", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PaymentDriverDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"content-sim-v1-setup-deletepaymentdrivers-post", "x-filename-id":"content-sim-v1-setup-deletepaymentdrivers-post" } }, "/content/sim/v2/setup/deletePaymentDrivers":{ "post":{ "tags":[ "v2/Setup/Payment Drivers/Payment Drivers" ], "summary":"Delete Payment Drivers", "description":"Deletes the payment driver object.", "operationId":"deletePaymentDriversv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PaymentDriverDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"content-sim-v2-setup-deletePaymentDrivers-post", "x-filename-id":"content-sim-v2-setup-deletepaymentdrivers-post" } }, "/content/sim/v1/setup/downloadpaymentdrivers":{ "post":{ "tags":[ "v1/Setup/Payment Drivers/Payment Drivers" ], "summary":"Download Payment Drivers", "description":"Downloads the content file for the specified object in the specified organization.", "operationId":"downloadPaymentDrivers", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PaymentDriverDownloadRequest" } ], "responses":{ "200":{ "description":"Download the file as a octet stream", "schema":{ "type":"string", "format":"binary" } } }, "x-internal-id":"content-sim-v1-setup-downloadpaymentdrivers-post", "x-filename-id":"content-sim-v1-setup-downloadpaymentdrivers-post" } }, "/content/sim/v2/setup/downloadPaymentDrivers":{ "post":{ "tags":[ "v2/Setup/Payment Drivers/Payment Drivers" ], "summary":"Download Payment Drivers", "description":"Downloads the content file for the specified object in the specified organization.", "operationId":"downloadPaymentDriversv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.PaymentDriverDownloadRequest" } ], "responses":{ "200":{ "description":"Download the file as a octet stream", "schema":{ "type":"string", "format":"binary" } } }, "x-internal-id":"content-sim-v2-setup-downloadPaymentDrivers-post", "x-filename-id":"content-sim-v2-setup-downloadpaymentdrivers-post" } }, "/config/sim/v1/menuItems/getMenuItem2":{ "post":{ "tags":[ "v1/Menu Items/Menu Item 2" ], "summary":"Get Menu Items 2", "description":"Gets all the Menu Items configured", "operationId":"getMenuItems2", "parameters":[ { "$ref":"#/parameters/body.MenuItems2GetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Menu Items", "schema":{ "$ref":"#/definitions/MenuItem2v1GetResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-getMenuItem2-post", "x-filename-id":"config-sim-v1-menuitems-getmenuitem2-post" } }, "/config/sim/v2/menuItems/getMenuItem2":{ "post":{ "tags":[ "v2/Menu Items/Menu Item 2" ], "summary":"Get Menu Items 2", "description":"Gets all the Menu Items configured", "operationId":"getMenuItems2v2", "parameters":[ { "$ref":"#/parameters/body.MenuItems2GetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Menu Items", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item objects of the organization.", "items":{ "$ref":"#/definitions/MenuItem2v2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getMenuItem2-post", "x-filename-id":"config-sim-v2-menuitems-getmenuitem2-post" } }, "/config/sim/v1/hierarchy/locations":{ "post":{ "tags":[ "v1/Hierarchy/Locations/Locations" ], "summary":"Add Locations", "description":"Add Location object to a specified hierarchy unit of specified organization. After inserting the Location, the corresponding Location Parameter needs to be added manually. ", "operationId":"addLocations", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LocationInsertRequestBody" } ], "responses":{ "200":{ "description":"Location Added.", "schema":{ "$ref":"#/definitions/LocationResponse" } } }, "x-internal-id":"config-sim-v1-hierarchy-locations-post", "x-filename-id":"config-sim-v1-hierarchy-locations-post" } }, "/config/sim/v2/hierarchy/locations":{ "post":{ "tags":[ "v2/Hierarchy/Locations/Locations" ], "summary":"Add Locations", "description":"Add Location object to a specified hierarchy unit of specified organization.", "operationId":"addLocationsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LocationInsertRequestBodyv2" } ], "responses":{ "200":{ "description":"Location Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Location", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-hierarchy-locations-post", "x-filename-id":"config-sim-v2-hierarchy-locations-post" } }, "/config/sim/v1/hierarchy/predeletechecklocations":{ "post":{ "tags":[ "v1/Hierarchy/Locations/Locations" ], "summary":"Pre-Delete Locations", "description":"Checks the existence of references to the object in the database.", "operationId":"preDeleteCheckLocations", "parameters":[ { "in":"body", "name":"Request body", "description":"A request body", "required":true, "schema":{ "$ref":"#/definitions/Location_dml" } } ], "responses":{ "200":{ "description":"The values of \"response\" can either be \"Dependency exist.\" or \"Dependency does not exist.\"", "schema":{ "$ref":"#/definitions/predeletecheck_nodependency_response" } } }, "x-internal-id":"config-sim-v1-hierarchy-predeletechecklocations-post", "x-filename-id":"config-sim-v1-hierarchy-predeletechecklocations-post" } }, "/config/sim/v2/hierarchy/preDeleteCheckLocations":{ "post":{ "tags":[ "v2/Hierarchy/Locations/Locations" ], "summary":"Pre-Delete Locations", "description":"Checks the existence of references to the object in the database.", "operationId":"preDeleteCheckLocationsv2", "parameters":[ { "in":"body", "name":"Request body", "description":"A request body", "required":true, "schema":{ "$ref":"#/definitions/Location_dml" } } ], "responses":{ "200":{ "description":"The values of \"response\" can either be \"Dependency exist.\" or \"Dependency does not exist.\"", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"response", "description":"Indicates existence of references to the object in the database." } } } } }, "x-internal-id":"config-sim-v2-hierarchy-preDeleteCheckLocations-post", "x-filename-id":"config-sim-v2-hierarchy-predeletechecklocations-post" } }, "/config/sim/v1/hierarchy/deleteLocations":{ "post":{ "tags":[ "v1/Hierarchy/Locations/Locations" ], "summary":"Delete Locations", "description":"Deletes the location object. The corresponding reporting location is not deleted. Before deleting the Location, the corresponding Location Parameter needs to be deleted manually. ", "operationId":"deleteLocations", "parameters":[ { "$ref":"#/parameters/body.LocationDeleteRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-hierarchy-deleteLocations-post", "x-filename-id":"config-sim-v1-hierarchy-deletelocations-post" } }, "/config/sim/v2/hierarchy/deleteLocations":{ "post":{ "tags":[ "v2/Hierarchy/Locations/Locations" ], "summary":"Delete Locations", "description":"Deletes the location object. The corresponding reporting location is not deleted.", "operationId":"deleteLocationsv2", "parameters":[ { "$ref":"#/parameters/body.LocationDeleteRequestBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-deleteLocations-post", "x-filename-id":"config-sim-v2-hierarchy-deletelocations-post" } }, "/config/sim/v1/hierarchy/getLocations":{ "post":{ "tags":[ "v1/Hierarchy/Locations/Locations" ], "summary":"Get Locations", "description":"Gets all the locations", "operationId":"getLocations", "parameters":[ { "$ref":"#/parameters/body.LocationsGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Location entities.", "schema":{ "$ref":"#/definitions/LocationGetResponsev1" } } }, "x-internal-id":"config-sim-v1-hierarchy-getLocations-post", "x-filename-id":"config-sim-v1-hierarchy-getlocations-post" } }, "/config/sim/v2/hierarchy/getLocations":{ "post":{ "tags":[ "v2/Hierarchy/Locations/Locations" ], "summary":"Get Locations", "description":"Gets all the locations", "operationId":"getLocationsv2", "parameters":[ { "$ref":"#/parameters/body.LocationsGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Location entities.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Location objects of the organization.", "items":{ "$ref":"#/definitions/Locationv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-getLocations-post", "x-filename-id":"config-sim-v2-hierarchy-getlocations-post" } }, "/config/sim/v1/hierarchy/updateLocations":{ "post":{ "tags":[ "v1/Hierarchy/Locations/Locations" ], "summary":"Update Locations", "description":"Updates the location. If location is not found is not found, it creates a new location.", "operationId":"updateLocations", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LocationUpdateRequestBody" } ], "responses":{ "200":{ "description":"Location Updated or Added.", "schema":{ "$ref":"#/definitions/LocationResponse" } } }, "x-internal-id":"config-sim-v1-hierarchy-updateLocations-post", "x-filename-id":"config-sim-v1-hierarchy-updatelocations-post" } }, "/config/sim/v2/hierarchy/updateLocations":{ "post":{ "tags":[ "v2/Hierarchy/Locations/Locations" ], "summary":"Update Locations", "description":"Updates the location.", "operationId":"updateLocationsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LocationUpdateRequestBodyv2" } ], "responses":{ "200":{ "description":"Location Updated .", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Location", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-hierarchy-updateLocations-post", "x-filename-id":"config-sim-v2-hierarchy-updatelocations-post" } }, "/config/sim/v2/employees/getEmployee":{ "post":{ "tags":[ "v2/Employees/Employee" ], "summary":"Get Employee", "description":"Gets the specific Employee configured at the enterpise", "operationId":"getEmployeev2", "parameters":[ { "$ref":"#/parameters/body.SingleEmployeeGetParameters" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":1, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":false, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":100, "description":"Server page size" }, "items":{ "type":"array", "description":"Array of Employee object.", "items":{ "$ref":"#/definitions/SingleEmployee" } } } } } }, "x-internal-id":"config-sim-v2-employees-getEmployee-post", "x-filename-id":"config-sim-v2-employees-getemployee-post" } }, "/config/sim/v1/setup/salesitemizers":{ "post":{ "tags":[ "v1/Setup/Sales Itemizers" ], "summary":"Add Sales Itemizers", "description":"Add Sales Itemizers", "operationId":"addSalesItemizers", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SalesItemizerCUDRequest" } ], "responses":{ "200":{ "description":"Sales Itemizer Added.", "schema":{ "$ref":"#/definitions/SalesItemizerResponse" } } }, "x-internal-id":"config-sim-v1-setup-salesitemizers-post", "x-filename-id":"config-sim-v1-setup-salesitemizers-post" } }, "/config/sim/v2/setup/salesItemizers":{ "post":{ "tags":[ "v2/Setup/Sales Itemizers" ], "summary":"Add Sales Itemizers", "description":"Add Sales Itemizers", "operationId":"addSalesItemizersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SalesItemizerCUDRequestv2" } ], "responses":{ "200":{ "description":"Sales Itemizer Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "salesItmzrIndex":{ "description":"Sequence number of sales itemizer", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-salesItemizers-post", "x-filename-id":"config-sim-v2-setup-salesitemizers-post" } }, "/config/sim/v1/setup/deletesalesitemizers":{ "post":{ "tags":[ "v1/Setup/Sales Itemizers" ], "summary":"Delete Sales Itemizers", "description":"Delete Sales Itemizers", "operationId":"deleteSalesItemizers", "parameters":[ { "$ref":"#/parameters/body.SalesItemizerDeleteRequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-setup-deletesalesitemizers-post", "x-filename-id":"config-sim-v1-setup-deletesalesitemizers-post" } }, "/config/sim/v2/setup/deleteSalesItemizers":{ "post":{ "tags":[ "v2/Setup/Sales Itemizers" ], "summary":"Delete Sales Itemizers", "description":"Delete Sales Itemizers", "operationId":"deleteSalesItemizersv2", "parameters":[ { "$ref":"#/parameters/body.SalesItemizerDeleteRequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteSalesItemizers-post", "x-filename-id":"config-sim-v2-setup-deletesalesitemizers-post" } }, "/config/sim/v1/setup/getsalesitemizers":{ "post":{ "tags":[ "v1/Setup/Sales Itemizers" ], "summary":"Get Sales Itemizers", "description":"Get Sales Itemizers", "operationId":"getSalesItemizers", "parameters":[ { "$ref":"#/parameters/body.SalesItemizersGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Sales Itemizers.", "schema":{ "$ref":"#/definitions/SalesItemizerGetResponsev1" } } }, "x-internal-id":"config-sim-v1-setup-getsalesitemizers-post", "x-filename-id":"config-sim-v1-setup-getsalesitemizers-post" } }, "/config/sim/v2/setup/getSalesItemizers":{ "post":{ "tags":[ "v2/Setup/Sales Itemizers" ], "summary":"Get Sales Itemizers", "description":"Get Sales Itemizers", "operationId":"getSalesItemizersv2", "parameters":[ { "$ref":"#/parameters/body.SalesItemizersGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Sales Itemizers.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Sales Itemizer objects of the organization.", "items":{ "$ref":"#/definitions/SalesItemizerv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getSalesItemizers-post", "x-filename-id":"config-sim-v2-setup-getsalesitemizers-post" } }, "/config/sim/v1/setup/updatesalesitemizers":{ "post":{ "tags":[ "v1/Setup/Sales Itemizers" ], "summary":"Update Sales Itemizers", "description":"Update Sales Itemizers", "operationId":"updateSalesItemizers", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SalesItemizerCUDRequest" } ], "responses":{ "200":{ "description":"Sales Itemizer Updated or Added.", "schema":{ "$ref":"#/definitions/SalesItemizerResponse" } } }, "x-internal-id":"config-sim-v1-setup-updatesalesitemizers-post", "x-filename-id":"config-sim-v1-setup-updatesalesitemizers-post" } }, "/config/sim/v2/setup/updateSalesItemizers":{ "post":{ "tags":[ "v2/Setup/Sales Itemizers" ], "summary":"Update Sales Itemizers", "description":"Update Sales Itemizers", "operationId":"updateSalesItemizersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SalesItemizerCUDRequestv2" } ], "responses":{ "200":{ "description":"Sales Itemizer Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "salesItmzrIndex":{ "description":"Sequence number of sales itemizer", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-updateSalesItemizers-post", "x-filename-id":"config-sim-v2-setup-updatesalesitemizers-post" } }, "/config/sim/v2/setup/getServingPeriods":{ "post":{ "tags":[ "v2/Setup/Serving Periods" ], "summary":"Get Serving Periods", "description":"Get Serving Periods", "operationId":"getServingPeriods", "parameters":[ { "$ref":"#/parameters/body.ServingPeriodsGetParameters" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "description":"Total number of records in the data set", "type":"integer", "example":100 }, "hasMore":{ "description":"Indicates whether there are additional pages of records", "type":"boolean", "example":true }, "count":{ "description":"Number of records returned on this page", "type":"integer", "example":10 }, "offset":{ "description":"The page number of this data. Starts at 0.", "type":"integer", "example":0 }, "limit":{ "description":"The maximum number of records returned on a page", "type":"integer", "example":10 }, "items":{ "description":"Serving Period records", "type":"array", "items":{ "$ref":"#/definitions/ServingPeriod" } } } } } }, "x-internal-id":"config-sim-v2-setup-getServingPeriods-post", "x-filename-id":"config-sim-v2-setup-getservingperiods-post" } }, "/config/sim/v2/setup/servingPeriods":{ "post":{ "tags":[ "v2/Setup/Serving Periods" ], "summary":"Add Serving Periods", "description":"Add Serving Periods", "operationId":"createServingPeriods", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServingPeriodCURequest" } ], "responses":{ "200":{ "description":"Insert operation executed successfully.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "objectNum":{ "description":"Object number of the serving period", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-servingPeriods-post", "x-filename-id":"config-sim-v2-setup-servingperiods-post" } }, "/config/sim/v2/setup/deleteServingPeriods":{ "post":{ "tags":[ "v2/Setup/Serving Periods" ], "summary":"Delete Serving Periods", "description":"Delete Serving Periods", "operationId":"deleteServingPeriods", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServingPeriodDeleteRequest" } ], "responses":{ "200":{ "description":"Delete operation executed successfully.", "schema":{ "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteServingPeriods-post", "x-filename-id":"config-sim-v2-setup-deleteservingperiods-post" } }, "/config/sim/v2/setup/updateServingPeriods":{ "post":{ "tags":[ "v2/Setup/Serving Periods" ], "summary":"Update Serving Periods", "description":"Update Serving Periods", "operationId":"updateServingPeriods", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServingPeriodCURequest" } ], "responses":{ "200":{ "description":"Update operation executed successfully.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "objectNum":{ "description":"Object number of the serving period", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-setup-updateServingPeriods-post", "x-filename-id":"config-sim-v2-setup-updateservingperiods-post" } }, "/config/sim/v2/menuItems/getMenuItemGroupsLite":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Groups/Menu Item Groups Lite" ], "summary":"Get Menu Item Groups Lite", "description":"Get Menu Item Groups", "operationId":"getMenuItemGroupsLite", "parameters":[ { "$ref":"#/parameters/body.MenuItemGroupsLiteGetParametersv2" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Groups", "items":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "name":{ "type":"object", "description":"A string that contains translations into multiple languages", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "groupType":{ "type":"integer", "example":1, "description":"Group Type Values
    Description Value
    Discount 1 (Default Value)
    Tax Class 2
    " }, "thresholdQty":{ "type":"integer", "example":2, "description":"Specifies the threshold quantity for applying overriden tax class " }, "taxClassObjNum":{ "type":"integer", "example":2, "description":"Specifies the tax class override. " } } } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getMenuItemGroupsLite-post", "x-filename-id":"config-sim-v2-menuitems-getmenuitemgroupslite-post" } }, "/config/sim/v2/menuItems/menuItemGroupsLite":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Groups/Menu Item Groups Lite" ], "summary":"Add Menu Item Groups Lite", "description":"Add Menu Item Groups", "operationId":"addMenuItemGroupsLite", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemGroupLiteCUDRequestv2" } ], "responses":{ "200":{ "description":"Menu Item Groups Added.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemGroupsLite-post", "x-filename-id":"config-sim-v2-menuitems-menuitemgroupslite-post" } }, "/config/sim/v2/menuItems/updateMenuItemGroupsLite":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Groups/Menu Item Groups Lite" ], "summary":"Update Menu Item Groups Lite", "description":"Update Menu Item Groups", "operationId":"updateMenuItemGroupsLite", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemGroupLiteCUDRequestv2" } ], "responses":{ "200":{ "description":"Menu Item Group Updated.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateMenuItemGroupsLite-post", "x-filename-id":"config-sim-v2-menuitems-updatemenuitemgroupslite-post" } }, "/config/sim/v2/menuItems/deleteMenuItemGroupsLite":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Groups/Menu Item Groups Lite" ], "summary":"Delete Menu Item Groups Lite", "description":"Delete Menu Item Groups", "operationId":"deleteMenuItemGroupsLite", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemGroupLiteDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteMenuItemGroupsLite-post", "x-filename-id":"config-sim-v2-menuitems-deletemenuitemgroupslite-post" } }, "/config/sim/v1/devices/getKitchenDisplayControllers":{ "post":{ "tags":[ "v1/Devices/Kitchen Display Controllers" ], "summary":"Get Kitchen Display Controllers", "description":"Gets all the KDS Controllers", "operationId":"getKDSControllers", "parameters":[ { "$ref":"#/parameters/body.KitchenDisplayControllersGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Kitchen Display Controllers.", "schema":{ "$ref":"#/definitions/KDSControllersGetResponsev1" } } }, "x-internal-id":"config-sim-v1-devices-getKitchenDisplayControllers-post", "x-filename-id":"config-sim-v1-devices-getkitchendisplaycontrollers-post" } }, "/config/sim/v2/devices/getKitchenDisplayControllers":{ "post":{ "tags":[ "v2/Devices/Kitchen Display Controllers" ], "summary":"Get Kitchen Display Controllers", "description":"Gets all the KDS Controllers", "operationId":"getKDSControllersv2", "parameters":[ { "$ref":"#/parameters/body.KitchenDisplayControllersGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Kitchen Display Controllers.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Kitchen Display Controller objects of the organization.", "items":{ "$ref":"#/definitions/KDSControllersv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-devices-getKitchenDisplayControllers-post", "x-filename-id":"config-sim-v2-devices-getkitchendisplaycontrollers-post" } }, "/config/sim/v1/devices/KitchenDisplayControllers":{ "post":{ "tags":[ "v1/Devices/Kitchen Display Controllers" ], "summary":"Add Kitchen Display Controllers", "description":"Add a KDS Controllers record for the current organization.", "operationId":"addKDSControllers", "parameters":[ { "$ref":"#/parameters/body.KDSControllerCUDRequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Kitchen Display Controller Added.", "schema":{ "$ref":"#/definitions/KDSController" } } }, "x-internal-id":"config-sim-v1-devices-KitchenDisplayControllers-post", "x-filename-id":"config-sim-v1-devices-kitchendisplaycontrollers-post" } }, "/config/sim/v2/devices/kitchenDisplayControllers":{ "post":{ "tags":[ "v2/Devices/Kitchen Display Controllers" ], "summary":"Add Kitchen Display Controllers", "description":"Add a KDS Controllers record for the current organization.", "operationId":"addKDSControllersv2", "parameters":[ { "$ref":"#/parameters/body.KDSControllerCUDRequestv2" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Kitchen Display Controller Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the KDS Controller", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-devices-kitchenDisplayControllers-post", "x-filename-id":"config-sim-v2-devices-kitchendisplaycontrollers-post" } }, "/config/sim/v1/devices/updateKitchenDisplayControllers":{ "post":{ "tags":[ "v1/Devices/Kitchen Display Controllers" ], "summary":"Update Kitchen Display Controllers", "description":"Updates a KDS Controllers record for the current organization.", "operationId":"updateKDSControllers", "parameters":[ { "$ref":"#/parameters/body.KDSControllerCUDRequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Kitchen Display Controller updated.", "schema":{ "$ref":"#/definitions/KDSController" } } }, "x-internal-id":"config-sim-v1-devices-updateKitchenDisplayControllers-post", "x-filename-id":"config-sim-v1-devices-updatekitchendisplaycontrollers-post" } }, "/config/sim/v2/devices/updateKitchenDisplayControllers":{ "post":{ "tags":[ "v2/Devices/Kitchen Display Controllers" ], "summary":"Update Kitchen Display Controllers", "description":"Updates a KDS Controllers record for the current organization.", "operationId":"updateKDSControllersv2", "parameters":[ { "$ref":"#/parameters/body.KDSControllerCUDRequestv2" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Kitchen Display Controller updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Kitchen Display Controller", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-devices-updateKitchenDisplayControllers-post", "x-filename-id":"config-sim-v2-devices-updatekitchendisplaycontrollers-post" } }, "/config/sim/v1/devices/deleteKitchenDisplayControllers":{ "post":{ "tags":[ "v1/Devices/Kitchen Display Controllers" ], "summary":"Delete Kitchen Display Controllers", "description":"Deletes the KDS Controllers object.", "operationId":"deleteKDSControllers", "parameters":[ { "$ref":"#/parameters/body.KDSController" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-devices-deleteKitchenDisplayControllers-post", "x-filename-id":"config-sim-v1-devices-deletekitchendisplaycontrollers-post" } }, "/config/sim/v2/devices/deleteKitchenDisplayControllers":{ "post":{ "tags":[ "v2/Devices/Kitchen Display Controllers" ], "summary":"Delete Kitchen Display Controllers", "description":"Deletes the KDS Controllers object.", "operationId":"deleteKDSControllersv2", "parameters":[ { "$ref":"#/parameters/body.KDSController" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-devices-deleteKitchenDisplayControllers-post", "x-filename-id":"config-sim-v2-devices-deletekitchendisplaycontrollers-post" } }, "/config/sim/v2/employees/getSystemEmployeeProperties":{ "post":{ "tags":[ "v2/Employees/System Employee Properties" ], "summary":"Get System Employee Properties", "description":"Gets all System Employee Properties", "operationId":"getSystemEmployeeProperties", "parameters":[ { "$ref":"#/parameters/body.SystemEmployeePropertiesGetParameters" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "description":"Total number of records in the data set", "type":"integer", "example":100 }, "hasMore":{ "description":"Indicates whether there are additional pages of records", "type":"boolean", "example":true }, "count":{ "description":"Number of records returned on this page", "type":"integer", "example":10 }, "offset":{ "description":"The page number of this data. Starts at 0.", "type":"integer", "example":0 }, "limit":{ "description":"The maximum number of records returned on a page", "type":"integer", "example":10 }, "items":{ "description":"System employee property records", "type":"array", "items":{ "$ref":"#/definitions/SystemEmployeeProperty" } } } } } }, "x-internal-id":"config-sim-v2-employees-getSystemEmployeeProperties-post", "x-filename-id":"config-sim-v2-employees-getsystememployeeproperties-post" } }, "/config/sim/v2/employees/systemEmployeeProperties":{ "post":{ "tags":[ "v2/Employees/System Employee Properties" ], "summary":"Add System Employee Properties", "description":"Assigns a System Employee Property", "operationId":"createSystemEmployeeProperties", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SystemEmployeePropertyCURequest" } ], "responses":{ "200":{ "description":"Insert operation executed successfully.", "schema":{ "type":"object", "properties":{ "objectNum":{ "description":"Object number of the system employee", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Hierarchy unit value of the associated property", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-employees-systemEmployeeProperties-post", "x-filename-id":"config-sim-v2-employees-systememployeeproperties-post" } }, "/config/sim/v2/employees/deleteSystemEmployeeProperties":{ "post":{ "tags":[ "v2/Employees/System Employee Properties" ], "summary":"Delete System Employee Properties", "description":"Unassigns a System Employee Property", "operationId":"deleteSystemEmployeeProperties", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SystemEmployeePropertyDeleteRequest" } ], "responses":{ "200":{ "description":"Delete operation executed successfully.", "schema":{ "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-employees-deleteSystemEmployeeProperties-post", "x-filename-id":"config-sim-v2-employees-deletesystememployeeproperties-post" } }, "/config/sim/v2/employees/updateSystemEmployeeProperties":{ "post":{ "tags":[ "v2/Employees/System Employee Properties" ], "summary":"Update System Employee Properties", "description":"Updates a System Employee Property", "operationId":"updateSystemEmployeeProperties", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SystemEmployeePropertyCURequest" } ], "responses":{ "200":{ "description":"Update operation executed successfully.", "schema":{ "type":"object", "properties":{ "objectNum":{ "description":"Object number of the system employee", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Hierarchy unit value of the associated property", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-employees-updateSystemEmployeeProperties-post", "x-filename-id":"config-sim-v2-employees-updatesystememployeeproperties-post" } }, "/config/sim/v1/setup/getordertypenames":{ "post":{ "tags":[ "v1/Setup/Order Types/Order Type Names" ], "summary":"Get Order Types", "description":"Gets all the Order Types", "operationId":"getOrderTypes", "parameters":[ { "$ref":"#/parameters/body.OrderTypesNamesGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Order Type Names.", "schema":{ "$ref":"#/definitions/OrderTypeGetResponse" } } }, "x-internal-id":"config-sim-v1-setup-getordertypenames-post", "x-filename-id":"config-sim-v1-setup-getordertypenames-post" } }, "/config/sim/v2/setup/getOrderTypeNames":{ "post":{ "tags":[ "v2/Setup/Order Types/Order Type Names" ], "summary":"Get Order Types", "description":"Gets all the Order Types", "operationId":"getOrderTypesv2", "parameters":[ { "$ref":"#/parameters/body.OrderTypesNamesGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Order Type Names.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Order Type objects of the organization.", "items":{ "$ref":"#/definitions/OrderTypev2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getOrderTypeNames-post", "x-filename-id":"config-sim-v2-setup-getordertypenames-post" } }, "/config/sim/v1/setup/ordertypenames":{ "post":{ "tags":[ "v1/Setup/Order Types/Order Type Names" ], "summary":"Add Order Types", "description":"

    Adds the Order Type Name

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5\n Starting from Simphony version 19.8, Add Order Types API will no longer be available.\n
    \n", "operationId":"addOrderTypes", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderTypeCUDRequest" } ], "responses":{ "200":{ "description":"Order Type Name Added.", "schema":{ "$ref":"#/definitions/OrderTypeResponse" } } }, "x-internal-id":"config-sim-v1-setup-ordertypenames-post", "x-filename-id":"config-sim-v1-setup-ordertypenames-post" } }, "/config/sim/v2/setup/orderTypeNames":{ "post":{ "tags":[ "v2/Setup/Order Types/Order Type Names" ], "summary":"Add Order Types", "description":"

    Adds the Order Type Name

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5\n Starting from Simphony version 19.8, Add Order Types API will no longer be available.\n
    \n", "operationId":"addOrderTypesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderTypeCUDRequestv2" } ], "responses":{ "200":{ "description":"Order Type Name Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "lineNum":{ "type":"integer", "example":1, "description":"Unique reference of the Order Type" } } } } }, "x-internal-id":"config-sim-v2-setup-orderTypeNames-post", "x-filename-id":"config-sim-v2-setup-ordertypenames-post" } }, "/config/sim/v1/setup/updateordertypenames":{ "post":{ "tags":[ "v1/Setup/Order Types/Order Type Names" ], "summary":"Update Order Types", "description":"

    Updates the Order Type. If Order Type is not found, it creates a new Order Type

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5\n Starting from Simphony version 19.8, Update Order Types API will no longer add records.\n
    \n", "operationId":"updateOrderTypes", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderTypeCUDRequest" } ], "responses":{ "200":{ "description":"Order Type Name Updated or Added.", "schema":{ "$ref":"#/definitions/OrderTypeResponse" } } }, "x-internal-id":"config-sim-v1-setup-updateordertypenames-post", "x-filename-id":"config-sim-v1-setup-updateordertypenames-post" } }, "/config/sim/v2/setup/updateOrderTypeNames":{ "post":{ "tags":[ "v2/Setup/Order Types/Order Type Names" ], "summary":"Update Order Types", "description":"

    Updates the Order Type.

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.5\n Starting from Simphony version 19.8, Update Order Types API will no longer add records.\n
    \n", "operationId":"updateOrderTypesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderTypeCUDRequestv2" } ], "responses":{ "200":{ "description":"Order Type Name Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "lineNum":{ "type":"integer", "example":1, "description":"Unique reference of the Order Type" } } } } }, "x-internal-id":"config-sim-v2-setup-updateOrderTypeNames-post", "x-filename-id":"config-sim-v2-setup-updateordertypenames-post" } }, "/config/sim/v1/setup/deleteordertypenames":{ "post":{ "tags":[ "v1/Setup/Order Types/Order Type Names" ], "summary":"Delete Order Types", "description":"Deletes the Order Type object.", "operationId":"deleteOrderTypes", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderTypeDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/OrderTypeDeleteResponse" } } }, "x-internal-id":"config-sim-v1-setup-deleteordertypenames-post", "x-filename-id":"config-sim-v1-setup-deleteordertypenames-post" } }, "/config/sim/v2/setup/deleteOrderTypeNames":{ "post":{ "tags":[ "v2/Setup/Order Types/Order Type Names" ], "summary":"Delete Order Types", "description":"Deletes the Order Type object.", "operationId":"deleteOrderTypesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.OrderTypeDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteOrderTypeNames-post", "x-filename-id":"config-sim-v2-setup-deleteordertypenames-post" } }, "/config/sim/v1/sales/getservicechargegroups":{ "post":{ "tags":[ "v1/Sales/Service Charge Groups/Service Charge Groups" ], "summary":"Get Service Charge Groups", "description":"Gets a list of all the Service Charge Groups", "operationId":"getServiceChargeGroups", "parameters":[ { "$ref":"#/parameters/body.ServiceChargeGroupsGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Service Charge Groups.", "schema":{ "$ref":"#/definitions/ServiceChargeGroupGetResponsev1" } } }, "x-internal-id":"config-sim-v1-sales-getservicechargegroups-post", "x-filename-id":"config-sim-v1-sales-getservicechargegroups-post" } }, "/config/sim/v2/sales/getServiceChargeGroups":{ "post":{ "tags":[ "v2/Sales/Service Charge Groups/Service Charge Groups" ], "summary":"Get Service Charge Groups", "description":"Gets a list of all the Service Charge Groups", "operationId":"getServiceChargeGroupsv2", "parameters":[ { "$ref":"#/parameters/body.ServiceChargeGroupsGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Service Charge Groups.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Service Charge Group objects of the organization.", "items":{ "$ref":"#/definitions/ServiceChargeGroupv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-sales-getServiceChargeGroups-post", "x-filename-id":"config-sim-v2-sales-getservicechargegroups-post" } }, "/config/sim/v1/sales/servicechargegroups":{ "post":{ "tags":[ "v1/Sales/Service Charge Groups/Service Charge Groups" ], "summary":"Add Service Charge Groups", "description":"Adds the Service Charge Group", "operationId":"addServiceChargeGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeGroupCURequestBody" } ], "responses":{ "200":{ "description":"Service Charge Group Added.", "schema":{ "$ref":"#/definitions/ServiceChargeGroupResponse" } } }, "x-internal-id":"config-sim-v1-sales-servicechargegroups-post", "x-filename-id":"config-sim-v1-sales-servicechargegroups-post" } }, "/config/sim/v2/sales/serviceChargeGroups":{ "post":{ "tags":[ "v2/Sales/Service Charge Groups/Service Charge Groups" ], "summary":"Add Service Charge Groups", "description":"Adds the Service Charge Group", "operationId":"addServiceChargeGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeGroupCURequestBodyv2" } ], "responses":{ "200":{ "description":"Service Charge Group Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-serviceChargeGroups-post", "x-filename-id":"config-sim-v2-sales-servicechargegroups-post" } }, "/config/sim/v1/sales/updateservicechargegroups":{ "post":{ "tags":[ "v1/Sales/Service Charge Groups/Service Charge Groups" ], "summary":"Update Service Charge Groups", "description":"Updates the Service Charge Group. If Service Charge Group is not found, it creates a new Service Charge Group.", "operationId":"updateServiceChargeGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeGroupCURequestBody" } ], "responses":{ "200":{ "description":"Service Charge Group Updated or Added.", "schema":{ "$ref":"#/definitions/ServiceChargeGroupResponse" } } }, "x-internal-id":"config-sim-v1-sales-updateservicechargegroups-post", "x-filename-id":"config-sim-v1-sales-updateservicechargegroups-post" } }, "/config/sim/v2/sales/updateServiceChargeGroups":{ "post":{ "tags":[ "v2/Sales/Service Charge Groups/Service Charge Groups" ], "summary":"Update Service Charge Groups", "description":"Updates the Service Charge Group.", "operationId":"updateServiceChargeGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeGroupCURequestBodyv2" } ], "responses":{ "200":{ "description":"Service Charge Group Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-updateServiceChargeGroups-post", "x-filename-id":"config-sim-v2-sales-updateservicechargegroups-post" } }, "/config/sim/v1/sales/deleteservicechargegroups":{ "post":{ "tags":[ "v1/Sales/Service Charge Groups/Service Charge Groups" ], "summary":"Delete Service Charge Groups", "description":"Deletes the Service Charge Group", "operationId":"deleteServiceChargeGroups", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeGroupDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-sales-deleteservicechargegroups-post", "x-filename-id":"config-sim-v1-sales-deleteservicechargegroups-post" } }, "/config/sim/v2/sales/deleteServiceChargeGroups":{ "post":{ "tags":[ "v2/Sales/Service Charge Groups/Service Charge Groups" ], "summary":"Delete Service Charge Groups", "description":"Deletes the Service Charge Group", "operationId":"deleteServiceChargeGroupsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeGroupDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-sales-deleteServiceChargeGroups-post", "x-filename-id":"config-sim-v2-sales-deleteservicechargegroups-post" } }, "/config/sim/v1/sales/getServicecharges":{ "post":{ "tags":[ "v1/Sales/Service Charges" ], "summary":"Get Service Charges", "description":"Gets all the Service Charge configured", "operationId":"getServiceCharges", "parameters":[ { "$ref":"#/parameters/body.ServiceChargesGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Service Charge entities.", "schema":{ "$ref":"#/definitions/ServiceChargeGetResponsev1" } } }, "x-internal-id":"config-sim-v1-sales-getServicecharges-post", "x-filename-id":"config-sim-v1-sales-getservicecharges-post" } }, "/config/sim/v2/sales/getServiceCharges":{ "post":{ "tags":[ "v2/Sales/Service Charges" ], "summary":"Get Service Charges", "description":"Gets all the Service Charge configured", "operationId":"getServiceChargesv2", "parameters":[ { "$ref":"#/parameters/body.ServiceChargesGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Service Charge entities.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of service charge objects of the organization.", "items":{ "$ref":"#/definitions/ServiceChargev2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-sales-getServiceCharges-post", "x-filename-id":"config-sim-v2-sales-getservicecharges-post" } }, "/config/sim/v1/sales/serviceCharges":{ "post":{ "tags":[ "v1/Sales/Service Charges" ], "summary":"Add Service Charges", "description":"Add the Service Charge object to a specified hierarchy unit .", "operationId":"addServiceCharges", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeCURequestBody" } ], "responses":{ "200":{ "description":"Service Charge entity Added.", "schema":{ "$ref":"#/definitions/ServiceChargeAddUpdateResponse" } } }, "x-internal-id":"config-sim-v1-sales-serviceCharges-post", "x-filename-id":"config-sim-v1-sales-servicecharges-post" } }, "/config/sim/v2/sales/serviceCharges":{ "post":{ "tags":[ "v2/Sales/Service Charges" ], "summary":"Add Service Charges", "description":"Add the Service Charge object to a specified hierarchy unit .", "operationId":"addServiceChargesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeCURequestBodyv2" } ], "responses":{ "200":{ "description":"Service Charge entity Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"Object number of the Effectivity Group for the current record", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-serviceCharges-post", "x-filename-id":"config-sim-v2-sales-servicecharges-post" } }, "/config/sim/v1/sales/updateServicecharges":{ "post":{ "tags":[ "v1/Sales/Service Charges" ], "summary":"Update Service Charges", "description":"Updates the Service Charge. If Service Charge is not found, it creates a new Service Charge.", "operationId":"updateServiceCharges", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeCURequestBody" } ], "responses":{ "200":{ "description":"Service Charge entity Updated or Added.", "schema":{ "$ref":"#/definitions/ServiceChargeAddUpdateResponse" } } }, "x-internal-id":"config-sim-v1-sales-updateServicecharges-post", "x-filename-id":"config-sim-v1-sales-updateservicecharges-post" } }, "/config/sim/v2/sales/updateServiceCharges":{ "post":{ "tags":[ "v2/Sales/Service Charges" ], "summary":"Update Service Charges", "description":"Updates the Service Charge.", "operationId":"updateServiceChargesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeCURequestBodyv2" } ], "responses":{ "200":{ "description":"Service Charge entity Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"Object number of the Effectivity Group for the current record", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-updateServiceCharges-post", "x-filename-id":"config-sim-v2-sales-updateservicecharges-post" } }, "/config/sim/v1/sales/deleteServicecharges":{ "post":{ "tags":[ "v1/Sales/Service Charges" ], "summary":"Delete Service Charges", "description":"Deletes the Service Charge object.", "operationId":"deleteServiceCharges", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-sales-deleteServicecharges-post", "x-filename-id":"config-sim-v1-sales-deleteservicecharges-post" } }, "/config/sim/v2/sales/deleteServiceCharges":{ "post":{ "tags":[ "v2/Sales/Service Charges" ], "summary":"Delete Service Charges", "description":"Deletes the Service Charge object.", "operationId":"deleteServiceChargesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-sales-deleteServiceCharges-post", "x-filename-id":"config-sim-v2-sales-deleteservicecharges-post" } }, "/config/sim/v1/sales/servicechargegroups/getdetails":{ "post":{ "tags":[ "v1/Sales/Service Charge Groups/Service Charge Group Details" ], "summary":"Get Service Charge Group Details", "description":"Gets a list of all the Service Charge Group Detail for the specified Service Charge Group", "operationId":"getServiceChargeGroupDetails", "parameters":[ { "$ref":"#/parameters/body.ServiceChargeGroupDetailsGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Service Charge Group Details.", "schema":{ "$ref":"#/definitions/ServiceChargeGroupDetailGetResponsev1" } } }, "x-internal-id":"config-sim-v1-sales-servicechargegroups-getdetails-post", "x-filename-id":"config-sim-v1-sales-servicechargegroups-getdetails-post" } }, "/config/sim/v2/sales/serviceChargeGroups/getDetails":{ "post":{ "tags":[ "v2/Sales/Service Charge Groups/Service Charge Group Details" ], "summary":"Get Service Charge Group Details", "description":"Gets a list of all the Service Charge Group Detail for the specified Service Charge Group", "operationId":"getServiceChargeGroupDetailsv2", "parameters":[ { "$ref":"#/parameters/body.ServiceChargeGroupDetailsGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Service Charge Group Details.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Service Charge Group Detail objects of the organization.", "items":{ "$ref":"#/definitions/ServiceChargeGroupDetailv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-sales-serviceChargeGroups-getDetails-post", "x-filename-id":"config-sim-v2-sales-servicechargegroups-getdetails-post" } }, "/config/sim/v1/sales/servicechargegroups/details":{ "post":{ "tags":[ "v1/Sales/Service Charge Groups/Service Charge Group Details" ], "summary":"Add Service Charge Group Details", "description":"Add the Service Charge Group Detail object to a service charge group unit", "operationId":"addServiceChargeGroupDetails", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeGroupDetailCreateRequestBody" } ], "responses":{ "200":{ "description":"Service Charge Group Detail Added.", "schema":{ "$ref":"#/definitions/ServiceChargeGroupDetailResponse" } } }, "x-internal-id":"config-sim-v1-sales-servicechargegroups-details-post", "x-filename-id":"config-sim-v1-sales-servicechargegroups-details-post" } }, "/config/sim/v2/sales/serviceChargeGroups/details":{ "post":{ "tags":[ "v2/Sales/Service Charge Groups/Service Charge Group Details" ], "summary":"Add Service Charge Group Details", "description":"Add the Service Charge Group Detail object to a service charge group unit", "operationId":"addServiceChargeGroupDetailsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeGroupDetailCreateRequestBody" } ], "responses":{ "200":{ "description":"Service Charge Group Detail Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence number of the service charge group detail in the service charge group", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-serviceChargeGroups-details-post", "x-filename-id":"config-sim-v2-sales-servicechargegroups-details-post" } }, "/config/sim/v1/sales/servicechargegroups/updatedetails":{ "post":{ "tags":[ "v1/Sales/Service Charge Groups/Service Charge Group Details" ], "summary":"Update Service Charge Group Details", "description":"Updates the Service Charge Group Detail. If Service Charge Group Detail is not found, it creates a new Service Charge Group Detail.", "operationId":"updateServiceChargeGroupDetails", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeGroupDetailUpdateRequestBody" } ], "responses":{ "200":{ "description":"Service Charge Group Detail Updated or Added.", "schema":{ "$ref":"#/definitions/ServiceChargeGroupDetailResponse" } } }, "x-internal-id":"config-sim-v1-sales-servicechargegroups-updatedetails-post", "x-filename-id":"config-sim-v1-sales-servicechargegroups-updatedetails-post" } }, "/config/sim/v2/sales/serviceChargeGroups/updateDetails":{ "post":{ "tags":[ "v2/Sales/Service Charge Groups/Service Charge Group Details" ], "summary":"Update Service Charge Group Details", "description":"Updates the Service Charge Group Detail.", "operationId":"updateServiceChargeGroupDetailsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeGroupDetailUpdateRequestBodyv2" } ], "responses":{ "200":{ "description":"Service Charge Group Detail Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence number of the service charge group detail in the service charge group", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-serviceChargeGroups-updateDetails-post", "x-filename-id":"config-sim-v2-sales-servicechargegroups-updatedetails-post" } }, "/config/sim/v1/sales/servicechargegroups/deletedetails":{ "post":{ "tags":[ "v1/Sales/Service Charge Groups/Service Charge Group Details" ], "summary":"Delete Service Charge Group Details", "description":"Deletes the Service Charge Group Detail object from a Service Charge Group.", "operationId":"deleteServiceChargeGroupDetails", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeGroupDetailDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-sales-servicechargegroups-deletedetails-post", "x-filename-id":"config-sim-v1-sales-servicechargegroups-deletedetails-post" } }, "/config/sim/v2/sales/serviceChargeGroups/deleteDetails":{ "post":{ "tags":[ "v2/Sales/Service Charge Groups/Service Charge Group Details" ], "summary":"Delete Service Charge Group Details", "description":"Deletes the Service Charge Group Detail object from a Service Charge Group.", "operationId":"deleteServiceChargeGroupDetailsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ServiceChargeGroupDetailDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-sales-serviceChargeGroups-deleteDetails-post", "x-filename-id":"config-sim-v2-sales-servicechargegroups-deletedetails-post" } }, "/config/sim/v1/setup/cal/getDeploymentSchedules":{ "post":{ "tags":[ "v1/Setup/CAL/CAL Deployment Schedules" ], "summary":"Get CAL Deployment Schedules", "description":"Gets all the CAL Deployment Schedules configured", "operationId":"getDeploymentSchedules", "parameters":[ { "$ref":"#/parameters/body.CALDeploymentSchedulesGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of CAL Deployment Schedules", "schema":{ "$ref":"#/definitions/DeploymentScheduleGetResponsev1" } } }, "x-internal-id":"config-sim-v1-setup-cal-getDeploymentSchedules-post", "x-filename-id":"config-sim-v1-setup-cal-getdeploymentschedules-post" } }, "/config/sim/v2/setup/cal/getDeploymentSchedules":{ "post":{ "tags":[ "v2/Setup/CAL/CAL Deployment Schedules" ], "summary":"Get CAL Deployment Schedules", "description":"Gets all the CAL Deployment Schedules configured", "operationId":"getDeploymentSchedulesv2", "parameters":[ { "$ref":"#/parameters/body.CALDeploymentSchedulesGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of CAL Deployment Schedules", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Deployment Schedule objects of the organization.", "items":{ "$ref":"#/definitions/CALDeploymentSchedulev2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-cal-getDeploymentSchedules-post", "x-filename-id":"config-sim-v2-setup-cal-getdeploymentschedules-post" } }, "/config/sim/v1/setup/cal/deploymentSchedules":{ "post":{ "tags":[ "v1/Setup/CAL/CAL Deployment Schedules" ], "summary":"Add CAL Deployment Schedules", "description":"Add a CAL Deployment Schedule to a specified organization", "operationId":"addDeploymentSchedules", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.InsertDeploymentSchedule" } ], "responses":{ "200":{ "description":"CAL Deployment Schedule Added.", "schema":{ "$ref":"#/definitions/ResponseObjectDeploymentSchedule" } } }, "x-internal-id":"config-sim-v1-setup-cal-deploymentSchedules-post", "x-filename-id":"config-sim-v1-setup-cal-deploymentschedules-post" } }, "/config/sim/v2/setup/cal/deploymentSchedules":{ "post":{ "tags":[ "v2/Setup/CAL/CAL Deployment Schedules" ], "summary":"Add CAL Deployment Schedules", "description":"Add a CAL Deployment Schedule to a specified organization", "operationId":"addDeploymentSchedulesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.InsertDeploymentSchedule" } ], "responses":{ "200":{ "description":"CAL Deployment Schedule Added.", "schema":{ "type":"object", "properties":{ "deploymentId":{ "description":"Unique reference of the CAL deployment schedule.", "type":"integer", "example":111 } } } } }, "x-internal-id":"config-sim-v2-setup-cal-deploymentSchedules-post", "x-filename-id":"config-sim-v2-setup-cal-deploymentschedules-post" } }, "/config/sim/v1/setup/cal/updateDeploymentSchedules":{ "post":{ "tags":[ "v1/Setup/CAL/CAL Deployment Schedules" ], "summary":"Update CAL Deployment Schedules", "description":"Updates the CAL Deployment Schedule. If Deployment Schedule is not found, it creates a new Deployment Schedule", "operationId":"updateDeploymentSchedules", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.UpdateDeploymentSchedule" } ], "responses":{ "200":{ "description":"CAL Deployment Schedule Updated or Added.", "schema":{ "$ref":"#/definitions/ResponseObjectDeploymentSchedule" } } }, "x-internal-id":"config-sim-v1-setup-cal-updateDeploymentSchedules-post", "x-filename-id":"config-sim-v1-setup-cal-updatedeploymentschedules-post" } }, "/config/sim/v2/setup/cal/updateDeploymentSchedules":{ "post":{ "tags":[ "v2/Setup/CAL/CAL Deployment Schedules" ], "summary":"Update CAL Deployment Schedules", "description":"Updates the CAL Deployment Schedule.", "operationId":"updateDeploymentSchedulesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.UpdateDeploymentSchedulev2" } ], "responses":{ "200":{ "description":"CAL Deployment Schedule Updated.", "schema":{ "type":"object", "properties":{ "deploymentId":{ "description":"Unique reference of the CAL deployment schedule.", "type":"integer", "example":111 } } } } }, "x-internal-id":"config-sim-v2-setup-cal-updateDeploymentSchedules-post", "x-filename-id":"config-sim-v2-setup-cal-updatedeploymentschedules-post" } }, "/config/sim/v1/setup/cal/deleteDeploymentSchedules":{ "post":{ "tags":[ "v1/Setup/CAL/CAL Deployment Schedules" ], "summary":"Delete CAL Deployment Schedules", "description":"Deletes the Deployment Schedule object.", "operationId":"deleteDeploymentSchedules", "parameters":[ { "$ref":"#/parameters/body.DeleteDeploymentSchedule" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-setup-cal-deleteDeploymentSchedules-post", "x-filename-id":"config-sim-v1-setup-cal-deletedeploymentschedules-post" } }, "/config/sim/v2/setup/cal/deleteDeploymentSchedules":{ "post":{ "tags":[ "v2/Setup/CAL/CAL Deployment Schedules" ], "summary":"Delete CAL Deployment Schedules", "description":"Deletes the Deployment Schedule object.", "operationId":"deleteDeploymentSchedulesv2", "parameters":[ { "$ref":"#/parameters/body.DeleteDeploymentSchedule" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-cal-deleteDeploymentSchedules-post", "x-filename-id":"config-sim-v2-setup-cal-deletedeploymentschedules-post" } }, "/config/sim/v1/sales/getdiscountitemizers":{ "post":{ "tags":[ "v1/Sales/Discount Itemizers" ], "summary":"Get Discount Itemizers", "description":"Gets all the Discount Itemizers configured", "operationId":"getDiscountItemizers", "parameters":[ { "$ref":"#/parameters/body.DiscountItemizersGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Discount Itemizers.", "schema":{ "$ref":"#/definitions/DiscountItemizersGetResponsev1" } } }, "x-internal-id":"config-sim-v1-sales-getdiscountitemizers-post", "x-filename-id":"config-sim-v1-sales-getdiscountitemizers-post" } }, "/config/sim/v2/sales/getDiscountItemizers":{ "post":{ "tags":[ "v2/Sales/Discount Itemizers" ], "summary":"Get Discount Itemizers", "description":"Gets all the Discount Itemizers configured", "operationId":"getDiscountItemizersv2", "parameters":[ { "$ref":"#/parameters/body.DiscountItemizersGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Discount Itemizers.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Discount Itemizer objects of the organization.", "items":{ "$ref":"#/definitions/DiscountItemizerv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-sales-getDiscountItemizers-post", "x-filename-id":"config-sim-v2-sales-getdiscountitemizers-post" } }, "/config/sim/v1/sales/discountitemizers":{ "post":{ "tags":[ "v1/Sales/Discount Itemizers" ], "summary":"Add Discount Itemizers", "description":"Add the Discount itemizer object to a specified hierarchy unit .", "operationId":"addDiscountItemizers", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountItmzrsCURequestBody" } ], "responses":{ "200":{ "description":"Discount Itemizer Added.", "schema":{ "$ref":"#/definitions/DiscountItemzrsResponse" } } }, "x-internal-id":"config-sim-v1-sales-discountitemizers-post", "x-filename-id":"config-sim-v1-sales-discountitemizers-post" } }, "/config/sim/v2/sales/discountItemizers":{ "post":{ "tags":[ "v2/Sales/Discount Itemizers" ], "summary":"Add Discount Itemizers", "description":"Add the Discount itemizer object to a specified hierarchy unit .", "operationId":"addDiscountItemizersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountItmzrsCURequestBodyv2" } ], "responses":{ "200":{ "description":"Discount Itemizer Added.", "schema":{ "type":"object", "properties":{ "dscItmzrIndex":{ "description":"Unique reference of the Discount Itemizer", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique Hierarchy Unit Value", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-discountItemizers-post", "x-filename-id":"config-sim-v2-sales-discountitemizers-post" } }, "/config/sim/v1/sales/updatediscountitemizers":{ "post":{ "tags":[ "v1/Sales/Discount Itemizers" ], "summary":"Update Discount Itemizers", "description":"Updates the Discount Itemizer. If Discount Itemizer is not found, it creates a new Discount Itemizer", "operationId":"updateDiscountItemizers", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountItmzrsCURequestBody" } ], "responses":{ "200":{ "description":"Discount Itemizer Updated or Added.", "schema":{ "$ref":"#/definitions/DiscountItemzrsResponse" } } }, "x-internal-id":"config-sim-v1-sales-updatediscountitemizers-post", "x-filename-id":"config-sim-v1-sales-updatediscountitemizers-post" } }, "/config/sim/v2/sales/updateDiscountItemizers":{ "post":{ "tags":[ "v2/Sales/Discount Itemizers" ], "summary":"Update Discount Itemizers", "description":"Updates the Discount Itemizer.", "operationId":"updateDiscountItemizersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountItmzrsCURequestBodyv2" } ], "responses":{ "200":{ "description":"Discount Itemizer Updated.", "schema":{ "type":"object", "properties":{ "dscItmzrIndex":{ "description":"Unique reference of the Discount Itemizer", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique Hierarchy Unit Value", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-sales-updateDiscountItemizers-post", "x-filename-id":"config-sim-v2-sales-updatediscountitemizers-post" } }, "/config/sim/v1/sales/deletediscountitemizers":{ "post":{ "tags":[ "v1/Sales/Discount Itemizers" ], "summary":"Delete Discount Itemizers", "description":"Deletes the Discount Itmzrs object.", "operationId":"deleteDiscountItemizers", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountItemzrsResponse" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-sales-deletediscountitemizers-post", "x-filename-id":"config-sim-v1-sales-deletediscountitemizers-post" } }, "/config/sim/v2/sales/deleteDiscountItemizers":{ "post":{ "tags":[ "v2/Sales/Discount Itemizers" ], "summary":"Delete Discount Itemizers", "description":"Deletes the Discount Itmzrs object.", "operationId":"deleteDiscountItemizersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiscountItemzrsResponse" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-sales-deleteDiscountItemizers-post", "x-filename-id":"config-sim-v2-sales-deletediscountitemizers-post" } }, "/config/sim/v1/hierarchy/locations/getReportingHierarchyLevels":{ "post":{ "tags":[ "v1/Hierarchy/Locations/Reporting Hierarchy Relationships" ], "summary":"Get Reporting Hierarchy Levels", "description":"Gets available reporting hierarchy levels within all reporting hierarchies.", "operationId":"getReportingHierarchyLevels", "parameters":[ { "$ref":"#/parameters/body.ReportingHierarchyLevelsGetParameters" } ], "responses":{ "200":{ "description":"A list of available reporting hierarchy levels present in the organization.", "schema":{ "$ref":"#/definitions/GetReportingHierarchyLevelsResponse" } } }, "x-internal-id":"config-sim-v1-hierarchy-locations-getReportingHierarchyLevels-post", "x-filename-id":"config-sim-v1-hierarchy-locations-getreportinghierarchylevels-post" } }, "/config/sim/v2/hierarchy/locations/getReportingHierarchyLevels":{ "post":{ "tags":[ "v2/Hierarchy/Locations/Reporting Hierarchy Relationships" ], "summary":"Get Reporting Hierarchy Levels", "description":"Gets available reporting hierarchy levels within all reporting hierarchies.", "operationId":"getReportingHierarchyLevelsv2", "parameters":[ { "$ref":"#/parameters/body.ReportingHierarchyLevelsGetParameters" } ], "responses":{ "200":{ "description":"A list of available reporting hierarchy levels present in the organization.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":1, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":false, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Available Reporting Hierarchy Levels of the organization.", "items":{ "$ref":"#/definitions/ReportingHierarchyLevels" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-locations-getReportingHierarchyLevels-post", "x-filename-id":"config-sim-v2-hierarchy-locations-getreportinghierarchylevels-post" } }, "/config/sim/v1/hierarchy/locations/getReportingHierarchyRelationships":{ "post":{ "tags":[ "v1/Hierarchy/Locations/Reporting Hierarchy Relationships" ], "summary":"Get Reporting Hierarchy Relationships", "description":"Returns details of parent enterprise levels assigned to a location within various reporting hierarchies.", "operationId":"getReportingHierarchyRelationships", "parameters":[ { "$ref":"#/parameters/body.ReportingHierarchyRelationshipsGetParameters" } ], "responses":{ "200":{ "description":"A collection of reporting hierarchy relationships for a location.", "schema":{ "$ref":"#/definitions/GetReportingHierarchyRelationshipResponse" } } }, "x-internal-id":"config-sim-v1-hierarchy-locations-getReportingHierarchyRelationships-post", "x-filename-id":"config-sim-v1-hierarchy-locations-getreportinghierarchyrelationships-post" } }, "/config/sim/v2/hierarchy/locations/getReportingHierarchyRelationships":{ "post":{ "tags":[ "v2/Hierarchy/Locations/Reporting Hierarchy Relationships" ], "summary":"Get Reporting Hierarchy Relationships", "description":"Returns details of parent enterprise levels assigned to a location within various reporting hierarchies.", "operationId":"getReportingHierarchyRelationshipsv2", "parameters":[ { "$ref":"#/parameters/body.ReportingHierarchyRelationshipsGetParameters" } ], "responses":{ "200":{ "description":"A collection of reporting hierarchy relationships for a location.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":1, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":false, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of reporting hierarchy relationships", "items":{ "$ref":"#/definitions/ReportingHierarchyRelationships" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-locations-getReportingHierarchyRelationships-post", "x-filename-id":"config-sim-v2-hierarchy-locations-getreportinghierarchyrelationships-post" } }, "/config/sim/v1/hierarchy/locations/updateReportingHierarchyRelationships":{ "post":{ "tags":[ "v1/Hierarchy/Locations/Reporting Hierarchy Relationships" ], "summary":"Update Reporting Hierarchy Relationships", "description":"Assigns, updates, or removes a parent level to a location within a reporting hierarchy.", "operationId":"updateReportingHierarchyRelationships", "parameters":[ { "$ref":"#/parameters/body.UpdateReportingHierarchyRelationshipRequest" } ], "responses":{ "200":{ "description":"Unique reference of the location", "schema":{ "$ref":"#/definitions/UpdateReportingHierarchyRelationshipResponse" } } }, "x-internal-id":"config-sim-v1-hierarchy-locations-updateReportingHierarchyRelationships-post", "x-filename-id":"config-sim-v1-hierarchy-locations-updatereportinghierarchyrelationships-post" } }, "/config/sim/v2/hierarchy/locations/updateReportingHierarchyRelationships":{ "post":{ "tags":[ "v2/Hierarchy/Locations/Reporting Hierarchy Relationships" ], "summary":"Update Reporting Hierarchy Relationships", "description":"Assigns, updates, or removes a parent level to a location within a reporting hierarchy.", "operationId":"updateReportingHierarchyRelationshipsv2", "parameters":[ { "$ref":"#/parameters/body.UpdateReportingHierarchyRelationshipRequest" } ], "responses":{ "200":{ "description":"Unique reference of the location", "schema":{ "type":"object", "properties":{ "locRef":{ "type":"string", "description":"The unique reference for the reporting location", "example":"locRef1" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-locations-updateReportingHierarchyRelationships-post", "x-filename-id":"config-sim-v2-hierarchy-locations-updatereportinghierarchyrelationships-post" } }, "/config/sim/v1/hierarchy/locations/deleteReportingHierarchyRelationships":{ "post":{ "tags":[ "v1/Hierarchy/Locations/Reporting Hierarchy Relationships" ], "summary":"Delete Reporting Hierarchy Relationships", "description":"Removes location from the given reporting hierarchy.", "operationId":"deleteReportingHierarchyRelationships", "parameters":[ { "$ref":"#/parameters/body.DeleteReportingHierarchyRelationshipRequest" } ], "responses":{ "200":{ "description":"Message indicating the location has been removed.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"Removed the location from the reporting hierarchy." } } } } }, "x-internal-id":"config-sim-v1-hierarchy-locations-deleteReportingHierarchyRelationships-post", "x-filename-id":"config-sim-v1-hierarchy-locations-deletereportinghierarchyrelationships-post" } }, "/config/sim/v2/hierarchy/locations/deleteReportingHierarchyRelationships":{ "post":{ "tags":[ "v2/Hierarchy/Locations/Reporting Hierarchy Relationships" ], "summary":"Delete Reporting Hierarchy Relationships", "description":"Removes location from the given reporting hierarchy.", "operationId":"deleteReportingHierarchyRelationshipsv2", "parameters":[ { "$ref":"#/parameters/body.DeleteReportingHierarchyRelationshipRequest" } ], "responses":{ "200":{ "description":"Message indicating the location has been removed.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"Removed the location from the reporting hierarchy." } } } } }, "x-internal-id":"config-sim-v2-hierarchy-locations-deleteReportingHierarchyRelationships-post", "x-filename-id":"config-sim-v2-hierarchy-locations-deletereportinghierarchyrelationships-post" } }, "/config/sim/v1/menuItems/getMenuItemPrices":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Prices" ], "summary":"Get Menu Item Prices", "description":"Gets all the Menu Item Prices configured and hierarchy unit", "operationId":"getMenuItemPrices", "parameters":[ { "$ref":"#/parameters/body.MenuItemPricesGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Menu Item Prices", "schema":{ "$ref":"#/definitions/menuItemPricesGetResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-getMenuItemPrices-post", "x-filename-id":"config-sim-v1-menuitems-getmenuitemprices-post" } }, "/config/sim/v2/menuItems/getMenuItemPrices":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Prices" ], "summary":"Get Menu Item Prices", "description":"Gets all the Menu Item Prices configured and hierarchy unit", "operationId":"getMenuItemPricesv2", "parameters":[ { "$ref":"#/parameters/body.MenuItemPricesGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Menu Item Prices", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Price objects.", "items":{ "$ref":"#/definitions/MenuItemPrice" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getMenuItemPrices-post", "x-filename-id":"config-sim-v2-menuitems-getmenuitemprices-post" } }, "/config/sim/v1/menuItems/menuItemPrices":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Prices" ], "summary":"Add Menu Item Prices", "description":"Add the Menu Item Price object to a specified hierarchy unit .", "operationId":"addMenuItemPrices", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.menuItemPricesInsertRequestBody" } ], "responses":{ "200":{ "description":"Menu Item Price Added", "schema":{ "$ref":"#/definitions/menuItemPricesResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-menuItemPrices-post", "x-filename-id":"config-sim-v1-menuitems-menuitemprices-post" } }, "/config/sim/v2/menuItems/menuItemPrices":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Prices" ], "summary":"Add Menu Item Prices", "description":"Add the Menu Item Price object to a specified hierarchy unit .", "operationId":"addMenuItemPricesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.menuItemPricesInsertRequestBody" } ], "responses":{ "200":{ "description":"Menu Item Price Added", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy unit unique reference" }, "menuItemDefinitionId":{ "type":"integer", "example":501, "description":"Unique menu item definition reference" }, "defSequenceNum":{ "type":"integer", "example":5, "description":"Definition sequence number" }, "priceSequenceNum":{ "type":"integer", "example":3, "description":"Price record number" }, "menuItemPriceId":{ "type":"integer", "example":1, "description":"Unique menu item price reference" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemPrices-post", "x-filename-id":"config-sim-v2-menuitems-menuitemprices-post" } }, "/config/sim/v1/menuItems/updateMenuItemPrices":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Prices" ], "summary":"Update Menu Item Prices", "description":"Updates Menu Item Prices. If Menu Item Price is not found, it creates a new Menu Item Price.", "operationId":"updateMenuItemPrices", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.menuItemPricesUpdateRequestBody" } ], "responses":{ "200":{ "description":"Menu Item Price Updated or Added.", "schema":{ "$ref":"#/definitions/menuItemPricesResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-updateMenuItemPrices-post", "x-filename-id":"config-sim-v1-menuitems-updatemenuitemprices-post" } }, "/config/sim/v2/menuItems/updateMenuItemPrices":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Prices" ], "summary":"Update Menu Item Prices", "description":"Updates Menu Item Prices", "operationId":"updateMenuItemPricesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.menuItemPricesUpdateRequestBodyv2" } ], "responses":{ "200":{ "description":"Menu Item Price Updated", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy unit unique reference" }, "menuItemDefinitionId":{ "type":"integer", "example":501, "description":"Unique menu item definition reference" }, "defSequenceNum":{ "type":"integer", "example":5, "description":"Definition sequence number" }, "priceSequenceNum":{ "type":"integer", "example":3, "description":"Price record number" }, "menuItemPriceId":{ "type":"integer", "example":1, "description":"Unique menu item price reference" } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateMenuItemPrices-post", "x-filename-id":"config-sim-v2-menuitems-updatemenuitemprices-post" } }, "/config/sim/v1/menuItems/deleteMenuItemPrices":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Prices" ], "summary":"Delete Menu Item Prices", "description":"Deletes Menu Item Prices", "operationId":"deleteMenuItemPrices", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.menuItemPricesDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/DeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-deleteMenuItemPrices-post", "x-filename-id":"config-sim-v1-menuitems-deletemenuitemprices-post" } }, "/config/sim/v2/menuItems/deleteMenuItemPrices":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Prices" ], "summary":"Deletes Menu Item Prices", "description":"Delete Menu Item Prices", "operationId":"deleteMenuItemPricesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.menuItemPricesDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteMenuItemPrices-post", "x-filename-id":"config-sim-v2-menuitems-deletemenuitemprices-post" } }, "/config/sim/v1/menuItems/bulkInsertMenuItemPrices":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Prices" ], "summary":"Bulk Insert Menu Item Prices", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertMenuItemPrices", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertMenuItemPriceRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v1-menuItems-bulkInsertMenuItemPrices-post", "x-filename-id":"config-sim-v1-menuitems-bulkinsertmenuitemprices-post" } }, "/config/sim/v2/menuItems/bulkInsertMenuItemPrices":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Prices" ], "summary":"Bulk Insert Menu Item Prices", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertMenuItemPricesv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertMenuItemPriceRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-bulkInsertMenuItemPrices-post", "x-filename-id":"config-sim-v2-menuitems-bulkinsertmenuitemprices-post" } }, "/config/sim/v2/menuItems/bulkUpdateMenuItemPrices":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Prices" ], "summary":"Bulk Update Menu Item Prices", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkUpdateMenuItemPricesv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkUpdateMenuItemPriceRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-bulkUpdateMenuItemPrices-post", "x-filename-id":"config-sim-v2-menuitems-bulkupdatemenuitemprices-post" } }, "/config/sim/v1/menuItems/getMenuItemDefinitions":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Definitions/Menu Item Definitions" ], "summary":"Get Menu Item Definitions", "description":"Gets all the Menu Item Definitions configured", "operationId":"getMenuItemDefinitions", "parameters":[ { "$ref":"#/parameters/body.MenuItemDefinitionGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of menuItemDefintions for the Hierarchy", "schema":{ "$ref":"#/definitions/MenuItemDefinitionGetResponseV1" } } }, "x-internal-id":"config-sim-v1-menuItems-getMenuItemDefinitions-post", "x-filename-id":"config-sim-v1-menuitems-getmenuitemdefinitions-post" } }, "/config/sim/v2/menuItems/getMenuItemDefinitions":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Definitions/Menu Item Definitions" ], "summary":"Get Menu Item Definitions", "description":"Gets all the Menu Item Definitions configured", "operationId":"getMenuItemDefinitionsV2", "parameters":[ { "$ref":"#/parameters/body.MenuItemDefinitionGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of menuItemDefintions for the Hierarchy", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Definition objects.", "items":{ "$ref":"#/definitions/MenuItemDefinitionResponseV2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getMenuItemDefinitions-post", "x-filename-id":"config-sim-v2-menuitems-getmenuitemdefinitions-post" } }, "/config/sim/v1/menuItems/menuItemDefinitions":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Definitions/Menu Item Definitions" ], "summary":"Add Menu Item Definitions", "description":"Add the Menu Item Definition object to a specified hierarchy unit .", "operationId":"addMenuItemDefinitions", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemDefintionInsertRequestBody" } ], "responses":{ "200":{ "description":"Menu Item Definition Added.", "schema":{ "$ref":"#/definitions/MenuItemDefintionResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-menuItemDefinitions-post", "x-filename-id":"config-sim-v1-menuitems-menuitemdefinitions-post" } }, "/config/sim/v2/menuItems/menuItemDefinitions":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Definitions/Menu Item Definitions" ], "summary":"Add Menu Item Definitions", "description":"Add the Menu Item Definition object to a specified hierarchy unit V2.", "operationId":"addMenuItemDefinitionsV2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemDefintionInsertRequestBodyV2" } ], "responses":{ "200":{ "description":"Menu Item Definition Added.", "schema":{ "type":"object", "properties":{ "menuItemMasterId":{ "type":"integer", "example":1, "description":"The unique reference for the Menu Item Master" }, "menuItemDefinitionId":{ "type":"integer", "example":1, "description":"The unique reference for the Menu Item Definition" }, "defSequenceNum":{ "type":"integer", "example":1, "description":"Indicates the definition sequence number, which is the number of the definition in the revenue center for this master record.Sequence Number should be with 1-64" }, "menuItemMasterObjNum":{ "type":"integer", "example":1, "description":"Menu item master object number." }, "menuItemMasterHierUnitId":{ "type":"integer", "example":1, "description":"Hierarchy location of the master the definition was added to." }, "menuItemDefitinitionHierUnitId":{ "type":"integer", "example":1, "description":"Hierarchy unit unique reference where definition was created." } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemDefinitions-post", "x-filename-id":"config-sim-v2-menuitems-menuitemdefinitions-post" } }, "/config/sim/v1/menuItems/updateMenuItemDefinitions":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Definitions/Menu Item Definitions" ], "summary":"Update Menu Item Definitions", "description":"Updates Menu Item Definition", "operationId":"updateMenuItemDefinitions", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemDefintionUpdateRequestBody" } ], "responses":{ "200":{ "description":"Menu Item Definition Updated.", "schema":{ "$ref":"#/definitions/MenuItemDefintionUpdateResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-updateMenuItemDefinitions-post", "x-filename-id":"config-sim-v1-menuitems-updatemenuitemdefinitions-post" } }, "/config/sim/v2/menuItems/updateMenuItemDefinitions":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Definitions/Menu Item Definitions" ], "summary":"Update Menu Item Definitions", "description":"Updates Menu Item Definition", "operationId":"updateMenuItemDefinitionsV2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemDefintionUpdateRequestBodyV2" } ], "responses":{ "200":{ "description":"Menu Item Definition Updated.", "schema":{ "type":"object", "properties":{ "menuItemMasterId":{ "type":"integer", "example":1, "description":"The unique reference for the Menu Item Master" }, "menuItemDefinitionId":{ "type":"integer", "example":1, "description":"The unique reference for the Menu Item Definition" }, "defSequenceNum":{ "type":"integer", "example":1, "description":"Indicates the definition sequence number, which is the number of the definition in the revenue center for this master record.Sequence Number should be with 1-64" }, "menuItemMasterObjNum":{ "type":"integer", "example":1, "description":"Menu item master object number." }, "menuItemMasterHierUnitId":{ "type":"integer", "example":1, "description":"Hierarchy location of the master the definition was added to." }, "menuItemDefitinitionHierUnitId":{ "type":"integer", "example":1, "description":"Hierarchy unit unique reference where definition was created." } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateMenuItemDefinitions-post", "x-filename-id":"config-sim-v2-menuitems-updatemenuitemdefinitions-post" } }, "/config/sim/v1/menuItems/deleteMenuItemDefinitions":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Definitions/Menu Item Definitions" ], "summary":"Delete Menu Item Definitions", "description":"Deletes a Menu Item Definition unit", "operationId":"deleteMenuItemDefinitions", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemDefintionDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/DeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-deleteMenuItemDefinitions-post", "x-filename-id":"config-sim-v1-menuitems-deletemenuitemdefinitions-post" } }, "/config/sim/v2/menuItems/deleteMenuItemDefinitions":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Definitions/Menu Item Definitions" ], "summary":"Delete Menu Item Definitions", "description":"Deletes a Menu Item Definition unit", "operationId":"deleteMenuItemDefinitionsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemDefintionDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteMenuItemDefinitions-post", "x-filename-id":"config-sim-v2-menuitems-deletemenuitemdefinitions-post" } }, "/config/sim/v1/menuItems/preDeleteCheckMenuItemDefinitions":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Definitions/Menu Item Definitions" ], "summary":"Pre-Delete Menu Item Definitions", "description":"Checks the existence of references to the object in the database.", "operationId":"preDeleteCheckMenuItemDefinitions", "parameters":[ { "in":"body", "name":"Request body", "description":"A request body", "required":true, "schema":{ "$ref":"#/definitions/menuitemdefinition_dml" } } ], "responses":{ "200":{ "description":"The values of \"response\" can either be \"Dependency exist.\" or \"Dependency does not exist.\"", "schema":{ "$ref":"#/definitions/predeletecheck_nodependency_response" } } }, "x-internal-id":"config-sim-v1-menuItems-preDeleteCheckMenuItemDefinitions-post", "x-filename-id":"config-sim-v1-menuitems-predeletecheckmenuitemdefinitions-post" } }, "/config/sim/v2/menuItems/preDeleteCheckMenuItemDefinitions":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Definitions/Menu Item Definitions" ], "summary":"Pre-Delete Menu Item Definitions", "description":"Checks the existence of references to the object in the database.", "operationId":"preDeleteCheckMenuItemDefinitionsv2", "parameters":[ { "in":"body", "name":"Request body", "description":"A request body", "required":true, "schema":{ "$ref":"#/definitions/menuitemdefinition_dml" } } ], "responses":{ "200":{ "description":"The values of \"response\" can either be \"Dependency exist.\" or \"Dependency does not exist.\"", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"response", "description":"Indicates existence of references to the object in the database." } }, "description":"The input Body model that needs to be given." } } }, "x-internal-id":"config-sim-v2-menuItems-preDeleteCheckMenuItemDefinitions-post", "x-filename-id":"config-sim-v2-menuitems-predeletecheckmenuitemdefinitions-post" } }, "/config/sim/v1/menuItems/bulkInsertMenuItemDefinitions":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Definitions/Menu Item Definitions" ], "summary":"Bulk Insert Menu Item Definitions", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertMenuItemDefinitions", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertMenuItemDefinitionRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v1-menuItems-bulkInsertMenuItemDefinitions-post", "x-filename-id":"config-sim-v1-menuitems-bulkinsertmenuitemdefinitions-post" } }, "/config/sim/v2/menuItems/bulkInsertMenuItemDefinitions":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Definitions/Menu Item Definitions" ], "summary":"Bulk Insert Menu Item Definitions", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertMenuItemDefinitionsv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertMenuItemDefinitionRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-bulkInsertMenuItemDefinitions-post", "x-filename-id":"config-sim-v2-menuitems-bulkinsertmenuitemdefinitions-post" } }, "/config/sim/v2/menuItems/bulkUpdateMenuItemDefinitions":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Definitions/Menu Item Definitions" ], "summary":"Bulk Update Menu Item Definitions", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkUpdateMenuItemDefinitionsV2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkUpdateMenuItemDefinitionRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-menuItems-bulkUpdateMenuItemDefinitions-post", "x-filename-id":"config-sim-v2-menuitems-bulkupdatemenuitemdefinitions-post" } }, "/config/sim/v1/setup/getmenulevels":{ "post":{ "tags":[ "v1/Setup/Menu Levels/Menu Levels" ], "summary":"Get Menu Levels", "description":"Gets all the Menu Levels configured", "operationId":"getMenuLevels", "parameters":[ { "$ref":"#/parameters/body.MenuLevelsGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Menu Levels in organization.", "schema":{ "$ref":"#/definitions/MenuLevelGetResponsev1" } } }, "x-internal-id":"config-sim-v1-setup-getmenulevels-post", "x-filename-id":"config-sim-v1-setup-getmenulevels-post" } }, "/config/sim/v2/setup/getMenuLevels":{ "post":{ "tags":[ "v2/Setup/Menu Levels/Menu Levels" ], "summary":"Get Menu Levels", "description":"Gets all the Menu Levels configured", "operationId":"getMenuLevelsv2", "parameters":[ { "$ref":"#/parameters/body.MenuLevelsGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Menu Levels in organization.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Level objects of the organization.", "items":{ "$ref":"#/definitions/MenuLevelv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getMenuLevels-post", "x-filename-id":"config-sim-v2-setup-getmenulevels-post" } }, "/config/sim/v1/setup/menulevels":{ "post":{ "tags":[ "v1/Setup/Menu Levels/Menu Levels" ], "summary":"Add Menu Levels", "description":"Add the Menu Level object to a specified hierarchy unit of specified organization", "operationId":"AddMenuLevel", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuLevelCUDRequestBody" } ], "responses":{ "200":{ "description":"Menu Level Added.", "schema":{ "$ref":"#/definitions/MenuLevelResponse" } } }, "x-internal-id":"config-sim-v1-setup-menulevels-post", "x-filename-id":"config-sim-v1-setup-menulevels-post" } }, "/config/sim/v2/setup/menuLevels":{ "post":{ "tags":[ "v2/Setup/Menu Levels/Menu Levels" ], "summary":"Add Menu Levels", "description":"Add the Menu Level object to a specified hierarchy unit of specified organization", "operationId":"AddMenuLevelv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuLevelCUDRequestBodyv2" } ], "responses":{ "200":{ "description":"Menu Level Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number the menu level" } } } } }, "x-internal-id":"config-sim-v2-setup-menuLevels-post", "x-filename-id":"config-sim-v2-setup-menulevels-post" } }, "/config/sim/v1/setup/updatemenulevels":{ "post":{ "tags":[ "v1/Setup/Menu Levels/Menu Levels" ], "summary":"Update Menu Levels", "description":"Updates the Menu Level. If no Menu Level is found, it creates a Menu Level", "operationId":"updateMenuLevel", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuLevelCUDRequestBody" } ], "responses":{ "200":{ "description":"Menu Level Updated or Added.", "schema":{ "$ref":"#/definitions/MenuLevelResponse" } } }, "x-internal-id":"config-sim-v1-setup-updatemenulevels-post", "x-filename-id":"config-sim-v1-setup-updatemenulevels-post" } }, "/config/sim/v2/setup/updateMenuLevels":{ "post":{ "tags":[ "v2/Setup/Menu Levels/Menu Levels" ], "summary":"Update Menu Levels", "description":"Updates the Menu Level. ", "operationId":"updateMenuLevelv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuLevelCUDRequestBodyv2" } ], "responses":{ "200":{ "description":"Menu Level Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number the menu level" } } } } }, "x-internal-id":"config-sim-v2-setup-updateMenuLevels-post", "x-filename-id":"config-sim-v2-setup-updatemenulevels-post" } }, "/config/sim/v1/setup/deletemenulevels":{ "post":{ "tags":[ "v1/Setup/Menu Levels/Menu Levels" ], "summary":"Delete Menu Levels", "description":"Deletes the Menu Level object.", "operationId":"DeleteMenuLevel", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuLevelDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/MenuLevelDeleteResponse" } } }, "x-internal-id":"config-sim-v1-setup-deletemenulevels-post", "x-filename-id":"config-sim-v1-setup-deletemenulevels-post" } }, "/config/sim/v2/setup/deleteMenuLevels":{ "post":{ "tags":[ "v2/Setup/Menu Levels/Menu Levels" ], "summary":"Delete Menu Levels", "description":"Deletes the Menu Level object.", "operationId":"DeleteMenuLevelv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuLevelDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteMenuLevels-post", "x-filename-id":"config-sim-v2-setup-deletemenulevels-post" } }, "/config/sim/v1/employees/classes/getOperators":{ "post":{ "tags":[ "v1/Employees/Employee Class Operators" ], "summary":"Get Employee Class Operators", "description":"Gets all the operator options configured for employee class in the specified organization.", "operationId":"getEmployeeClassOperators", "parameters":[ { "$ref":"#/parameters/body.EmployeeClassOperatorGetRequestBody.Required" } ], "responses":{ "200":{ "description":"A collection of Employee Class Operators.", "schema":{ "$ref":"#/definitions/EmployeeClassOperatorGetResponsev1" } } }, "x-internal-id":"config-sim-v1-employees-classes-getOperators-post", "x-filename-id":"config-sim-v1-employees-classes-getoperators-post" } }, "/config/sim/v2/employees/classes/getOperators":{ "post":{ "tags":[ "v2/Employees/Employee Class Operators" ], "summary":"Get Employee Class Operators", "description":"Gets all the operator options configured for employee class in the specified organization.", "operationId":"getEmployeeClassOperatorsv2", "parameters":[ { "$ref":"#/parameters/body.EmployeeClassOperatorGetRequestBodyv2" } ], "responses":{ "200":{ "description":"A collection of Employee Class Operators.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Employee Class Operator objects of the organization.", "items":{ "$ref":"#/definitions/EmployeeClassOperatorv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-employees-classes-getOperators-post", "x-filename-id":"config-sim-v2-employees-classes-getoperators-post" } }, "/config/sim/v1/employees/classes/updateOperators":{ "post":{ "tags":[ "v1/Employees/Employee Class Operators" ], "summary":"Update Employee Class Operators", "description":"Updates operator record of the given employee class.", "operationId":"updateEmployeeClassOperators", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeClassOperator.Required" } ], "responses":{ "200":{ "description":"Employee Class Operator Updated.", "schema":{ "$ref":"#/definitions/EmployeeClassOperatorResponse" } } }, "x-internal-id":"config-sim-v1-employees-classes-updateOperators-post", "x-filename-id":"config-sim-v1-employees-classes-updateoperators-post" } }, "/config/sim/v2/employees/classes/updateOperators":{ "post":{ "tags":[ "v2/Employees/Employee Class Operators" ], "summary":"Update Employee Class Operators", "description":"Updates operator record of the given employee class.", "operationId":"updateEmployeeClassOperatorsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeClassOperator.Required" } ], "responses":{ "200":{ "description":"Employee Class Operator Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value where the employee class is configured" }, "objectNum":{ "type":"integer", "example":2, "description":"Object number of the Employee Class" }, "rvcObjNum":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value where the employee class is configured" } } } } }, "x-internal-id":"config-sim-v2-employees-classes-updateOperators-post", "x-filename-id":"config-sim-v2-employees-classes-updateoperators-post" } }, "/config/sim/v2/devices/getDeviceStatus":{ "post":{ "tags":[ "v2/Devices/Device Status/Device Status" ], "summary":"Get Device Status", "description":"Get Device Status records", "operationId":"getDeviceStatus", "parameters":[ { "$ref":"#/parameters/body.DeviceStatusGetParameters" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "description":"Total number of records in the data set", "type":"integer", "example":100 }, "hasMore":{ "description":"Indicates whether there are additional pages of records", "type":"boolean", "example":true }, "count":{ "description":"Number of records returned on this page", "type":"integer", "example":10 }, "offset":{ "description":"The page number of this data. Starts at 0.", "type":"integer", "example":0 }, "limit":{ "description":"The maximum number of records returned on a page", "type":"integer", "example":10 }, "items":{ "description":"Device Status records", "type":"array", "items":{ "$ref":"#/definitions/deviceStatus" } } } } } }, "x-internal-id":"config-sim-v2-devices-getDeviceStatus-post", "x-filename-id":"config-sim-v2-devices-getdevicestatus-post" } }, "/config/sim/v1/hierarchy/getRevenueCenterParameters":{ "post":{ "tags":[ "v1/Hierarchy/Revenue Centers/Revenue Center Parameters" ], "summary":"Get Revenue Center Parameters", "description":"Gets all the Revenue Center Parameters for a RVC.", "operationId":"getRevenueCenterParams", "parameters":[ { "$ref":"#/parameters/body.RevenueCenterParameterGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Revenue Center Parameters.", "schema":{ "$ref":"#/definitions/RevenueCenterParameterGetResponsev1" } } }, "x-internal-id":"config-sim-v1-hierarchy-getRevenueCenterParameters-post", "x-filename-id":"config-sim-v1-hierarchy-getrevenuecenterparameters-post" } }, "/config/sim/v2/hierarchy/getRevenueCenterParameters":{ "post":{ "tags":[ "v2/Hierarchy/Revenue Centers/Revenue Center Parameters" ], "summary":"Get Revenue Center Parameters", "description":"Gets all the Revenue Center Parameters for a RVC.", "operationId":"getRevenueCenterParamsv2", "parameters":[ { "$ref":"#/parameters/body.RevenueCenterParameterGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Revenue Center Parameters.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Revenue Center Parameter objects of the organization.", "items":{ "$ref":"#/definitions/RevenueCenterParameterv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-getRevenueCenterParameters-post", "x-filename-id":"config-sim-v2-hierarchy-getrevenuecenterparameters-post" } }, "/config/sim/v1/hierarchy/revenueCenterParameters":{ "post":{ "tags":[ "v1/Hierarchy/Revenue Centers/Revenue Center Parameters" ], "summary":"Add Revenue Center Parameters", "description":"Add the parameters to the specified revenue center.", "operationId":"addRevenueCenterParams", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.RevenueCenterParameterCUDRequestBody.Required" } ], "responses":{ "200":{ "description":"Revenue Center Parameter Added.", "schema":{ "$ref":"#/definitions/RevenueCenterParameterResponse" } } }, "x-internal-id":"config-sim-v1-hierarchy-revenueCenterParameters-post", "x-filename-id":"config-sim-v1-hierarchy-revenuecenterparameters-post" } }, "/config/sim/v1/hierarchy/updateRevenueCenterParameters":{ "post":{ "tags":[ "v1/Hierarchy/Revenue Centers/Revenue Center Parameters" ], "summary":"Update Revenue Center Parameters", "description":"Updates the parameter of the specified revenue center. If revenue center parameter is not found, it creates a new revenue center parameter.", "operationId":"updateRevenueCenterParams", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.RevenueCenterParameterCUDRequestBody.Required" } ], "responses":{ "200":{ "description":"Revenue Center Parameter Updated or Added.", "schema":{ "$ref":"#/definitions/RevenueCenterParameterResponse" } } }, "x-internal-id":"config-sim-v1-hierarchy-updateRevenueCenterParameters-post", "x-filename-id":"config-sim-v1-hierarchy-updaterevenuecenterparameters-post" } }, "/config/sim/v2/hierarchy/updateRevenueCenterParameters":{ "post":{ "tags":[ "v2/Hierarchy/Revenue Centers/Revenue Center Parameters" ], "summary":"Update Revenue Center Parameters", "description":"Updates the parameter of the specified revenue center.", "operationId":"updateRevenueCenterParamsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.RevenueCenterParameterCUDRequestBody.Required" } ], "responses":{ "200":{ "description":"Revenue Center Parameter Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"unique HierUnitId of the RVC" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-updateRevenueCenterParameters-post", "x-filename-id":"config-sim-v2-hierarchy-updaterevenuecenterparameters-post" } }, "/config/sim/v1/hierarchy/deleteRevenueCenterParameters":{ "post":{ "tags":[ "v1/Hierarchy/Revenue Centers/Revenue Center Parameters" ], "summary":"Delete Revenue Center Parameters", "description":"Deletes the parameters associated with the specified revenue center.", "operationId":"deleteRevenueCenterParams", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.RevenueCenterParameterDeleteRequest.Required" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-hierarchy-deleteRevenueCenterParameters-post", "x-filename-id":"config-sim-v1-hierarchy-deleterevenuecenterparameters-post" } }, "/config/sim/v1/employees/getEMCVisibility":{ "post":{ "tags":[ "v1/Employees/Employee EMC Visibility" ], "summary":"Get Employee EMC Visibility", "description":"Gets all the EMC modules visible for the given employee in the specified organization", "operationId":"getEMCVisibility", "parameters":[ { "$ref":"#/parameters/body.EMCVisibilityGetRequestv1" } ], "responses":{ "200":{ "description":"A Collection of Employee EMC Visibilties.", "schema":{ "$ref":"#/definitions/EMCVisibilityGetResponseV1" } } }, "x-internal-id":"config-sim-v1-employees-getEMCVisibility-post", "x-filename-id":"config-sim-v1-employees-getemcvisibility-post" } }, "/config/sim/v2/employees/getEMCVisibility":{ "post":{ "tags":[ "v2/Employees/Employee EMC Visibility" ], "summary":"Get Employee EMC Visibility", "description":"Gets all the EMC modules visible for the given employee in the specified organization", "operationId":"getEMCVisibilityv2", "parameters":[ { "$ref":"#/parameters/body.EMCVisibilityGetRequestv2" } ], "responses":{ "200":{ "description":"A Collection of Employee EMC Visibilties.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Employee EMC Visibility objects of the organization.", "items":{ "$ref":"#/definitions/EmployeeEMCVisibilityv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-employees-getEMCVisibility-post", "x-filename-id":"config-sim-v2-employees-getemcvisibility-post" } }, "/config/sim/v1/employees/emcVisibility":{ "post":{ "tags":[ "v1/Employees/Employee EMC Visibility" ], "summary":"Add Employee EMC Visibility", "description":"Assign the hierarchy unit visibility to the Employee.", "operationId":"addEMCVisibility", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeEMCVisibilityCUDRequest" } ], "responses":{ "200":{ "description":"Employee EMC Visibility added.", "schema":{ "$ref":"#/definitions/EmployeeEMCVisbilityResponse" } } }, "x-internal-id":"config-sim-v1-employees-emcVisibility-post", "x-filename-id":"config-sim-v1-employees-emcvisibility-post" } }, "/config/sim/v2/employees/EMCVisibility":{ "post":{ "tags":[ "v2/Employees/Employee EMC Visibility" ], "summary":"Add Employee EMC Visibility", "description":"Assign the hierarchy unit visibility to the Employee.", "operationId":"addEMCVisibilityv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeEMCVisibilityCUDRequest" } ], "responses":{ "200":{ "description":"Employee EMC Visibility added.", "schema":{ "description":"Model for the response", "type":"object", "properties":{ "objectNum":{ "description":"Unique reference of the Employee", "type":"integer" }, "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer" } } } } }, "x-internal-id":"config-sim-v2-employees-EMCVisibility-post", "x-filename-id":"config-sim-v2-employees-emcvisibility-post" } }, "/config/sim/v1/employees/updateEMCVisibility":{ "post":{ "tags":[ "v1/Employees/Employee EMC Visibility" ], "summary":"Update Employee EMC Visibility", "description":"Updates the hierarchy unit visibility to the Employee. If hierarchy unit is not found, it assigns the hierarchy unit to the Employee", "operationId":"updateEMCVisibility", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeEMCVisibilityCUDRequest" } ], "responses":{ "200":{ "description":"Employee EMC Visibility Updated or Added.", "schema":{ "$ref":"#/definitions/EmployeeEMCVisbilityResponse" } } }, "x-internal-id":"config-sim-v1-employees-updateEMCVisibility-post", "x-filename-id":"config-sim-v1-employees-updateemcvisibility-post" } }, "/config/sim/v2/employees/updateEMCVisibility":{ "post":{ "tags":[ "v2/Employees/Employee EMC Visibility" ], "summary":"Update Employee EMC Visibility", "description":"Updates the hierarchy unit visibility to the Employee.", "operationId":"updateEMCVisibilityv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeEMCVisibilityCUDRequest" } ], "responses":{ "200":{ "description":"Employee EMC Visibility Updated.", "schema":{ "description":"Model for the response", "type":"object", "properties":{ "objectNum":{ "description":"Unique reference of the Employee", "type":"integer" }, "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer" } } } } }, "x-internal-id":"config-sim-v2-employees-updateEMCVisibility-post", "x-filename-id":"config-sim-v2-employees-updateemcvisibility-post" } }, "/config/sim/v1/employees/deleteEmployeeVisibility":{ "post":{ "tags":[ "v1/Employees/Employee EMC Visibility" ], "summary":"Delete Employee EMC Visibility", "description":"Deletes the hierarchy unit visibility from the specified employee", "operationId":"deleteEMCVisibility", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeEMCVisbilityResponse" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-employees-deleteEmployeeVisibility-post", "x-filename-id":"config-sim-v1-employees-deleteemployeevisibility-post" } }, "/config/sim/v2/employees/deleteEMCVisibility":{ "post":{ "tags":[ "v2/Employees/Employee EMC Visibility" ], "summary":"Delete Employee EMC Visibility", "description":"Deletes the hierarchy unit visibility from the specified employee", "operationId":"deleteEMCVisibilityv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeEMCVisbilityResponse" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-employees-deleteEMCVisibility-post", "x-filename-id":"config-sim-v2-employees-deleteemcvisibility-post" } }, "/config/sim/v1/menuItems/getMenuItemMasters":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Master" ], "summary":"Get Menu Item Masters", "description":"Gets all Menu Item Masters", "operationId":"getMenuItemMasters", "parameters":[ { "$ref":"#/parameters/body.MenuItemMastersGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Menu Item Masters", "schema":{ "$ref":"#/definitions/menuItemMasterGetResponseV1" } } }, "x-internal-id":"config-sim-v1-menuItems-getMenuItemMasters-post", "x-filename-id":"config-sim-v1-menuitems-getmenuitemmasters-post" } }, "/config/sim/v2/menuItems/getMenuItemMasters":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Master" ], "summary":"Get Menu Item Masters", "description":"Gets all Menu Item Masters", "operationId":"getMenuItemMastersV2", "parameters":[ { "$ref":"#/parameters/body.MenuItemMastersGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Menu Item Masters", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Master objects.", "items":{ "$ref":"#/definitions/menuItemMasterV2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getMenuItemMasters-post", "x-filename-id":"config-sim-v2-menuitems-getmenuitemmasters-post" } }, "/config/sim/v1/menuItems/menuItemMasters":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Master" ], "summary":"Add Menu Item Masters", "description":"

    Add the Menu Item Master object to a specified hierarchy unit:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.4 Starting with the API release 23.4, Insert Menu Item Masters is permitted only for unique object numbers within the organization
    \n", "operationId":"addMenuItemMasters", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterInsertRequestBody" } ], "responses":{ "200":{ "description":"Menu Item Master Added", "schema":{ "$ref":"#/definitions/menuItemMasterResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-menuItemMasters-post", "x-filename-id":"config-sim-v1-menuitems-menuitemmasters-post" } }, "/config/sim/v2/menuItems/menuItemMasters":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Master" ], "summary":"Add Menu Item Masters", "description":"

    Add the Menu Item Master object to a specified hierarchy unit:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.4 Starting with the API release 23.4, Insert Menu Item Masters is permitted only for unique object numbers within the organization
    \n", "operationId":"addMenuItemMastersV2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterInsertRequestBodyV2" } ], "responses":{ "200":{ "description":"Menu Item Master Added", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemMasters-post", "x-filename-id":"config-sim-v2-menuitems-menuitemmasters-post" } }, "/config/sim/v1/menuItems/updateMenuItemMasters":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Master" ], "summary":"Update Menu Item Masters", "description":"

    Updates Menu Item Master:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.4 Starting with the API release 23.4, Update Menu Item Masters is permitted only for object numbers defined uniquely within the organization
    \n", "operationId":"updateMenuItemMasters", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterUpdateRequestBody" } ], "responses":{ "200":{ "description":"Menu Item Master Updated or Added.", "schema":{ "$ref":"#/definitions/menuItemMasterResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-updateMenuItemMasters-post", "x-filename-id":"config-sim-v1-menuitems-updatemenuitemmasters-post" } }, "/config/sim/v2/menuItems/updateMenuItemMasters":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Master" ], "summary":"Update Menu Item Masters", "description":"

    Updates Menu Item Master:

    \n\n \n \n \n \n \n \n \n \n
    ReleaseDescription
    23.4 Starting with the API release 23.4, Update Menu Item Masters is permitted only for object numbers defined uniquely within the organization
    \n", "operationId":"updateMenuItemMastersV2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterUpdateRequestBodyV2" } ], "responses":{ "200":{ "description":"Menu Item Master Updated.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateMenuItemMasters-post", "x-filename-id":"config-sim-v2-menuitems-updatemenuitemmasters-post" } }, "/config/sim/v1/menuItems/deleteMenuItemMasters":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Master" ], "summary":"Delete Menu Item Masters", "description":"Deletes a Menu Item Master unit", "operationId":"deleteMenuItemMasters", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/DeleteResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-deleteMenuItemMasters-post", "x-filename-id":"config-sim-v1-menuitems-deletemenuitemmasters-post" } }, "/config/sim/v2/menuItems/deleteMenuItemMasters":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Master" ], "summary":"Delete Menu Item Masters", "description":"Deletes a Menu Item Master unit", "operationId":"deleteMenuItemMastersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemMasterDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteMenuItemMasters-post", "x-filename-id":"config-sim-v2-menuitems-deletemenuitemmasters-post" } }, "/config/sim/v1/menuItems/preDeleteCheckMenuItemMasters":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Master" ], "summary":"Pre-Delete Check Menu Item Masters", "description":"Checks the existence of references to the object in the database.", "operationId":"preDeleteCheckMenuItemMasters", "parameters":[ { "in":"body", "name":"Request body", "description":"A request body", "required":true, "schema":{ "$ref":"#/definitions/menuitemmaster_dml" } } ], "responses":{ "200":{ "description":"The values of \"response\" can either be \"Dependency exist.\" or \"Dependency does not exist.\"", "schema":{ "$ref":"#/definitions/predeletecheck_nodependency_response" } } }, "x-internal-id":"config-sim-v1-menuItems-preDeleteCheckMenuItemMasters-post", "x-filename-id":"config-sim-v1-menuitems-predeletecheckmenuitemmasters-post" } }, "/config/sim/v2/menuItems/preDeleteCheckMenuItemMasters":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Master" ], "summary":"Pre-Delete Check Menu Item Masters", "description":"Checks the existence of references to the object in the database.", "operationId":"preDeleteCheckMenuItemMastersv2", "parameters":[ { "$ref":"#/parameters/body.MenuItemMasterDeleteRequest" } ], "responses":{ "200":{ "description":"The values of \"response\" can either be \"Dependency exist.\" or \"Dependency does not exist.\"", "schema":{ "$ref":"#/definitions/predeletecheck_nodependency_response" } } }, "x-internal-id":"config-sim-v2-menuItems-preDeleteCheckMenuItemMasters-post", "x-filename-id":"config-sim-v2-menuitems-predeletecheckmenuitemmasters-post" } }, "/config/sim/v1/menuItems/bulkInsertMenuItemMasters":{ "post":{ "tags":[ "v1/Menu Items/Menu Item Master" ], "summary":"Bulk Insert Menu Item Master", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertMenuItemMasters", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertMenuItemMasterRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "$ref":"#/definitions/BulkRequestSubmitResponse" } } }, "x-internal-id":"config-sim-v1-menuItems-bulkInsertMenuItemMasters-post", "x-filename-id":"config-sim-v1-menuitems-bulkinsertmenuitemmasters-post" } }, "/config/sim/v2/menuItems/bulkInsertMenuItemMasters":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Master" ], "summary":"Bulk Insert Menu Item Master", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertMenuItemMastersv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkInsertMenuItemMasterRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "$ref":"#/definitions/BulkRequestSubmitResponse" } } }, "x-internal-id":"config-sim-v2-menuItems-bulkInsertMenuItemMasters-post", "x-filename-id":"config-sim-v2-menuitems-bulkinsertmenuitemmasters-post" } }, "/config/sim/v2/menuItems/bulkUpdateMenuItemMasters":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Master" ], "summary":"Bulk Update Menu Item Master", "description":"Refer to the Bulk Processing chapter for more details.", "operationId":"bulkUpdateMenuItemMastersv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkUpdateMenuItemMasterRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request", "schema":{ "$ref":"#/definitions/BulkRequestSubmitResponse" } } }, "x-internal-id":"config-sim-v2-menuItems-bulkUpdateMenuItemMasters-post", "x-filename-id":"config-sim-v2-menuitems-bulkupdatemenuitemmasters-post" } }, "/config/sim/v1/employees/getClasses":{ "post":{ "tags":[ "v1/Employees/Employee Classes" ], "summary":"Get Employee Classes", "description":"Gets all Employees Classes", "operationId":"getEmployeeClasses", "parameters":[ { "$ref":"#/parameters/body.EmployeeClassesGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Employee Class", "schema":{ "$ref":"#/definitions/EmployeeClassGetResponseV1" } } }, "x-internal-id":"config-sim-v1-employees-getClasses-post", "x-filename-id":"config-sim-v1-employees-getclasses-post" } }, "/config/sim/v2/employees/getClasses":{ "post":{ "tags":[ "v2/Employees/Employee Classes" ], "summary":"Get Employee Classes", "description":"Gets all Employees Classes", "operationId":"getEmployeeClassesV2", "parameters":[ { "$ref":"#/parameters/body.EmployeeClassesGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Employee Class", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Employee Classes objects of the organization.", "items":{ "$ref":"#/definitions/EmployeeClassV2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-employees-getClasses-post", "x-filename-id":"config-sim-v2-employees-getclasses-post" } }, "/config/sim/v1/employees/classes":{ "post":{ "tags":[ "v1/Employees/Employee Classes" ], "summary":"Add Employee Classes", "description":"Add the Employee class object to a specified hierarchy unit .", "operationId":"addEmployeeClasses", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeClass.Required" } ], "responses":{ "200":{ "description":"Employee Class Added", "schema":{ "$ref":"#/definitions/EmployeeClassResponse" } } }, "x-internal-id":"config-sim-v1-employees-classes-post", "x-filename-id":"config-sim-v1-employees-classes-post" } }, "/config/sim/v2/employees/classes":{ "post":{ "tags":[ "v2/Employees/Employee Classes" ], "summary":"Add Employee Classes", "description":"Add the Employee class object to a specified hierarchy unit .", "operationId":"addEmployeeClassesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeClassCURequestv2" } ], "responses":{ "200":{ "description":"Employee Class Added", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object number of the Employee Class" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value where the employee class is configured" } } } } }, "x-internal-id":"config-sim-v2-employees-classes-post", "x-filename-id":"config-sim-v2-employees-classes-post" } }, "/config/sim/v1/employees/updateClasses":{ "post":{ "tags":[ "v1/Employees/Employee Classes" ], "summary":"Update Employee Classes", "description":"Updates the Employee Class. If Employee Class is not found, it creates a new Employee Class.", "operationId":"updateEmployeeClasses", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeClass.Required" } ], "responses":{ "200":{ "description":"Employee Class Updated or Added.", "schema":{ "$ref":"#/definitions/EmployeeClassResponse" } } }, "x-internal-id":"config-sim-v1-employees-updateClasses-post", "x-filename-id":"config-sim-v1-employees-updateclasses-post" } }, "/config/sim/v2/employees/updateClasses":{ "post":{ "tags":[ "v2/Employees/Employee Classes" ], "summary":"Update Employee Classes", "description":"Updates the Employee Class.", "operationId":"updateEmployeeClassesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeClassCURequestv2" } ], "responses":{ "200":{ "description":"Employee Class Updated .", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object number of the Employee Class" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value where the employee class is configured" } } } } }, "x-internal-id":"config-sim-v2-employees-updateClasses-post", "x-filename-id":"config-sim-v2-employees-updateclasses-post" } }, "/config/sim/v1/employees/deleteClasses":{ "post":{ "tags":[ "v1/Employees/Employee Classes" ], "summary":"Delete Employee Classes", "description":"Deletes the Employee Class object.", "operationId":"deleteEmployeeClasses", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeClassDeleteRequest.Required" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-employees-deleteClasses-post", "x-filename-id":"config-sim-v1-employees-deleteclasses-post" } }, "/config/sim/v2/employees/deleteClasses":{ "post":{ "tags":[ "v2/Employees/Employee Classes" ], "summary":"Delete Employee Classes", "description":"Deletes the Employee Class object.", "operationId":"deleteEmployeeClassesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeClassDeleteRequest.Required" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-employees-deleteClasses-post", "x-filename-id":"config-sim-v2-employees-deleteclasses-post" } }, "/config/sim/v1/employees/properties/getJobCodes":{ "post":{ "tags":[ "v1/Employees/Employee Job Codes" ], "summary":"Get Employee Job Codes", "description":"Gets all the job codes assigned to the given employee at the specified property", "operationId":"getEmployeeJobCodes", "parameters":[ { "$ref":"#/parameters/body.EmployeeJobCodesGetRequestv1" } ], "responses":{ "200":{ "description":"A Collection of Employee Job Codes.", "schema":{ "$ref":"#/definitions/EmployeeJobCodeGetResponsev1" } } }, "x-internal-id":"config-sim-v1-employees-properties-getJobCodes-post", "x-filename-id":"config-sim-v1-employees-properties-getjobcodes-post" } }, "/config/sim/v2/employees/properties/getJobCodes":{ "post":{ "tags":[ "v2/Employees/Employee Job Codes" ], "summary":"Get Employee Job Codes", "description":"Gets all the job codes assigned to the given employee at the specified property", "operationId":"getEmployeeJobCodesv2", "parameters":[ { "$ref":"#/parameters/body.EmployeeJobCodesGetRequestv2" } ], "responses":{ "200":{ "description":"A Collection of Employee Job Codes.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Employee Job Code objects of the organization.", "items":{ "$ref":"#/definitions/EmployeeJobCodev2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-employees-properties-getJobCodes-post", "x-filename-id":"config-sim-v2-employees-properties-getjobcodes-post" } }, "/config/sim/v1/employees/employees":{ "post":{ "tags":[ "v1/Employees/Employees" ], "summary":"Add Employee", "description":"Add the Employee object to a specified hierarchy unit of specified organization.", "operationId":"addEmployees", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.Employee.Insert" } ], "responses":{ "200":{ "description":"Employee Added.", "schema":{ "$ref":"#/definitions/EmployeeResponse" } } }, "x-internal-id":"config-sim-v1-employees-employees-post", "x-filename-id":"config-sim-v1-employees-employees-post" } }, "/config/sim/v2/employees/employees":{ "post":{ "tags":[ "v2/Employees/Employees" ], "summary":"Add Employee", "description":"Add the Employee object to a specified hierarchy unit of specified organization.", "operationId":"addEmployeesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.Employee.Insert" } ], "responses":{ "200":{ "description":"Employee Added.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" } } } } }, "x-internal-id":"config-sim-v2-employees-employees-post", "x-filename-id":"config-sim-v2-employees-employees-post" } }, "/config/sim/v1/employees/preDeleteCheckEmployees":{ "post":{ "tags":[ "v1/Employees/Employees" ], "summary":"Pre-Delete Employees", "description":"Checks the existence of references to the object in the database.", "operationId":"preDeleteCheckEmployees", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DeleteRequest.Required" } ], "responses":{ "200":{ "description":"Dependency check Response", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"Dependency exists/Dependency does not exist" } } } } }, "x-internal-id":"config-sim-v1-employees-preDeleteCheckEmployees-post", "x-filename-id":"config-sim-v1-employees-predeletecheckemployees-post" } }, "/config/sim/v2/employees/preDeleteCheckEmployees":{ "post":{ "tags":[ "v2/Employees/Employees" ], "summary":"Pre-Delete Employees", "description":"Checks the existence of references to the object in the database.", "operationId":"preDeleteCheckEmployeesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DeleteRequest.Required" } ], "responses":{ "200":{ "description":"Dependency check Response", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"Dependency exists/Dependency does not exist" } } } } }, "x-internal-id":"config-sim-v2-employees-preDeleteCheckEmployees-post", "x-filename-id":"config-sim-v2-employees-predeletecheckemployees-post" } }, "/config/sim/v1/employees/deleteEmployees":{ "post":{ "tags":[ "v1/Employees/Employees" ], "summary":"Delete Employees", "description":"Deletes Employees", "operationId":"deleteEmployees", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DeleteRequest.Required" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-employees-deleteEmployees-post", "x-filename-id":"config-sim-v1-employees-deleteemployees-post" } }, "/config/sim/v2/employees/deleteEmployees":{ "post":{ "tags":[ "v2/Employees/Employees" ], "summary":"Delete Employees", "description":"Deletes Employees", "operationId":"deleteEmployeesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DeleteRequest.Required" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-employees-deleteEmployees-post", "x-filename-id":"config-sim-v2-employees-deleteemployees-post" } }, "/config/sim/v1/employees/getEmployees":{ "post":{ "tags":[ "v1/Employees/Employees" ], "summary":"Get Employees", "description":"Gets all the Employees", "operationId":"getEmployees", "parameters":[ { "$ref":"#/parameters/body.EmployeesGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Employees.", "schema":{ "$ref":"#/definitions/EmployeeGetResponse" } } }, "x-internal-id":"config-sim-v1-employees-getEmployees-post", "x-filename-id":"config-sim-v1-employees-getemployees-post" } }, "/config/sim/v2/employees/getEmployees":{ "post":{ "tags":[ "v2/Employees/Employees" ], "summary":"Get Employees", "description":"Gets all the Employees", "operationId":"getEmployeesv2", "parameters":[ { "$ref":"#/parameters/body.EmployeesGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Employees.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Employee objects of the organization.", "items":{ "$ref":"#/definitions/Employeev2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-employees-getEmployees-post", "x-filename-id":"config-sim-v2-employees-getemployees-post" } }, "/config/sim/v1/employees/reactivateEmployee":{ "post":{ "tags":[ "v1/Employees/Employees" ], "summary":"Reactivate Employee", "description":"Reactivates a deleted employee", "operationId":"reactivateEmployee", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ReactivateRequest.Required" } ], "responses":{ "200":{ "description":"Reactivation Response", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"Employee record updated" } } } } }, "x-internal-id":"config-sim-v1-employees-reactivateEmployee-post", "x-filename-id":"config-sim-v1-employees-reactivateemployee-post" } }, "/config/sim/v2/employees/reactivateEmployee":{ "post":{ "tags":[ "v2/Employees/Employees" ], "summary":"Reactivate Employee", "description":"Reactivates a deleted employee", "operationId":"reactivateEmployeev2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ReactivateRequest.Required" } ], "responses":{ "200":{ "description":"Reactivation Response", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"Employee record updated" } } } } }, "x-internal-id":"config-sim-v2-employees-reactivateEmployee-post", "x-filename-id":"config-sim-v2-employees-reactivateemployee-post" } }, "/config/sim/v1/employees/updateEmployees":{ "post":{ "tags":[ "v1/Employees/Employees" ], "summary":"Update Employees", "description":"Updates the Employee. If Employee is not found, it creates a new Employee.", "operationId":"updateEmployees", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.Employee.Update" } ], "responses":{ "200":{ "description":"Employee Updated or Added.", "schema":{ "$ref":"#/definitions/EmployeeResponse" } } }, "x-internal-id":"config-sim-v1-employees-updateEmployees-post", "x-filename-id":"config-sim-v1-employees-updateemployees-post" } }, "/config/sim/v2/employees/updateEmployees":{ "post":{ "tags":[ "v2/Employees/Employees" ], "summary":"Update Employees", "description":"Updates the Employee.", "operationId":"updateEmployeesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.Employee.Update" } ], "responses":{ "200":{ "description":"Employee Updated.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" } } } } }, "x-internal-id":"config-sim-v2-employees-updateEmployees-post", "x-filename-id":"config-sim-v2-employees-updateemployees-post" } }, "/config/sim/v1/employees/getProperties":{ "post":{ "tags":[ "v1/Employees/Employee Properties" ], "summary":"Get Employee Properties", "description":"Gets all the properties to which the given employee is assigned in the specified organization.", "operationId":"getEmployeeProperties", "parameters":[ { "$ref":"#/parameters/body.EmployeePropertiesGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Employee Properties", "schema":{ "$ref":"#/definitions/EmployeePropertyGetResponse" } } }, "x-internal-id":"config-sim-v1-employees-getProperties-post", "x-filename-id":"config-sim-v1-employees-getproperties-post" } }, "/config/sim/v2/employees/getProperties":{ "post":{ "tags":[ "v2/Employees/Employee Properties" ], "summary":"Get Employee Properties", "description":"Gets all the properties to which the given employee is assigned in the specified organization.", "operationId":"getEmployeePropertiesv2", "parameters":[ { "$ref":"#/parameters/body.EmployeePropertiesGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Employee Properties", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Employee Property objects of the organization.", "items":{ "$ref":"#/definitions/EmployeePropertyv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-employees-getProperties-post", "x-filename-id":"config-sim-v2-employees-getproperties-post" } }, "/config/sim/v1/employees/properties":{ "post":{ "tags":[ "v1/Employees/Employee Properties" ], "summary":"Add Employee Properties", "description":"Assign a property to an Employee at the specified hierarchy unit .", "operationId":"addEmployeeProperties", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeProperty.Required" } ], "responses":{ "200":{ "description":"Employee Property Added.", "schema":{ "$ref":"#/definitions/EmployeePropertyResponse" } } }, "x-internal-id":"config-sim-v1-employees-properties-post", "x-filename-id":"config-sim-v1-employees-properties-post" } }, "/config/sim/v2/employees/properties":{ "post":{ "tags":[ "v2/Employees/Employee Properties" ], "summary":"Add Employee Properties", "description":"Assign a property to an Employee at the specified hierarchy unit .", "operationId":"addEmployeePropertiesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeProperty.Required" } ], "responses":{ "200":{ "description":"Employee Property Added.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" }, "propertyHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value of the property" } } } } }, "x-internal-id":"config-sim-v2-employees-properties-post", "x-filename-id":"config-sim-v2-employees-properties-post" } }, "/config/sim/v1/employees/updateProperties":{ "post":{ "tags":[ "v1/Employees/Employee Properties" ], "summary":"Update Employee Properties", "description":"Updates the property assigned to the Employee at the specified hierarchy unit. If Employee property is not found, it assigns the property to the Employee.", "operationId":"updateEmployeeProperties", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeProperty.Required" } ], "responses":{ "200":{ "description":"Employee Property Updated or Added.", "schema":{ "$ref":"#/definitions/EmployeePropertyResponse" } } }, "x-internal-id":"config-sim-v1-employees-updateProperties-post", "x-filename-id":"config-sim-v1-employees-updateproperties-post" } }, "/config/sim/v2/employees/updateProperties":{ "post":{ "tags":[ "v2/Employees/Employee Properties" ], "summary":"Update Employee Properties", "description":"Updates the property assigned to the Employee at the specified hierarchy unit.", "operationId":"updateEmployeePropertiesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeeProperty.Required" } ], "responses":{ "200":{ "description":"Employee Property Updated.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" }, "propertyHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value of the property" } } } } }, "x-internal-id":"config-sim-v2-employees-updateProperties-post", "x-filename-id":"config-sim-v2-employees-updateproperties-post" } }, "/config/sim/v1/employees/deleteProperties":{ "post":{ "tags":[ "v1/Employees/Employee Properties" ], "summary":"Delete Employee Properties", "description":"Unassigns the property from the specified employee", "operationId":"deleteEmployeeProperties", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeePropertyDeleteRequest.Required" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-employees-deleteProperties-post", "x-filename-id":"config-sim-v1-employees-deleteproperties-post" } }, "/config/sim/v2/employees/deleteProperties":{ "post":{ "tags":[ "v2/Employees/Employee Properties" ], "summary":"Delete Employee Properties", "description":"Unassigns the property from the specified employee", "operationId":"deleteEmployeePropertiesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeePropertyDeleteRequest.Required" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-employees-deleteProperties-post", "x-filename-id":"config-sim-v2-employees-deleteproperties-post" } }, "/config/sim/v1/employees/properties/getOperators":{ "post":{ "tags":[ "v1/Employees/Employee Property Operators" ], "summary":"Get Employee Property Operators", "description":"Gets all the operator records for the given employee at the assigned property in the specified organization.", "operationId":"getEmployeePropertyOperators", "parameters":[ { "$ref":"#/parameters/body.EmployeePropertyOperatorsGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Employee Property Operators.", "schema":{ "$ref":"#/definitions/EmployeePropertyOperatorGetResponse" } } }, "x-internal-id":"config-sim-v1-employees-properties-getOperators-post", "x-filename-id":"config-sim-v1-employees-properties-getoperators-post" } }, "/config/sim/v2/employees/properties/getOperators":{ "post":{ "tags":[ "v2/Employees/Employee Property Operators" ], "summary":"Get Employee Property Operators", "description":"Gets all the operator records for the given employee at the assigned property in the specified organization.", "operationId":"getEmployeePropertyOperatorsv2", "parameters":[ { "$ref":"#/parameters/body.EmployeePropertyOperatorsGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Employee Property Operators.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Employee Property Operator objects of the organization.", "items":{ "$ref":"#/definitions/EmployeePropertyOperatorv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-employees-properties-getOperators-post", "x-filename-id":"config-sim-v2-employees-properties-getoperators-post" } }, "/config/sim/v1/employees/properties/operators":{ "post":{ "tags":[ "v1/Employees/Employee Property Operators" ], "summary":"Add Employee Property Operator", "description":"Adds an operator to the Employee at a property.", "operationId":"addEmployeePropertyOperators", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeePropertyOperator.Required" } ], "responses":{ "200":{ "description":"Employee Property Operator Added.", "schema":{ "$ref":"#/definitions/EmployeePropertyOperatorResponse" } } }, "x-internal-id":"config-sim-v1-employees-properties-operators-post", "x-filename-id":"config-sim-v1-employees-properties-operators-post" } }, "/config/sim/v2/employees/properties/operators":{ "post":{ "tags":[ "v2/Employees/Employee Property Operators" ], "summary":"Add Employee Property Operator", "description":"Adds an operator to the Employee at a property.", "operationId":"addEmployeePropertyOperatorsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeePropertyOperator.Required" } ], "responses":{ "200":{ "description":"Employee Property Operator Added.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" }, "propertyHierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value of the property" }, "rvcHierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value of the revenue center." } } } } }, "x-internal-id":"config-sim-v2-employees-properties-operators-post", "x-filename-id":"config-sim-v2-employees-properties-operators-post" } }, "/config/sim/v1/employees/properties/updateOperators":{ "post":{ "tags":[ "v1/Employees/Employee Property Operators" ], "summary":"Update Employee Property Operator", "description":"Updates the operator record assigned to the Employee at the specified hierarchy unit. If operator record is not found, it adds the operator record to the employee at the property.", "operationId":"updateEmployeePropertyOperators", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeePropertyOperator.Required" } ], "responses":{ "200":{ "description":"Employee Property Operator Updated or Added.", "schema":{ "$ref":"#/definitions/EmployeePropertyOperatorResponse" } } }, "x-internal-id":"config-sim-v1-employees-properties-updateOperators-post", "x-filename-id":"config-sim-v1-employees-properties-updateoperators-post" } }, "/config/sim/v2/employees/properties/updateOperators":{ "post":{ "tags":[ "v2/Employees/Employee Property Operators" ], "summary":"Update Employee Property Operator", "description":"Updates the operator record assigned to the Employee at the specified hierarchy unit.", "operationId":"updateEmployeePropertyOperatorsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeePropertyOperator.Required" } ], "responses":{ "200":{ "description":"Employee Property Operator Updated.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" }, "propertyHierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value of the property" }, "rvcHierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value of the revenue center." } } } } }, "x-internal-id":"config-sim-v2-employees-properties-updateOperators-post", "x-filename-id":"config-sim-v2-employees-properties-updateoperators-post" } }, "/config/sim/v1/employees/properties/deleteOperators":{ "post":{ "tags":[ "v1/Employees/Employee Property Operators" ], "summary":"Delete Employee Property Operator", "description":"Deletes the operator record for the specified employee at the given property", "operationId":"deleteEmployeePropertyOperators", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeePropertyOperatorDeleteRequest.Required" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-employees-properties-deleteOperators-post", "x-filename-id":"config-sim-v1-employees-properties-deleteoperators-post" } }, "/config/sim/v2/employees/properties/deleteOperators":{ "post":{ "tags":[ "v2/Employees/Employee Property Operators" ], "summary":"Delete Employee Property Operator", "description":"Deletes the operator record for the specified employee at the given property", "operationId":"deleteEmployeePropertyOperatorsv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EmployeePropertyOperatorDeleteRequest.Required" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-employees-properties-deleteOperators-post", "x-filename-id":"config-sim-v2-employees-properties-deleteoperators-post" } }, "/config/sim/v2/employees/getSystemEmployees":{ "post":{ "tags":[ "v2/Employees/System Employees" ], "summary":"Get System Employees", "description":"Gets all System Employees", "operationId":"getSystemEmployees", "parameters":[ { "$ref":"#/parameters/body.SystemEmployeesGetParameters" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "description":"Total number of records in the data set", "type":"integer", "example":100 }, "hasMore":{ "description":"Indicates whether there are additional pages of records", "type":"boolean", "example":true }, "count":{ "description":"Number of records returned on this page", "type":"integer", "example":10 }, "offset":{ "description":"The page number of this data. Starts at 0.", "type":"integer", "example":0 }, "limit":{ "description":"The maximum number of records returned on a page", "type":"integer", "example":10 }, "items":{ "description":"System employee records", "type":"array", "items":{ "$ref":"#/definitions/SystemEmployee" } } } } } }, "x-internal-id":"config-sim-v2-employees-getSystemEmployees-post", "x-filename-id":"config-sim-v2-employees-getsystememployees-post" } }, "/config/sim/v2/employees/systemEmployees":{ "post":{ "tags":[ "v2/Employees/System Employees" ], "summary":"Add System Employees", "description":"Adds a System Employee", "operationId":"createSystemEmployees", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SystemEmployeeCURequest" } ], "responses":{ "200":{ "description":"Insert operation executed successfully.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the system employee is configured.", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the system employee", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-employees-systemEmployees-post", "x-filename-id":"config-sim-v2-employees-systememployees-post" } }, "/config/sim/v2/employees/deleteSystemEmployees":{ "post":{ "tags":[ "v2/Employees/System Employees" ], "summary":"Delete System Employees", "description":"Deletes a System Employee", "operationId":"deleteSystemEmployees", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SystemEmployeeDeleteRequest" } ], "responses":{ "200":{ "description":"Delete operation executed successfully.", "schema":{ "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-employees-deleteSystemEmployees-post", "x-filename-id":"config-sim-v2-employees-deletesystememployees-post" } }, "/config/sim/v2/employees/updateSystemEmployees":{ "post":{ "tags":[ "v2/Employees/System Employees" ], "summary":"Update System Employees", "description":"Updates a System Employee", "operationId":"updateSystemEmployees", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.SystemEmployeeCURequest" } ], "responses":{ "200":{ "description":"Update operation executed successfully.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the system employee is configured.", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the system employee", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-employees-updateSystemEmployees-post", "x-filename-id":"config-sim-v2-employees-updatesystememployees-post" } }, "/config/sim/v2/menuItems/getMenuItemClasses2":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Class 2" ], "summary":"Get Menu Item Classes 2", "description":"Gets all the Menu Item Class", "operationId":"getMenuItemClasses2", "parameters":[ { "$ref":"#/parameters/body.MenuItemClass2GetRequestBody" } ], "responses":{ "200":{ "description":"A collection of Menu Item Classes", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Classes", "items":{ "$ref":"#/definitions/MenuItemClass2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getMenuItemClasses2-post", "x-filename-id":"config-sim-v2-menuitems-getmenuitemclasses2-post" } }, "/config/sim/v2/menuItems/menuItemClasses2":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Class 2" ], "summary":"Add Menu Item Classes 2", "description":"Adds Menu Item Classes", "operationId":"addMenuItemClasses2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemClass2CUDRequest" } ], "responses":{ "200":{ "description":"Menu Item Class Added.", "schema":{ "description":"Model for the response", "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Menu Item Class" } } } } }, "x-internal-id":"config-sim-v2-menuItems-menuItemClasses2-post", "x-filename-id":"config-sim-v2-menuitems-menuitemclasses2-post" } }, "/config/sim/v2/menuItems/updateMenuItemClasses2":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Class 2" ], "summary":"Update Menu Item Classes 2", "description":"Updates Menu Item Classes.", "operationId":"updateMenuItemClasses2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemClass2CUDRequest" } ], "responses":{ "200":{ "description":"Menu Item Class Updated.", "schema":{ "description":"Model for the response", "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Menu Item Class" } } } } }, "x-internal-id":"config-sim-v2-menuItems-updateMenuItemClasses2-post", "x-filename-id":"config-sim-v2-menuitems-updatemenuitemclasses2-post" } }, "/config/sim/v2/menuItems/deleteMenuItemClasses2":{ "post":{ "tags":[ "v2/Menu Items/Menu Item Class 2" ], "summary":"Delete Menu Item Classes 2", "description":"Deletes Menu Item Classes", "operationId":"deleteMenuItemClasses2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuItemClass2DeleteRequest.Required" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-deleteMenuItemClasses2-post", "x-filename-id":"config-sim-v2-menuitems-deletemenuitemclasses2-post" } }, "/config/sim/v2/setup/getHeadersTrailersByChannelType":{ "post":{ "tags":[ "v2/Setup/Headers Trailers By Channel Type" ], "summary":"Get Headers Trailers By Channel Type", "description":"Get Headers Trailers By Channel Type", "operationId":"getHeadersTrailersByChannelType", "parameters":[ { "$ref":"#/parameters/body.HeadersTrailersByChannelTypeGetParameters" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "description":"Total number of records in the data set", "type":"integer", "example":100 }, "hasMore":{ "description":"Indicates whether there are additional pages of records", "type":"boolean", "example":true }, "count":{ "description":"Number of records returned on this page", "type":"integer", "example":10 }, "offset":{ "description":"The page number of this data. Starts at 0.", "type":"integer", "example":0 }, "limit":{ "description":"The maximum number of records returned on a page", "type":"integer", "example":10 }, "items":{ "description":"Headers Trailers By Channel Type records", "type":"array", "items":{ "$ref":"#/definitions/HeadersTrailersByChannelType" } } } } } }, "x-internal-id":"config-sim-v2-setup-getHeadersTrailersByChannelType-post", "x-filename-id":"config-sim-v2-setup-getheaderstrailersbychanneltype-post" } }, "/config/sim/v2/setup/headersTrailersByChannelType":{ "post":{ "tags":[ "v2/Setup/Headers Trailers By Channel Type" ], "summary":"Add Headers Trailers By Channel Type", "description":"Add Headers Trailers By Channel Type", "operationId":"createHeadersTrailersByChannelType", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.HeadersTrailersByChannelTypeCURequest" } ], "responses":{ "200":{ "description":"Insert operation executed successfully.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "objectNum":{ "description":"Object number of the descriptor", "type":"integer", "example":1 }, "descriptorTypeNum":{ "description":"Descriptor type number. The valid values are - 55 => Check Header - Order Type/Order Channel, 56 => Check Trailer - Order Type/Order Channel, 57 => Receipt Header - Order Type/Order Channel.", "type":"integer", "example":55 } } } } }, "x-internal-id":"config-sim-v2-setup-headersTrailersByChannelType-post", "x-filename-id":"config-sim-v2-setup-headerstrailersbychanneltype-post" } }, "/config/sim/v2/setup/deleteHeadersTrailersByChannelType":{ "post":{ "tags":[ "v2/Setup/Headers Trailers By Channel Type" ], "summary":"Delete Headers Trailers By Channel Type", "description":"Delete Headers Trailers By Channel Type", "operationId":"deleteHeadersTrailersByChannelType", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.HeadersTrailersByChannelTypeDeleteRequest" } ], "responses":{ "200":{ "description":"Delete operation executed successfully.", "schema":{ "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteHeadersTrailersByChannelType-post", "x-filename-id":"config-sim-v2-setup-deleteheaderstrailersbychanneltype-post" } }, "/config/sim/v2/setup/updateHeadersTrailersByChannelType":{ "post":{ "tags":[ "v2/Setup/Headers Trailers By Channel Type" ], "summary":"Update Headers Trailers By Channel Type", "description":"Update Headers Trailers By Channel Type", "operationId":"updateHeadersTrailersByChannelType", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.HeadersTrailersByChannelTypeCURequest" } ], "responses":{ "200":{ "description":"Update operation executed successfully.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "objectNum":{ "description":"Object number of the descriptor", "type":"integer", "example":1 }, "descriptorTypeNum":{ "description":"Descriptor type number. The valid values are - 55 => Check Header - Order Type/Order Channel, 56 => Check Trailer - Order Type/Order Channel, 57 => Receipt Header - Order Type/Order Channel.", "type":"integer", "example":55 } } } } }, "x-internal-id":"config-sim-v2-setup-updateHeadersTrailersByChannelType-post", "x-filename-id":"config-sim-v2-setup-updateheaderstrailersbychanneltype-post" } }, "/config/sim/v2/setup/getReasonCodes":{ "post":{ "tags":[ "v2/Setup/Reason Codes" ], "summary":"Get Reason Codes", "description":"Gets all Reason Codes", "operationId":"getReasonCodes", "parameters":[ { "$ref":"#/parameters/body.ReasonCodesGetParameters" } ], "responses":{ "200":{ "description":"A collection of Reason Codes", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of records in the data set" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Number of records returned on this page." }, "items":{ "type":"array", "description":"Reason Codes records.", "items":{ "$ref":"#/definitions/ReasonCode" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"The maximum number of records returned on a page" } } } } }, "x-internal-id":"config-sim-v2-setup-getReasonCodes-post", "x-filename-id":"config-sim-v2-setup-getreasoncodes-post" } }, "/config/sim/v2/setup/reasonCodes":{ "post":{ "tags":[ "v2/Setup/Reason Codes" ], "summary":"Add Reason Codes", "description":"Adds a Reason Code. Operation is supported only for Cash Management Reasons", "operationId":"addReasonCodes", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ReasonCodesInsertRequest" } ], "responses":{ "200":{ "description":"Reason Code Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the reason code is configured.", "type":"integer", "example":7 }, "objectNum":{ "description":"Object number of the reason code.", "type":"integer", "example":2 }, "descriptorTypeNum":{ "description":"Descriptor type number of the reason code.", "type":"integer", "example":30 } } } } }, "x-internal-id":"config-sim-v2-setup-reasonCodes-post", "x-filename-id":"config-sim-v2-setup-reasoncodes-post" } }, "/config/sim/v2/setup/updateReasonCodes":{ "post":{ "tags":[ "v2/Setup/Reason Codes" ], "summary":"Update Reason Codes", "description":"Updates a Reason Code", "operationId":"updateReasonCodes", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ReasonCodesUpdateRequest" } ], "responses":{ "200":{ "description":"Reason Code Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the reason code is configured.", "type":"integer", "example":7 }, "objectNum":{ "description":"Object number of the reason code.", "type":"integer", "example":2 }, "descriptorTypeNum":{ "description":"Descriptor type number of the reason code.", "type":"integer", "example":30 } } } } }, "x-internal-id":"config-sim-v2-setup-updateReasonCodes-post", "x-filename-id":"config-sim-v2-setup-updatereasoncodes-post" } }, "/config/sim/v2/setup/deleteReasonCodes":{ "post":{ "tags":[ "v2/Setup/Reason Codes" ], "summary":"Delete Reason Codes", "description":"Deletes a Reason Code. Only Cash Management Reasons can be deleted at the enterprise level.", "operationId":"deleteReasonCodes", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ReasonCodesDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteReasonCodes-post", "x-filename-id":"config-sim-v2-setup-deletereasoncodes-post" } }, "/config/sim/v2/menuItems/getNutritionNames":{ "post":{ "tags":[ "v2/Menu Items/Nutrition Names" ], "summary":"Get Nutrition Names", "description":"Gets all the Nutrition Names configured at the enterpise", "operationId":"getNutritionNamesv2", "responses":{ "200":{ "description":"A Collection of Nutrition Names", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":12, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":false, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":12, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Nutrition Name objects of the organization.", "items":{ "$ref":"#/definitions/NutritionNamesv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-getNutritionNames-post", "x-filename-id":"config-sim-v2-menuitems-getnutritionnames-post" } }, "/config/sim/v1/hierarchy/getRevenueCenters":{ "post":{ "tags":[ "v1/Hierarchy/Revenue Centers/Revenue Centers" ], "summary":"Get Revenue Centers", "description":"Gets all the revenue centers for the specified organization", "operationId":"getRevenueCenters", "parameters":[ { "$ref":"#/parameters/body.RevenueCentersGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Revenue Centers.", "schema":{ "$ref":"#/definitions/RevenueCenterGetResponsev1" } } }, "x-internal-id":"config-sim-v1-hierarchy-getRevenueCenters-post", "x-filename-id":"config-sim-v1-hierarchy-getrevenuecenters-post" } }, "/config/sim/v2/hierarchy/getRevenueCenters":{ "post":{ "tags":[ "v2/Hierarchy/Revenue Centers/Revenue Centers" ], "summary":"Get Revenue Centers", "description":"Gets all the revenue centers for the specified organization", "operationId":"getRevenueCentersv2", "parameters":[ { "$ref":"#/parameters/body.RevenueCentersGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Revenue Centers.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Revenue Center objects of the organization.", "items":{ "$ref":"#/definitions/RevenueCenterGETv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-getRevenueCenters-post", "x-filename-id":"config-sim-v2-hierarchy-getrevenuecenters-post" } }, "/config/sim/v1/hierarchy/revenueCenters":{ "post":{ "tags":[ "v1/Hierarchy/Revenue Centers/Revenue Centers" ], "summary":"Add Revenue Centers", "description":"Add the revenue centers for the given location for the specified organization. After inserting the RVC, the corresponding RVC Parameter needs to be added manually. ", "operationId":"addRevenueCenters", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.RevenueCenterInsert" } ], "responses":{ "200":{ "description":"Revenue Center Added.", "schema":{ "$ref":"#/definitions/RevenueCenterResponse" } } }, "x-internal-id":"config-sim-v1-hierarchy-revenueCenters-post", "x-filename-id":"config-sim-v1-hierarchy-revenuecenters-post" } }, "/config/sim/v2/hierarchy/revenueCenters":{ "post":{ "tags":[ "v2/Hierarchy/Revenue Centers/Revenue Centers" ], "summary":"Add Revenue Centers", "description":"Add the revenue centers for the given location for the specified organization", "operationId":"addRevenueCentersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.RevenueCenterInsertv2" } ], "responses":{ "200":{ "description":"Revenue Center Added.", "schema":{ "type":"object", "properties":{ "locHierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the revenue center", "type":"integer", "example":2 } } } } }, "x-internal-id":"config-sim-v2-hierarchy-revenueCenters-post", "x-filename-id":"config-sim-v2-hierarchy-revenuecenters-post" } }, "/config/sim/v1/hierarchy/updateRevenueCenters":{ "post":{ "tags":[ "v1/Hierarchy/Revenue Centers/Revenue Centers" ], "summary":"Update Revenue Centers", "description":"Updates the revenue center", "operationId":"updateRevenueCenters", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.RevenueCenterUpdate" } ], "responses":{ "200":{ "description":"Revenue Center Updated or Added.", "schema":{ "$ref":"#/definitions/RevenueCenterResponse" } } }, "x-internal-id":"config-sim-v1-hierarchy-updateRevenueCenters-post", "x-filename-id":"config-sim-v1-hierarchy-updaterevenuecenters-post" } }, "/config/sim/v2/hierarchy/updateRevenueCenters":{ "post":{ "tags":[ "v2/Hierarchy/Revenue Centers/Revenue Centers" ], "summary":"Update Revenue Centers", "description":"Updates the revenue center", "operationId":"updateRevenueCentersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.RevenueCenterUpdatev2" } ], "responses":{ "200":{ "description":"Revenue Center Updated.", "schema":{ "type":"object", "properties":{ "locHierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the revenue center", "type":"integer", "example":2 } } } } }, "x-internal-id":"config-sim-v2-hierarchy-updateRevenueCenters-post", "x-filename-id":"config-sim-v2-hierarchy-updaterevenuecenters-post" } }, "/config/sim/v1/hierarchy/deleteRevenueCenters":{ "post":{ "tags":[ "v1/Hierarchy/Revenue Centers/Revenue Centers" ], "summary":"Delete Revenue Centers", "description":"Deletes the revenue center of a given location for the specified organization. Before deleting the RVC, the corresponding RVC Parameter needs to be deleted manually. ", "operationId":"deleteRevenueCenters", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.RevenueCenterDelete" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-hierarchy-deleteRevenueCenters-post", "x-filename-id":"config-sim-v1-hierarchy-deleterevenuecenters-post" } }, "/config/sim/v2/hierarchy/deleteRevenueCenters":{ "post":{ "tags":[ "v2/Hierarchy/Revenue Centers/Revenue Centers" ], "summary":"Delete Revenue Centers", "description":"Deletes the revenue center of a given location for the specified organization.", "operationId":"deleteRevenueCentersv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.RevenueCenterDelete" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-deleteRevenueCenters-post", "x-filename-id":"config-sim-v2-hierarchy-deleterevenuecenters-post" } }, "/config/sim/v1/hierarchy/preDeleteCheckRevenueCenters":{ "post":{ "tags":[ "v1/Hierarchy/Revenue Centers/Revenue Centers" ], "summary":"Pre-Delete Check Revenue Centers", "description":"Checks the existence of references to the object in the database.", "operationId":"preDeleteCheckRevenueCenters", "parameters":[ { "$ref":"#/parameters/body.RevenueCenterDelete" } ], "responses":{ "200":{ "description":"The values of \"response\" can either be \"Dependency exist.\" or \"Dependency does not exist.\"", "schema":{ "$ref":"#/definitions/predeletecheck_nodependency_response" } } }, "x-internal-id":"config-sim-v1-hierarchy-preDeleteCheckRevenueCenters-post", "x-filename-id":"config-sim-v1-hierarchy-predeletecheckrevenuecenters-post" } }, "/config/sim/v2/hierarchy/preDeleteCheckRevenueCenters":{ "post":{ "tags":[ "v2/Hierarchy/Revenue Centers/Revenue Centers" ], "summary":"Pre-Delete Check Revenue Centers", "description":"Checks the existence of references to the object in the database.", "operationId":"preDeleteCheckRevenueCentersv2", "parameters":[ { "$ref":"#/parameters/body.RevenueCenterDelete" } ], "responses":{ "200":{ "description":"The values of \"response\" can either be \"Dependency exist.\" or \"Dependency does not exist.\"", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"response", "description":"Indicates existence of references to the object in the database." } } } } }, "x-internal-id":"config-sim-v2-hierarchy-preDeleteCheckRevenueCenters-post", "x-filename-id":"config-sim-v2-hierarchy-predeletecheckrevenuecenters-post" } }, "/config/sim/v1/hierarchy/getZones":{ "post":{ "tags":[ "v1/Hierarchy/Zones" ], "summary":"Get Zones", "description":"Gets a list of Zones", "operationId":"getZones", "parameters":[ { "$ref":"#/parameters/body.ZonesGetParametersv1" } ], "responses":{ "200":{ "description":"A Collection of Zones", "schema":{ "$ref":"#/definitions/ZoneGetResponsev1" } } }, "x-internal-id":"config-sim-v1-hierarchy-getZones-post", "x-filename-id":"config-sim-v1-hierarchy-getzones-post" } }, "/config/sim/v2/hierarchy/getZones":{ "post":{ "tags":[ "v2/Hierarchy/Zones/Zones" ], "summary":"Get Zones", "description":"Gets a list of Zones", "operationId":"getZonesv2", "parameters":[ { "$ref":"#/parameters/body.ZonesGetParametersv2" } ], "responses":{ "200":{ "description":"A Collection of Zones", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Zone objects.", "items":{ "$ref":"#/definitions/Zonev2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-getZones-post", "x-filename-id":"config-sim-v2-hierarchy-getzones-post" } }, "/config/sim/v2/hierarchy/bulkDeleteZones":{ "post":{ "tags":[ "v2/Hierarchy/Zones/Zones" ], "summary":"Bulk Delete Zones", "description":"Deletes a zone and all Zones, Properties, RVCs beneath it. Supports only 1 Zone per request. This endpoint is available from Simphony 19.9 and above. Refer to the Bulk Processing chapter for more details.", "operationId":"bulkDeleteZones", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkDeleteZoneRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request.", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-bulkDeleteZones-post", "x-filename-id":"config-sim-v2-hierarchy-bulkdeletezones-post" } }, "/config/sim/v2/hierarchy/bulkPreDeleteCheckZones":{ "post":{ "tags":[ "v2/Hierarchy/Zones/Zones" ], "summary":"Bulk Pre-Delete Zones", "description":"Returns the count of all configuration data linked to a zone and all zones beneath it. Supports only 1 Zone per request. This endpoint is available from Simphony 19.9 and above. Refer to the Bulk Processing chapter for more details.", "operationId":"bulkPreDeleteZones", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkPreDeleteZoneRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request.", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-bulkPreDeleteCheckZones-post", "x-filename-id":"config-sim-v2-hierarchy-bulkpredeletecheckzones-post" } }, "/config/sim/v1/setup/menulevels/getMenuLevelEntries":{ "post":{ "tags":[ "v1/Setup/Menu Levels/Menu Level Entries" ], "summary":"Get Menu Level Entries", "description":"Gets a list of all the menu levels entries for the specified menu level set", "operationId":"getMenuLevelEntry", "parameters":[ { "$ref":"#/parameters/body.MenuLevelEntriesGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of menu level entries.", "schema":{ "$ref":"#/definitions/MenuLevelEntryGetResponsev1" } } }, "x-internal-id":"config-sim-v1-setup-menulevels-getMenuLevelEntries-post", "x-filename-id":"config-sim-v1-setup-menulevels-getmenulevelentries-post" } }, "/config/sim/v2/setup/menuLevels/getMenuLevelEntries":{ "post":{ "tags":[ "v2/Setup/Menu Levels/Menu Level Entries" ], "summary":"Get Menu Level Entries", "description":"Gets a list of all the menu levels entries for the specified menu level set", "operationId":"getMenuLevelEntryv2", "parameters":[ { "$ref":"#/parameters/body.MenuLevelEntriesGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of menu level entries", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Level Entry objects of the organization.", "items":{ "$ref":"#/definitions/MenuLevelEntryv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-menuLevels-getMenuLevelEntries-post", "x-filename-id":"config-sim-v2-setup-menulevels-getmenulevelentries-post" } }, "/config/sim/v1/setup/menulevels/menuLevelEntries":{ "post":{ "tags":[ "v1/Setup/Menu Levels/Menu Level Entries" ], "summary":"Add Menu Level Entries", "description":"Add a Menu Level Entry for the specified menu level set", "operationId":"AddMenuLevelEntry", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuLevelEntryCUDRequestBody" } ], "responses":{ "200":{ "description":"Menu Level Entry Added.", "schema":{ "$ref":"#/definitions/MenuLevelEntryResponse" } } }, "x-internal-id":"config-sim-v1-setup-menulevels-menuLevelEntries-post", "x-filename-id":"config-sim-v1-setup-menulevels-menulevelentries-post" } }, "/config/sim/v2/setup/menuLevels/menuLevelEntries":{ "post":{ "tags":[ "v2/Setup/Menu Levels/Menu Level Entries" ], "summary":"Add Menu Level Entries", "description":"Add a Menu Level Entry for the specified menu level set", "operationId":"AddMenuLevelEntryv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuLevelEntryCUDRequestBodyv2" } ], "responses":{ "200":{ "description":"Menu Level Entry Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the menu level set" }, "index":{ "type":"integer", "example":1, "description":"Object number of the menu level entry" } }, "description":"Model for a Menu Level Entry Response" } } }, "x-internal-id":"config-sim-v2-setup-menuLevels-menuLevelEntries-post", "x-filename-id":"config-sim-v2-setup-menulevels-menulevelentries-post" } }, "/config/sim/v1/setup/menulevels/updateMenuLevelEntries":{ "post":{ "tags":[ "v1/Setup/Menu Levels/Menu Level Entries" ], "summary":"Update Menu Level Entries", "description":"Updates menu level entry of the specified menu level set. If Menu Level Entry is not found, it creates a new Menu Level Entry.", "operationId":"UpdateMenuLevelEntry", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuLevelEntryCUDRequestBody" } ], "responses":{ "200":{ "description":"Menu Level Entry Updated or Added.", "schema":{ "$ref":"#/definitions/MenuLevelEntryResponse" } } }, "x-internal-id":"config-sim-v1-setup-menulevels-updateMenuLevelEntries-post", "x-filename-id":"config-sim-v1-setup-menulevels-updatemenulevelentries-post" } }, "/config/sim/v2/setup/menuLevels/updateMenuLevelEntries":{ "post":{ "tags":[ "v2/Setup/Menu Levels/Menu Level Entries" ], "summary":"Update Menu Level Entries", "description":"Updates menu level entry of the specified menu level set", "operationId":"UpdateMenuLevelEntryv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuLevelEntryCUDRequestBodyv2" } ], "responses":{ "200":{ "description":"Menu Level Entry Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the menu level set" }, "index":{ "type":"integer", "example":1, "description":"Object number of the menu level entry" } }, "description":"Model for a Menu Level Entry Response" } } }, "x-internal-id":"config-sim-v2-setup-menuLevels-updateMenuLevelEntries-post", "x-filename-id":"config-sim-v2-setup-menulevels-updatemenulevelentries-post" } }, "/config/sim/v1/setup/menulevels/deleteMenuLevelEntries":{ "post":{ "tags":[ "v1/Setup/Menu Levels/Menu Level Entries" ], "summary":"Delete Menu Level Entries", "description":"Deletes Menu Level Entry", "operationId":"DeleteMenuLevelEntry", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuLevelEntryDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "$ref":"#/definitions/DeleteResponse" } } }, "x-internal-id":"config-sim-v1-setup-menulevels-deleteMenuLevelEntries-post", "x-filename-id":"config-sim-v1-setup-menulevels-deletemenulevelentries-post" } }, "/config/sim/v2/setup/menuLevels/deleteMenuLevelEntries":{ "post":{ "tags":[ "v2/Setup/Menu Levels/Menu Level Entries" ], "summary":"Delete Menu Level Entries", "description":"Deletes Menu Level Entry", "operationId":"DeleteMenuLevelEntryv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.MenuLevelEntryDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-menuLevels-deleteMenuLevelEntries-post", "x-filename-id":"config-sim-v2-setup-menulevels-deletemenulevelentries-post" } }, "/config/sim/v2/menuItems/comboSideGroups/getSideGroupItemsLite":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Group Items Lite" ], "summary":"Get Combo Side Group Items Lite", "description":"Gets a list of all the items of a combo side group.", "operationId":"getComboGroupItemLite", "parameters":[ { "$ref":"#/parameters/body.ComboSideGroupItemsLiteGetParameters" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Combo Side Group Items", "items":{ "$ref":"#/definitions/ComboSideGroupItemsLite" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroups-getSideGroupItemsLite-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroups-getsidegroupitemslite-post" } }, "/config/sim/v2/menuItems/comboSideGroups/sideGroupItemsLite":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Group Items Lite" ], "summary":"Add Combo Side Group Items Lite", "description":"Adds an item to the combo side group.", "operationId":"CreateComboSideGroupItemLite", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboGroupItemsLiteCURequest" } ], "responses":{ "200":{ "description":"Combo Side Group Item Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit where the side group item is located" }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" }, "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroups-sideGroupItemsLite-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroups-sidegroupitemslite-post" } }, "/config/sim/v2/menuItems/comboSideGroups/updateSideGroupItemsLite":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Group Items Lite" ], "summary":"Update Combo Side Group Items Lite", "description":"Updates the Combo Side Group Item.", "operationId":"UpdateComboGroupItemLite", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboGroupItemsLiteCURequest" } ], "responses":{ "200":{ "description":"Combo Side Group Item Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit where the side group item is located" }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" }, "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroups-updateSideGroupItemsLite-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroups-updatesidegroupitemslite-post" } }, "/config/sim/v2/menuItems/comboSideGroups/deleteSideGroupItemsLite":{ "post":{ "tags":[ "v2/Menu Items/Combo Side Groups/Combo Side Group Items Lite" ], "summary":"Delete Combo Side Group Items Lite", "description":"Deletes the item from the combo side group.", "operationId":"DeleteComboGroupItemLite", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.ComboGroupItemsLiteDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-comboSideGroups-deleteSideGroupItemsLite-post", "x-filename-id":"config-sim-v2-menuitems-combosidegroups-deletesidegroupitemslite-post" } }, "/config/sim/v2/menuItems/nutrientSets/getNutrients":{ "post":{ "tags":[ "v2/Menu Items/Nutrient Sets/Nutrients" ], "summary":"Get Nutrients", "description":"Gets all the Nutrients", "operationId":"getNutrientSetNutrients", "parameters":[ { "$ref":"#/parameters/body.NutrientSetNutrientsGetParameters" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "description":"Total number of records in the data set", "type":"integer", "example":100 }, "hasMore":{ "description":"Indicates whether there are additional pages of records", "type":"boolean", "example":true }, "count":{ "description":"Number of records returned on this page", "type":"integer", "example":10 }, "offset":{ "description":"The page number of this data. Starts at 0.", "type":"integer", "example":0 }, "limit":{ "description":"The maximum number of records returned on a page", "type":"integer", "example":10 }, "items":{ "description":"Nutrient records", "type":"array", "items":{ "$ref":"#/definitions/NutrientSetNutrient" } } } } } }, "x-internal-id":"config-sim-v2-menuItems-nutrientSets-getNutrients-post", "x-filename-id":"config-sim-v2-menuitems-nutrientsets-getnutrients-post" } }, "/config/sim/v2/menuItems/nutrientSets/nutrients":{ "post":{ "tags":[ "v2/Menu Items/Nutrient Sets/Nutrients" ], "summary":"Add Nutrient", "description":"Adds a nutrient to the nutrient set", "operationId":"createNutrientSetNutrient", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.NutrientSetNutrientInsertRequest" } ], "responses":{ "200":{ "description":"Nutrient inserted.", "schema":{ "type":"object", "properties":{ "nutrientSetNutrientId":{ "description":"Unique Id of the nutrient.", "type":"integer", "example":101 } } } } }, "x-internal-id":"config-sim-v2-menuItems-nutrientSets-nutrients-post", "x-filename-id":"config-sim-v2-menuitems-nutrientsets-nutrients-post" } }, "/config/sim/v2/menuItems/nutrientSets/deleteNutrients":{ "post":{ "tags":[ "v2/Menu Items/Nutrient Sets/Nutrients" ], "summary":"Delete Nutrient", "description":"Deletes a nutrient from the nutrient set", "operationId":"deleteNutrientSetNutrient", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.NutrientSetNutrientDeleteRequest" } ], "responses":{ "200":{ "description":"Nutrient deleted.", "schema":{ "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-menuItems-nutrientSets-deleteNutrients-post", "x-filename-id":"config-sim-v2-menuitems-nutrientsets-deletenutrients-post" } }, "/config/sim/v2/menuItems/nutrientSets/updateNutrients":{ "post":{ "tags":[ "v2/Menu Items/Nutrient Sets/Nutrients" ], "summary":"Update Nutrient", "description":"Updates an existing nutrient in the nutrient set", "operationId":"updateNutrientSetNutrient", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.NutrientSetNutrientUpdateRequest" } ], "responses":{ "200":{ "description":"Nutrient updated.", "schema":{ "type":"object", "properties":{ "nutrientSetNutrientId":{ "description":"Unique Id of the nutrient.", "type":"integer", "example":101 } } } } }, "x-internal-id":"config-sim-v2-menuItems-nutrientSets-updateNutrients-post", "x-filename-id":"config-sim-v2-menuitems-nutrientsets-updatenutrients-post" } }, "/config/sim/v1/setup/locales":{ "post":{ "tags":[ "v1/Setup/Locale" ], "summary":"Add Locales", "description":"Add Locales", "operationId":"AddLocales", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "in":"body", "name":"Request Body", "description":"Locale object of the organization", "required":true, "schema":{ "$ref":"#/definitions/Locale" } } ], "responses":{ "200":{ "description":"Locale record Added.", "schema":{ "$ref":"#/definitions/LocaleResponse" } } }, "x-internal-id":"config-sim-v1-setup-locales-post", "x-filename-id":"config-sim-v1-setup-locales-post" } }, "/config/sim/v2/setup/locales":{ "post":{ "tags":[ "v2/Setup/Locale" ], "summary":"Add Locales", "description":"Add Locales", "operationId":"AddLocalesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LocalesCUDRequestParametersv2" } ], "responses":{ "200":{ "description":"Locale record Added.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object Number of Locale" } } } } }, "x-internal-id":"config-sim-v2-setup-locales-post", "x-filename-id":"config-sim-v2-setup-locales-post" } }, "/config/sim/v1/setup/deleteLocales":{ "post":{ "tags":[ "v1/Setup/Locale" ], "summary":"Delete locales", "description":"Delete Locales", "operationId":"deleteLocales", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LocalesDeleteRequestParameters" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "$ref":"#/definitions/LocaleDeleteResponse" } } }, "x-internal-id":"config-sim-v1-setup-deleteLocales-post", "x-filename-id":"config-sim-v1-setup-deletelocales-post" } }, "/config/sim/v2/setup/deleteLocales":{ "post":{ "tags":[ "v2/Setup/Locale" ], "summary":"Delete locales", "description":"Delete Locales", "operationId":"deleteLocalesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LocalesDeleteRequestParameters" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteLocales-post", "x-filename-id":"config-sim-v2-setup-deletelocales-post" } }, "/config/sim/v1/setup/getLocales":{ "post":{ "tags":[ "v1/Setup/Locale" ], "summary":"Get Locales", "description":"Get Locales", "operationId":"getLocales", "parameters":[ { "$ref":"#/parameters/body.LocalesGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of Locales.", "schema":{ "$ref":"#/definitions/LocaleGetResponse" } } }, "x-internal-id":"config-sim-v1-setup-getLocales-post", "x-filename-id":"config-sim-v1-setup-getlocales-post" } }, "/config/sim/v2/setup/getLocales":{ "post":{ "tags":[ "v2/Setup/Locale" ], "summary":"Get Locales", "description":"Get Locales", "operationId":"getLocalesv2", "parameters":[ { "$ref":"#/parameters/body.LocalesGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of Locales.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Locale objects of the organization.", "items":{ "$ref":"#/definitions/Localesv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-setup-getLocales-post", "x-filename-id":"config-sim-v2-setup-getlocales-post" } }, "/config/sim/v1/setup/updateLocales":{ "post":{ "tags":[ "v1/Setup/Locale" ], "summary":"Update Locales", "description":"Update Locales", "operationId":"updateLocales", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "in":"body", "name":"Request Body", "description":"Locale object of the organization", "required":true, "schema":{ "$ref":"#/definitions/Locale" } } ], "responses":{ "200":{ "description":"Locale record Updated or Added.", "schema":{ "$ref":"#/definitions/LocaleResponse" } } }, "x-internal-id":"config-sim-v1-setup-updateLocales-post", "x-filename-id":"config-sim-v1-setup-updatelocales-post" } }, "/config/sim/v2/setup/updateLocales":{ "post":{ "tags":[ "v2/Setup/Locale" ], "summary":"Update Locales", "description":"Update Locales", "operationId":"updateLocalesv2", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.LocalesCUDRequestParametersv2" } ], "responses":{ "200":{ "description":"Locale record Updated.", "schema":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object Number of Locale" } } } } }, "x-internal-id":"config-sim-v2-setup-updateLocales-post", "x-filename-id":"config-sim-v2-setup-updatelocales-post" } }, "/config/sim/v1/bulkStatusRequest":{ "post":{ "tags":[ "v1/Other/Bulk Request Status" ], "summary":"Gets the status of a bulk processing request", "description":"Get the status for the bulk processing request ID provided", "operationId":"bulkUploadStatus", "parameters":[ { "$ref":"#/parameters/body.BulkProcessingStatusRequest" } ], "responses":{ "200":{ "description":"A response body containing the status of the bulk request", "schema":{ "$ref":"#/definitions/BulkProcessingStatusResponse" } } }, "x-internal-id":"config-sim-v1-bulkStatusRequest-post", "x-filename-id":"config-sim-v1-bulkstatusrequest-post" } }, "/config/sim/v2/bulkStatusRequest":{ "post":{ "tags":[ "v2/Other/Bulk Request Status" ], "summary":"Gets the status of a bulk processing request", "description":"Get the status for the bulk processing request ID provided", "operationId":"bulkUploadStatusv2", "parameters":[ { "$ref":"#/parameters/body.BulkProcessingStatusRequest" } ], "responses":{ "200":{ "description":"A response body containing the status of the bulk request", "schema":{ "type":"object", "description":"A response body containing the status of the bulk request", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The bulk processing request ID" }, "successRecordCount":{ "type":"integer", "example":5000, "description":"The count of successful records." }, "failedRecordCount":{ "type":"integer", "example":5000, "description":"The count of failed records." }, "message":{ "type":"string", "example":"Time taken to process the bulk request : 1012 is 2 seconds", "description":"A message giving details about the bulk request." }, "status":{ "type":"string", "example":"Completed", "description":"Bulk processing request ID status. Status can be one of the following :- Queued - To be processed, InProgress - Being processed, Completed - Processed successfully, CompletedWithErrors - Processing completed with some errors" }, "comments":{ "type":"string", "example":"Bulk Insert", "description":"The comments provided by the user while placing the bulk request." }, "response":{ "type":"array", "description":"The result for each object submitted in the bulk request", "items":{ "$ref":"#/definitions/BulkRecordsResponse" } } } } } }, "x-internal-id":"config-sim-v2-bulkStatusRequest-post", "x-filename-id":"config-sim-v2-bulkstatusrequest-post" } }, "/config/sim/v2/hierarchy/getZones2":{ "post":{ "tags":[ "v2/Hierarchy/Zones/Zones2" ], "summary":"Get Zones2", "description":"Gets a list of Zones2", "operationId":"getZones2", "parameters":[ { "$ref":"#/parameters/body.Zones2GetParameters" } ], "responses":{ "200":{ "description":"A Collection of Zones", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Zone2 objects.", "items":{ "$ref":"#/definitions/Zone2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-getZones2-post", "x-filename-id":"config-sim-v2-hierarchy-getzones2-post" } }, "/config/sim/v2/hierarchy/zones/getEMCModules":{ "post":{ "tags":[ "v2/Hierarchy/Zones/EMC Modules" ], "summary":"Get EMC Modules", "description":"Get the EMC Modules assigned to zones", "operationId":"getEMCModules", "parameters":[ { "$ref":"#/parameters/body.EMCModulesGetParameters" } ], "responses":{ "200":{ "description":"Success", "schema":{ "type":"object", "properties":{ "totalResults":{ "description":"Total number of records in the data set", "type":"integer", "example":100 }, "hasMore":{ "description":"Indicates whether there are additional pages of records", "type":"boolean", "example":true }, "count":{ "description":"Number of records returned on this page", "type":"integer", "example":10 }, "items":{ "description":"EMCModule records", "type":"array", "items":{ "$ref":"#/definitions/EMCModule" } }, "offset":{ "description":"The page number of this data. Starts at 0.", "type":"integer", "example":0 }, "limit":{ "description":"The maximum number of records returned on a page", "type":"integer", "example":10 } } } } }, "x-internal-id":"config-sim-v2-hierarchy-zones-getEMCModules-post", "x-filename-id":"config-sim-v2-hierarchy-zones-getemcmodules-post" } }, "/config/sim/v2/hierarchy/zones/enableEMCModules":{ "post":{ "tags":[ "v2/Hierarchy/Zones/EMC Modules" ], "summary":"Enable EMC Modules", "description":"Enable an EMC Module. Enabling EMCModule 1 for a hierStrucId disables all other EMCModules for that hierarchy structure.", "operationId":"enableEMCModules", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EMCModuleRequest" } ], "responses":{ "200":{ "description":"Enable operation executed successfully.", "schema":{ "properties":{ "hierStrucId":{ "type":"integer", "description":"Unique hierarchy structure value.", "example":1 }, "EMCModule":{ "description":"Enabled EMC Module", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-hierarchy-zones-enableEMCModules-post", "x-filename-id":"config-sim-v2-hierarchy-zones-enableemcmodules-post" } }, "/config/sim/v2/hierarchy/zones/disableEMCModules":{ "post":{ "tags":[ "v2/Hierarchy/Zones/EMC Modules" ], "summary":"Disable EMC Modules", "description":"Disable an EMC Module", "operationId":"disableEMCModules", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.EMCModuleRequest" } ], "responses":{ "200":{ "description":"Disable operation executed successfully.", "schema":{ "type":"object", "properties":{ "hierStrucId":{ "type":"integer", "description":"Unique hierarchy structure value.", "example":1 }, "EMCModule":{ "description":"Disabled EMC Module", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-hierarchy-zones-disableEMCModules-post", "x-filename-id":"config-sim-v2-hierarchy-zones-disableemcmodules-post" } }, "/config/sim/v2/hierarchy/zones/bulkEnableEMCModules":{ "post":{ "tags":[ "v2/Hierarchy/Zones/EMC Modules" ], "summary":"Bulk Enable EMC Modules", "description":"This endpoint is available from Simphony 19.9 and above. Refer to the Bulk Processing chapter for more details.", "operationId":"bulkEnableEMCModulesv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkEnableEMCModuleRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request.", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-zones-bulkEnableEMCModules-post", "x-filename-id":"config-sim-v2-hierarchy-zones-bulkenableemcmodules-post" } }, "/config/sim/v2/hierarchy/zones/bulkDisableEMCModules":{ "post":{ "tags":[ "v2/Hierarchy/Zones/EMC Modules" ], "summary":"Bulk Disable EMC Modules", "description":"This endpoint is available from Simphony 19.9 and above. Refer to the Bulk Processing chapter for more details.", "operationId":"bulkDisableEMCModulesv2", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkDisableEMCModuleRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request.", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-zones-bulkDisableEMCModules-post", "x-filename-id":"config-sim-v2-hierarchy-zones-bulkdisableemcmodules-post" } }, "/config/sim/v2/hierarchy/zones/nodes":{ "post":{ "tags":[ "v2/Hierarchy/Zones/Nodes" ], "summary":"Add Hierarchy Nodes", "description":"Add a Hierarchy Node of hierType 'Zone'", "operationId":"createNodes", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.NodeCreateRequest" } ], "responses":{ "200":{ "description":"Insert operation executed successfully.", "schema":{ "type":"object", "properties":{ "hierStrucId":{ "type":"integer", "description":"Unique hierarchy structure value.", "example":1 } } } } }, "x-internal-id":"config-sim-v2-hierarchy-zones-nodes-post", "x-filename-id":"config-sim-v2-hierarchy-zones-nodes-post" } }, "/config/sim/v2/hierarchy/zones/updateNodes":{ "post":{ "tags":[ "v2/Hierarchy/Zones/Nodes" ], "summary":"Update Hierarchy Nodes", "description":"Update a Hierarchy Node of hierType 'Zone'", "operationId":"updateHierarchyNodes", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.NodeUpdateRequest" } ], "responses":{ "200":{ "description":"Update operation executed successfully.", "schema":{ "properties":{ "hierStrucId":{ "type":"integer", "description":"Unique hierarchy structure value.", "example":1 } } } } }, "x-internal-id":"config-sim-v2-hierarchy-zones-updateNodes-post", "x-filename-id":"config-sim-v2-hierarchy-zones-updatenodes-post" } }, "/config/sim/v2/hierarchy/zones/deleteNodes":{ "post":{ "tags":[ "v2/Hierarchy/Zones/Nodes" ], "summary":"Delete Hierarchy Nodes", "description":"Delete a Hierarchy Node of hierType 'Zone' and nodeType 'Location' or 'RVC'. Deleting a Hierarchy Node of nodeType 'Location' deletes the RVCs of hierType 'Zone' underneath it.", "operationId":"deleteHierarchyNodes", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.NodeDeleteRequest" } ], "responses":{ "200":{ "description":"Delete operation executed successfully.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record(s) deleted" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-zones-deleteNodes-post", "x-filename-id":"config-sim-v2-hierarchy-zones-deletenodes-post" } }, "/config/sim/v2/hierarchy/zones/bulkInsertNodes":{ "post":{ "tags":[ "v2/Hierarchy/Zones/Nodes" ], "summary":"Bulk Insert Hierarchy Nodes", "description":"This endpoint is available from Simphony 19.9 and above. Refer to the Bulk Processing chapter for more details.", "operationId":"bulkInsertHierarchyNodes", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkUpdateNodeRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request.", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-zones-bulkInsertNodes-post", "x-filename-id":"config-sim-v2-hierarchy-zones-bulkinsertnodes-post" } }, "/config/sim/v2/hierarchy/zones/bulkUpdateNodes":{ "post":{ "tags":[ "v2/Hierarchy/Zones/Nodes" ], "summary":"Bulk Update Hierarchy Nodes", "description":"This endpoint is available from Simphony 19.9 and above. Refer to the Bulk Processing chapter for more details.", "operationId":"bulkUpdateHierarchyNodes", "consumes":[ "multipart/form-data" ], "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/header.BulkRequest-Comments" }, { "$ref":"#/parameters/formData.BulkUpdateNodeRequest" } ], "responses":{ "200":{ "description":"A response body for the submitted bulk request.", "schema":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } } } }, "x-internal-id":"config-sim-v2-hierarchy-zones-bulkUpdateNodes-post", "x-filename-id":"config-sim-v2-hierarchy-zones-bulkupdatenodes-post" } }, "/config/sim/v1/devices/getWorkstationClasses":{ "post":{ "tags":[ "v1/Devices/Workstation Classes" ], "summary":"Get Workstation Classes", "description":"Gets all the Workstation Class configured", "operationId":"getWorkstationClasses", "parameters":[ { "$ref":"#/parameters/body.WorkstationClassesGetParametersv1" } ], "responses":{ "200":{ "description":"A collection of workstation classes.", "schema":{ "$ref":"#/definitions/WorkstationClassGetResponsev1" } } }, "x-internal-id":"config-sim-v1-devices-getWorkstationClasses-post", "x-filename-id":"config-sim-v1-devices-getworkstationclasses-post" } }, "/config/sim/v2/devices/getWorkstationClasses":{ "post":{ "tags":[ "v2/Devices/Workstation Classes" ], "summary":"Get Workstation Classes", "description":"Gets all the Workstation Class configured", "operationId":"getWorkstationClassesv2", "parameters":[ { "$ref":"#/parameters/body.WorkstationClassesGetParametersv2" } ], "responses":{ "200":{ "description":"A collection of workstation classes.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Workstation Class objects of the organization.", "items":{ "$ref":"#/definitions/WorkstationClassv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } } } }, "x-internal-id":"config-sim-v2-devices-getWorkstationClasses-post", "x-filename-id":"config-sim-v2-devices-getworkstationclasses-post" } }, "/config/sim/v1/devices/workstationClasses":{ "post":{ "tags":[ "v1/Devices/Workstation Classes" ], "summary":"Add Workstation Classes", "description":"Add a Workstation Class record for the current organization.", "operationId":"addWorkstationClasses", "parameters":[ { "$ref":"#/parameters/body.WorkstationClassCUDRequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Workstation Class Added.", "schema":{ "$ref":"#/definitions/WorkstationClassMinimalBody" } } }, "x-internal-id":"config-sim-v1-devices-workstationClasses-post", "x-filename-id":"config-sim-v1-devices-workstationclasses-post" } }, "/config/sim/v2/devices/workstationClasses":{ "post":{ "tags":[ "v2/Devices/Workstation Classes" ], "summary":"Add Workstation Classes", "description":"Add a Workstation Class record for the current organization.", "operationId":"addWorkstationClassesv2", "parameters":[ { "$ref":"#/parameters/body.WorkstationClassCUDRequestv2" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Workstation class added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Workstation class", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-devices-workstationClasses-post", "x-filename-id":"config-sim-v2-devices-workstationclasses-post" } }, "/config/sim/v1/devices/updateWorkstationClasses":{ "post":{ "tags":[ "v1/Devices/Workstation Classes" ], "summary":"Update Workstation Classes", "description":"Updates a Workstation Class record for the current organization.", "operationId":"updateWorkstationClasses", "parameters":[ { "$ref":"#/parameters/body.WorkstationClassCUDRequest" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Workstation class Updated or Added.", "schema":{ "$ref":"#/definitions/WorkstationClassMinimalBody" } } }, "x-internal-id":"config-sim-v1-devices-updateWorkstationClasses-post", "x-filename-id":"config-sim-v1-devices-updateworkstationclasses-post" } }, "/config/sim/v2/devices/updateWorkstationClasses":{ "post":{ "tags":[ "v2/Devices/Workstation Classes" ], "summary":"Update Workstation Classes", "description":"Updates a Workstation Class record for the current organization.", "operationId":"updateWorkstationClassesv2", "parameters":[ { "$ref":"#/parameters/body.WorkstationClassCUDRequestv2" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Workstation class Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Workstation class", "type":"integer", "example":1 } } } } }, "x-internal-id":"config-sim-v2-devices-updateWorkstationClasses-post", "x-filename-id":"config-sim-v2-devices-updateworkstationclasses-post" } }, "/config/sim/v1/devices/deleteWorkstationClasses":{ "post":{ "tags":[ "v1/Devices/Workstation Classes" ], "summary":"Delete Workstation Classes", "description":"Deletes the Workstation Class object.", "operationId":"deleteWorkstationClasses", "parameters":[ { "$ref":"#/parameters/body.WorkstationClassBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v1-devices-deleteWorkstationClasses-post", "x-filename-id":"config-sim-v1-devices-deleteworkstationclasses-post" } }, "/config/sim/v2/devices/deleteWorkstationClasses":{ "post":{ "tags":[ "v2/Devices/Workstation Classes" ], "summary":"Delete Workstation Classes", "description":"Deletes the Workstation Class object.", "operationId":"deleteWorkstationClassesv2", "parameters":[ { "$ref":"#/parameters/body.WorkstationClassBody" }, { "$ref":"#/parameters/header.Simphony-AuditTrailRef" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-devices-deleteWorkstationClasses-post", "x-filename-id":"config-sim-v2-devices-deleteworkstationclasses-post" } }, "/config/sim/v2/setup/getDiningTables":{ "post":{ "tags":[ "v2/Setup/Dining Tables" ], "summary":"Get Dining Tables", "description":"Gets all the Dining Tables", "operationId":"getDiningTables", "parameters":[ { "$ref":"#/parameters/body.DiningTablesGetParameters" } ], "responses":{ "200":{ "description":"A collection of Dining Tables.", "schema":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of records in the data set" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Number of records returned on this page." }, "items":{ "type":"array", "description":"Dining Table records.", "items":{ "$ref":"#/definitions/DiningTable" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"The maximum number of records returned on a page" } } } } }, "x-internal-id":"config-sim-v2-setup-getDiningTables-post", "x-filename-id":"config-sim-v2-setup-getdiningtables-post" } }, "/config/sim/v2/setup/diningTables":{ "post":{ "tags":[ "v2/Setup/Dining Tables" ], "summary":"Add Dining Tables", "description":"Add Dining Table.", "operationId":"addDiningTables", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiningTablesCURequest" } ], "responses":{ "200":{ "description":"Dining Table Added.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Hier Unit Id of the RVC", "type":"integer", "example":7 }, "objectNum":{ "type":"integer", "example":2, "description":"Object number of the dining table" } } } } }, "x-internal-id":"config-sim-v2-setup-diningTables-post", "x-filename-id":"config-sim-v2-setup-diningtables-post" } }, "/config/sim/v2/setup/updateDiningTables":{ "post":{ "tags":[ "v2/Setup/Dining Tables" ], "summary":"Update Dining Tables", "description":"Updates Dining Tables.", "operationId":"updateDiningTables", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiningTablesCURequest" } ], "responses":{ "200":{ "description":"Dining Table Updated.", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Hier Unit Id of the RVC", "type":"integer", "example":7 }, "objectNum":{ "type":"integer", "example":2, "description":"Object number of the dining table" } } } } }, "x-internal-id":"config-sim-v2-setup-updateDiningTables-post", "x-filename-id":"config-sim-v2-setup-updatediningtables-post" } }, "/config/sim/v2/setup/deleteDiningTables":{ "post":{ "tags":[ "v2/Setup/Dining Tables" ], "summary":"Delete Dining Tables", "description":"Deletes Dining Table.", "operationId":"deleteDiningTables", "parameters":[ { "$ref":"#/parameters/header.Simphony-AuditTrailRef" }, { "$ref":"#/parameters/body.DiningTablesDeleteRequest" } ], "responses":{ "200":{ "description":"Message indicating the number of records deleted.", "schema":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } } } }, "x-internal-id":"config-sim-v2-setup-deleteDiningTables-post", "x-filename-id":"config-sim-v2-setup-deletediningtables-post" } } }, "parameters":{ "header.Simphony-AuditTrailRef":{ "name":"Simphony-AuditTrailRef", "in":"header", "description":"Detail that identifies, who made the change.", "type":"string" }, "body.OrderChannelCURequestBody":{ "name":"Request body", "in":"body", "description":"Order Channel Request Body for Create and Update Requests", "schema":{ "$ref":"#/definitions/OrderChannelCURequestBody" }, "required":true }, "body.OrderChannelCURequestBodyv2":{ "name":"Request body", "in":"body", "description":"Order Channel Request Body for Create and Update Requests", "schema":{ "description":"Order Channel Request Body for Create and Update Requests", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "objectNum":{ "type":"integer", "example":2, "description":"Object number of the Order Channel" }, "name":{ "type":"object", "description":"A string that contains translations into multiple languages\n", "example":{ "1":"Order Channel", "2":"Bestellkanal", "3":"Canal de pedidos" } }, "active":{ "type":"boolean", "example":true, "description":"A Boolean flag indicating the order channel is active" } } }, "required":true }, "body.OrderChannelGetParametersv1":{ "name":"Get Order Channel Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.OrderChannelGetParametersv2":{ "name":"Get Order Channel Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.MenuItemMasterEffectivityRequestBody":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "effectivityGroupObjNum", "menuItemMasterId", "hierUnitId" ], "properties":{ "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Menu item master effectivity group object number. Disable menu item at a store by setting it as -1." }, "hierUnitId":{ "type":"integer", "example":662, "description":"Unique hierarchy unit reference" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" } } } }, "body.MenuItemMasterEffectivityDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "menuItemMasterId", "hierUnitId" ], "properties":{ "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" }, "hierUnitId":{ "type":"integer", "example":662, "description":"Unique hierarchy unit reference" } } } }, "body.MenuItemMasterEffectivityGetParametersv1":{ "name":"Get MenuItem Master Effectivity Group Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.MenuItemMasterEffectivityGetParametersv2":{ "name":"Get MenuItem Master Effectivity Group Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.EmployeeRole":{ "name":"EmployeeRole", "in":"body", "description":"Employee Role Object", "required":true, "schema":{ "$ref":"#/definitions/EmployeeRolev1" } }, "body.EmployeeRolesGetParametersv1":{ "name":"Request Body", "in":"body", "description":"Request body", "schema":{ "description":"The input Body model that needs to be given.", "type":"object", "required":[ "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of employee" } } }, "required":true }, "body.EmployeeRolesGetParametersv2":{ "name":"Request Body", "in":"body", "description":"The input Body model that needs to be given.", "schema":{ "type":"object", "required":[ "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum, 1)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "objectNum":{ "type":"integer", "example":1 } } }, "required":true }, "body.EmployeeRoleUpdateRequest":{ "name":"Request Body", "in":"body", "description":"Employee Role Update Request body", "schema":{ "description":"Model for an Employee Role Update Request body.", "type":"object", "required":[ "objectNum", "hierUnitId", "roleObjNum", "roleEmployeeId" ], "properties":{ "objectNum":{ "description":"Unique reference of the employee in the system.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the employee role is configured", "type":"integer", "example":3599 }, "roleEmployeeId":{ "description":"Unique reference of Employee Role Association", "type":"integer", "example":1 }, "roleObjNum":{ "description":"The object number of the role assigned to the employee", "type":"integer", "example":1000 } } }, "required":true }, "body.EmployeeRoleInsertRequest":{ "name":"Request Body", "in":"body", "description":"Employee Role Insert Request body", "schema":{ "description":"Model for an Employee Role Insert Request body.", "type":"object", "required":[ "objectNum", "hierUnitId", "roleObjNum" ], "properties":{ "objectNum":{ "description":"Unique reference of the employee in the system.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the employee role is configured", "type":"integer", "example":3599 }, "roleObjNum":{ "description":"The object number of the role assigned to the employee", "type":"integer", "example":1000 } } }, "required":true }, "body.EmployeeRoleDeleteRequest":{ "name":"Request Body", "in":"body", "description":"Employee Role Delete Request body", "schema":{ "description":"Model for an Employee Role Delete Request body.", "type":"object", "required":[ "roleEmployeeId" ], "properties":{ "roleEmployeeId":{ "description":"Unique reference of Employee Role Association", "type":"integer", "example":1 } } }, "required":true }, "body.RolesResourceObject":{ "name":"Request body", "in":"body", "description":"Roles Resource Object", "schema":{ "$ref":"#/definitions/RolesResourceObjectv1" }, "required":true }, "body.RolesCURequestBody":{ "name":"Request body Insert/Update", "in":"body", "description":"Roles Resource Object", "schema":{ "$ref":"#/definitions/RolesCURequestBody" }, "required":true }, "body.RolesCURequestBodyv2":{ "name":"Request body Insert/Update", "in":"body", "description":"Roles Resource Object", "schema":{ "description":"Model for Roles Object", "type":"object", "required":[ "objectNum", "name" ], "properties":{ "objectNum":{ "description":"Object Number of the Role.", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Role Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "emcControlLevel":{ "type":"integer", "example":0, "description":"Security Level of the role." }, "comment":{ "type":"string", "example":"Comment", "description":"Description of the role in no more than 2000 characters" }, "emcModules":{ "description":"An array of privileges for access to EMC modules by the role", "type":"array", "items":{ "$ref":"#/definitions/Role_emcModuleCU" } }, "flmModules":{ "description":"An array of privileges for access to FLM modules by the role", "type":"array", "items":{ "$ref":"#/definitions/Role_flmModuleCU" } }, "actions":{ "description":"An array of enablement of actions that can be performed by the role's users", "type":"array", "items":{ "$ref":"#/definitions/Role_actionsCU" } }, "operations":{ "description":"An array of enablement of operations that can be performed by the role's users", "type":"array", "items":{ "$ref":"#/definitions/Role_operationsCU" } }, "visibility":{ "description":"An array of hierarchy units where the role is visible", "type":"array", "items":{ "$ref":"#/definitions/Role_visibilityCU" } }, "enableRVCLevelSecurity":{ "type":"boolean", "example":false, "description":"A Boolean flag to restrict employees with this role to perform workstation operations only in revenue centers in which they are an operator." }, "fields":{ "description":"An array of objects containing the access control to specific fields of the EMC module", "type":"array", "items":{ "$ref":"#/definitions/Role_fieldsCU" } }, "dataExtensions":{ "description":"An array of data extensions for the Roles", "type":"array", "items":{ "$ref":"#/definitions/Role_dataExtensionsCU" } } } }, "required":true }, "body.RolesGetParametersv1":{ "name":"Get Roles Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.RolesGetParametersv2":{ "name":"Get Roles Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.RolesDeleteRequest":{ "name":"Request Body", "in":"body", "description":"Roles Delete Request Body", "required":true, "schema":{ "type":"object", "required":[ "objectNum" ], "properties":{ "objectNum":{ "description":"Object Number of the Role.", "type":"integer", "example":2 } } } }, "body.HeadersTrailersResourceObject":{ "name":"Request body", "in":"body", "description":"Headers Trailers Resource Object", "schema":{ "$ref":"#/definitions/HeadersTrailersResourceObject" } }, "body.HeadersTrailersCURequestBody":{ "name":"Request body", "in":"body", "description":"Headers Trailers Request Body", "schema":{ "$ref":"#/definitions/HeadersTrailersCURequestBody" }, "required":true }, "body.HeadersTrailersCURequestBodyv2":{ "name":"Request body", "in":"body", "description":"Headers Trailers Request Body", "schema":{ "type":"object", "required":[ "hierUnitId", "lineNum", "descriptorTypeNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":6384, "description":"Unique hierarchy unit reference" }, "lineNum":{ "type":"integer", "example":1, "description":"Line Number of the Header/Trailer\n\n| descriptorTypeNum | Max Number of Lines Allowed |\n|-------------------|---------------------------------|\n| 1 | 6 |\n| 2 | 6 |\n| 3 | 3 | \n| 5 | 12 |\n| 7 | 6 |\n| 8 | 12 |\n| 37 | 6 |\n| 46 | 3 |\n| 47 | 12 |\n| 52 | 12 |\n| 53 | 12 |\n" }, "descriptorTypeNum":{ "type":"integer", "example":2, "description":"

    Descriptor Type Number assigned to the Header/Trailer

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    descriptorTypeNum descriptorTypeName
    1 Customer Receipt Header
    2 Check Header
    3 Training Header
    5 Check Trailer
    7 Credit Card Header
    8 Credit Card Trailer
    37 Autofire Check Offline Header
    46 Waste Header
    47 Waste Trailer
    52 Report Header
    53 Report Trailer
    \n" }, "useLogo":{ "type":"boolean", "example":true, "description":"Boolean flag for using either logoObjectNum(true) or text(false) for the specified lineNum. Automatically set to false if value is not specified." }, "text":{ "type":"object", "description":"A string that contains the text of a line in multiple languages.\n", "example":{ "1":"Please visit again!", "2":"Bitte schauen Sie noch einmal vorbei!", "3":"Por favor visite de nuevo!" } }, "logoObjectNum":{ "type":"integer", "example":1, "description":"Object Number of the logo." } } }, "required":true }, "body.HeadersTrailersGetParametersv1":{ "name":"Get Headers/Trailers Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.HeadersTrailersGetParametersv2":{ "name":"Get Headers/Trailers Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.HeadersTrailersDeleteRequest":{ "name":"Request Body", "in":"body", "description":"Order Type Delete Request Body", "schema":{ "type":"object", "required":[ "hierUnitId", "lineNum", "descriptorTypeNum" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "lineNum":{ "type":"integer", "example":2, "description":"Line Number of the Header/Trailer\n\n| descriptorTypeNum | Max Number of Lines Allowed |\n|-------------------|---------------------------------|\n| 1 | 6 |\n| 2 | 6 |\n| 3 | 3 | \n| 5 | 12 |\n| 7 | 6 |\n| 8 | 12 |\n| 37 | 6 |\n| 46 | 3 |\n| 47 | 12 |\n| 52 | 12 |\n| 53 | 12 |\n" }, "descriptorTypeNum":{ "type":"integer", "example":2, "description":"

    Descriptor Type Number assigned to the Header/Trailer

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    descriptorTypeNum descriptorTypeName
    1 Customer Receipt Header
    2 Check Header
    3 Training Header
    5 Check Trailer
    7 Credit Card Header
    8 Credit Card Trailer
    37 Autofire Check Offline Header
    46 Waste Header
    47 Waste Trailer
    52 Report Header
    53 Report Trailer
    \n" } } } }, "body.CMReceptacleTemplateGetParametersv1":{ "name":"Get Cash Management Receptacle Template Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.CMReceptacleTemplateGetParametersv2":{ "name":"Get Cash Management Receptacle Template Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.CMTemplateGetResponse":{ "name":"Request Body", "in":"body", "description":"CM Template complete object including read-only properties.", "required":true, "schema":{ "$ref":"#/definitions/CMTemplateGetResponse" } }, "body.CMTemplateDeleteBodyAndCUResponse":{ "name":"Request Body", "in":"body", "description":"CM Template Delete Request Body / Get Response", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "objectNum":{ "description":"Object number of the cash management template", "type":"integer", "example":1 } } } }, "body.CMTemplateRequestBody":{ "name":"Request Body", "in":"body", "description":"CM Template Insert and Update Request body", "required":true, "schema":{ "$ref":"#/definitions/CMTemplateRequestBody" } }, "body.CMTemplateRequestBodyv2":{ "name":"Request Body", "in":"body", "description":"CM Template Insert and Update Request body", "required":true, "schema":{ "description":"Model for Cash Management Template Object Insert and Update Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "objectNum":{ "description":"Object Number of the Cash Management Template.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Cash Management Template is configured. ", "type":"integer", "example":3599 }, "name":{ "description":"Cash Management Template Name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "description":{ "description":"Cash Management Template Description", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "recepatacleType":{ "description":"Type of receptacle template. Range=>[0-5]. Default type is 0. | Receptacle Type | Receptacle Name | |-----------------|-----------------| | 0 | None | | 1 | Safe | | 2 | Till | | 3 | Server Bank | | 4 | Bank Deposit | | 5 | Petty Cash |", "type":"integer", "example":1 }, "startingAmount":{ "description":"The initial currency value of the session upon opening. Range => [0 - 999999999999]. It only affects the behavior of types 2 and 3", "type":"integer", "example":10000 }, "startingAmountSourceObjNum":{ "description":"Determines where the starting amount for the session originates. The source receptacle session should be active session of type 1 - Safe. It only affects the behavior of types 2 and 3. Required for type 2.", "type":"integer", "example":1 }, "promptForStartingAmount":{ "description":"Select this option to prompt the workstation operator to enter the starting amount for the receptacle session upon opening. When you select this option, the application ignores the value in the starting amount field. It only affects the behavior of types 2 and 3.", "type":"boolean", "example":true }, "cashPullThresholdObjNum":{ "description":"Determines object number the Cash Pull Threshold Set that a receptacle session uses. It only affects the behavior of types 2 and 3.", "type":"integer", "example":1 }, "cashPullDestinationObjNum":{ "description":"Object number of destination receptacle into which funds from cash pull operations will transfer; if you select None, funds do not transfer and ownership remains with the receptacle session. It only affects the behavior of types 2 and 3.", "type":"integer", "example":1 }, "countSheetObjNum":{ "description":"Determines the Count Sheet object number that is used to count the receptacle. It only affects the behavior of types 1, 2 and 3 and 5.", "type":"integer", "example":1 }, "cashCountThresholdObjNum":{ "description":"Determines Cash Count Threshold Set Object number that a receptacle session uses. It only affects the behavior of types 1, 2 and 3 and 5.", "type":"integer", "example":1 }, "closeOnCountCompletion":{ "description":"Select this option to have the application attempt to automatically reconcile the receptacle session upon completion of the count. This process transfers funds from the receptacle session to the sessions designated under Starting Amount Source and Cash Deposit Routing to bring the session to zero. Deselect this option to leave the session open after the count completes. The workstation operator must then manually reconcile all funds and close the receptacle.It only affects the behavior of types 2 and 3.", "type":"boolean", "example":true }, "parLevelObjNum":{ "description":"Defines the object number of PAR Level Set (quantity to maintain of each currency denomination) to use for the safe session. It only affects the behavior of type 1.", "type":"integer", "example":1 }, "minimum":{ "description":"Determines the lowest amount of funds permitted as part of a receptacle session. If you do not set a minimum balance, the application defaults to 0. It only affects the behavior of type 5.", "type":"number", "example":10 }, "maximum":{ "description":"Determines the largest amount of funds permitted as part of a receptacle session. If you do not set a minimum balance, the application defaults to 0. It only affects the behavior of types 4 and 5.", "type":"number", "example":100 }, "cashDepositRoutingObjNum":{ "description":"Object number of the destination receptacle (safe or bank deposit) session to receive funds that transfer from a receptacle session as part of a cash deposit operation. It only affects the behavior of types 2 and 3", "type":"number", "example":1 }, "classDetails":{ "description":"Used to create additional currency classes (alternate currency such as Dollar, Peso, Euro, or Pounds, or non-currency such as gift cards) for a receptacle session or operation. You can add/ modify alternate classes for types 0, 2, 3, 4 and 5 only. You cannot add a duplicate class entry.", "type":"array", "items":{ "$ref":"#/definitions/ClassDetails" } }, "parLevels":{ "description":"Used to add additional PAR Levelsation. You can add/modify alternate PAR Levels for type 1 only. You cannot add a duplicate PAR Level entry.", "type":"array", "items":{ "$ref":"#/definitions/PARLevels" } }, "classExclusions":{ "description":"To specify currency classes that cannot be used in till(Type 2) and server bank(Type 3) receptacles created with the receptacle template. You cannot add a duplicate class exclusion entry.", "type":"array", "items":{ "$ref":"#/definitions/ClassExclusions" } } } } }, "body.AllergenNamesGetParameters":{ "name":"Get Record Parameters", "in":"body", "required":true, "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(allergenCode, 'Beef')", "description":"If specified, returns records that match the criteria. Allowed field is allergenCode." }, "include":{ "type":"string", "example":"hierUnitId, allergenCode", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order. Allowed field is allergenCode.", "example":"allergenCode:asc" } } } }, "body.AllergenNameDeleteRequest":{ "name":"Delete Request Parameters", "in":"body", "description":"Allergen Names delete request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "allergenId" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "allergenId":{ "type":"integer", "description":"Allergen Name ID", "example":1 } } } }, "body.AllergenNameInsertRequest":{ "name":"Insert Request Body", "in":"body", "description":"Allergen Names insert request body", "required":true, "schema":{ "description":"Model for Allergen Name Object Insert Request", "type":"object", "required":[ "hierUnitId", "name", "allergenCode" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the allergen is configured.", "type":"integer", "example":3599 }, "name":{ "description":"Allergen Name", "type":"object", "example":{ "1":"Apple", "2":"Pomme", "3":"Manzana" } }, "allergenCode":{ "description":"Allergen Code. It should be unique for any allergen and maximum allowed length of string is 128.", "type":"string", "example":"Apple" } } } }, "body.AllergenNameUpdateRequest":{ "name":"Update Request Body", "in":"body", "description":"Allergen Names update request body", "required":true, "schema":{ "description":"Model for Allergen Name Object Update Request", "type":"object", "required":[ "hierUnitId", "allergenId", "name", "allergenCode" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the allergen is configured.", "type":"integer", "example":3599 }, "allergenId":{ "description":"Allergen Id", "type":"integer", "example":364 }, "name":{ "description":"Allergen Name", "type":"object", "example":{ "1":"Apple", "2":"Pomme", "3":"Manzana" } }, "allergenCode":{ "description":"Allergen Code. It should be unique for any allergen and maximum allowed length of string is 128.", "type":"string", "example":"Apple" } } } }, "body.AuditTrailGetParameters":{ "name":"Get audit trail parameters", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria. Allowed fields are hierUnitId, hierStrucId, operation, subSystem, itemNumber, auditTrailId, fileNum and employeeObjNum." }, "include":{ "type":"string", "example":"hierUnitId, operation, fileNum", "description":"If specified, limits the data returned to these fields." }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order. Allowed fields are hierUnitId, hierStrucId, operation, subSystem, auditTime, itemNumber, auditTrailId, fileNum and employeeObjNum.", "example":"hierUnitId:asc" } } } }, "body.GetAvailableObjNumbersGetParameters":{ "name":"Request body", "in":"body", "description":"Request body for get available object numbers.", "schema":{ "type":"object", "required":[ "tag" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value. By default, the enterprise hierUnitId is used.", "example":1 }, "tag":{ "type":"string", "description":"Unique tag or insert endpoint of the object for which the available object numbers are requested. Refer to enum for allowed objects and the corresponding maximum values.", "enum":[ "employees: 999999999" ], "example":"employees/employees" }, "start":{ "type":"integer", "description":"Object number determining the starting position for getting the next object numbers.", "example":1, "default":1 }, "count":{ "type":"integer", "description":"Count of object numbers to be returned.", "example":1, "default":1 }, "startFromHighest":{ "type":"boolean", "description":"This can be used if you need to know the available object numbers after the highest value in use. If true, the value of start field is ignored.", "example":true, "default":false } } }, "required":true }, "body.SystemEmployeePropertyOperatorsGetParameters":{ "name":"Get Record Parameters", "in":"body", "required":true, "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectnum, 1792)", "description":"If specified, returns records that match the criteria. Allowed fields are objectNum and hierUnitId" }, "include":{ "type":"string", "example":"objectNum, hierUnitId", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order. Allowed fields are objectNum and hierUnitId", "example":"objectNum:asc" } } } }, "body.SystemEmployeePropertyOperatorDeleteRequest":{ "name":"Delete Request Parameters", "in":"body", "description":"System employee property operator delete request body", "required":true, "schema":{ "type":"object", "required":[ "objectNum", "hierUnitId" ], "properties":{ "objectNum":{ "description":"Object number of the system employee", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Hierarchy unit value of the associated operator", "type":"integer", "example":1 } } } }, "body.SystemEmployeePropertyOperatorCURequest":{ "name":"Insert Update Request Body", "in":"body", "description":"System Employee Property Operator insert and update request body", "required":true, "schema":{ "description":"Model for System Employee Property Operator Object Insert and Update Request", "type":"object", "required":[ "objectNum", "hierUnitId" ], "properties":{ "objectNum":{ "description":"Object number of the system employee.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Hierarchy unit value of operator associated with employee.", "type":"integer", "example":3599 }, "cashierObjNum":{ "description":"Object number of the cashier linked to the workstation operator..", "type":"integer", "example":1 } } } }, "body.FamilyGroupConsumerFacingContentGetParametersv1":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/FamilyGroupConsumerFacingContentGetRequest" } }, "body.FamilyGroupConsumerFacingContentGetParametersv2":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the family group", "type":"integer", "example":1 } } } }, "body.FamilyGroupConsumerFacingContentCUDRequestBody":{ "name":"FamilyGroup", "in":"body", "description":"Family Group Consumer Facing Content object of the organization", "required":true, "schema":{ "description":"Model for Family Group Facing Content Object", "type":"object", "required":[ "hierUnitId", "objectNum", "imageIndex" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the Family Group", "type":"integer", "example":1 }, "imageIndex":{ "description":"Number of the image. Values range from 1-10.", "type":"integer", "example":1 }, "title":{ "description":"Title of the image", "type":"string", "example":"Image of appetizers" }, "comments":{ "description":"Comment of the images.", "type":"string", "example":"Image of Appetizers" }, "size":{ "description":"The size of an image", "type":"string", "example":"Size: 12 kb, png: 100 x 100 px" } } } }, "body.FamilyGroupConsumerFacingContentDelete":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "imageIndex" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the family group", "type":"integer", "example":1 }, "imageIndex":{ "description":"Image number of the family group.", "type":"integer", "example":1 } } } }, "body.LanguageResourceObject":{ "name":"Request body", "in":"body", "description":"Language Resource Object", "schema":{ "$ref":"#/definitions/LanguageResourceObject" } }, "body.LanguageCUDRequest":{ "name":"Request body", "in":"body", "description":"Language Resource Object", "schema":{ "$ref":"#/definitions/LanguageCUDRequestBody" } }, "body.LanguageCUDRequestV2":{ "name":"Request body", "in":"body", "description":"Language Resource Object V2", "schema":{ "description":"Model for Language Object V2", "type":"object", "required":[ "objectNum", "name" ], "properties":{ "objectNum":{ "description":"Object Number of the language.", "type":"integer", "example":1 }, "name":{ "description":"name of the language", "type":"object", "example":{ "1":"US", "2":"de" } }, "reportFont":{ "type":"string", "description":"The font to use for the language in the Extensible Client local reports.", "example":"Microsoft Sans Serif" }, "reportFontSize":{ "type":"integer", "example":23, "description":"The font size to use for the language in the Extensible Client local reports." }, "customerDisplayFont":{ "description":"The font for the customer display.", "type":"string", "example":"Courier New" }, "textFileName":{ "description":"The file name that contains the translated version of the XML text files.", "type":"string", "example":"translations.xml" }, "keyboardLayoutObjNum":{ "description":"The object number of the keyboard layout", "type":"integer", "example":1033 }, "rightToLeftOrientation":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to have the check detail area and customer receipts appear in right-to-left orientation." }, "reverseWOrientation":{ "description":"A Boolean flag to using Hebrew language in printing. Setting this option will reverse the order of the characters in the word so that the words read correctly.", "type":"boolean", "example":false }, "customNumerals":{ "description":"The digit to print in place of the value shown. Leave blank to use the hard-coded values shown.", "type":"string", "example":"0123456789" }, "printOptions":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the print options associated with the language.", "type":"string", "example":"00000000" }, "mappingFont":{ "description":"Use Vmap for Thai and Japanese. Use Amap otherwise.", "type":"string", "example":"Amap" }, "localeId":{ "description":"Locale ID of the language. Refer to Language Codes under Additional Information chapter for more details.", "type":"integer", "example":1034, "default":1033 }, "compareFlag":{ "description":"This field is used for comparison of strings when strings are to be sorted.", "type":"integer", "example":1 }, "languageCulture":{ "description":"The abbreviated language code.", "type":"string", "example":"en-US" } } }, "required":true }, "body.LanguagesGetParametersv1":{ "name":"Get Languages Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.LanguagesGetParametersv2":{ "name":"Get Languages Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum, 1)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"objectNum:asc" } } } }, "body.LanguageDeleteRequest":{ "name":"Request Body", "in":"body", "description":"Language Delete Request Body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "objectNum":{ "description":"Object number of the language", "type":"integer", "example":2 } } } }, "body.WorkstationGetRequest":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "$ref":"#/definitions/WorkstationGetRequestBody" }, "required":true }, "body.WorkstationGetRequestv2":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "description":"The input Body model that needs to be given.", "type":"object", "required":[ "hierUnitId" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 } } }, "required":true }, "body.WorkstationCUDRequest":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "$ref":"#/definitions/WorkstationCUDRequestBody" }, "required":true }, "body.WorkstationCUDRequestv2":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name", "type" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the workstation", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Workstation Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "type":{ "description":"The type of the workstation.
    Description Value
    Mobile 1
    Workstation Client 2
    POSAPI Client 3
    Tablet Client 6
    Castle Device 7
    ", "type":"integer", "example":2 }, "languageObjNum":{ "description":"Object number of the default language for the workstation sign-on screen.", "type":"integer", "example":1 }, "paymentTerminalSerialNumber":{ "description":"Serial number of the paymentTerminal to be assigned to the workstation.", "type":"string", "example":"S1F2-000000000000000" }, "logVerbosity":{ "description":"The logging verbosity for the Workstation. Select 0 (zero) for minimal logging. Higher settings cause the workstation's disk or flash drive to fill more quickly.", "type":"integer", "example":0 }, "wsClassObjNum":{ "description":"Object number of the Workstation Class for this workstation.", "type":"integer", "example":0 }, "enableSTSGen1":{ "description":"A Boolean flag indicating to enable Simphony Transaction Services Gen 1 for the workstation", "type":"boolean", "example":false }, "enableSTSGen2Loc":{ "description":"A Boolean flag indicating to enable Simphony Transaction Services Gen 2 for location for the workstation", "type":"boolean", "example":false }, "enableSTSGen2Cloud":{ "description":"A Boolean flag indicating to enable Simphony Transaction Services Gen 2 for Cloud for the workstation", "type":"boolean", "example":false }, "svcHostID":{ "description":"The service host where the workstation application runs. It is auto-generated, except for workstation type 3. For type 3, the service host of existing workstation can be assigned.", "type":"integer", "example":17121 }, "hostName":{ "description":"The IP address or host name of the service host where the workstation application runs.", "type":"string", "example":"0.0.0.0" }, "subnetMask":{ "description":"The Subnet Mask of the service host where the workstation application runs.", "type":"string", "example":"0.0.0.0" }, "defaultGateway":{ "description":"The Default Gateway of the service host where the workstation application runs.", "type":"string", "example":"0.0.0.0" }, "isWindowsService":{ "description":"A Boolean flag indicating to run the service host as a Windows service (without GUI).", "type":"boolean", "example":false }, "dbUpdateFrequencyInSecs":{ "description":"The number of seconds the workstation waits to retrieve updates from the database. This field overrides the Property Parameters Database Update Frequency setting.", "type":"integer", "example":0 }, "checkInactivtyTimeoutInSecs":{ "description":"the number of seconds the workstation waits before showing a message (Do you need more time?), prompting the workstation operator to cancel the transaction. If set to 0, the prompt does not appear. If RVC Parameter Follow Me is enabled, the check is automatically suspended rather than canceled.", "type":"integer", "example":0 }, "chkInactiveDialogTimeoutInSecs":{ "description":"The number of seconds the workstation shows the Inactivity Dialog before automatically canceling the transaction. If set to 0, the transaction does not automatically cancel.", "type":"integer", "example":0 }, "reportTimeoutInSecs":{ "description":"The number of seconds the workstation waits to retrieve reporting information before failing. The gateway report service uses a separate timeout while waiting for a response from the Reporting and Analytics server.", "type":"integer", "example":0 }, "wlsStrengthOfflineThreshold":{ "description":"The percentage amount to be used to determine if communications should be suspended for wireless workstations, until network signal strength is improved.", "type":"integer", "example":0 }, "wlsStrengthReconnectThreshold":{ "description":"The percentage amount of signal strength to be used to determine at which point the system attempts to reconnect wireless workstations to the network. This setting must be a higher value than the Offline Threshold setting.", "type":"integer", "example":0 }, "reslCols":{ "description":"the number of resolution columns for the workstation's display. This must correspond to one of the resolutions defined in the workstation's INI file or leave it at 0 (zero) as a default.", "type":"integer", "example":0 }, "reslRows":{ "description":"the number of resolution rows for the workstation's display. This must correspond to one of the resolutions defined in the workstation's INI file or leave it at 0 (zero) as a default.", "type":"integer", "example":0 }, "locFromTop":{ "description":"Specify how far from the top (in pixels) the workstation window should be placed on the display screen.", "type":"integer", "example":0 }, "locFromLeft":{ "description":"Specify how far from the left (in pixels) the workstation window should be placed on the display screen.", "type":"integer", "example":0 }, "svcHosts":{ "description":"An array of services that are running on the workstation's service host", "type":"array", "items":{ "properties":{ "svcHostType":{ "description":"The Service Record Type for each service", "type":"string", "example":"Workstation" }, "port":{ "description":"The port number for each service on the selected service host.", "type":"string", "example":8080 } } } }, "minGuestCheckNum":{ "description":"the minimum check number to use when The workstation is in offline mode. The workstation is used in revenue centers without the RVC Parameters option Use Revenue Center Check Numbers. In these revenue centers, each workstation determines its own check number range.", "type":"integer", "example":1 }, "maxGuestCheckNum":{ "description":"the maximum check number to use when The workstation is in offline mode. The workstation is used in revenue centers without the RVC Parameters option Use Revenue Center Check Numbers. In these revenue centers, each workstation determines its own check number range.", "type":"integer", "example":99999999 }, "defltOrderTypeObjNum":{ "description":"Object number of the order type to remain active on the workstation, unless changed manually.", "type":"integer", "example":1 }, "barcodeFormatSetObjNum":{ "description":"Object number of the barcode format to use for the workstation.", "type":"integer", "example":0 }, "cashierLinkObjNum":{ "description":"Object number of the cashier record to link to the workstation. You must also select 8 - On = Link Cashier Totals to Workstation; Off = Link to Operator in the Workstations module.", "type":"integer", "example":0 }, "thaiTaxRDNum":{ "description":"The number to print on Thai Tax trailers. The name RD NUM must be included as part of the descriptor line to be printed in the trailer.", "type":"string", "example":"TU1" }, "cashDrawers":{ "description":"The number of cash drawers that are physically installed at this workstation. Maximum of 2 cash drawers can be installed at the workstation", "type":"integer", "example":0 }, "cdBeepTimeoutInSecs":{ "description":"The number of seconds the cash drawer can stay open before the workstation begins beeping. If set to 0, no beeping occurs. You must also select option 3 - Require Cash Drawer to be Closed Before New Transaction in the Workstations module.", "type":"integer", "example":0 }, "cdNotifyTimeoutInSecs":{ "description":"The number of seconds the cash drawer can stay opened before the workstation posts a message to the journal log. If set to 0, no message posts to the journal log. This function only works when Workstations option 3 - Require Cash Drawer to be Closed Before New Transaction is enabled.", "type":"integer", "example":0 }, "displayOptions":{ "description":"A string value of 0s & 1s of length 13 representing the enablement or disablement of the display options associated with the workstation", "type":"string", "example":"0000000000000" }, "securityOptions":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the security options associated with the workstation", "type":"string", "example":"00000000" }, "hardwareOptions":{ "description":"A string value of 0s & 1s of length 4 representing the enablement or disablement of the 4 hardware options associated with the workstation", "type":"string", "example":"0000" }, "cashDrawerOptions":{ "description":"A string value of 0s & 1s of length 4 representing the enablement or disablement of the cash drawer options associated with the workstation", "type":"string", "example":"0000" }, "offlineOptions":{ "description":"A string value of 0s & 1s of length 3 representing the enablement or disablement of the offline options associated with the workstation", "type":"string", "example":"000" }, "miscOptions":{ "description":"A string value of 0s & 1s of length 6 representing the enablement or disablement of the miscellaneous options associated with the workstation", "type":"string", "example":"000000" }, "enabledOrderDevices":{ "description":"A string of 0s and 1s of length 32 representing the enablement of the order devices outputs from the workstation", "type":"string", "example":"00000000000000000000000000000000" }, "routingGroups":{ "description":"An array of objects representing the routing groups associated with the workstation", "type":"array", "items":{ "properties":{ "routingGroupObjNum":{ "description":"Object number of the routing group", "type":"integer", "example":1 } } } }, "printJobConfiguration":{ "description":"A group of objects representing the printer configuration for the workstation", "type":"array", "items":{ "properties":{ "printerType":{ "description":"The type of the printer", "type":"integer", "example":1 }, "printerObjNum":{ "description":"Object number of the printer", "type":"integer", "example":1 }, "destPrinterGroupObjNum":{ "description":"Object number of the Printer Group to be displayed to allow a printer to be chosen.", "type":"integer", "example":1 } } } }, "revenueCenters":{ "description":"An array of revenue centers that are available from this workstation when signing on.", "type":"array", "items":{ "properties":{ "index":{ "description":"Index of the revenue center. There can be only a maximum of 8 revenue center available to a workstation. Index =1 indicates the default revenue center for the workstation", "type":"integer", "example":1 }, "rvcObjNum":{ "description":"Object number of the revenue center", "type":"integer", "example":1 } } } }, "devices":{ "description":"An array of peripheral devices associated with the workstation", "type":"array", "items":{ "required":[ "deviceNum" ], "properties":{ "deviceNum":{ "description":"Sequence number of the device", "type":"integer", "example":1 }, "deviceType":{ "description":"Type of the peripheral device. Valid device types are 1, 2, 3, 5, 8, 10, 12, 13, 14, 15, 16, 17, 18, 20.", "type":"integer", "example":1 }, "comPort":{ "description":"COM Port of the device", "type":"integer", "example":1 }, "baudRate":{ "description":"Baud Rate of the device.", "type":"integer", "example":9600 }, "parity":{ "description":"Parity of the device", "type":"string", "example":"N" }, "dataBits":{ "description":"Data bits of the device", "type":"integer", "example":8 }, "stopBits":{ "description":"Stop Bits of the device", "type":"integer", "example":2 }, "customDeviceSettingsConfig":{ "description":"Configuration parameters of the peripheral device", "type":"string", "example":"Custom Settings" }, "customDevice":{ "description":"Device type of the custom peripheral device", "type":"integer", "example":1 }, "progId":{ "description":"Prog Id of the custom peripheral device", "type":"string", "example":1 }, "configuration":{ "description":"Configuration parameters of the custom peripheral device", "type":"string", "example":"config" }, "clientCertCommonName":{ "description":"Client certificate common name of the payment interface", "type":"string", "example":"certificate" }, "clientCertEffectiveDt":{ "description":"Client Certificate effective date of the payment interface", "type":"string", "example":"2020-10-11" }, "clientCertExpDt":{ "description":"Expiration date of the client certificate of the payment interface", "type":"string", "example":"2020-10-11" }, "clientCertPassword":{ "description":"Client Certificate password", "type":"string", "example":"passw0rd" }, "deleteCertificate":{ "description":"A flag indicating if the certificates need to be deleted. Applicable for type=20 and for SPI only", "type":"boolean", "example":false }, "hostTimeoutInSecs":{ "description":"Timeout in seconds if request is abandoned", "type":"integer", "example":180 }, "clientCertificate":{ "description":"Client Certificate object. Applicable only for type=20 and SPI", "type":"string", "example":"Cert" }, "serverCertificate":{ "description":"Server certificate object", "type":"string", "example":"Cert" }, "primaryHost":{ "description":"URL of the endpoint. Format http(s)://host:port number", "type":"string", "example":"http://url.domain.com:443" }, "securitySettings":{ "description":"Security settings for the interface", "type":"integer", "example":1 }, "serverCertCommonName":{ "description":"Common name of the Server Certificate", "type":"string", "example":"certificate" }, "serverCertEffectiveDt":{ "description":"Effective date of the server certificate", "type":"string", "example":"2020-10-11" }, "serverCertExpDt":{ "description":"Expiration date of the server certificate", "type":"string", "example":"2020-10-11T00:00:00.000Z" }, "validateXMLAgainstSchema":{ "description":"A Boolean flag indicating if the XML message is validated against schema and log errors. Applicable only for type=20 and SPI", "type":"boolean", "example":false } } } }, "dataExtensions":{ "description":"An array of data extensions for the menu item", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } }, "defaultOrderChannelObjNum":{ "description":"Object number of the order channel to remain active on the workstation, unless changed manually.", "type":"integer", "example":1 } } }, "required":true }, "body.WorkstationResponse":{ "name":"WorkstationResponse", "in":"body", "description":"Workstation Response Object", "required":true, "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the workstation", "type":"integer", "example":1 } } } }, "body.Workstation":{ "name":"Workstation", "in":"body", "description":"Workstation Object", "required":true, "schema":{ "$ref":"#/definitions/Workstationv1" } }, "body.PrintClassesGetParametersv1":{ "description":"The input Body model that needs to be given.", "name":"Get Print Classes Method", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported.", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.PrintClassesGetParametersv2":{ "name":"Get Print Classes Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.PrintClassCUDRequest":{ "name":"Request body", "in":"body", "description":"Request Body", "schema":{ "$ref":"#/definitions/PrintClassCUDRequestBody" }, "required":true }, "body.PrintClassCUDRequestv2":{ "name":"Request body", "in":"body", "description":"Request Body", "schema":{ "description":"Model for Print CUD Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the print class is configured", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object Number of the Print Class.", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Print Class Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "options":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the Print Class", "type":"string", "example":"11010101" }, "routingGroupObjNum":{ "description":"Select the routing group to use for each print class if Routing Group Printing is enabled.", "type":"integer", "example":3 }, "orderDeviceOutput":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device output associated with the Print Class", "type":"string", "example":"11010101110101011101010111010101" }, "orderDeviceDisabled":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order devices associated with the Print Class", "type":"string", "example":"11010101110101011101010111010101" } } }, "required":true }, "body.PrintClass":{ "name":"Print Class", "in":"body", "description":"Print Class Object", "required":true, "schema":{ "$ref":"#/definitions/PrintClassv1" } }, "body.PrintClasses":{ "name":"Print Class", "in":"body", "description":"Print Class", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the printer", "type":"integer", "example":1 } } } }, "body.PrintLogosCURequest":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/PrintLogosCURequestBody" } }, "body.PrintLogosCURequestv2":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "description":"Model for Print Logos Object", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Print Logos is configured", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object Number of the Print Logos.", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Print Logos in configured languages", "type":"object", "example":{ "1":"Print Logos", "2":"Print Logos" } }, "size":{ "description":"The size of the image in bytes.Maximum file size - 2 MB", "type":"integer", "example":1 }, "filename":{ "description":"The name of the image file, including its extension. Supported extension - .bmp", "type":"string", "example":"ImageAppetizers.bmp" } } } }, "body.PrintLogosDelete":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Print Logos is configured", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object Number of the Print Logos.", "type":"integer", "example":1 } } } }, "body.PrintLogosGetParametersv1":{ "name":"Get Print Logos Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.PrintLogosGetParametersv2":{ "name":"Get Print Logos Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.NutrientSetGetParameters":{ "name":"Get Record Parameters", "in":"body", "required":true, "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum, 45)", "description":"If specified, returns records that match the criteria. Allowed fields are objectNum, name." }, "include":{ "type":"string", "example":"hierUnitId, objectNum", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order. Allowed fields are objectNum, name.", "example":"objectNum:asc" } } } }, "body.NutrientSetDeleteRequest":{ "name":"Delete Request Body", "in":"body", "description":"Nutrient set delete request body.", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit. Only Enterprise hierarchy is allowed.", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object number of the nutrient set.", "type":"integer", "example":10 } } } }, "body.NutrientSetInsertRequest":{ "name":"Insert Request Body", "in":"body", "description":"Nutrient set insert request body.", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit. Only Enterprise hierarchy is allowed.", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object number of the nutrient set.", "type":"integer", "example":10 }, "name":{ "type":"object", "description":"Name of the Nutrient Set", "example":{ "1":"Entp", "2":"Untm", "3":"Emp" } } } } }, "body.NutrientSetUpdateRequest":{ "name":"Update Request Body", "in":"body", "description":"Nutrient set update request body.", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit. Only Enterprise hierarchy is allowed.", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object number of the nutrient set.", "type":"integer", "example":10 }, "name":{ "type":"object", "description":"Name of the Nutrient Set", "example":{ "1":"Entp", "2":"Untm", "3":"Emp" } } } } }, "body.InstallStatusGetRequest":{ "name":"Get Record Parameters", "in":"body", "required":true, "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 1792)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"installStatusId:asc" } } } }, "body.PrintersGetParametersv1":{ "description":"The input Body model that needs to be given.", "name":"Get Printers Method", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported.", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.PrintersGetParametersv2":{ "name":"Get Printers Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.PrinterCUDRequest":{ "name":"Request body", "in":"body", "description":"A request body", "required":true, "schema":{ "$ref":"#/definitions/PrinterCUDRequestBody" } }, "body.PrinterCUDRequestv2":{ "name":"Request body", "in":"body", "description":"A request body", "required":true, "schema":{ "description":"Model for the Printer CUD Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Printer", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Printer in configured languages.", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "wsObjNum":{ "description":"Object number of the workstation to function as the print controller.", "type":"integer", "example":1 }, "printerType":{ "description":"The type of the printer. The value must lie between 1 and 16 (both inclusive).", "type":"integer", "example":1 }, "trailingLineFeeds":{ "description":"The number of trailing line feeds, normally used in guest check and customer receipt.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 6 representing the enablement or disablement of the options associated with the Printer", "type":"string", "example":"000000" }, "printerConfiguration":{ "$ref":"#/definitions/PrinterConfiguration" } } } }, "body.Printer":{ "name":"Printer", "in":"body", "description":"Printer Object", "required":true, "schema":{ "$ref":"#/definitions/Printersv1" } }, "body.PrinterResponse":{ "name":"PrinterResponse", "in":"body", "description":"Printer Response Object", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the printer", "type":"integer", "example":1 } } } }, "body.VersionInformationGetParametersv2":{ "name":"Get Version Information Method", "in":"body", "description":"The input Body model that needs to be given.", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } }, "required":true }, "body.VersionInformationGetParametersv1":{ "name":"Get Version Information Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.ParentEnterpriseLevelsGetParameters":{ "name":"Request body", "in":"body", "description":"Request body for get enterprise levels.", "schema":{ "description":"The input body model that needs to be given for get request.", "type":"object", "properties":{ "include":{ "type":"string", "example":"hierUnitId, objectNum", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 } } }, "required":true }, "body.WorkstationDeviceGetRequest":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "$ref":"#/definitions/WorkstationDeviceGetRequestBody" }, "required":true }, "body.WorkstationDeviceGetRequestv2":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "description":"The input Body model that needs to be given.", "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the workstation", "type":"integer", "example":1 } } }, "required":true }, "body.WorkstationDeviceCUDRequest":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "deviceNum", "deviceType", "progId" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the workstation", "type":"integer", "example":1 }, "deviceNum":{ "description":"Sequence number of the device", "type":"integer", "example":1 }, "deviceType":{ "description":"Type of the peripheral device", "type":"integer", "example":1 }, "comPort":{ "description":"COM Port of the device. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.", "type":"integer", "example":1 }, "baudRate":{ "description":"Baud Rate of the device. Allowed values - 1200, 2400, 4800, 9600, 19200, 38400. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.", "type":"integer", "example":9600 }, "parity":{ "description":"Parity of the device. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.", "type":"string", "example":"N" }, "dataBits":{ "description":"Data bits of the device. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.", "type":"integer", "example":1 }, "stopBits":{ "description":"Stop Bits of the device. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.", "type":"integer", "example":1 }, "customDeviceSettingsConfig":{ "description":"Configuration parameters of the peripheral device", "type":"string", "example":"Custom Settings" }, "customDevice":{ "description":"Device type of the custom peripheral device", "type":"integer", "example":1 }, "progId":{ "description":"Prog Id of the custom peripheral device", "type":"string", "example":"Micros.Devices.BarCodeReader.RS232" }, "configuration":{ "description":"Configuration parameters of the custom peripheral device", "type":"string", "example":"config" }, "clientCertCommonName":{ "description":"Client certificate common name of the payment interface", "type":"string", "example":"Certificate" }, "clientCertEffectiveDt":{ "description":"Client Certificate effective date of the payment interface", "type":"string", "example":"2020-10-11" }, "clientCertExpDt":{ "description":"Expiration date of the client certificate of the payment interface", "type":"string", "example":"2020-10-11" }, "clientCertPassword":{ "description":"Client Certificate password", "type":"string", "example":"password" }, "deleteCertificate":{ "description":"A flag indicating if the certificates need to be deleted. Applicable for type=20 and for SPI only.", "type":"boolean", "example":false }, "hostTimeoutInSecs":{ "description":"Timeout in seconds if request is abandoned. This is a required field for device type 20.", "type":"integer", "example":180 }, "clientCertificate":{ "description":"Client Certificate object. Applicable only for type=20 and SPI", "type":"string", "example":"Cert" }, "serverCertificate":{ "description":"Server certificate object", "type":"string", "example":"cert" }, "primaryHost":{ "description":"URL of the endpoint. Format http(s)://host:port number. This is a required field for device type 20.", "type":"string", "example":"http://url.domain.com:443" }, "securitySettings":{ "description":"Security settings for the interface. This is a required field for device type 20.", "type":"integer", "example":1 }, "serverCertCommonName":{ "description":"Common name of the Server Certificate", "type":"string", "example":"cert" }, "serverCertEffectiveDt":{ "description":"Effective date of the server certificate", "type":"string", "example":"2020-10-11" }, "serverCertExpDt":{ "description":"Expiration date of the server certificate", "type":"string", "example":"2020-10-11" }, "validateXMLAgainstSchema":{ "description":"A Boolean flag indicating if xml message is validated against schema and log errors. Applicable only for type=20 and SPI.", "type":"boolean", "example":false } } }, "required":true }, "body.WorkstationDevice":{ "name":"WorkstationDevice", "in":"body", "description":"Workstation Device Object", "required":true, "schema":{ "$ref":"#/definitions/WorkstationDevicev1" } }, "body.WorkstationDeviceResponse":{ "name":"WorkstationDeviceResponse", "in":"body", "description":"Workstation Device Response Object", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "deviceNum" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the workstation", "type":"integer", "example":1 }, "deviceNum":{ "description":"The sequence number of the device", "type":"integer", "example":1 } } } }, "body.OrderTypeParametersGetParametersv1":{ "name":"Get Order Type Parameters Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.OrderTypeParametersGetParametersv2":{ "name":"Get Order Type Parameters Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.OrderTypeParameterCUDRequest":{ "name":"Request Body", "in":"body", "description":"CUD Request Body", "schema":{ "$ref":"#/definitions/OrderTypeParameterCUDRequestBody" } }, "body.OrderTypeParameterCUDRequestv2":{ "name":"Request Body", "in":"body", "description":"CUD Request Body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the Order Type Parameter" }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s representing enabled or disabled options.
    Simphony Version Length of options
    19.8.x 16
    19.9.x 24
    " }, "taxMask":{ "type":"string", "example":"1000000000000000000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 64 representing the enablement or disablement of the tax mask associated with the Order Type parameter" }, "active":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating the order type is active" }, "orderDeviceMask":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device mask associated with the Order Type parameter" }, "kdsHighlightSchemeObjNum":{ "type":"integer", "example":0, "description":"Object number of the KDS Highlight Scheme to use for the order type parameter" }, "slaTime":{ "type":"integer", "example":0, "description":"Service Level Agreement Time" }, "tipPercent1":{ "type":"integer", "example":10, "description":"Guest Pay - Suggested Tip Percentage 1. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false." }, "tipPercent2":{ "type":"integer", "example":15, "description":"Guest Pay - Suggested Tip Percentage 2. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false." }, "tipPercent3":{ "type":"integer", "example":5, "description":"Guest Pay - Suggested Tip Percentage 3. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false." }, "tipAmount1":{ "type":"number", "example":21.22, "description":"Guest Pay - Suggested Tip Amount 1. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true." }, "tipAmount2":{ "type":"number", "example":4.87, "description":"Guest Pay - Suggested Tip Amount 2. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true." }, "tipAmount3":{ "type":"number", "example":51.11, "description":"Guest Pay - Suggested Tip Amount 3. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true." }, "guestCheckHeaderObjNum":{ "type":"integer", "example":2, "description":"Object Number of check header descriptor. It is available from Simphony version 19.8 and above." }, "guestCheckTrailerObjNum":{ "type":"integer", "example":2, "description":"Object Number of check trailer descriptor. It is available from Simphony version 19.8 and above." }, "receiptHeaderObjNum":{ "type":"integer", "example":2, "description":"Object Number of receipt header descriptor. It is available from Simphony version 19.8 and above." }, "defaultOrderChannelObjNum":{ "type":"integer", "example":2, "description":"Object Number of order channel. It is available from Simphony version 19.8 and above." } } } }, "body.OrderTypeParamterDeleteRequest":{ "name":"Request Body", "in":"body", "description":"Order Type Delete Request Body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the Order Type Parameter", "type":"integer", "example":2 } } }, "required":true }, "body.TextFileConfigurationInsertRequest":{ "name":"Request body", "in":"body", "description":"Text File Configuration Resource Object", "schema":{ "description":"Model for Text File Configuration Object V2", "type":"object", "required":[ "hierUnitId", "langId", "baseFileName" ], "properties":{ "hierUnitId":{ "description":"Hier Unit Id of the Enterprise", "type":"integer", "example":2 }, "langId":{ "description":"Unique identifier of the language", "type":"integer", "example":1 }, "baseFileName":{ "type":"string", "description":"Base File Name of the Text File Configuration.", "example":"CustomBaseFileName" }, "fileType":{ "type":"integer", "example":0, "default":0, "description":"

    File Type of the Text File Configuration. Valid range is [0 - 5].

    \n

    Use the corresponding file name from the below table as baseFileName for fileType ranging between [1 - 5]

    \n\n \n \n \n \n \n \n \n
    fileType baseFileName
    1 OpsText
    2 PosCoreText
    3 Micros.Payment.Cash
    4 Micros.Payment.MCreditDebit
    5 Micros.Payment.CreditDebit
    \n" } } }, "required":true }, "body.TextFileConfigurationUpdateRequest":{ "name":"Request body", "in":"body", "description":"Text File Configuration Resource Object", "schema":{ "description":"Model for Text File Configuration Object V2", "type":"object", "required":[ "hierUnitId", "langId", "baseFileName" ], "properties":{ "hierUnitId":{ "description":"Hier Unit Id of the Enterprise", "type":"integer", "example":2 }, "langId":{ "description":"Unique identifier of the language.", "type":"integer", "example":1 }, "baseFileName":{ "type":"string", "description":"Base File Name of the Text File Configuration.", "example":"Micros.Payment.Cash" } } }, "required":true }, "body.TextFileConfigurationsGetParameters":{ "name":"Get Record Parameters", "description":"Get Record Parameters.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(langId, 1)", "description":"If specified, returns records that match the criteria." }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"fileType:asc" } } } }, "body.TextFileConfigurationDeleteDownloadRequest":{ "name":"Request Body", "in":"body", "description":"Request Body.", "required":true, "schema":{ "type":"object", "required":[ "langId", "baseFileName" ], "properties":{ "langId":{ "description":"Unique identifier of the language.", "type":"integer", "example":1 }, "baseFileName":{ "description":"Base File Name of the Text File Configuration.", "type":"string", "example":"Micros.Payment.Cash" } } } }, "body.OrderChannelParametersGetParametersv1":{ "name":"Get Order Channel Parameters Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.OrderChannelParametersGetParametersv2":{ "name":"Get Order Channel Parameters Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.OrderChannelParamterDeleteRequest":{ "name":"Request Body", "in":"body", "description":"Order Channel Parameter Delete Request Body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit reference", "example":1 }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Order Channel Parameter" } } }, "required":true }, "body.OrderChannelParametersCURequestBody":{ "name":"Request body", "in":"body", "description":"Order Channel Parameters Request Body for Create and Update requests.", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "orderChannelId" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Order Channel Parameter" }, "orderChannelId":{ "type":"integer", "example":1, "description":"Unique reference of the Order Channel" }, "options":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing enabled or disabled options" }, "active":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating the order channel is active" }, "orderDeviceMask":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device mask associated with the Order Channel parameter" } } }, "required":true }, "body.OrderChannelParametersCURequestBodyv2":{ "name":"Request body", "in":"body", "description":"Order Channel Parameters Request Body for Create and Update requests.", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "orderChannelId" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Order Channel Parameter" }, "orderChannelId":{ "type":"integer", "example":1, "description":"Unique reference of the Order Channel" }, "options":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing enabled or disabled options" }, "active":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating the order channel is active" }, "guestCheckHeaderObjNum":{ "type":"integer", "example":2, "description":"Object Number of check header descriptor. It is available from Simphony version 19.8 and above." }, "guestCheckTrailerObjNum":{ "type":"integer", "example":2, "description":"Object Number of check trailer descriptor. It is available from Simphony version 19.8 and above." }, "receiptHeaderObjNum":{ "type":"integer", "example":2, "description":"Object Number of receipt header descriptor. It is available from Simphony version 19.8 and above." }, "slaTime":{ "type":"integer", "example":10, "description":"Service Level Agreement Time. Allowed values are from 0-999. It is available from Simphony version 19.8 and above." }, "orderDeviceMask":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device mask associated with the Order Channel parameter" } } }, "required":true }, "body.MenuItemDefinitionDefaultCondimentGetParametersv1":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/DefaultCondimentGetRequestBody" } }, "body.MenuItemDefinitionDefaultCondimentGetParametersv2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "miMstrObjNum", "miDefSequence" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "miMstrObjNum":{ "type":"integer", "example":1, "description":"Object Number of the menu item master for which the condiments are associated." }, "miDefSequence":{ "type":"integer", "example":1, "description":"Sequence number of the menu item definition to which the condiments are associated" } } } }, "body.defaultcondimentInsertRequestBody":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "miMstrObjNum", "miDefSequence" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "miMstrObjNum":{ "type":"integer", "example":1, "description":"Object Number of the menu item master for which the condiments are associated." }, "miDefSequence":{ "type":"integer", "example":1, "description":"Sequence number of the menu item definition to which the condiments are associated" }, "condimentSetObjNum":{ "type":"integer", "example":1, "description":"Object number of the Condiment Set items that are to be assigned as the default condiments when the associated Menu Item is ordered." }, "sortGroup":{ "type":"integer", "example":1, "description":"Sort Group number for the Condiment Set." }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment set associated with the menu item" } }, "description":"Model for a Default Condiment Object" } }, "body.defaultcondimentUpdateRequestBody":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "miMstrObjNum", "miDefSequence" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "miMstrObjNum":{ "type":"integer", "example":1, "description":"Object Number of the menu item master for which the condiments are associated." }, "miDefSequence":{ "type":"integer", "example":1, "description":"Sequence number of the menu item definition to which the condiments are associated" }, "menuItemDefaultCondimentId":{ "type":"integer", "example":1000, "description":"Unique reference of the Menu Item Default Condiment" }, "condimentSetObjNum":{ "type":"integer", "example":1, "description":"Object number of the Condiment Set items that are to be assigned as the default condiments when the associated Menu Item is ordered." }, "sortGroup":{ "type":"integer", "example":1, "description":"Sort Group number for the Condiment Set." }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment set associated with the menu item" } }, "description":"Model for a Default Condiment Object" } }, "body.DefaultCondimentDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "miMstrObjNum", "miDefSequence", "menuItemDefaultCondimentId" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "miMstrObjNum":{ "type":"integer", "example":1, "description":"Object Number of the menu item master for which the condiments are associated." }, "miDefSequence":{ "type":"integer", "example":1, "description":"Sequence number of the menu item definition to which the condiments are associated" }, "menuItemDefaultCondimentId":{ "type":"integer", "example":1000, "description":"Unique reference of the Menu Item Default Condiment" } } } }, "header.BulkRequest-Comments":{ "name":"Comments", "in":"header", "description":"Bulk Request Comment.", "type":"string" }, "body.MenuItemGroupDetailsGetParametersv1":{ "name":"Get Menu Item Group Details Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.MenuItemGroupDetailsGetParametersv2":{ "name":"Get Menu Item Group Details Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.MenuItemGroupDetailCURequestBody":{ "in":"body", "name":"Request Body", "description":"A Request body for Menu Item Group", "required":true, "schema":{ "type":"object", "required":[ "menuItemGroupObjNum", "hierUnitId", "seq", "exclude" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "menuItemGroupObjNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "seq":{ "type":"integer", "example":1, "description":"Sequence number of the Menu Item Group Detail entry. Value must lie between 1 and 32767." }, "type":{ "type":"integer", "example":1, "description":"Group type to include or exclude for the Menu Item Group Detail entry\n\n**Below is a list of accetable values for this field**\n| # | Type Description|\n|---------------|-----------------|\n| 0 | None |\n| 1 | All |\n| 2 | By Major Group |\n| 3 | By Family Group |\n| 4 | By Menu Item |\n" }, "exclude":{ "type":"boolean", "example":false, "description":"Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not active" }, "startObjNum":{ "type":"integer", "example":1, "description":"Starting object number for the selected type" }, "endObjNum":{ "type":"integer", "example":100, "description":"Ending object number for the selected type" }, "overridePricePercent":{ "type":"number", "example":10.5, "description":"Indicates the amount off, percent off, or amount substitution based on the discount configuration. This is only active for Group Type 1- Discount when exclude is set to false." } } } }, "body.MenuItemGroupDetailDeleteRequest":{ "in":"body", "name":"Request Body", "description":"A Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "menuItemGroupObjNum", "seq", "exclude" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "menuItemGroupObjNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "seq":{ "type":"integer", "example":1, "description":"Sequence number of the Menu Item Group Detail entry. Value must lie between 1 and 32767." }, "exclude":{ "type":"boolean", "example":false, "description":"Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not active" } } } }, "formData.BulkInsertMenuItemGroupDetailRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for inserting Menu Item Group Details in bulk", "type":"file", "required":true }, "formData.BulkUpdateMenuItemGroupDetailRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for updating Menu Item Group Details in bulk", "type":"file", "required":true }, "body.CurrencyConversionGetParametersv1":{ "name":"Get Currency Conversion Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.CurrencyConversionGetParametersv2":{ "name":"Get Currency Conversion Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.CUDCurrencyConversionRequest":{ "name":"Request body", "in":"body", "description":"A CUD request body", "schema":{ "description":"Model for Currency Conversion CUD Request", "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "objectNum":{ "description":"Object number of the currency conversion.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Currency Conversion is configured", "type":"integer", "example":3599 }, "currencyObjectNum":{ "description":"Object number of the currency.", "type":"integer", "example":31 }, "conversionCurrencyObjectNum":{ "description":"Object number of the conversion currency.", "type":"integer", "example":31 }, "rate":{ "description":"Rate of conversion between currency and conversion currency", "type":"number", "example":1.3 } } }, "required":true }, "body.DeleteRequestBody":{ "name":"Delete Request body", "in":"body", "description":"Delete request body.", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Currency Conversion", "type":"integer", "example":1 } } }, "required":true }, "body.CurrencyAvailabilityGetParametersv1":{ "name":"Get Currency Availibilty Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.CurrencyAvailabilityGetParametersv2":{ "name":"Get Currency Availibility Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.CUDCurrencyAvailabilityRequest":{ "name":"Request body", "in":"body", "description":"A CUD request body", "schema":{ "description":"Model for Currency Availability CUD Request", "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object number of the currency availability.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currency availability", "type":"string", "example":"11010101" }, "currencyObjectNum":{ "description":"Object number of the currency.", "type":"integer", "example":1 } } }, "required":true }, "body.DeleteCurrencyAvailabilityRequestBody":{ "name":"Delete Request body", "in":"body", "description":"Delete request body.", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Currency Availability", "type":"integer", "example":1 } } }, "required":true }, "body.CreateCloneRequest":{ "name":"Request body", "in":"body", "description":"A Clone request", "schema":{ "$ref":"#/definitions/CreateCloneRequest" }, "required":true }, "body.RequestDetails":{ "name":"Request Details", "in":"body", "description":"Request body for getStatus.", "schema":{ "$ref":"#/definitions/RequestDetails" } }, "formdata.ConfigDataFile":{ "name":"configDataFile", "in":"formData", "description":"The config data file. Required if importType is 1.
    \nExample: extract23101.zip\n", "type":"file" }, "formdata.ConfigFileURL":{ "name":"configFileURL", "description":"The pre-authenticated URL of the object store from where the configuration can be cloned. Required if importType is 2.
    \nExample: \"https://objectstorage.us-ashburn-1.oraclecloud.com/n/idvvfekwvhut/b/extract23101.zip\"\n", "in":"formData", "type":"string" }, "formdata.ImportType":{ "name":"importType", "in":"formData", "description":"The type of file for import.
    \nExample: 1\n", "type":"integer", "required":true }, "body.TagGroupsGetParametersv1":{ "name":"Get Tag Groups Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.TagGroupsGetParametersv2":{ "name":"Get Tag Groups Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.TagGroups":{ "name":"Request Body", "in":"body", "description":"Tag Group Object", "required":true, "schema":{ "description":"Model for Tag Groups Object", "type":"object", "required":[ "objectNum", "hierUnitId", "tagGroupName" ], "properties":{ "objectNum":{ "description":"Object Number of the Tag Groups.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Tag Groups is configured. Only root hierUnitId is allowed.", "type":"integer", "example":3599 }, "tagGroupName":{ "description":"A string representing the name of the Tag Group", "type":"string", "example":"Tag Group 1" } } } }, "body.TagGroupsDelete":{ "name":"Request Body", "in":"body", "description":"Tag Groups Delete Request Body", "required":true, "schema":{ "description":"Model for Tag Groups Object", "type":"object", "required":[ "objectNum", "hierUnitId" ], "properties":{ "objectNum":{ "description":"Object Number of the Tag Groups.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Tag Groups is configured. Only root hierUnitId is allowed.", "type":"integer", "example":3599 } } } }, "body.MenuItemGroupsGetParametersv1":{ "name":"Get Menu Item Groups Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.MenuItemGroupsGetParametersv2":{ "name":"Get Menu Item Groups Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.MenuItemGroup":{ "in":"body", "name":"Request Body", "description":"A Request body for Menu Item Group", "required":true, "schema":{ "$ref":"#/definitions/MenuItemGroup" } }, "body.MenuItemGroupCUDRequest":{ "in":"body", "name":"Request Body", "description":"A Request body for Menu Item Group", "required":true, "schema":{ "$ref":"#/definitions/MenuItemGroupCUDRequestBody" } }, "body.MenuItemGroupCUDRequestv2":{ "in":"body", "name":"Request Body", "description":"A Request body for Menu Item Group", "required":true, "schema":{ "type":"object", "required":[ "objectNum", "hierUnitId", "name" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "name":{ "type":"object", "description":"A string that contains translations into multiple languages", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "groupType":{ "type":"integer", "example":1, "description":"Group Type of Menu Item Group" }, "thresholdQty":{ "type":"integer", "example":2, "description":"Specifies the threshold quantity for applying overriden tax class" }, "taxClassObjNum":{ "type":"integer", "example":2, "description":"Specifies the tax class override for the threshold quantity" }, "detail":{ "type":"array", "description":"An array of menu items to be included/excluded in the defined group", "items":{ "type":"object", "properties":{ "seq":{ "type":"integer", "example":1, "description":"Sequence number of the Menu Item Group Detail entry" }, "type":{ "type":"integer", "example":1, "description":"Group type to include or exclude for the Menu Item Group Detail entry\n\n**Below is a list of accetable values for this field**\n| # | Type Description|\n|---------------|-----------------|\n| 0 | None |\n| 1 | All |\n| 2 | By Major Group |\n| 3 | By Family Group |\n| 4 | By Menu Item |\n" }, "exclude":{ "type":"boolean", "example":false, "description":"Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not active" }, "startObjNum":{ "type":"integer", "example":1, "description":"Starting object number for the selected type" }, "endObjNum":{ "type":"integer", "example":100, "description":"Ending object number for the selected type" }, "overridePricePercent":{ "type":"number", "example":10.5, "description":"Indicates the amount off, percent off, or amount substitution based on the discount configuration. This is only active for Group Type 1- Discount when exclude is set to false." } } } } } } }, "body.MenuItemGroupDeleteRequest":{ "in":"body", "name":"Request Body", "description":"A Request body", "required":true, "schema":{ "type":"object", "required":[ "objectNum", "hierUnitId" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" } } } }, "formData.BulkInsertMenuItemGroupRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for inserting Menu Item Groups in bulk", "type":"file", "required":true }, "formData.BulkUpdateMenuItemGroupRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for updating Menu Item Groups in bulk", "type":"file", "required":true }, "body.MenuItemMasterGroupGetParametersv1":{ "name":"Get Menu Item Master Effectivity Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.MenuItemMasterGroupGetParametersv2":{ "name":"Get Menu Item Master Effectivity Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.MenuItemMasterGroup":{ "in":"body", "name":"Request Body", "description":"A Request body for Menu Item Master Group", "required":true, "schema":{ "$ref":"#/definitions/MenuItemMasterGroup" } }, "body.MenuItemMasterGroupCUDRequest":{ "in":"body", "name":"Request Body", "description":"A CUD Request body for Menu Item Master Group", "required":true, "schema":{ "$ref":"#/definitions/MenuItemMasterGroupCUDRequestBody" } }, "body.MenuItemMasterGroupCUDRequestv2":{ "in":"body", "name":"Request Body", "description":"A CUD Request body for Menu Item Master Group", "required":true, "schema":{ "type":"object", "required":[ "objectNum", "hierUnitId", "name" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "name":{ "type":"object", "description":"A string that contains translations into multiple languages\n", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "sluObjNum":{ "type":"integer", "example":4, "description":"Associated SLU index. Valid range is between 1 and 32. By default, it is null." } } } }, "body.MenuItemMasterGroupDeleteRequest.Required":{ "in":"body", "name":"Request Body", "description":"A Request body", "required":true, "schema":{ "type":"object", "required":[ "objectNum", "hierUnitId" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" } } } }, "body.SPIServerCertificateCURequest":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "deviceNum", "fileName" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the workstation" }, "deviceNum":{ "type":"integer", "example":1, "description":"Sequence number of the device" }, "size":{ "type":"integer", "example":72534, "description":"The size of the certificate file in bytes." }, "fileName":{ "type":"string", "example":"ServerCertificate.xml", "description":"The name of the server certificate file with extension." } } } }, "body.SPIServerCertificateDeleteRequest":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "deviceNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the workstation" }, "deviceNum":{ "type":"integer", "example":1, "description":"Sequence number of the device" } } } }, "body.SPIClientCertificateCURequest":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "deviceNum", "fileName", "passKey" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the workstation" }, "deviceNum":{ "type":"integer", "example":1, "description":"Sequence number of the device" }, "size":{ "type":"integer", "example":72534, "description":"The size of the certificate file in bytes." }, "fileName":{ "type":"string", "example":"ClientCertificate.xml", "description":"The name of the client certificate file with extension." }, "passKey":{ "type":"string", "example":"pass@123", "description":"The password for the client certificate file." } } } }, "body.SPIClientCertificateDeleteRequest":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "deviceNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the workstation" }, "deviceNum":{ "type":"integer", "example":1, "description":"Sequence number of the device" } } } }, "body.TenderMediaGetParametersv1":{ "name":"Get Tender Media Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.TenderMediaGetParametersv2":{ "name":"Get Tender Media Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.TenderMediaCURequestBody":{ "name":"Tender Media", "in":"body", "description":"Tender Media Object", "required":true, "schema":{ "$ref":"#/definitions/TenderMediaCURequestBody" } }, "body.TenderMediaCURequestBodyv2":{ "name":"Tender Media", "in":"body", "description":"Tender Media Object", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the tender media", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Tender Media in configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "effGrpObjNum":{ "description":"Effectivity Group object number", "type":"integer", "example":1 }, "consumerDisplayName":{ "description":"A group of string objects representing the consumer display name of the Tender Media in configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "privilegeGroup":{ "description":"Select a privilege group (0-3) to restrict this Tender/Media to only employees who are assigned to the same privilege group. Set to 0 to allow all employees to use the tender.", "type":"integer", "example":1 }, "reportGroupObjnum":{ "description":"Object number of the Report Group to which this Tender/Media record belongs.", "type":"integer", "example":1 }, "printClassObjNum":{ "description":"Object number of the Print Class for the Tender Media.", "type":"integer", "example":1 }, "belowThresholdPrintClassObjNum":{ "description":"Object number of the Print Class for the Tender Media when the check total amount is less than the RVC Order Routing Threshold Amount, in this case it will override the Print Class of the Tender Media.", "type":"integer", "example":1 }, "tmSLUNum":{ "description":"Object number the Screen Lookup key on which to show the Tender/Media.Applicable only for keyType = 2 / 3 / 4", "type":"integer", "example":1 }, "nlu":{ "description":"A unique NLU number (0-255) for this Tender/Media record", "type":"integer", "example":1 }, "keyType":{ "description":"The Key Type for this Tender/Media. 1 - Payment 2 - Service Total 3 - Pickup 4 - Loan. The default value for keyType is 1.", "type":"integer", "example":1 }, "srmPaymentType":{ "description":"The SRM Payment Type for the Tender/Media 0 - None 1 - ARG 2 - CRE 3 - DEB 4 - AUT 5 - PKG", "type":"integer", "example":1 }, "printOptions":{ "description":"A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the print options associated with Tender Media", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "interfaceOptions":{ "description":"An object containing the interface link and options associated with the Tender / Media", "type":"object", "properties":{ "interfaceLinkNum":{ "description":"Object number of the interface", "type":"integer", "example":1 }, "options":{ "description":"A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the interface options associated with Tender Media", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" } } }, "creditCardOptions":{ "description":"An object containing the credit card options associated with the Tender / Media", "type":"object", "properties":{ "estimatedTipPercent":{ "description":"The percentage amount (above the check amount) to authorize. Use this field to obtain an authorization that includes the potential tip amount. Override this setting at the revenue center by selecting Do Not Estimate Tips of Credit Card Authorizations.", "type":"number", "example":0 }, "baseLimit":{ "description":"The amount that can be charged on a credit card before sending an authorization request to a credit card processor.", "type":"number", "example":0 }, "secondLimit":{ "description":"The amount above the initial authorization that must be exceeded before a second authorization is required. You must also select the credit card option Use Amount Secondary Floor Limits in the RVC Parameters module", "type":"number", "example":0 }, "secondLimitPercent":{ "description":"The percentage above the initial authorization amount that must be exceeded before a second authorization is required. You must also select the credit card option Use Percent Secondary Floor Limits in the RVC Parameters module.", "type":"number", "example":0 }, "initialAuthAmt":{ "description":"A charge amount to be authorized before sales begin. Enter 0.00 to prompt for an amount. This field is used at sites that require a credit card to have a certain amount available, so the workstation operator can begin a tab.", "type":"number", "example":0 }, "offlineEstTipPercent":{ "description":"The percentage amount (above the check amount) to authorize. Use this field to obtain an authorization that includes the potential tip amount. Override this setting at the revenue center by selecting Do Not Estimate Tips of Credit Card Authorizations.", "type":"number", "example":0 }, "unAuthorizedAuthThreshold":{ "description":"The limit for which credit cards are considered to have a good authorization when the workstation is offline. When this limit is exceeded, only employees with the Role privilege to exceed the threshold can pay transactions.", "type":"number", "example":0 }, "caOfflineLimit":{ "description":"The limit for which credit cards are considered to have a good authorization when the credit card service is offline. You must also select Use CA Offline Base Limit when CA Offline in the RVC Parameters module", "type":"number", "example":0 }, "noSignatureLimit":{ "description":"the amount to be charged on a credit card before a voucher includes a signature line.", "type":"number", "example":0 }, "quickServiceLimit":{ "description":"The amount that is checked by the system to determine if credit card vouchers are printed or not if Quick Service Transactions are enabled for an RVC (RVC Parameters Option 18 Enable Quick Service Transactions),. If the check total on the transaction is higher than the number in this field, a credit card voucher prints.", "type":"number", "example":0 }, "options":{ "description":"A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the credit card options associated with Tender Media", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "preambles":{ "description":"An array of preambles defined for the tender/ media.", "properties":{ "start":{ "description":"a preamble number for the credit card. If the preamble record defines a range (3050 to 3090), this field represents the begin range (3050*). The start field cannot be empty, and will only have numeric characters followed by a single * character.", "type":"string", "example":"3050*" }, "end":{ "description":"the end range of a preamble number for the credit card. If the preamble record defines a range (3050 to 3090), this field represents the end range (3090*). The end field, if specified, will only have numeric characters followed by a single * character. The length of start and end fields should be same. Value of start field has to be strictly lower than value of end field.", "type":"string", "example":"3090*" }, "length":{ "description":"the number of digits in the credit card number that is associated with the preamble record. If the length field is specified, then both start and end fields' length before * should be less than or equal to the specified value of length field.", "type":"integer", "example":4 } } } } }, "exemptTaxes":{ "description":"A string value of 0s and 1s of length 64 representing tax rates", "type":"string", "example":"0000000000000000000000000000000000000000000000000000000000000000" }, "opsOptions":{ "description":"A string value of 0s and 1s of length 128 representing POS client behavior options", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "holdType":{ "description":"the Hold Type for the tender 0 - Fire Order 1 - Keep Hold Status 2 - Hold Order", "type":"integer", "example":1 }, "svcObjNum":{ "description":"Object Number of the service charge to post charged tips. Use this field with Charge Payment keys (Credit Cards and Room Charges).", "type":"integer", "example":1 }, "paymentChargeTipOptions":{ "description":"A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the payment charge tip options associated with Tender Media", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "miscOptions":{ "description":"An array of miscellaneous options associated with the tender media", "type":"object", "properties":{ "haloCode":{ "description":"the High Amount Lock Out value for the Tender/Media. The value must contain all zeroes except for the first digit.", "type":"integer", "example":1 }, "defaultTipPercent":{ "description":"The percentage amount to which the tip screen (on Signature Capture pads) defaults when using the Tender/Media.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s and 1s of length 128 representing Miscellaneous options", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" } } }, "menuLevels":{ "description":"An object containing the menu levels on which the Tender / Media is active", "type":"object", "properties":{ "mainLevel":{ "description":"A string value of 0s and 1s of length 8 representing Main Levels", "type":"string", "example":"00001011" }, "sublevel":{ "description":"A string value of 0s and 1s of length 8 representing Sub levels", "type":"string", "example":"00001011" } } }, "transDefaultMainLevel":{ "description":"return the transaction to the default transaction Main Level after pressing this Tender/Media", "type":"boolean", "example":false }, "mainLevelPopup":{ "description":"The Main Level that becomes active after pressing this Tender/Media. Enable Transaction Default to return the transaction to the default Main Level, select 0-Stay Down to retain the current transaction levels, or select a level 1-8 to become active.", "type":"integer", "example":1 }, "transDefaultSubLevel":{ "description":"return the transaction to the default transaction Sub Level after pressing this Tender/Media.", "type":"boolean", "example":false }, "subLevelPopup":{ "description":"The Sub Level that becomes active after pressing this Tender/Media. Enable Transaction Default to return the transaction to the default Sub Level, select 0-Stay Down to retain the current transaction levels, or select a level 1-8 to become active", "type":"integer", "example":1 }, "dataExtensions":{ "description":"An array of data extensions for the tender / media", "type":"object", "properties":{ "columnName":{ "description":"Name of the extention field", "type":"string", "example":"Extention Column 1" }, "value":{ "description":"Value of the extention field", "type":"string", "example":"Value 1" } } }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" } } } }, "body.TenderMedia":{ "name":"Tender Media", "in":"body", "description":"Tender Media Object", "required":true, "schema":{ "$ref":"#/definitions/TenderMediaCURequestBody" } }, "body.TenderMediaDeleteRequestBody":{ "name":"Tender Media", "in":"body", "description":"Tender Media Object", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the tender media", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"Effectivity Group object number", "type":"integer", "example":1 } } } }, "body.TaxBreakPointsGetParametersv1":{ "name":"Tax BreakPoint Body", "in":"body", "description":"Tax Break Point Body object of the organization", "required":true, "schema":{ "$ref":"#/definitions/TaxBrkPointBodyv1" } }, "body.TaxBreakPointsGetParametersv2":{ "name":"Tax BreakPoint Body", "in":"body", "description":"Tax Break Point Body object of the organization", "required":true, "schema":{ "description":"The input Body model that needs to be given.", "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "description":"Unique hierarchy unit value", "example":2, "type":"integer" }, "objectNum":{ "description":"Object number of the Tax rate", "example":2, "type":"integer" } } } }, "body.TaxBreakpointsCURequestBody":{ "name":"Tax BreakPoint Body", "in":"body", "description":"Tax Break Point object of the organization", "required":true, "schema":{ "description":"Model for Tax Breakpoint object", "type":"object", "required":[ "hierUnitId", "objectNum", "index" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the Tax rate", "type":"integer", "example":1 }, "index":{ "description":"Tax breakpoint index", "type":"integer", "example":2 }, "breakpoint":{ "description":"Tax Breakpoint", "type":"integer", "example":2 }, "repeatStart":{ "description":"The field (1-32) when the incrementing pattern begins. Applicable only if type = 1", "type":"integer", "example":2 }, "repeatEnd":{ "description":"The field (1-32) when the incrementing pattern ends. Applicable only if type = 1", "type":"integer", "example":2 } } } }, "body.PackagesGetParametersv1":{ "name":"Get Packages Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.PackagesGetParametersv2":{ "name":"Get Packages Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.SLUGetParametersv1":{ "name":"Get Screen Look Ups Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.SLUGetParametersv2":{ "name":"Get Screen Look Ups Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.SLUInsertRequest":{ "name":"Request body", "in":"body", "description":"A CUD request body", "schema":{ "$ref":"#/definitions/SLUInsertRequestBody" }, "required":true }, "body.SLUUpdateRequest":{ "name":"Request body", "in":"body", "description":"A CUD request body", "schema":{ "$ref":"#/definitions/SLUUpdateRequestBody" }, "required":true }, "body.SLUInsertRequestv2":{ "name":"Request body", "in":"body", "description":"A CUD request body", "schema":{ "description":"Model for an SLU CUD Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name", "type" ], "properties":{ "hierUnitId":{ "description":"Hierarchy Unit Id of the root node of the hierarchy", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the SLU", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"SLU Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "type":{ "description":"

    Slu Type Number assigned to the SLU

    \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    Slu TypeSLU NameAllowed Hierarchy LevelAllowed objectNum
    1Discount SLUZone/Location1-64
    2Service Charges SLUZone/Location1-64
    3Tender Media SLUZone/Location1-64
    6Menu Items SLUEnterprise/Zone/Location/RVC1-999999999
    7Menu Item Master Groups SLUZone/Location1-32
    \n", "type":"integer", "example":1 }, "images":{ "type":"array", "description":"An array of images associated with the SLU", "items":{ "$ref":"#/definitions/SLU_image" } } } }, "required":true }, "body.SLUUpdateRequestv2":{ "name":"Request body", "in":"body", "description":"A CUD request body", "schema":{ "description":"Model for an SLU CUD Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name", "type" ], "properties":{ "hierUnitId":{ "description":"Hierarchy Unit Id of the root node of the hierarchy", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the SLU", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"SLU Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "type":{ "description":"

    Slu Type Number assigned to the SLU

    \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    Slu TypeSLU NameAllowed Hierarchy LevelAllowed objectNum
    1Discount SLUZone/Location1-64
    2Service Charges SLUZone/Location1-64
    3Tender Media SLUZone/Location1-64
    6Menu Items SLUEnterprise/Zone/Location/RVC1-999999999
    7Menu Item Master Groups SLUZone/Location1-32
    \n", "type":"integer", "example":1 }, "images":{ "type":"array", "description":"An array of images associated with the SLU", "items":{ "$ref":"#/definitions/SLU_image" } } } }, "required":true }, "body.SLU":{ "name":"SLU", "in":"body", "description":"SLU object of the organization", "schema":{ "$ref":"#/definitions/SLU" }, "required":true }, "body.SLUDeleteRequestBody":{ "name":"DeleteRequestBody", "in":"body", "description":"Body for SLU delete request", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "type" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the SLU", "type":"integer", "example":1 }, "type":{ "description":"

    Slu Type Number assigned to the SLU

    \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    Slu TypeSLU NameAllowed Hierarchy LevelAllowed objectNum
    1Discount SLUZone/Location1-64
    2Service Charges SLUZone/Location1-64
    3Tender Media SLUZone/Location1-64
    6Menu Items SLUEnterprise/Zone/Location/RVC1-999999999
    7Menu Item Master Groups SLUZone/Location1-32
    \n", "type":"integer", "example":1 } } }, "required":true }, "body.ReportGroupsGetParametersv1":{ "name":"Get Locales Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.ReportGroupsGetParametersv2":{ "name":"Get Locales Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.ReportGroupCUDRequest":{ "name":"Request body", "in":"body", "description":"CUD request Body", "required":true, "schema":{ "$ref":"#/definitions/ReportGroupCUDRequestBody" } }, "body.ReportGroupCUDRequestv2":{ "name":"Request body", "in":"body", "description":"CUD request Body", "required":true, "schema":{ "description":"Model for Report Groups CUD Request Body", "type":"object", "required":[ "objectNum", "hierUnitId", "name" ], "properties":{ "objectNum":{ "description":"Object Number of the Report Groups.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Report Groups is configured", "type":"integer", "example":3599 }, "name":{ "description":"A group of string objects representing the name of the Report Group in configured languages", "type":"object", "example":{ "1":"Routing Group", "2":"Routing-Gruppe" } }, "options":{ "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the Report Groups", "type":"string", "example":"1000000000000000" }, "type":{ "description":"Type of the report group; 0 - None; 1 - Tender / Media; 2 - Discount; 3 - Service Charge", "type":"integer", "example":1 } } } }, "body.ReportGroups":{ "name":"ReportGroups", "in":"body", "description":"Report Group Object", "required":true, "schema":{ "$ref":"#/definitions/ReportGroups" } }, "body.ReportGroupResponse":{ "name":"ReportGroupResponse", "in":"body", "description":"Response Object", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Report Group", "type":"integer", "example":1 } } } }, "body.DiscountAwardGrpsCURequestBody":{ "name":"DiscountAwardGrpsCURequestBody", "in":"body", "description":"DiscountAwardGrps object of the organization", "required":true, "schema":{ "description":"Model for Discount Award Groups Object", "type":"object", "required":[ "hierUnitId", "objectNum", "sequenceNum", "awardMIGroupObjNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Discount", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"Object Number of the effectivity group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence Number of the Discount Award Group", "type":"integer", "example":1 }, "awardMIGroupObjNum":{ "description":"Object number of the Menu Item Group to trigger the discount award.", "type":"integer", "example":1 }, "awardType":{ "description":"Type of the award; 0 - None, 1 - Percent Off, 2 - Amount Off, 3 - Amount Substitution", "type":"integer", "example":1 }, "percentOff":{ "description":"The percentage of the percent-based discount. Applicable only for awardType - 1", "type":"number", "example":1.55 }, "amountOff":{ "description":"The discount amount for flat amount-based discount. Applicable only for awardType - 2", "type":"number", "example":2.55 }, "amountSubstitution":{ "description":"The price to charge for each item in the Trigger Menu Item Group. Applicable only for awardType - 3", "type":"number", "example":1.22 }, "maxCount":{ "description":"When Simple Transaction Exclusivity is set for this discount, enter the maximum number of discounts that can be applied to one check. Applicable only for autoRuleType - 1-4", "type":"integer", "example":1 }, "awardCount":{ "description":"The number of award items that are allowed once the Trigger MI Group's Minimum quantity is reached.", "type":"integer", "example":1 } } } }, "body.DiscountAwardGroupsGetParametersv1":{ "name":"DiscountAwardGroups", "in":"body", "description":"Discount Award Groups Get Object", "required":true, "schema":{ "$ref":"#/definitions/DiscountAwardGrpsBody" } }, "body.DiscountAwardGroupsGetParametersv2":{ "name":"DiscountAwardGroups", "in":"body", "description":"Discount Award Groups Get Object", "required":true, "schema":{ "description":"The input Body model that needs to be given.", "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "description":"Unique reference of the hierarchy.", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the discount", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"Object Number of the effectivity group", "type":"integer", "example":1 } } } }, "body.DiscountAwardGrpsDeleteRequestBody":{ "name":"DiscountAwardGrpsResponse", "in":"body", "description":"Discount Award Group Response Object", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "sequenceNum" ], "properties":{ "hierUnitId":{ "description":"Unique Hierarchy Unit Value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the Discount", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"ObjectNumber of Effectivity Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence Number of the discount award group", "type":"integer", "example":1 } } } }, "body.BarcodesGetParametersv1":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/BarCodesGetRequestBody" } }, "body.BarcodesGetParametersv2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy location of the barcodes being fetched" }, "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.Barcode":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/BarCode" } }, "body.BarcodeCUDRequestBody":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy location where the barcode is being added" }, "objectNum":{ "type":"integer", "example":101, "description":"Barcode record object number" }, "barcode":{ "type":"integer", "example":1, "description":"Barcode value" }, "masterObjNum":{ "type":"integer", "example":501, "description":"Master object number" }, "defSequenceNum":{ "type":"integer", "example":5, "description":"Definition sequence number this barcode applies to. If null, all definitions apply" }, "priceSequenceNum":{ "type":"integer", "example":3, "description":"Price sequence this barcode applies to. If null, applies to all price records for the selected master and definitions." }, "alternatePrice":{ "type":"number", "example":5.16, "description":"Price used when ordering with barcode" }, "alternatePrepCost":{ "type":"number", "example":0.18, "description":"Prep cost used when ordering with barcode" }, "leadNumZeros":{ "type":"number", "example":2, "description":"Leading Zeroes" } }, "description":"Model for Barcode CUD Request" } }, "body.BarcodeDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy location where the barcode is being added" }, "objectNum":{ "type":"integer", "example":101, "description":"Barcode record object number" } }, "description":"Model for Barcode Response object" } }, "body.BarCodeResponse":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/BarCodeResponse" } }, "formData.BulkInsertBarcodeRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for inserting Barcodes in bulk", "type":"file", "required":true }, "body.TaxRatesGetParametersv1":{ "name":"Get Tax Rates Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.TaxRatesGetParametersv2":{ "name":"Get Tax Rates Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.TaxCURequestBody":{ "name":"Tax", "in":"body", "description":"Tax object of the organization", "required":true, "schema":{ "$ref":"#/definitions/TaxCURequestBody" } }, "body.TaxCURequestBodyv2":{ "name":"Tax", "in":"body", "description":"Tax object of the organization", "required":true, "schema":{ "description":"Model for TaxObject", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the tax rate", "type":"integer", "example":1 }, "name":{ "description":"Tax Rate Name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "type":{ "description":"\n

    Tax Rate Type

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    TypeType Description
    0 Disabled for Tax Rates that are not in use.
    1 Add On Breakpoint
    2 Add On Percentage
    3 Included
    4 Surcharge
    6 Add on, Excludes Start Amount
    \n", "type":"integer", "example":1 }, "start":{ "description":"Taxable sales amount that must be reached in a transaction before the tax rate is applied", "type":"number", "example":0.5 }, "percent":{ "description":"The tax percentage for the tax rate", "type":"number", "example":1 }, "breakpoints":{ "description":"An array of breakpoints configured for the tax rate Applicable only if type = 1", "type":"array", "items":{ "type":"object", "properties":{ "index":{ "description":"Tax breakpoint index", "type":"integer", "example":1 }, "breakpoint":{ "description":"Tax Breakpoint", "type":"integer", "example":1 } } } }, "repeatStart":{ "description":"The field (1-32) when the incrementing pattern begins. Applicable only if type =1", "type":"integer", "example":1 }, "repeatEnd":{ "description":"The field (1-32) when the incrementing pattern ends. Applicable only if type =1", "type":"integer", "example":32 }, "reportGroup":{ "description":"The report group number (0-99) for the Tax Rate. If set to 0, the tax rate does not appear on the reports.", "type":"integer", "example":0 }, "taxLabel":{ "description":"Tax Code for the tax rate", "type":"string", "example":"aaa" }, "effGrpObjNum":{ "description":"Object number of the effectivity group associated with the tax rate", "type":"integer", "example":1 } } } }, "body.Tax":{ "name":"Tax", "in":"body", "description":"Tax object of the organization", "required":true, "schema":{ "$ref":"#/definitions/Tax" } }, "body.TaxDeleteRequest":{ "name":"Delete Request body", "in":"body", "description":"Delete Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the tax rate", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"Object number of the effectivity group associated with the tax rate", "type":"integer", "example":1 } } } }, "body.TaxParametersGetParametersv1":{ "name":"Get Tax Parameters Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.TaxParametersGetParametersv2":{ "name":"Get Tax Parameters Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.TaxParametersCURequestBody":{ "name":"TaxParameters", "in":"body", "description":"Tax Parameter object of the organization", "required":true, "schema":{ "description":"Model for Tax Parameter object.", "type":"object", "required":[ "hierUnitId" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "internationalOptions":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the tax parameter", "type":"string", "example":"00000000000000000000000000000000" }, "options":{ "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the tax parameter", "type":"string", "example":"0000000000000000" }, "printVATLineForTaxRates":{ "description":"A string value of 0s & 1s of length 64 representing the enablement / disablement of printing the VAT lines for the tax rates.", "type":"string", "example":"0000000001011110000000000000000000000000000000000000000000000000" } } } }, "body.TaxParameterResponse":{ "name":"Tax Parameter Response", "in":"body", "description":"Tax Parameter Response", "required":true, "schema":{ "description":"Model for the tax Parameter response", "type":"object", "required":[ "hierUnitId" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 } } } }, "body.TaxClassesGetParametersv1":{ "name":"Get Tax Classes Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.TaxClassesGetParametersv2":{ "name":"Get Tax Classes Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.TaxClassCURequestBody":{ "name":"TaxClass", "in":"body", "description":"Tax Class object of the organization", "required":true, "schema":{ "$ref":"#/definitions/TaxClassCURequestBody" } }, "body.TaxClassCURequestBodyv2":{ "name":"TaxClass", "in":"body", "description":"Tax Class object of the organization", "required":true, "schema":{ "description":"Model for Tax Class Object", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the Tax Class", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Tax Class Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "taxes":{ "description":"An array of taxes configured for the tax class", "type":"array", "items":{ "type":"object", "properties":{ "taxObjNum":{ "description":"Object Number of the tax", "type":"integer", "example":1 } } } }, "dataExtensions":{ "description":"An array of data extensions for the tax class", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } } }, "body.TaxResponse":{ "name":"TaxResponse", "in":"body", "description":"Tax Response object of the organization", "required":true, "schema":{ "description":"Model for the response", "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the tax class", "type":"integer", "example":1 } } } }, "body.ComboSideGroupsLiteInsertRequest":{ "in":"body", "name":"Request Body", "description":"Insert Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value." }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the combo side group." }, "name":{ "type":"object", "description":"Name of the combo side group.", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing enabled or disabled options" }, "alternateGroups":{ "type":"array", "description":"An array of alternate groups associated with combo side group.", "items":{ "type":"object", "properties":{ "sequenceNum":{ "type":"integer", "example":1, "description":"Sequence number of the alternate combo side group." }, "alternateGroupObjNum":{ "type":"integer", "example":2, "description":"Object number of the alternate combo side group." } } } } } } }, "body.ComboSideGroupsLiteUpdateRequest":{ "in":"body", "name":"Request Body", "description":"Update Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealGroupId", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value." }, "comboMealGroupId":{ "type":"integer", "example":2, "description":"Unique ID of combo side group." }, "name":{ "type":"object", "description":"Name of the combo side group.", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing enabled or disabled options" }, "alternateGroups":{ "type":"array", "description":"An array of alternate groups associated with combo side group.", "items":{ "type":"object", "properties":{ "sequenceNum":{ "type":"integer", "example":1, "description":"Sequence number of the alternate combo side group." }, "alternateGroupObjNum":{ "type":"integer", "example":2, "description":"Object number of the alternate combo side group." } } } } } } }, "body.ComboSideGroupsLiteGetParameters":{ "in":"body", "name":"Request Body", "description":"Get Request body", "required":true, "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.ComboSideGroupsLiteDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Delete Request body", "required":true, "schema":{ "type":"object", "required":[ "comboMealGroupId" ], "properties":{ "comboMealGroupId":{ "type":"integer", "example":1, "description":"Unique ID of combo side group." } } } }, "body.ComboMealsLiteDeleteRequest":{ "in":"body", "name":"Request body", "description":"Delete request body", "required":false, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Object number of the Combo Meal" } } } }, "body.ComboMealsLiteCURequestBody":{ "in":"body", "name":"Request body", "description":"Combo Meals Lite insert and update request body", "required":false, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "objectNum":{ "type":"integer", "example":1, "description":"Combo Meal object number" }, "name":{ "type":"object", "description":"Combo Meal Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "menuItemMasterObjNum":{ "type":"integer", "example":101, "description":"Menu item master object number" }, "priority":{ "type":"integer", "example":1, "description":"The combo meal priority when pressing the Auto Combo function key" }, "autoComboMealAlgorithm":{ "type":"integer", "example":0, "description":"The Auto-Combo Algorithm. Allowed values are 0,1,2
    Description Value
    First Deal Found 0
    Best Deal for Customer 1
    Best Deal for Merchant 2
    " }, "pricingAlgorithm":{ "type":"integer", "example":1, "description":"Pricing Algorithm Values
    Description Value
    Default NULL
    Most Expensive Side Group 1
    Least Expensive Side Group 2
    " }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing enabled or disabled options" } } } }, "body.ComboMealsLiteGetParameters":{ "name":"Request body", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.HierarchyGetParametersv1":{ "name":"Get Hierarchy Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.HierarchyGetParametersv2":{ "name":"Get Hierarchy Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.CustomContentGetParametersv1":{ "name":"Get Custom Content Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.CustomContentGetParametersv2":{ "name":"Get Custom Content Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.CustomContent":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/CustomContent" } }, "body.CustomContentInsertRequest":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/CustomContentInsertRequestBody" } }, "body.CustomContentInsertRequestv2":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "name", "description", "type" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "name":{ "type":"string", "example":"Image Spoons", "description":"The name of the content object" }, "description":{ "description":"A group of string objects representing the description of custom content in configured languages", "type":"object", "example":{ "1":"Image Spoons", "2":"Bild L??ffel", "3":"Cucharas de Imagen" } }, "size":{ "type":"integer", "example":"Size: 12 kb, png: 100 x 100 px", "description":"the size of the custom content in bytes." }, "type":{ "type":"integer", "example":9, "description":"The file type for the custom content" }, "filenameOrigin":{ "type":"string", "example":"C:\\Program Files\\Oracle Hospitality\\EMCClient\\OPIPayment.dll", "description":"the content file origin." }, "target":{ "type":"string", "example":"11111111111111111111111111111111", "description":"A string value of 0's & 1's representing the platforms where the content is targeted" }, "filename":{ "type":"string", "example":"ImageSpoons.jpg", "description":"The name of the custom content file with extension" } } } }, "body.UpdateCustomContent":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/UpdateCustomContent" } }, "body.UpdateCustomContentv2":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "name", "id", "description", "type" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "id":{ "type":"integer", "example":1, "description":"Unique reference of the content" }, "name":{ "type":"string", "example":"Image Spoons", "description":"The name of the content object" }, "description":{ "description":"A group of string objects representing the description of custom content in configured languages", "type":"object", "example":{ "1":"Image Spoons", "2":"Bild L??ffel", "3":"Cucharas de Imagen" } }, "size":{ "type":"integer", "example":"Size: 12 kb, png: 100 x 100 px", "description":"the size of the custom content in bytes." }, "type":{ "type":"integer", "example":9, "description":"The file type for the custom content" }, "filenameOrigin":{ "type":"string", "example":"C:\\Program Files\\Oracle Hospitality\\EMCClient\\OPIPayment.dll", "description":"the content file origin." }, "target":{ "type":"string", "example":"11111111111111111111111111111111", "description":"A string value of 0's & 1's representing the platforms where the content is targeted" }, "filename":{ "type":"string", "example":"ImageSpoons.jpg", "description":"The name of the custom content file with extension" } } } }, "body.CustomContentDeleteRequest":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "id" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." }, "id":{ "type":"integer", "example":1, "description":"Unique reference of the content" } } } }, "body.CustomContentDownloadRequest":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "id" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." }, "id":{ "type":"integer", "example":1, "description":"Unique reference of the content" } } } }, "body.DiscountTriggerGroupsGetParametersv1":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "$ref":"#/definitions/DiscountTriggerGrpsGetRequestBody" }, "required":true }, "body.DiscountTriggerGroupsGetParametersv2":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "description":"The input Body model that needs to be given.", "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Discount", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"ObjectNumber of Effectivity Group", "type":"integer", "example":1 } } }, "required":true }, "body.DiscountTriggerGrpsCURequestBody":{ "name":"Discount Trigger Groups", "in":"body", "description":"Discount Trigger Group object of the organization", "required":true, "schema":{ "description":"Model for Discount Trigger Groups Object", "type":"object", "required":[ "hierUnitId", "objectNum", "sequenceNum", "triggerMIGroupObjNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Discount", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"ObjectNumber of Effectivity Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence Number of the discount trigger group", "type":"integer", "example":1 }, "triggerMIGroupObjNum":{ "description":"Object number of the Menu Item Group to trigger the discount award.", "type":"integer", "example":1 }, "triggerCondimentGroupObjNum":{ "description":"Object number of the Condiment Menu Item Group to use as the trigger for the discount", "type":"integer", "example":1 }, "minimumQuantity":{ "description":"The minimum number of items that must be ordered from the Trigger Menu Item Group before the discount is applied to the check. Applicable only for autoRuleType 1 and 2", "type":"integer", "example":1 }, "total":{ "description":"The total amount of Trigger Menu Item Group Items that must ordered to activate the Award Menu Item Group. Applicable only for autoRuleType 3", "type":"number", "example":1.23 } } } }, "body.DiscountTriggerGrpsDeleteRequestBody":{ "name":"Discount Trigger Group", "in":"body", "description":"Discount Trigger Group Object", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "sequenceNum" ], "properties":{ "hierUnitId":{ "description":"Unique Hierarchy Unit Value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the Discount.", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"ObjectNumber of Effectivity Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence Number of the discount trigger group", "type":"integer", "example":1 } } } }, "body.MenuItemsGetParameters":{ "in":"body", "name":"Request Body", "description":"Request body", "required":false, "schema":{ "$ref":"#/definitions/MenuItemsGetRequestBody" } }, "body.SLUConsumerFacingContentGetParametersv1":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/SLUConsumerFacingContentGetRequest" } }, "body.SLUConsumerFacingContentGetParametersv2":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the SLU", "type":"integer", "example":1 } } } }, "body.SLUConsumerFacingContentCURequest":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "description":"Model for Screen Lookup Consumer Facing Content Object", "type":"object", "required":[ "hierUnitId", "objectNum", "imageIndex" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the SLU", "type":"integer", "example":1 }, "imageIndex":{ "description":"Number of the image. Values range from 1-4.", "type":"integer", "example":1 }, "title":{ "description":"Title of the image", "type":"string", "example":"Image of appetizers" }, "size":{ "description":"The size of an image", "type":"string", "example":"Size: 12 kb, png: 100 x 100 px" }, "fileName":{ "description":"The name of the image file", "type":"string", "example":"ImageAppetizers.jpg" } } } }, "body.SLUConsumerFacingContentDelete":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "imageIndex" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the SLU", "type":"integer", "example":1 }, "imageIndex":{ "description":"Unique number of the image.", "type":"integer", "example":1 } } } }, "body.MenuItemDefinitionConsumerFacingContentGetParametersv1":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/MenuItemConsumerFacingContentGetRequest" } }, "body.MenuItemDefinitionConsumerFacingContentGetParametersv2":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "defSeqNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Menu Item definition is configured.", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the menu item master.", "type":"integer", "example":1 }, "defSeqNum":{ "description":"Sequence Number of the menu item definition", "type":"integer", "example":1 } } } }, "body.MenuItemConsumerFacingContentCUDRequestBody":{ "name":"MenuItem", "in":"body", "required":true, "description":"Menu Item Consumer Facing Content object of the organization", "schema":{ "description":"Model for Menu Item Consumer Facing Content Object", "type":"object", "required":[ "hierUnitId", "objectNum", "defSeqNum", "imageIndex" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Menu Item definition is configured.", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the menu item master.", "type":"integer", "example":1 }, "defSeqNum":{ "description":"Sequence Number of the menu item definition", "type":"integer", "example":1 }, "imageIndex":{ "description":"Number of the image. Values range from 1-10.", "type":"integer", "example":1 }, "altText":{ "description":"altText of the image", "type":"string", "example":"Image of appetizers" }, "description":{ "description":"Description of the image.", "type":"string", "example":"Image of Appetizers" }, "size":{ "description":"The size of an image", "type":"string", "example":"Size: 12 kb, png: 100 x 100 px" } } } }, "body.MenuItemConsumerFacingContentDelete":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "defSeqNum", "imageIndex" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Menu Item definition is configured.", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the menu item master.", "type":"integer", "example":1 }, "defSeqNum":{ "description":"Sequence Number of the menu item definition", "type":"integer", "example":1 }, "imageIndex":{ "description":"Number of the image. Values range from 1-10.", "type":"integer", "example":1 } } } }, "body.Employees2GetParametersv1":{ "name":"Get Employees2 Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.Employees2GetParametersv2":{ "name":"Get Employees2 Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.Employee2.Insert":{ "name":"Request Body", "in":"body", "description":"Basic Employee Request Body", "schema":{ "type":"object", "required":[ "objectNum" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee in the system." }, "firstName":{ "type":"string", "example":"Employee", "description":"Employee's first name, which prints on reports." }, "lastName":{ "type":"string", "example":"Employee", "description":"Employee's last name, which prints on reports." }, "checkName":{ "type":"string", "example":"Employee Check Name", "description":"Name to print on guest checks." }, "languageObjNum":{ "type":"integer", "example":1, "description":"The object number of the default language for the employee on the EMC and the workstation." }, "payrollId":{ "type":"string", "example":"EMP-01", "description":"External payroll ID for the employee." }, "id":{ "type":"integer", "example":2021, "description":"ID number to identify the employee on workstations." }, "alternateId":{ "type":"integer", "example":2121, "description":"ID to use instead of the Employee ID when signing into the workstation." }, "pin":{ "type":"integer", "example":2222, "description":"PIN for the employee." }, "level":{ "type":"integer", "example":1, "description":"The level of the employee. This value should be between 1-9." }, "group":{ "type":"integer", "example":1, "description":"The group of the employee." }, "terminationDate":{ "type":"string", "example":"2021-11-21T00:00:00.000Z", "description":"The date the employee was terminated.Format:YYYY-MM-DD. This value is set from Labor Management and cannot be added" }, "isDataPrivacyConsentGranted":{ "type":"boolean", "example":false, "description":"The consent status of the employee." }, "infoLine1":{ "type":"string", "example":"Information line 1", "description":"Information line 1" }, "infoLine2":{ "type":"string", "example":"Information line 2", "description":"Information line 2" }, "infoLine3":{ "type":"string", "example":"Information line 3", "description":"Information line 3" }, "infoLine4":{ "type":"string", "example":"Information line 4", "description":"Information line 4" }, "userName":{ "type":"string", "example":"empName", "description":"The login name for the EMC." }, "localeObjNum":{ "type":"integer", "example":1, "description":"The object number of the locale of the employee" }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for employees", "items":{ "$ref":"#/definitions/Employee_dataExtensions" } } } }, "required":true }, "body.Employee2.Update":{ "name":"Request Body", "in":"body", "description":"Basic Employee Request Body", "schema":{ "type":"object", "required":[ "objectNum" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee in the system." }, "firstName":{ "type":"string", "example":"Employee", "description":"Employee's first name, which prints on reports." }, "lastName":{ "type":"string", "example":"Employee", "description":"Employee's last name, which prints on reports." }, "checkName":{ "type":"string", "example":"Employee Check Name", "description":"Name to print on guest checks." }, "languageObjNum":{ "type":"integer", "example":1, "description":"The object number of the default language for the employee on the EMC and the workstation." }, "payrollId":{ "type":"string", "example":"EMP-01", "description":"External payroll ID for the employee." }, "id":{ "type":"integer", "example":2021, "description":"ID number to identify the employee on workstations." }, "alternateId":{ "type":"integer", "example":2121, "description":"ID to use instead of the Employee ID when signing into the workstation." }, "pin":{ "type":"integer", "example":2222, "description":"PIN for the employee." }, "level":{ "type":"integer", "example":1, "description":"The level of the employee. This value should be between 1-9." }, "group":{ "type":"integer", "example":1, "description":"The group of the employee." }, "terminationDate":{ "type":"string", "example":"2021-11-21T00:00:00.000Z", "description":"The date the employee was terminated.Format:YYYY-MM-DD. This value is set from Labor Management and cannot be added" }, "isDataPrivacyConsentGranted":{ "type":"boolean", "example":false, "description":"The consent status of the employee." }, "infoLine1":{ "type":"string", "example":"Information line 1", "description":"Information line 1" }, "infoLine2":{ "type":"string", "example":"Information line 2", "description":"Information line 2" }, "infoLine3":{ "type":"string", "example":"Information line 3", "description":"Information line 3" }, "infoLine4":{ "type":"string", "example":"Information line 4", "description":"Information line 4" }, "userName":{ "type":"string", "example":"empName", "description":"The login name for the EMC." }, "localeObjNum":{ "type":"integer", "example":1, "description":"The object number of the locale of the employee" }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for employees", "items":{ "$ref":"#/definitions/Employee_dataExtensions" } } } }, "required":true }, "body.Delete2Request.Required":{ "name":"Request Body", "in":"body", "description":"Request body", "schema":{ "type":"object", "required":[ "objectNum" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" } } }, "required":true }, "body.MajorGroupsGetParametersv1":{ "name":"Get Major Groups Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.MajorGroupsGetParametersv2":{ "name":"Get Major Groups Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.MajorGroupCUDRequestBody":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/MajorGroupCUDRequestBody" } }, "body.MajorGroupCUDRequestBodyv2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit of an Enterprise" }, "reportGroup":{ "description":"Object number of the Report Group.", "type":"integer", "example":1 }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the major group" }, "name":{ "type":"object", "description":"Major Group Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } } } } }, "body.MajorGroupDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the major group" } } } }, "body.AutoMenuLevelsGetParametersv1":{ "name":"Get Auto Menu Levels Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.AutoMenuLevelsGetParametersv2":{ "name":"Get Auto Menu Levels Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.AutoMenuLevelCUDRequest":{ "in":"body", "name":"Request Body", "description":"CUD Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "index", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "index":{ "type":"integer", "example":1, "description":"Object number of the auto menu level" }, "start":{ "type":"string", "example":"10:10", "description":"Indicates the Start Time for every Menu Level in 24-hour format" }, "end":{ "type":"string", "example":"20:20", "description":"Indicates the End Time for every Menu Level in 24-hour format" }, "mainLevelIndex":{ "type":"integer", "example":1, "description":"Select the Main Level, if any, that becomes active at the specified time" }, "subLevelIndex":{ "type":"integer", "example":1, "description":"Select the Sub Level, if any, that becomes active at the specified time" }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated" } }, "description":"Model for an Auto Menu Level" } }, "body.AutoMenuLevelDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "index" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "index":{ "type":"integer", "example":1, "description":"Object number of the auto menu level" } } } }, "body.ComboSideGroupItemPricesGetParametersv1":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/ComboGroupItemPriceGetRequestBody" } }, "body.ComboSideGroupItemPricesGetParametersv2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "comboMealGroupItemObjNum", "comboMealGroupId" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 2)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "comboMealGroupItemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" } } } }, "body.ComboGroupItemPrice":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/ComboGroupItemPrice" } }, "body.ComboGroupItemPriceUpdateRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealGroupItemObjNum", "comboMealGroupObjNum", "sequenceNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealGroupObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal group" }, "comboMealGroupItemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "sequenceNum":{ "type":"integer", "example":1, "description":"Sequence number of Combo Group Item" }, "price":{ "type":"number", "example":1.23, "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items" }, "prepcost":{ "type":"number", "example":0.89, "description":"The preparation cost of the combo group side items." }, "activeOnLevel":{ "type":"integer", "example":0, "description":"The main menu level on which the price is active. Setting it to 0 indicates the prices is active on all levels" }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group associated with the price" } }, "description":"Model for Combo Group Item Price Object" } }, "body.ComboGroupItemPriceUpdateRequestV2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealGroupItemObjNum", "comboMealGroupId", "sequenceNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value where the price is located." }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" }, "comboMealGroupItemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "sequenceNum":{ "type":"integer", "example":1, "description":"Sequence number of the price" }, "price":{ "type":"number", "example":1.23, "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items" }, "prepcost":{ "type":"number", "example":0.89, "description":"The preparation cost of the combo group side items." }, "activeOnLevel":{ "type":"integer", "example":0, "description":"The main menu level on which the price is active. Setting it to 0 indicates the prices is active on all levels" }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group associated with the price" } }, "description":"Update request body for Combo Group Item Prices" } }, "body.ComboGroupItemPriceInsertRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealGroupItemObjNum", "comboMealGroupObjNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealGroupObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal group" }, "comboMealGroupItemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "price":{ "type":"number", "example":1.23, "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items" }, "prepcost":{ "type":"number", "example":0.89, "description":"The preparation cost of the combo group side items." }, "activeOnLevel":{ "type":"integer", "example":0, "description":"The main menu level on which the price is active. Setting it to 0 indicates the prices is active on all levels" }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group associated with the price" } }, "description":"Model for Combo Group Item Price Object" } }, "body.ComboGroupItemPriceInsertRequestV2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealGroupItemObjNum", "comboMealGroupId" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value where the price is located." }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Unique Id of the Combo Meal group" }, "comboMealGroupItemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "price":{ "type":"number", "example":1.23, "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items" }, "prepcost":{ "type":"number", "example":0.89, "description":"The preparation cost of the combo group side items." }, "activeOnLevel":{ "type":"integer", "example":0, "description":"The main menu level on which the price is active. Setting it to 0 indicates the prices is active on all levels" }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group associated with the price" } }, "description":"Insert request body for Combo Group Item Prices" } }, "body.ComboGroupItemPriceDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealGrpObjNum", "comboMealGroupItemObjNum", "sequenceNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealGrpObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal group" }, "comboMealGroupItemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" } } } }, "body.ComboGroupItemPriceDeleteRequestV2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealGroupId", "comboMealGroupItemObjNum", "sequenceNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value where the price is located." }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" }, "comboMealGroupItemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" } } } }, "formData.BulkInsertComboSideGroupItemPriceRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for inserting Combo Side Group Item Prices in bulk", "type":"file", "required":true }, "formData.BulkUpdateComboSideGroupItemPriceRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for udpating Combo Side Group Item Prices in bulk", "type":"file", "required":true }, "body.ComboMealSideGroupPricesGetParametersv1":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/ComboMealPriceGetRequestBody" } }, "body.ComboMealSideGroupPricesGetParametersv2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealObjNum", "sideNum" ], "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "langIds":{ "type":"string", "example":"1,2,3", "description":"If specified, limits translated strings returned." }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal" }, "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side" } } } }, "body.ComboMealPrice":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/ComboMealPricev1" } }, "body.ComboMealPriceInsertRequest":{ "in":"body", "name":"Request Body", "description":"Insert Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealObjNum", "sideNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal" }, "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side" }, "price":{ "type":"number", "example":1.23, "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items." }, "prepCost":{ "type":"number", "example":0.67, "description":"The preparation cost of the combo meal side." }, "activeOnMenuLevel":{ "type":"integer", "example":0, "description":"The menu level (main or sub) on which the price is active. This should be a value between 0-8.Setting it to 0 indicates the prices is active on all levels" } }, "description":"Model for Price of side of Combo Meal Object" } }, "body.ComboMealPriceUpdateRequest":{ "in":"body", "name":"Request Body", "description":"Update Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealObjNum", "sideNum", "sequenceNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal" }, "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side" }, "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" }, "price":{ "type":"number", "example":1.23, "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items." }, "prepCost":{ "type":"number", "example":0.67, "description":"The preparation cost of the combo meal side." }, "activeOnMenuLevel":{ "type":"integer", "example":0, "description":"The menu level (main or sub) on which the price is active. This should be a value between 0-8.Setting it to 0 indicates the prices is active on all levels" } } } }, "body.ComboMealPriceDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealObjNum", "sideNum", "sequenceNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal" }, "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side" }, "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" } } } }, "body.ComboMealsDeleteRequest":{ "in":"body", "name":"request body", "description":"request body for Combo Meals", "required":false, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Combo Meal" } } } }, "body.ComboMealsResourceObjectCUDRequestBodyv2":{ "in":"body", "name":"request body", "description":"request body for Combo Meals", "required":false, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "objectNum":{ "type":"integer", "example":1, "description":"Combo Meal object number" }, "name":{ "type":"object", "description":"Combo Meal Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "menuItemMasterObjNum":{ "type":"integer", "example":101, "description":"Menu item master object number" }, "priority":{ "type":"integer", "example":1, "description":"The combo meal priority when pressing the Auto Combo function key" }, "autoComboMealAlgorithm":{ "type":"integer", "example":0, "description":"The Auto-Combo Algorithm" }, "pricingAlgorithm":{ "type":"integer", "example":1, "description":"Pricing Algorithm Values
    Description Value
    Default NULL
    Most Expensive Side Group 1
    Least Expensive Side Group 2
    " }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing enabled or disabled options" }, "sides":{ "type":"array", "description":"An array of Sides that are associated with the combo meal", "items":{ "$ref":"#/definitions/ComboMeals_Sides_CUD" } } } } }, "body.ComboMealsGetParametersv2":{ "name":"request body", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "formData.BulkInsertComboMealRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for inserting Combo Meals in bulk", "type":"file", "required":true }, "formData.BulkUpdateComboMealRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for updating Combo Meals in bulk", "type":"file", "required":true }, "body.KitchenDisplayClientsGetParametersv1":{ "name":"Get Kitchen Display Clients Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.KitchenDisplayClientsGetParametersv2":{ "name":"Get Kitchen Display Clients Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.KDSDisplaysCUDRequest":{ "name":"Request Body", "in":"body", "description":"KDS Displays CUD Request Body", "required":true, "schema":{ "$ref":"#/definitions/KDSDisplaysCUDRequestBody" } }, "body.KDSDisplaysCUDRequestv2":{ "name":"Request Body", "in":"body", "description":"KDS Displays CUD Request Body", "required":true, "schema":{ "description":"Model for KDS Displays CUD Request.", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit.", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the KDS Display.", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the KDS Display in configured languages.", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "kdsControllerObjNum":{ "description":"Object number of the KDS controller for the display.", "type":"integer", "example":1 }, "ipAddress":{ "description":"The IP address for the display.", "type":"string", "example":"0.0.0.0" }, "toolbarObjNum":{ "description":"Object number of the toolbar to use for the display.", "type":"integer", "example":1 }, "bumpBarObjNum":{ "description":"Object number of the bump bar to use for the display.", "type":"integer", "example":1 }, "platformType":{ "description":"The platform type of the display.", "type":"integer", "example":1 }, "cardId":{ "description":"The slot number or position of the SEI card in the OASYS box. Applicable only if platformType = 1", "type":"integer", "example":1 }, "videoId":{ "description":"An ID to identify the display in the system. Applicable only if platformType = 1", "type":"integer", "example":1 }, "displayOrientation":{ "description":"The orientation type for the display.", "type":"integer", "example":1 }, "orderSelectionTimeInSecs":{ "description":"The amount of time in seconds an order remains selected on the display.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the KDS Display", "type":"string", "example":"00000011000000000000000000000000" }, "displayType":{ "description":"An integer value representing the type of the display.", "type":"integer", "example":1 }, "toolBarPosition":{ "description":"An integer value representing the location for the toolbar on the display.", "type":"integer", "example":1 }, "panelLayout":{ "description":"If the display has two panels, select whether the panels appear side-by-side or one on top of the other. Applicable only if displayType = 2 or 3", "type":"integer", "example":1 }, "tableDetailToolbarObjNum":{ "description":"Object number of the toolbar to use when viewing Table Details on a SOS Display.", "type":"integer", "example":1 }, "panelConfiguration":{ "description":"An array of configurations for the different panel definitions of the Display. Applicable only if displayType = 2 or 3", "type":"array", "items":{ "type":"object", "properties":{ "panelNum":{ "description":"The number of panels to show on the KDS Display.", "type":"integer", "example":1 }, "proportion":{ "description":"The ratio for the panel to occupy on the KDS Display.", "type":"integer", "example":1 }, "chitColumns":{ "description":"The number of chit columns to display in the panel.", "type":"integer", "example":1 }, "chitRows":{ "description":"The number of chit rows to display in the panel.", "type":"integer", "example":1 }, "capacity":{ "description":"The relative capacity of the order devices linked to this panel. This field should only be used with KDS Controllers | General | Options | 13 - Enable Capacity Scheduling.", "type":"integer", "example":1 } } } }, "kdsChitLayoutStyleObjNum":{ "description":"Object number of the chit layout type for the display.", "type":"integer", "example":1 }, "serpentineMode":{ "description":"A value representing the arrangement of chits on the display.", "type":"integer", "example":1 }, "menuItemFont":{ "description":"The font size for menu items to appear on the display.", "type":"integer", "example":1 }, "comboItemFont":{ "description":"The font size for the Combo Items as they should appear on the KDS Display.", "type":"integer", "example":1 }, "orderTypeFont":{ "description":"The font size for the Order Type text to appear on the display.", "type":"integer", "example":1 }, "sosDisplayTableColumns":{ "description":"The number of columns to use to present table numbers for the SOS Table Display. Applicable only if displayType = 1", "type":"integer", "example":1 }, "sosDisplayTimeout":{ "description":"The duration that a table appears on the regular Expo Display screen before returning to the SOS Table Display. Applicable only if displayType = 1", "type":"integer", "example":1 }, "sosZoneFont":{ "description":"The font size for SOS zones to appear on the display. Applicable only if displayType = 1", "type":"integer", "example":1 }, "sosSortMethod":{ "description":"The SOS sort method for the display. Use the Width fields to determine how each column appears.", "type":"integer", "example":1 }, "recallReviewList":{ "description":"

    An array of column configurations to display on the KDS Recall/ Review List.

    \n

    Configuration is allowed for up to 6 columns. Use the Column Type to select the detail types from the following preset 9 choices.

    \n\n \n \n \n \n \n \n \n \n \n \n \n
    0 None
    1 Check
    2 Table
    3 Revenue Center
    4 Done Time
    5 Done Time Elapsed
    6 Order Time Elapsed
    7 Server
    8 Order Type
    9 Items
    \n

    Use the Width fields to determine how each column appears.

    \n", "type":"array", "items":{ "type":"object", "properties":{ "colNum":{ "description":"The column number of the recall/review list.", "type":"integer", "example":1 }, "colType":{ "description":"The column type from the preset 9 choices.", "type":"integer", "example":1 }, "width":{ "description":"The column width relative to the total screen width.", "type":"integer", "example":1 } } } }, "kdsProdLocation":{ "description":"The placement of production item counters on the display. 1 - Top, 2 - Bottom", "type":"integer", "example":1 }, "kdsProdColumns":{ "description":"The maximum number of production item counters to show per line or production bar.", "type":"integer", "example":1 }, "prodItems":{ "description":"An array of production items.", "type":"array", "items":{ "type":"object", "properties":{ "prodItemNum":{ "description":"Sequence number of the production item.", "type":"integer", "example":1 }, "prodItemObjNum":{ "description":"Object number of the production item.", "type":"integer", "example":1 }, "persistence":{ "description":"An integer value representing the persistence type of the item on the display. 1 - Static. Shows counts on KDS displays even when the quantity is zero. 2 - Dynamic. Shows counts on KDS displays only for a non-zero quantity.", "type":"integer", "example":1 } } } }, "resolutionWidth":{ "description":"The width (in pixels) used to display KDS in a side-by-side (split window) display.", "type":"integer", "example":1 }, "resolutionHeight":{ "description":"The height (in pixels) used to display KDS in a side-by-side (split window) display.", "type":"integer", "example":1 }, "locationFromTop":{ "description":"A value representing how far from the top (in pixels) the KDS window should be placed on the workstation display screen.", "type":"integer", "example":1 }, "locationFromLeft":{ "description":"A value representing how far from the left (in pixels) the KDS window should be placed on the workstation display screen.", "type":"integer", "example":1 }, "minTableState":{ "description":"Minimum Table State", "type":"integer", "example":0 }, "maxTableState":{ "description":"Maximum Table State", "type":"integer", "example":1 } } } }, "body.KDS":{ "name":"Request Body", "in":"body", "description":"KDS parameters.", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "objectNum":{ "description":"Object number of the Kitchen Display Client.", "type":"integer", "example":1 } } } }, "body.OrderDevicesGetParametersv1":{ "description":"The input Body model that needs to be given.", "name":"Get Order Devices Method", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":100, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.OrderDevicesGetParametersv2":{ "name":"Get Order Devices Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.OrderDeviceCUDRequest":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "$ref":"#/definitions/OrderDeviceCUDRequestBody" }, "required":true }, "body.OrderDeviceCUDRequestv2":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Order Device", "type":"integer", "example":1 }, "name":{ "description":"A string that contains translations of name", "type":"object", "example":{ "1":"Property", "2":"Eigentum", "3":"Propiedad" } }, "deviceType":{ "description":"The remote device to which orders print. For a local device, orders print at the Local Order Receipt printer set for the workstation from which the order is placed. 1 - Remote, 2 - Local", "type":"integer", "example":1 }, "primaryDeviceType":{ "description":"Select the Primary Device Type . 0 - Printer, 1 - KDS", "type":"integer", "example":0 }, "deviceObjNum":{ "description":"Object number of the relevant order device record.", "type":"integer", "example":0 }, "backupDeviceObjNum":{ "description":"Object number of the backup order device in the event of a communication failure or other problem.", "type":"integer", "example":0 }, "orderDeviceRedirectObjNum":{ "description":"Object number of the order device to which orders sent to this device should be redirected. Typically, this field is set to itself.", "type":"integer", "example":0 }, "customInstructions":{ "description":"instructions (up to 250 characters) for the workstation's script to handle order output based on custom instructions in the script in case of using Custom Print Handling", "type":"string", "example":"Custom Instructions" }, "primaryDistGroupObjNum":{ "description":"Object number of the Primary Distribution Group for the KDS. Applicable only if primaryDeviceType = 1", "type":"integer", "example":1 }, "condimentSortType":{ "description":"Specify how condiments will be sorted on the selected order device. The options are: 1 - No condiment sorting - (Condiments are listed in the order entered by the user), 2 - Sort allowed condiments - (Required condiments are not sorted), 3 - Sort all condiments (All condiments are sorted)", "type":"integer", "example":1 }, "menuItemPrinting":{ "description":"the type of menu items to output to the order device. 1 - All Items, 2 - Only Items with Condiments, 3 - Only items without condiments", "type":"integer", "example":1 }, "maxNumLinePerChit":{ "description":"the maximum number of lines (0-99) to print on each page of an order chit. Applicable only if primaryDeviceType = 0", "type":"integer", "example":0 }, "sortConsoldiationMethod":{ "description":"

    The sort and consolidation method for the order device.

    \n \n \n \n \n \n \n \n \n \n \n
    0 Do Not Sort
    1 Seat Consolidated
    2 Seat No Consolidation
    3 Print Group Consolidated
    4 Print Group No Consolidation
    5 Seat & Print Group Consolidated
    6 Seat & Print Group No Consolidation
    7 Print Group and Seat Consolidated
    8 Print Group and Seat No Consolidation
    \n

    Applicable only if primaryDeviceType = 0

    \n", "type":"integer", "example":0 }, "languageObjNum":{ "description":"Object number of the primary language for the order device. Applicable only if primaryDeviceType = 0", "type":"integer", "example":1 }, "language2ObjNum":{ "description":"Object number of the secondary language for the print output. Applicable only if primaryDeviceType = 0", "type":"integer", "example":2 }, "language3ObjNum":{ "description":"Object number of the third language for the print output. Applicable only if primaryDeviceType = 0", "type":"integer", "example":3 }, "lineFeedBeforeOrder":{ "description":"The number of lines to advance before printing the order on order chits. Applicable only if primaryDeviceType = 0", "type":"integer", "example":0 }, "lineFeedsAfterOrder":{ "description":"The number of lines to advance after printing the order on order chits. Applicable only if primaryDeviceType = 0", "type":"integer", "example":0 }, "kdsSettings":{ "type":"object", "properties":{ "course1FirstAlertTimeInSecs":{ "description":"The amount of time, in seconds, for course 1 items to show the first alert.", "type":"integer", "example":0 }, "course1SecondAlertTimeInSecs":{ "description":"The amount of time, in seconds, for course 2 items to show the second alert.", "type":"integer", "example":0 }, "othCourseFirstAlertTimeInSecs":{ "description":"The amount of time, in seconds, for any course except course 1 to show the first alert.", "type":"integer", "example":0 }, "othCourseSecondAlertTimeInSecs":{ "description":"The amount of time, in seconds, for any course except course 1 to show the second alert.", "type":"integer", "example":0 }, "primaryRunnerChitPrinterObjNum":{ "description":"Object number of the printer where runner chits print when orders are bumped from the KDS.", "type":"integer", "example":0 }, "backupRunnerChitPrinterObjNum":{ "description":"Object number of the printer where runner chits print when orders are bumped from the KDS if Simphony cannot establish communication with the primary runner chit printer", "type":"integer", "example":0 }, "sendToPanelNum":{ "description":"The number of a panel (1 through 9) where orders appear on this device.", "type":"integer", "example":0 }, "domType":{ "description":"the Dynamic Order Mode type for the KDS Display.", "type":"integer", "example":0 }, "addSortRule":{ "description":"The sort type to use when the quantity of an item changes.", "type":"integer", "example":0 }, "modifySortRule":{ "description":"The sort type to use when existing items on an order are modified.\\ 0 - Sort to Top", "type":"integer", "example":0 }, "voidSortRule":{ "description":"The sort type to use when an item is voided.", "type":"integer", "example":0 }, "addHighlightScheme":{ "description":"The color configuration to use to highlight items with the quantity changed.", "type":"integer", "example":0 }, "modifyHighlightScheme":{ "description":"The color configuration to use to highlight modified items on orders.", "type":"integer", "example":0 }, "voidHighlightScheme":{ "description":"The color configuration to use to highlight voided items.", "type":"integer", "example":0 }, "beepOnNewOrder":{ "description":"The sound type to emit when an order is received on the order device", "type":"integer", "example":0 }, "newOrderNotificationTimeInSecs":{ "description":"The length of time, in seconds, newly added items flash on screen.", "type":"integer", "example":0 }, "displayNewOrderNotification":{ "description":"A Boolean flag indicating to make new orders flash when appearing on the KDS Display if not using DOM", "type":"boolean", "example":false }, "beepOnPrioritize":{ "description":"The sound type to emit when an order is prioritized or the order priority is increased on the order device. 0 - None, 1 - PC Speaker, 2 - WAV File, 3 - Bump Bar Speaker", "type":"integer", "example":0 }, "beepOnVIP":{ "description":"The sound type to emit when a VIP order is received.", "type":"integer", "example":0 }, "beepOnRush":{ "description":"0 - None, 1 - PC Speaker, 2 - WAV File, 3 - Bump Bar Speaker", "type":"integer", "example":0 } } }, "printerOptions":{ "description":"A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the Printer Order Device. Applicable if primaryDeviceType = 0", "type":"string", "example":"000000000000000000000000000000000000000000000000" }, "kdsOptions":{ "description":"A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the KDS Order Device. Applicable if primaryDeviceType = 1", "type":"string", "example":"000000000000000000000000000000000000000000000000" } } }, "required":true }, "body.CashiersGetParametersv1":{ "description":"The input Body model that needs to be given.", "name":"Get Cashiers Method", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported.", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.CashiersGetParametersv2":{ "name":"Get Cashiers Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.CUCashiersRequest":{ "name":"Request body", "in":"body", "description":"A CU request body", "schema":{ "$ref":"#/definitions/CUCashiersRequestBody" }, "required":true }, "body.CUCashiersRequestv2":{ "name":"Request body", "in":"body", "description":"A CU request body", "schema":{ "description":"Model for Cashiers CU Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit id of the revenue center.", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object number of the cashiers.", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the cashiers in configured languages.", "type":"object", "example":{ "1":"Cashier", "2":"La caissiere", "3":"Cajero" } } } }, "required":true }, "body.Cashiers":{ "name":"Cashiers", "in":"body", "description":"Cashiers Object", "schema":{ "$ref":"#/definitions/CashierResponseV1" }, "required":true }, "body.DeleteCashiersRequestBody":{ "name":"Delete Request body", "in":"body", "description":"Delete request body.", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit id of the revenue center.", "example":1 }, "objectNum":{ "description":"Object number of the Cashiers.", "type":"integer", "example":1 } } }, "required":true }, "body.PaymentDriverConfigurationsGetParametersv1":{ "name":"Get Payment Driver Configuration Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.PaymentDriverConfigurationsGetParametersv2":{ "name":"Get Payment Driver Configuration Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.PaymentDriverConfigCUDRequest":{ "name":"Request body", "in":"body", "description":"A CUD request body", "schema":{ "description":"Model for a Payment Driver Configuration CUD Request.", "type":"object", "required":[ "hierUnitId", "objectNum", "name", "configuration" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit.", "type":"integer", "example":1034 }, "objectNum":{ "description":"Object number of the Payment Driver.", "type":"integer", "example":20 }, "configuration":{ "description":"An object containing the configuration parameters for the payment driver.", "type":"object", "properties":{ "assemblyName":{ "description":"Name of the assembly containing the module", "type":"string" }, "categoryAndType":{ "description":"Category and type of the driver to be initiated", "type":"string" }, "className":{ "description":"Class name of the module to be initiated", "type":"string" }, "description":{ "description":"A description for this module", "type":"string" }, "currencyCode":{ "description":"Enter the 3 digit ISO Numeric Currency Code. (SPI Only)", "type":"string" }, "enableQuickChip":{ "description":"Select True to enable the Quick Chip feature with fast transactions. The payment Service provider should support this feature.(SPI only)", "type":"boolean" }, "merchantNumber":{ "description":"Enter the merchant identification number.", "type":"string" }, "supportsCardAcquisition":{ "description":"Select True to enable the Payment Service Provider to supply Card Acquisition payment and loyalty data.(SPI only)", "type":"boolean" }, "hostTimeout":{ "description":"Timeout in seconds before the request is abandoned.", "type":"integer" }, "includeNamespaceWithXMLMessage":{ "description":"Include NameSpace elements in XML message.(SPI only)", "type":"boolean" }, "passphrase":{ "description":"Enter the authentication pass phrase.(OPI only)", "type":"string" }, "primaryHost":{ "description":"Enter the URL for the endpoint.(format- http(s)://host:port number)", "type":"string" }, "spiInterface":{ "description":"True- Use SPI Interface, False- Use OPI JSON Interface", "type":"boolean" }, "validateXMLAgainstSchema":{ "description":"Validate XML message against schema and log errors in SPIXML.log.(SPI only)", "type":"boolean" }, "securitySettings":{ "description":"Http Only; Https without certificate validation; Https with certificate validation(Server certificate required, Client certificate optional)(SPI only)", "type":"integer" }, "serverCertificate":{ "description":"Server certificate public key", "type":"string" }, "serverCertCommonName":{ "description":"Displays server certificate common name, if loaded", "type":"string" }, "serverCertEffectiveDt":{ "description":"Displays server certificate effective date, if loaded", "type":"string" }, "serverCertExpDt":{ "description":"Displays server certificate expiration date, if loaded", "type":"string" }, "clientCertificate":{ "description":"Client certificate public key", "type":"string" }, "clientCertCommonName":{ "description":"Displays client certificate common name, if loaded", "type":"string" }, "clientCertEffectiveDt":{ "description":"Displays client certificate effective date, if loaded", "type":"string" }, "clientCertExpDt":{ "description":"Displays client certificate expiration date, if loaded", "type":"string" }, "clientCertPassword":{ "description":"Client certificate password", "type":"string" } } } } }, "required":true }, "body.PaymentDriverConfig":{ "name":"Payment Driver Configuration", "in":"body", "description":"Payment Driver Configuration Object.", "required":true, "schema":{ "$ref":"#/definitions/PaymentDriverConfigv1" } }, "body.EffectivityGroupsGetParametersv1":{ "name":"Get Effectivity Groups Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.EffectivityGroupsGetParametersv2":{ "name":"Get Effectivity Groups Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.EffectivityGroupsCUDRequest":{ "name":"Request body", "in":"body", "description":"CUD request body for effectivity groups", "schema":{ "$ref":"#/definitions/EffectivityGroupsCUDRequestBody" }, "required":true }, "body.EffectivityGroupsCUDRequestv2":{ "name":"Request body", "in":"body", "description":"CUD request body for effectivity groups", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the effectivity group", "type":"integer", "example":1 }, "name":{ "description":"name of the Effectivity Group", "type":"object", "example":{ "1":"Effectivity Group 1", "2":"Efectividad Grupo 1" } }, "activeTimes":{ "type":"array", "items":{ "properties":{ "effId":{ "description":"The unique reference of the effectivity record", "type":"integer", "example":1 }, "startTime":{ "description":"The time that the record becomes active for each Active Time interval. Leave the field blank if the start time is not relevant.", "type":"string", "example":"2020-01-01T00:00:00" }, "endTime":{ "description":"The time that the record becomes inactive for each Active Time interval. Leave the field blank if the record never becomes inactive", "type":"string", "example":"2020-12-31T23:59:59" }, "timeIsLocal":{ "description":"A Boolean flag indicating if the Start/End times represent the local time of the property.", "type":"boolean", "example":false }, "mustActivateBy":{ "description":"The time that the record must activate for each Active Time. This should be between startTime and endTime.\n", "type":"string", "example":"2023-11-17T02:27:39" } } } }, "allowLocalControl":{ "description":"A Boolean flag indicating if the effectivity group is allowed to be controlled at local level.\n", "type":"boolean", "example":true }, "dataExtensions":{ "description":"An array of data extensions for the effectivity group", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extention field", "type":"string", "example":"extension_Column" }, "value":{ "description":"value of the extension field", "type":"string", "example":"value1" } } } } } }, "required":true }, "body.EffGroupDeleteRequestBody":{ "name":"EffGroup Delete Request Body", "in":"body", "description":"EffGroup Delete Request body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the effectivity group", "type":"integer", "example":1 } } }, "required":true }, "formData.BulkInsertEffectivityGroupsRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for inserting Effectivity Groups in bulk", "type":"file", "required":true }, "formData.BulkUpdateEffectivityGroupsRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for updating Effectivity Groups in bulk", "type":"file", "required":true }, "body.CurrencyGetParametersv1":{ "name":"Get Currency and Currency parameters Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.CurrencyParametersGetParametersv1":{ "name":"Get Currency and Currency parameters Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.CurrencyGetParametersv2":{ "name":"Get Currency and currency parameters Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.CurrencyParametersGetParametersv2":{ "name":"Get Currency and currency parameters Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.CUDCurrencyRequest":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "$ref":"#/definitions/CUDCurrencyRequestBody" }, "required":true }, "body.CUDCurrencyRequestv2":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "description":"Model for Currency CUD Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "objectNum":{ "description":"Object number of the currency.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Currency is configured", "type":"integer", "example":3599 }, "name":{ "type":"object", "description":"Currency Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "abbreviation":{ "type":"object", "description":"Abbreviation", "example":{ "1":"USD", "2":"INR", "3":"IND" } }, "symbol":{ "description":"The record symbol of the currency.", "type":"string", "example":"$" }, "numberOfDigits":{ "description":"The number of digits after the decimal point that each currency allows. Default value is 2.Values between 1-3.", "type":"integer", "example":2 }, "options":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currency", "type":"string", "example":"11010101" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } }, "required":true }, "body.CUDCurrencyParameterRequest":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "description":"Model for Currency Parameter CUD Request", "type":"object", "required":[ "hierUnitId", "baseCurrObjNum" ], "properties":{ "baseCurrObjNum":{ "description":"Object number of the currency.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Currency Parameter is configured", "type":"integer", "example":3599 }, "options":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currency parameter", "type":"string", "example":"11010101" } } }, "required":true }, "body.DeleteCurrrencyParameterRequestBody":{ "name":"Delete Request body", "in":"body", "description":"Delete request body.", "schema":{ "type":"object", "required":[ "hierUnitId" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 } } }, "required":true }, "body.EnableEffectivityGroupsGetParametersv1":{ "name":"Get Enable Effectivity Groups Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.EnableEffectivityGroupsGetParametersv2":{ "name":"Get Enable Effectivity Groups Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.EnableEffGroupsCURequest":{ "name":"Request body", "in":"body", "description":"CU request body for Enable Effectivity Groups", "schema":{ "type":"object", "required":[ "hierUnitId", "changeSetId", "enableEffectivityGroup" ], "properties":{ "hierUnitId":{ "description":"hierUnitId of property where the record is inherited", "type":"integer", "example":1 }, "changeSetId":{ "description":"Unique reference of the inherited effectivity group.", "type":"integer", "example":1 }, "enableEffectivityGroup":{ "description":"Flag indicating if the effectivity group is enabled or not.", "type":"boolean", "example":false } } }, "required":true }, "body.EnableEffGroupsDeleteRequestBody":{ "name":"Delete Request Body for Enable Effectivity Groups", "in":"body", "description":"Delete Request body for Enable Effectivity Groups", "schema":{ "type":"object", "required":[ "hierUnitId", "changeSetId" ], "properties":{ "hierUnitId":{ "description":"hierUnitId of property where the record is inherited", "type":"integer", "example":1 }, "changeSetId":{ "description":"Unique reference of the inherited effectivity group.", "type":"integer", "example":1 } } }, "required":true }, "body.MenuItemClassesGetParametersv1":{ "name":"Get Menu Item Classes Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.MenuItemClassesGetParametersv2":{ "name":"Get Menu Item Classes Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.MenuItemClass.Required":{ "name":"Request Body", "in":"body", "description":"Request body", "schema":{ "$ref":"#/definitions/MenuItemClass" }, "required":true }, "body.MenuItemClassCUDRequest":{ "name":"Request Body", "in":"body", "description":"CUD Request body", "schema":{ "$ref":"#/definitions/MenuItemClassCUDRequestBody" }, "required":true }, "body.MenuItemClassCUDRequestv2":{ "name":"Request Body", "in":"body", "description":"CUD Request body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the menu item Class." }, "name":{ "type":"object", "description":"Menu Item Class Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "taxClassObjNum":{ "type":"integer", "example":1, "description":"Tax Class object for the Menu Item class" }, "mainLevelPopupIndex":{ "type":"integer", "example":1, "description":"Main Level of the transaction to become active after adding an item from this Menu Item Class." }, "mainLevelDefault":{ "type":"boolean", "example":false, "description":"Select Main Level Dflt to return the Main Level of the transaction to the default Main Level after adding an item from this Menu Item Class." }, "subLevelPopupIndex":{ "type":"integer", "example":1, "description":"Sub Level of the transaction to become active after adding an item from this Menu Item Class." }, "subLevelDefault":{ "type":"boolean", "example":false, "description":"Select Sub Level Dflt to return the Sub Level of the transaction to the default Sub Level after adding an item from this Menu Item Class." }, "privilegeGroup":{ "type":"integer", "example":1, "description":"Privilege Group number to restrict the use of items in this Menu Item Class to employees who are linked to the same Privilege Group" }, "slsItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Sales Itemizer used to sort Menu Item Classes." }, "dscItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Discount Itemizer associated with this Menu Item Class." }, "svcItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Service Charge Itemizer associated with menus items assigned to this Menu item Class." }, "halo":{ "type":"integer", "example":1, "description":"High Amount Lock Out (HALO) value for items in this Menu Item Class." }, "kdsCourseObjNum":{ "type":"integer", "example":1, "description":"Object number of the course to which items in this Menu Item Class belong." }, "defaultMasterGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the default parent item for a condiment during conversational ordering." }, "condimentOrderType":{ "type":"integer", "example":1, "description":"Method for adding a condiment to a check. Value should be between 0-4." }, "condimentOrderPopup":{ "type":"integer", "example":1, "description":"Popup Condiment Orderer page to automatically pop up when adding a menu item with required condiments." }, "condimentEditPopup":{ "type":"integer", "example":0, "description":"Condiment Orderer page to automatically pop up when selecting a menu item with required condiments in the check detail." }, "priceCalculation":{ "type":"integer", "example":0, "description":"Calculation method to use for pricing menu items in the class when entering a decimal count." }, "countDisplay":{ "type":"integer", "example":1, "description":"Count that appear on the workstation and printers." }, "countEntry":{ "type":"integer", "example":1, "description":"Select the operator entry method for item sales count." }, "printGroup":{ "type":"integer", "example":1, "description":"The sorting mechanism uses this value for receipt printing, check detail, and order output devices." }, "printClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Print Class for the menu item class." }, "kdsHighlightScheme":{ "type":"integer", "example":1, "description":"Object number of the KDS Highlight Scheme color to display menu items on the KDS." }, "condimentPrefixType":{ "type":"integer", "example":1, "description":"Prefix Type associated with a Condiment type." }, "condimentHandlingWithParentItemSwitching":{ "type":"integer", "example":0, "description":"Condiment behavior to use for Default and other Condiments when the parent item is switched in Conversational Ordering." }, "nextPage":{ "type":"integer", "example":0, "description":"Next screen or page to which the workstation user is directed." }, "nextPanel":{ "type":"integer", "example":0, "description":"Panel specifies which Tab to navigate." }, "maxRefillCount":{ "type":"integer", "example":1, "description":"Maximum number of Refills allowed for a Menu item." }, "refillDescriptor":{ "type":"object", "description":"Refill Descriptor", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "svcGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the Service Charge Group to apply to this Menu Item Class." }, "preProdChitPrintClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Pre Production Chit Print Class for the Menu Item Class." }, "allergenClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Allergen Class for the Menu Item Class." }, "options":{ "type":"string", "example":"010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 96 representing the enablement or disablement of the options associated with the Menu Item Class." }, "condimentGroups":{ "$ref":"#/definitions/MenuItemClass_condimentGroups" }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item class", "items":{ "$ref":"#/definitions/MenuItemClass_dataExtensions" } } } }, "required":true }, "body.MenuItemClassDeleteRequest.Required":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Menu Item Class" } } } }, "formData.BulkInsertComboSideGroupRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for inserting Combo Side Groups in bulk", "type":"file", "required":true }, "formData.BulkUpdateComboSideGroupRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for updating Combo Side Groups in bulk", "type":"file", "required":true }, "body.ComboSideGroupsGetParametersv1":{ "name":"Get Combo Side Groups Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.ComboSideGroupsGetParametersv2":{ "name":"Get Combo Side Groups Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.ComboMealGroupCUDRequestBodyv2":{ "name":"Request Body", "description":"Request body.", "required":true, "in":"body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "objectNum":{ "type":"integer", "example":1, "description":"Combo Meal object number" }, "name":{ "type":"object", "description":"Combo Group Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing enabled or disabled options" }, "alternateGroups":{ "type":"array", "description":"An array of Alternate Groups, if any, for this Combo Meal Group.", "items":{ "$ref":"#/definitions/ComboMealGroup_AlternateGroup" } }, "items":{ "type":"array", "description":"An array of items that are associated with the combo meal group", "items":{ "$ref":"#/definitions/ComboMealGroup_Items_CUD" } } } } }, "body.ComboMealGroupUpdateRequestBodyv2":{ "name":"Request Body", "description":"Request body.", "required":true, "in":"body", "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealGroupId", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" }, "name":{ "type":"object", "description":"Combo Group Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing enabled or disabled options" }, "alternateGroups":{ "type":"array", "description":"An array of Alternate Groups, if any, for this Combo Meal Group.", "items":{ "$ref":"#/definitions/ComboMealGroup_AlternateGroup" } }, "items":{ "type":"array", "description":"An array of items that are associated with the combo meal group", "items":{ "$ref":"#/definitions/ComboMealGroup_Items_UpdateV2" } } } } }, "body.ComboSideGroupsDeleteRequest":{ "name":"Request Body", "description":"Request body.", "required":true, "in":"body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Combo Meal" } } } }, "body.ComboSideGroupsDeleteRequestV2":{ "name":"Request Body", "description":"Request body.", "required":true, "in":"body", "schema":{ "type":"object", "required":[ "comboMealGroupId" ], "properties":{ "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" } } } }, "body.ComboMealsSideGroupsDeleteRequestBody":{ "in":"body", "name":"request body", "description":"Combo Meal Side Groups object", "required":false, "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "comboMealObjNum":{ "type":"integer", "example":2, "description":"Unique reference of the Combo Meal." }, "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side." } } } }, "body.ComboMealsSideGroupsInsertRequestBody":{ "in":"body", "name":"request body", "description":"Combo Meal Side Groups", "required":false, "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealObjNum", "comboGrpObjNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "comboMealObjNum":{ "type":"integer", "example":1, "description":"Combo Meal object number" }, "comboGrpObjNum":{ "type":"integer", "example":1, "description":"Object number of the Side Item Group that contains the side items for the combo meal." }, "sideCount":{ "type":"integer", "example":1, "description":"Number of Combo Meal Group items required for the combo meal side." }, "defaultMenuLevelIndex":{ "type":"integer", "example":1, "description":"Index of the default menu level for this combo group." }, "menuLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing the configured menu levels that are available for ordering with this combo group" } } } }, "body.ComboMealsSideGroupsUpdateRequestBody":{ "in":"body", "name":"request body", "description":"Combo Meal Side Groups Object", "required":false, "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealObjNum", "sideNum", "comboGrpObjNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "comboMealObjNum":{ "type":"integer", "example":1, "description":"Combo Meal object number" }, "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side." }, "comboGrpObjNum":{ "type":"integer", "example":1, "description":"Object number of the Side Item Group that contains the side items for the combo meal." }, "sideCount":{ "type":"integer", "example":1, "description":"Number of Combo Meal Group items required for the combo meal side." }, "defaultMenuLevelIndex":{ "type":"integer", "example":1, "description":"Index of the default menu level for this combo group." }, "menuLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing the configured menu levels that are available for ordering with this combo group" } } } }, "body.ComboMealsSideGroupsGetParametersv2":{ "in":"body", "name":"request body", "description":"request body for Combo Meals", "required":false, "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealObjNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "comboMealObjNum":{ "type":"integer", "example":2, "description":"Unique reference of the Combo Meal" } } } }, "body.ComboGroupItemCUDRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealGroupObjNum", "itemObjNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealGroupObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal group" }, "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "quantity":{ "type":"integer", "example":1, "description":"The quantity of the item" }, "options":{ "type":"string", "example":"000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the Combo Meal Group Item. If not specified, this will represent the default options associated with the Combo MealGroup Item" }, "size1ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 1 function key (663)." }, "size2ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 2 function key (664)." }, "size3ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 3 function key (665)." }, "size4ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 4 function key (666)." }, "size1MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 1. Valid range is between 1 and 8." }, "size2MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 2. Valid range is between 1 and 8." }, "size3MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 3. Valid range is between 1 and 8." }, "size4MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 4. Valid range is between 1 and 8." }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group" }, "prices":{ "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items.", "$ref":"#/definitions/Price_ComboGroupItem" } }, "description":"Model for Combo Group Item Object" } }, "body.ComboGroupItemCUDRequestV2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealGroupId", "itemObjNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit where the side group item is located" }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" }, "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "quantity":{ "type":"integer", "example":1, "description":"The quantity of the item" }, "options":{ "type":"string", "example":"000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the Combo Meal Group Item. If not specified, this will represent the default options associated with the Combo MealGroup Item" }, "size1ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 1 function key (663)." }, "size2ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 2 function key (664)." }, "size3ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 3 function key (665)." }, "size4ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 4 function key (666)." }, "size1MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 1. Valid range is between 1 and 8." }, "size2MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 2. Valid range is between 1 and 8." }, "size3MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 3. Valid range is between 1 and 8." }, "size4MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 4. Valid range is between 1 and 8." }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group" }, "prices":{ "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items.", "$ref":"#/definitions/Price_ComboGroupItemV2" } }, "description":"Model for Combo Group Item Object" } }, "body.ComboSideGroupItemsGetParametersv1":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/ComboGroupItemGetRequestBody" } }, "body.ComboSideGroupItemsGetParametersv2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "comboMealGroupId" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" } } } }, "body.ComboGroupItemDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "itemObjNum", "comboMealGroupObjNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit where the side group item is located" }, "comboMealGroupObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal group" }, "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" } } } }, "body.ComboGroupItemDeleteRequestV2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "itemObjNum", "comboMealGroupId" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit where the side group item is located" }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" }, "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" } } } }, "formData.BulkInsertComboSideGroupItemRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for inserting Combo Side Group Items in bulk", "type":"file", "required":true }, "formData.BulkUpdateComboSideGroupItemRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for updating Combo Side Group Items in bulk", "type":"file", "required":true }, "body.CondimentGroupCUDRequestBody":{ "in":"body", "name":"CondimentGroup CUD Request Body", "description":"CUD Request Body for Condiment Group object of the organization", "required":true, "schema":{ "$ref":"#/definitions/CondimentGroupCUDRequestBody" } }, "body.CondimentGroupCUDRequestBodyv2":{ "in":"body", "name":"CondimentGroup CUD Request Body", "description":"CUD Request Body for Condiment Group object of the organization", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the condiment Group" }, "name":{ "type":"object", "description":"Condiment Group Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "consumerDescription":{ "type":"object", "description":"Consumer Description", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } } }, "description":"CUD Request Body for Condiment Group Object" } }, "body.CondimentGroupsGetParametersv1":{ "name":"Get Condiment Groups Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.CondimentGroupsGetParametersv2":{ "name":"Get Condiment Groups Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.CondimentGroupDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment group" } } } }, "body.CondimentSet":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/CondimentSet" } }, "body.CondimentSetCUDRequestBody":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/CondimentSetCUDRequestBody" } }, "body.CondimentSetCUDRequestBodyv2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment set" }, "name":{ "type":"object", "description":"Condiment Set Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "condimentItems":{ "type":"array", "description":"An array of menu items that are part of the condiment set", "items":{ "$ref":"#/definitions/CondimentSet_condimentItemsCUD" } } }, "description":"CUD Request Body for Condiment Set Object" } }, "body.CondimentSetDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment set" } } } }, "body.CondimentSetsGetParametersv1":{ "name":"Get Condiment Sets Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.CondimentSetsGetParametersv2":{ "name":"Get Condiment Sets Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.CondimentSetItemsGetParametersv1":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/CondimentSetItemsGetRequestBody" } }, "body.CondimentSetItemsGetParametersv2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the condiment set" } } } }, "body.CondimentSetItemInsertRequestBody":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment set" }, "miMstrObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master assigned to the condiment item" }, "defaultCount":{ "type":"integer", "example":1, "description":"The number of each condiment that comes with the set. Value must lie between 0 and 99999999." }, "sortOrder":{ "type":"integer", "example":1, "description":"The order in which the condiments are displayed on checks, receipts, SLUs, and KDS displays. Value must lie between 0 and 32767." }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment item" }, "miDefSequence":{ "type":"integer", "example":0, "description":"The Menu Item definition sequence number of each record. This coincides with the Menu Item Definition that appears in the POS client when the condiment is triggered." } }, "description":"Model for Condiment Set Item Object" } }, "body.CondimentSetItemUpdateRequestBody":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment set" }, "condimentItemNum":{ "type":"integer", "example":1, "description":"Sequence number of the condiment item" }, "miMstrObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master assigned to the condiment item" }, "defaultCount":{ "type":"integer", "example":1, "description":"The number of each condiment that comes with the set. Value must lie between 0 and 99999999." }, "sortOrder":{ "type":"integer", "example":1, "description":"The order in which the condiments are displayed on checks, receipts, SLUs, and KDS displays. Value must lie between 0 and 32767." }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment item" }, "miDefSequence":{ "type":"integer", "example":0, "description":"The Menu Item definition sequence number of each record. This coincides with the Menu Item Definition that appears in the POS client when the condiment is triggered." } }, "description":"Model for Condiment Set Item Object" } }, "body.CondimentSetItemDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "condimentItemNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment set" }, "condimentItemNum":{ "type":"integer", "example":1, "description":"Sequence number of the condiment item" } } } }, "body.ServiceChargeItemizersGetParametersv1":{ "name":"Get Service Charge Itemizers Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.ServiceChargeItemizersGetParametersv2":{ "name":"Get Service Charge Itemizers Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.ServiceChargeItemizersCURequestBody":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/ServiceChargeItemizersCURequestBody" } }, "body.ServiceChargeItemizersCURequestBodyv2":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "description":"Model for Service Charge Itemizers Object for Create/Update Request", "type":"object", "required":[ "hierUnitId", "svcItmzrIndex", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "svcItmzrIndex":{ "description":"Object number of the Service Charge Itemizer", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Service Charge Itemizer in configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } } } } }, "body.ServiceChargeItemizers":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/ServiceChargeItemizers" } }, "body.ServiceChargeItemizersDeleteRequest":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "svcItmzrIndex" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "svcItmzrIndex":{ "description":"Object number of the Service Charge Itemizer", "type":"integer", "example":1 } } } }, "body.AllergenClassesGetParameters":{ "name":"Get Allergen Classes Method", "description":"Allergen class get request body.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum, 2)", "description":"If specified, returns records that match the criteria. Allowed fields are objectNum, name and allergenCodes." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order. Allowed fields are objectNum, name and allergenCodes.", "example":"objectNum:asc" } } } }, "body.AllergenClassesCURequest":{ "name":"Insert and Update Request Body", "in":"body", "description":"Allergen Classes insert and update request body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Hier Unit Id of the Enterprise", "type":"integer", "example":7 }, "objectNum":{ "description":"Object Number of the Allergen Class.", "type":"integer", "example":2 }, "name":{ "type":"object", "description":"Name of the Allergen Class.", "example":{ "1":"Entp", "2":"AllergenClass", "3":"Emp" } }, "allergenCodes":{ "type":"string", "description":"Allergen Codes listed as comma-separated values for an Allergen Class.", "example":"Milk,Eggs,Fish" } } } }, "body.AllergenClassesDeleteRequest":{ "name":"Delete Request Parameters", "in":"body", "description":"Allergen Class Delete Request Body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":7, "description":"Hier Unit Id of the Enterprise." }, "objectNum":{ "type":"integer", "example":2, "description":"Object Number of the Allergen Class." } } } }, "body.LocationParametersGetRequestBodyv1":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/LocationParametersGetRequestBodyv1" } }, "body.LocationParametersGetRequestBodyv2":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." } } } }, "body.LocationParametersCUDRequestBody":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/LocationParametersCUDRequestBody" } }, "body.LocationParametersUpdateRequestBodyv2":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "taiwanGUIParameters", "timekeeping", "calendar", "serialNumberInfo" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the location", "type":"integer", "example":1 }, "numDaystoSaveCABatchFiles":{ "description":"The number of days to retain Credit Authorization batch files and log files. Value must lie between 1 and 999 (both inclusive).", "type":"integer", "example":1 }, "ldsNLUGroup":{ "description":"The number of the Menu Item NLU Group to be used by menu items posted by the LDS", "type":"integer", "example":0 }, "taiwanGUIParameters":{ "$ref":"#/definitions/LocationParams_taiwanGUIParameters" }, "serialNumberInfo":{ "$ref":"#/definitions/LocationParams_serialNumberInfo" }, "language":{ "$ref":"#/definitions/LocationParams_languageV2CUD" }, "secondaryPrintLanguageObjNum":{ "description":"Object number of the language to print under the Default Language on a guest check or customer receipt", "type":"integer", "example":0 }, "secondaryPrintLanguageName":{ "description":"Name of the language to print under the Default Language on a guest check or customer receipt.", "type":"string", "example":"English" }, "wlsStrengthOfflineThreshold":{ "description":"The percentage amount to be used to determine if communications should be suspended for wireless workstations, until network signal strength is improved.", "type":"number", "example":0 }, "wlsStrengthReconnectThreshold":{ "description":"the percentage amount of signal strength to be used to determine at which point the system attempts to reconnect wireless workstations to the network.", "type":"number", "example":0 }, "emailConfiguration":{ "$ref":"#/definitions/LocationParams_emailConfiguration" }, "options":{ "description":"A string value of 0s & 1s of length 96 reprsenting options for location parameters.", "type":"string", "example":"000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" }, "optionsExt":{ "$ref":"#/definitions/LocationParams_optionsExt" }, "postingOptions":{ "description":"A string value of 0s & 1s of length 8 reprsenting posting options for location parameters.", "type":"string", "example":"00000000" }, "postingOptionsExt":{ "$ref":"#/definitions/LocationParams_postingOptionsExt" }, "workstationOptions":{ "$ref":"#/definitions/LocationParams_workstationOptionsv2" }, "serviceHosts":{ "type":"array", "description":"An array of service hosts associated with the location.", "items":{ "$ref":"#/definitions/LocationParams_serviceHostsv2" } }, "timekeeping":{ "$ref":"#/definitions/LocationParams_timekeeping" }, "calendar":{ "$ref":"#/definitions/LocationParams_calendarv2" }, "security":{ "$ref":"#/definitions/LocationParams_security" }, "simphonyEssentials":{ "$ref":"#/definitions/LocationParams_simphonyEssentials" }, "reportingOrgId":{ "description":"the ID of the organization to which this property belongs in the reporting databases", "type":"integer", "example":11866 }, "reportingLanguageObjNum":{ "description":"The object number of the language to use when posting data to Reporting and Analytics.", "type":"integer", "example":1 }, "reportingLanguage":{ "description":"The name of the language to use when posting data to Reporting and Analytics.", "type":"string", "example":"English" } } } }, "body.LocationParametersDeleteRequest":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/LocationParametersResponse" } }, "body.DiscountsGetParametersv1":{ "name":"Get Discounts Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.DiscountsGetParametersv2":{ "name":"Get Discounts Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.DiscountCURequestBody":{ "name":"Discount", "in":"body", "description":"Discount object of the organization", "required":true, "schema":{ "$ref":"#/definitions/DiscountCURequestBody" } }, "body.DiscountCURequestBodyv2":{ "name":"Discount", "in":"body", "description":"Discount object of the organization", "required":true, "schema":{ "description":"Model for Discount Object", "type":"object", "required":[ "hierUnitId", "objectNum", "name", "options" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Discount", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Discounts in configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "effGrpObjNum":{ "description":"Object number of the Effectivity Group for the current record", "type":"integer", "example":1 }, "consumerDisplayname":{ "description":"A group of string objects representing the name of the Discounts in configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "activationType":{ "description":"Type of Discount ; 0 - Manual (Manually Entered and applied);1 - Automatic (Automatically applied and operator cannot enter);2 - Coupon (Automatically applied, operator must enter)", "type":"integer", "example":1 }, "percent":{ "description":"Percentage for the manual discount. Value must lie between 0 and 1.", "type":"integer", "example":1 }, "minAmount":{ "description":"Minimum menu item subtotal amount", "type":"integer", "example":1 }, "maxAmount":{ "description":"Maximum amount allowed for an open-priced or amount discount", "type":"integer", "example":1 }, "taxClassObjNum":{ "description":"Tax Class to be Discounted", "type":"integer", "example":1 }, "privilegeGroup":{ "description":"Privilege Group number to restrict the use of the discount", "type":"integer", "example":1 }, "condimentDiscountability":{ "description":"Determine how condiment menu items are discounted;0 - Use Menu Item ClassOption;1 - Parent Items only;2 - Condiment Items only;3 - Parent and Highlighted Condiment Items;4 - Parent and all Condiment Items;5 - Single Condiment", "type":"integer", "example":1 }, "reportGroupObjnum":{ "description":"Report Group to associate with the discount.", "type":"integer", "example":1 }, "printClassObjNum":{ "description":"Print Class for the Discount", "type":"integer", "example":1 }, "enabled":{ "description":"A Boolean flag indicating to enabling the Discount", "type":"boolean", "example":false }, "triggerMIGrpObjNum":{ "description":"Menu Item Group that triggers the discount.", "type":"integer", "example":1 }, "triggerCondimentGrpObjNum":{ "description":"Condiment Menu Item Group to use as the trigger for the discount.", "type":"integer", "example":1 }, "options":{ "description":"A String of Values of 0s and 1s of length 56 representing the enablement or disablement of the options associated with Discounts", "type":"string", "example":"00000000000000000000000000000000000000000000000000000000" }, "effectivity":{ "description":"An object representing the effective dates for the record", "type":"object", "properties":{ "startDateTime":{ "description":"The effective start date for the record.", "type":"string", "example":"2021-09-22T00:00:00" }, "endDateTime":{ "description":"Enter the effective end date for the record", "type":"string", "example":"2022-09-21T23:59:59" }, "activeStartTime":{ "description":"Enter the effective start time for the record", "type":"string", "example":"09:00" }, "activeEndTime":{ "description":"Enter the effective end time for the record", "type":"string", "example":"22:00" }, "recurrenceDayOfWeek":{ "description":"Select the recurrence effective day of the week(Monday - Sunday) for the record", "type":"string", "example":"1111111" } } }, "rvcType":{ "description":"A string value of 0s & 1s of length 32 to configure the availability of the Discount in an RVC", "type":"string", "example":"00000000000000000000000000000000" }, "dscItmzr":{ "description":"A string value of 0s & 1s of length 15 representing the enablement or disablement of the discount itemizers on which the discount is computable", "type":"string", "example":"000000000000000" }, "menuLevels":{ "description":"An object containing the menu levels on which the discount is active", "type":"object", "properties":{ "mainLevel":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the discount on main levels", "type":"string", "example":"00000000" }, "sublevel":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the discount on sub levels", "type":"string", "example":"00000000" } } }, "transDefaultMainLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Main Level after pressing the discount", "type":"boolean", "example":false }, "mainLevelPopup":{ "description":"The Main Level that activates after pressing the discount", "type":"integer", "example":1 }, "transDefaultSubLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Sub Level after pressing the discount.", "type":"boolean", "example":false }, "subLevelPopup":{ "description":"The Sub Level that activates after pressing the discount", "type":"integer", "example":1 }, "sluObjNum":{ "description":"Object number of the Screen Lookup key for the discount.", "type":"integer", "example":1 }, "nlu":{ "description":"A unique Number Lookup (0-9,999,999,999) for the discount", "type":"integer", "example":1 }, "autoRule":{ "description":"Determine how Simphony calculates a discount", "type":"object", "properties":{ "autoRuleType":{ "description":"The types of Automatic Discounts rule;0 - Not Active;1 - Item Price Substitution;2 - Quantity Threshold;3 - Total Price Threshold;4 - Combination Pricing;5 - Sales Price", "type":"integer", "example":1 }, "constraintType":{ "description":"The types of Discounts Constraints;1-No Constraint, 2-Menu Item,3-Major Group,4-Family Group, Applicable only for autoRuleType 2 and 3.", "type":"integer", "example":1 }, "awardAlgorithm":{ "description":"The award algorithm to be used in the discount.;1- Best Deal for Customer to apply the highest discount amount to the check;2 - Best Deal for Merchant to apply the lowest discount amount to the check", "type":"integer", "example":1 }, "priority":{ "description":"The order in which the POS client calculates discounts. Applicable only for autoRuleType 1-4", "type":"integer", "example":1 }, "maxCountPerCheck":{ "description":"The maximum number of times the coupon discount can be entered on a check. Enter 0 for unlimited entries", "type":"integer", "example":1 }, "usePriceInMIGroupDetail":{ "description":"A Boolean flag indicating to use the Menu Item Groups promotion price for the discounted menu item. Does not function with Combination Pricing Discounts. Applicable only for autoRuleType - 1,2,3 and 5", "type":"boolean", "example":false }, "allowAwardOfHigherPricedTriggerItem":{ "description":"A Boolean flag indicating to allow award of a higher priced trigger item if the trigger item is also an award item. Applicable only for autoRuleType - 2 and 3", "type":"boolean", "example":false }, "triggerGroups":{ "description":"Menu Item Group to trigger the discount award.", "type":"array", "items":{ "type":"object", "properties":{ "sequenceNum":{ "description":"Sequence Number of the Menu Item Group", "type":"integer", "example":1 }, "triggerMIGroupObjNum":{ "description":"Object number of the Menu Item Group to trigger the discount award.", "type":"integer", "example":1 }, "triggerCondimentGroupObjNum":{ "description":"Object number of the Condiment Menu Item Group to use as the trigger for the discount", "type":"integer", "example":1 }, "minimumQuantity":{ "description":"Number of items that customers must order from the corresponding trigger menu group before applying the discount award.", "type":"integer", "example":1 }, "total":{ "description":"Total amount of corresponding trigger menu item group items customers must order before applying the discount", "type":"number", "example":1 } } } }, "awardGroups":{ "description":"An array of award groups for the discount", "type":"array", "items":{ "type":"object", "properties":{ "sequenceNum":{ "description":"The sequence number of the award group", "type":"integer", "example":1 }, "awardMIGroupObjNum":{ "description":"Object number of the menu item group that is to be discounted. Applicable only for autoRuleType - 2 and 3", "type":"integer", "example":1 }, "awardType":{ "description":"Type of the award;0 - None;1 - Percent Off;2 - Amount Off;3 - Amount Substitution", "type":"integer", "example":1 }, "percentOff":{ "description":"The percentage of the percent-based discount. Applicable only for awardType - 1. Value must lie between 0 and 1. For Example 15% will be 0.15 in the 200 response body.", "type":"integer", "example":1 }, "amountOff":{ "description":"The discount amount for flat amount-based discount. Applicable only for awardType - 2", "type":"number", "example":1 }, "amountSubstitution":{ "description":"The price to charge for each item in the Trigger Menu Item Group. Applicable only for awardType - 3", "type":"number", "example":1 }, "awardCount":{ "description":"The maximum number of items discounted after reaching the Trigger MI Group's Minimum Quantity", "type":"number", "example":1 }, "maxCount":{ "description":"When Simple Transaction Exclusivity is set for this discount, enter the maximum number of discounts that can be applied to one check. Applicable only for autoRuleType - 1-4", "type":"number", "example":1 } } } } } }, "exclusivity":{ "description":"Exclusivity stops all discounts from applying to a check at once. Discount exclusivity controls how multiple discounts interact with each other.", "type":"object", "properties":{ "transaction":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the discount on transactions", "type":"string", "example":"00000000000000000000000000000000" }, "item":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the discount on specific menu items", "type":"string", "example":"00000000000000000000000000000000" } } }, "orderChannelRestrictions":{ "description":"The order channels that are considered for the discount. Each objectNum belongs to a particular order channel.", "type":"array", "items":{ "type":"object", "required":[ "objectNum" ], "properties":{ "objectNum":{ "type":"integer", "description":"object number of a particular order channel", "example":1 } } } }, "orderTypeRestrictions":{ "description":"A string of values of 0s and 1s of length 32 representing ordertypes from 1 to 32, with a value of 1 indicating respected order type is included and 0 indicating exclusion.", "type":"string", "example":"11100000000000000000000000000000" }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } } }, "body.DiscountDeleteRequestBody":{ "name":"DiscountResponse", "in":"body", "description":"Discount object of the organization", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "effGrpObjNum":{ "description":"ObjectNumber of Effectivity Group", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the Discount.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique Hierarchy Unit Value", "type":"integer", "example":1 } } } }, "body.FamilyGroupsGetParametersv1":{ "name":"Get Family Groups Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.FamilyGroupsGetParametersv2":{ "name":"Get Family Groups Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.FamilyGroupCUDRequestBody":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/FamilyGroupCUDRequestBody" } }, "body.FamilyGroupCUDRequestBodyv2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit of an Enterprise" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the family group" }, "name":{ "type":"object", "description":"Family Group Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "consumerDesc":{ "type":"object", "description":"Consumer Description. Maximum length supported is 1024 characters.", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "consumerName":{ "type":"object", "description":"Consumer Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "majorGrpObjNum":{ "type":"integer", "example":2, "description":"Object number of the major group" }, "reportGroup":{ "description":"Object number of the Report Group.", "type":"integer", "example":1 }, "images":{ "type":"array", "description":"An array of images associated with the family group", "items":{ "$ref":"#/definitions/FamilyGroup_image" } } }, "description":"Model for Family Group Object" } }, "body.FamilyGroupDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the family group" } } } }, "body.TagsGetParametersv1":{ "name":"Get Tags Request Body", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value. Allowed values are hierUnitId, objectNum, name, tagGroupObjNum." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order. Allowed values are hierUnitId, objectNum, name, tagGroupObjNum." }, "dietaryLabel":{ "type":"integer", "default":0, "description":"A flag indicating a dietary label when set to 1. Permissible values are 0 and 1. It cannot be updated once set. Introduced in C&C API v23.7.", "example":1 } } } }, "body.TagsGetParametersv2":{ "name":"Get Tags Request Body", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria. Allowed values are hierUnitId, objectNum, name, tagGroupObjNum." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order. Allowed values are hierUnitId, objectNum, name, tagGroupObjNum.", "example":"hierUnitId:asc" }, "dietaryLabel":{ "type":"integer", "default":0, "description":"A flag indicating a dietary label when set to 1. Permissible values are 0 and 1. It cannot be updated once set. Introduced in C&C API v23.7.", "example":1 } } } }, "body.TagsInsertRequestBody":{ "name":"Insert Request Body", "in":"body", "description":"Request body for Insert operation.", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "name", "objectNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Tag or the Dietary Label is configured. Only Enterprise hierUnitId is allowed.", "type":"integer", "example":3599 }, "name":{ "description":"A string representing the name of the Tag or the Dietary Label.", "type":"string", "maxLength":255, "minLength":1, "example":"Tag" }, "objectNum":{ "type":"integer", "description":"Object Number of a Tag or a Dietary Label.", "example":200 }, "tagGroupObjNum":{ "type":"integer", "description":"Object number of the Tag Group associated with the tag. It must not be included in the Insert request body and is ignored in the Update request body when dietaryLabel is set to 1.", "example":5 }, "dietaryLabel":{ "type":"integer", "default":0, "description":"A flag indicating a dietary label when set to 1. Permissible values are 0 and 1. It cannot be updated once set. Introduced in C&C API v23.7.", "example":1 } } } }, "body.TagsUpdateRequestBody":{ "name":"Update Request Body", "in":"body", "description":"Tags Update Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "name", "objectNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Tag or the Dietary Label is configured. Only Enterprise hierUnitId is allowed.", "type":"integer", "example":3599 }, "name":{ "description":"A string representing the name of the Tag or the Dietary Label.", "type":"string", "maxLength":255, "minLength":1, "example":"Tag" }, "objectNum":{ "type":"integer", "description":"Object Number of a Tag or a Dietary Label.", "example":200 }, "tagGroupObjNum":{ "type":"integer", "description":"Object number of the Tag Group associated with the tag. It must not be included in the Insert request body and is ignored in the Update request body when dietaryLabel is set to 1.", "example":5 }, "dietaryLabel":{ "type":"integer", "default":0, "description":"A flag indicating a dietary label when set to 1. Permissible values are 0 and 1. It cannot be updated once set. Introduced in C&C API v23.7.", "example":1 } } } }, "body.TagsDeleteRequestBody":{ "name":"Delete Request Body", "in":"body", "description":"Delete Request Body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Tag or the Dietary Label is configured. Only Enterprise hierUnitId is allowed.", "type":"integer", "example":3599 }, "objectNum":{ "type":"integer", "description":"Object Number of a Tag or a Dietary Label.", "example":200 } } } }, "body.DataExtensionResourceObject":{ "name":"Request body", "in":"body", "description":"Data Extension Resource Object", "schema":{ "$ref":"#/definitions/DataExtensionResourceObject" }, "required":true }, "body.DataExtensionResourceObjectv2":{ "name":"Request body", "in":"body", "description":"Data Extension Resource Object", "schema":{ "description":"Model for Data Extension Object", "type":"object", "required":[ "objectNum", "extraColumnName", "type", "dataConstraints" ], "properties":{ "objectNum":{ "description":"Object Number of the Data Extension property.", "type":"integer", "example":1 }, "extraColumnName":{ "description":"name of the data extension property, cannot be empty. Maximum allowed length of string is 128.", "type":"string", "example":"isKiosk" }, "type":{ "type":"integer", "description":"Type of data that can be inserted for this data extension property.\n\n** Below is a list of acceptable values for type\n\n|Type |Description |\n|-----|--------------|\n|0 |Text |\n|1 |Multiline Text|\n|2 |Number |\n|3 |Decimal |\n|4 |Boolean |\n|5 |Date |\n|6 |Time |\n|7 |Date/Time |\n|8 |Text List |\n|9 |Lookup List |\n|10 |Big Text List |\n|11 |XML Document |\n|12 |JSON |\n", "example":1 }, "dataConstraints":{ "description":"Constraints on the values that can be inserted for this data extension property. Note that for 'Boolean' and \"XML Document\" types, data constraints are not required. For all other types, this is a required field", "type":"object", "properties":{ "maxChars":{ "description":"maximum characters allowed. For types- Text and JSON", "type":"integer", "example":128 }, "lines":{ "description":"number of lines allowed. For types- Multiline Text", "example":2, "type":"integer" }, "minValue":{ "description":"minimum value for the allowed range. For types- Number, Decimal", "type":"number", "example":0 }, "maxValue":{ "description":"maximum value for the allowed range. For types- Number, Decimal", "type":"number", "example":9999 }, "dateTimeFormat":{ "description":"Valid Date/Time format. For types- Date, Time, Date/Time. Following is the format in which each of the mentioned fields should be passed:\nyear: yyyy or yy\nmonth: MM or M\ndate: dd or d\nhour: HH or H or h or hh\nminute: mm or m or mm:ss\ndisplay_type: t or tt (optional and applicable only when hour is in 'h' or 'hh' format)\ndate_format: year/month/date or month/date/year or date/month/year or year-month-date or month-date-year or date-month-year\ntime_format: hour:minute display_type\ndateTime format: date_format time_format\n", "type":"string", "example":"yyyy/MM/dd hh:mm t" }, "lookupList":{ "description":"List to choose data values from. For types- Lookup List, Text List, Big Text List", "type":"object", "example":{ "1":"Entry-1", "2":"Entry-2", "3":"Entry-3" } } } }, "tableNum":{ "description":"Object Number of the table.\n\n** Below table descibes acceptable values for tableNum and the corresponding table Name\n\n| tableNum | tableName |\n|-----------|--------------------|\n| 17 |Hierarchy Unit |\n| 20 |Revenue Center |\n| 25 |Order Type |\n| 41 |Workstations |\n| 50 |Currency |\n| 54 |Tax Class |\n| 58 |Menu Item Class |\n| 67 |Discount |\n| 70 |Service Charge |\n| 71 |Tender/Media |\n| 85 |Job Code |\n| 104 |Employee Class |\n| 106 |Employee |\n| 128 |Serving Period |\n| 131 |Menu Item Master |\n| 134 |Menu Item Definition|\n| 138 |Effectivity Groups |\n| 1001 |Property |\n| 1010 |Role |\n", "type":"integer", "example":1 }, "sortPriority":{ "type":"integer", "example":1, "description":"sort priority of the property." }, "displayWidth":{ "description":"The display width of the column, acceptable values include null, 30-999 inclusive", "type":"integer", "example":150 }, "translatableName":{ "description":"A string that contains translations of column name for the property", "type":"object", "example":{ "1":"Property", "2":"Eigentum", "3":"Propiedad" } }, "translatableHelp":{ "description":"A string that contains translations of help for the property", "type":"object", "example":{ "1":"Property", "2":"Eigentum", "3":"Propiedad" } }, "isEditable":{ "description":"boolean value to specify if the property is editable. Default Value = true", "type":"boolean", "example":true }, "isViewable":{ "description":"boolean value to specify if the property is viewable. Default Value = true", "type":"boolean", "example":true }, "isDownloadable":{ "description":"boolean value to specify if the property is downloadable. Default Value = true", "type":"boolean", "example":true } } }, "required":true }, "body.DataExtensionsGetParametersv1":{ "name":"Get Data Extensions Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.DataExtensionsGetParametersv2":{ "name":"Get Data Extensions Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.DataExtensionDeleteRequest":{ "name":"Request Body", "in":"body", "description":"Data Extension Delete Request Body", "required":true, "schema":{ "type":"object", "required":[ "objectNum" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object number of the data extension property" } } } }, "body.PaymentDriversGetParametersv1":{ "name":"Get Payment Drivers Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.PaymentDriversGetParametersv2":{ "name":"Get Payment Drivers Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.PaymentDriverCURequest":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/PaymentDriverCURequestBody" } }, "body.PaymentDriverCURequestv2":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name", "displayName", "passphrase" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the payment driver" }, "name":{ "description":"A group of string objects representing the name of the payment driver in configured languages", "type":"object", "example":{ "1":"Payment Driver", "2":"Zahlungstreiber", "3":"Conductor de pago" } }, "displayName":{ "type":"string", "example":"Payment Driver", "description":"Class name of the driver to be instantiated." }, "passphrase":{ "type":"string", "example":"Pa$$woRd123", "description":"Enter the authentication passphrase (OPI Only)." }, "type":{ "type":"integer", "example":26, "description":"the type of the file." }, "filenameOrigin":{ "type":"string", "example":"C:\\Program Files\\Oracle Hospitality\\EMCClient\\OPIPayment.dll", "description":"the content file origin." }, "filename":{ "type":"string", "example":"OPIPayment.dll", "description":"The name of the image file with extension." } } } }, "body.PaymentDriverDeleteRequest":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the payment driver." } } } }, "body.PaymentDriverDownloadRequest":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the payment driver." } } } }, "body.MenuItems2GetParametersv1":{ "name":"Get Menu Items2 method", "in":"body", "description":"The input Body model that needs to be given.", "required":true, "schema":{ "type":"object", "required":[ "menuItemMasterId" ], "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" } } } }, "body.MenuItems2GetParametersv2":{ "name":"Get Menu Items2 method", "in":"body", "description":"The input Body model that needs to be given.", "required":true, "schema":{ "type":"object", "required":[ "menuItemMasterId" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" } } } }, "body.LocationsGetParametersv1":{ "name":"Get Locations Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.LocationsGetParametersv2":{ "name":"Get Locations Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.LocationInsertRequestBody":{ "name":"Location", "in":"body", "description":"Location object of the organization", "required":true, "schema":{ "$ref":"#/definitions/LocationInsertRequestBody" } }, "body.LocationInsertRequestBodyv2":{ "name":"Location", "in":"body", "description":"Location object of the organization", "required":true, "schema":{ "description":"Model for Location Object", "type":"object", "required":[ "objectNum", "name", "tZIndex", "locRef", "reportingLocName", "reportingParentEnterpriseLevelName" ], "properties":{ "objectNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "consumerFacingName":{ "description":"A group of string objects representing the consumer facing name in the configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "phoneCountryCode":{ "description":"The phone number country code of the property. It cannot be null when assigning a phone number to the property.", "type":"string", "example":"US" }, "phone":{ "description":"The phone number of the property. If it is not null, the phoneCountryCode is required.", "type":"string", "example":1234567890 }, "address1":{ "description":"The address line 1 for the property.", "type":"string", "example":"Address Line 1" }, "address2":{ "description":"The address line 2 for the property.", "type":"string", "example":"Address Line 2" }, "address3":{ "description":"The address line 3 for the property.", "type":"string", "example":1 }, "city":{ "description":"The city for the property", "type":"string", "example":"City" }, "stateOrRegionCode":{ "description":"The state or region code for the property. It cannot be null when stateOrRegion is not null.", "type":"string", "example":"NY" }, "stateOrRegion":{ "description":"The state or region for the property. It cannot be null when stateOrRegionCode is not null.", "type":"string", "example":"New York" }, "zipOrPostalCode":{ "description":"The state or region for the property. The ZIP or postal code for the property.", "type":"string", "example":"YXA123" }, "countryCode":{ "description":"The country code for the property.", "type":"string", "example":"US" }, "latitude":{ "description":"The property latitude. Latitude must be within range -90 to +90", "type":"string", "example":12.23 }, "longitude":{ "description":"The property longitude. Longitude must be between -180 and 180", "type":"string", "example":12.34 }, "comment":{ "description":"Additional information about the property.", "type":"string", "example":"Comment" }, "tZIndex":{ "description":"The index time zone of the property.", "type":"integer", "example":20 }, "localeInfoId":{ "description":"Unique reference of the locale for the property to determine the use of decimal or thousand separators.", "type":"integer", "example":1 }, "reportingLocName":{ "description":"The location name created in Simphony Reporting.", "type":"string", "example":"Location1" }, "locRef":{ "description":"The unique reference for the location in Simphony Reporting", "type":"string", "example":"Loc1" }, "laborEnabled":{ "description":"Flag indicating if enterprise labor is enabled,", "type":"boolean", "example":false }, "inventoryEnabled":{ "description":"Flag indicating if inventory is enabled,", "type":"boolean", "example":false }, "laborLogin":{ "description":"The username to use to connect to the Simphony Labor Service. Either both laborLogin and laborPassword have to be null or non-null.", "type":"string", "example":"user123" }, "laborPassword":{ "description":"The password to use to log on to the Simphony Labor Service. Either both laborLogin and laborPassword have to be null or non-null.", "type":"string", "example":"slkdrtj132@!#$1" }, "reportingParentEnterpriseLevelName":{ "description":"The name of the parent organization level under which this location is to be reported.", "type":"string", "example":"District" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } } }, "body.LocationUpdateRequestBody":{ "name":"Location", "in":"body", "description":"Location object of the organization", "required":true, "schema":{ "$ref":"#/definitions/LocationUpdateRequestBody" } }, "body.LocationUpdateRequestBodyv2":{ "name":"Location", "in":"body", "description":"Location object of the organization", "required":true, "schema":{ "description":"Model for Location Object", "type":"object", "required":[ "hierUnitId", "name", "tZIndex", "locRef", "reportingLocName", "reportingParentEnterpriseLevelName" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":2 }, "name":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "consumerFacingName":{ "description":"A group of string objects representing the consumer facing name in the configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "phoneCountryCode":{ "description":"The phone number country code of the property. It cannot be null when assigning a phone number to the property.", "type":"string", "example":"US" }, "phone":{ "description":"The phone number of the property. If it is not null, the phoneCountryCode is required.", "type":"string", "example":1234567890 }, "address1":{ "description":"The address line 1 for the property.", "type":"string", "example":"Address Line 1" }, "address2":{ "description":"The address line 2 for the property.", "type":"string", "example":"Address Line 2" }, "address3":{ "description":"The address line 3 for the property.", "type":"string", "example":1 }, "city":{ "description":"The city for the property", "type":"string", "example":"City" }, "stateOrRegionCode":{ "description":"The state or region code for the property. It cannot be null when stateOrRegion is not null.", "type":"string", "example":"NY" }, "stateOrRegion":{ "description":"The state or region for the property. It cannot be null when stateOrRegionCode is not null.", "type":"string", "example":"New York" }, "zipOrPostalCode":{ "description":"The state or region for the property. The ZIP or postal code for the property.", "type":"string", "example":"YXA123" }, "countryCode":{ "description":"The country code for the property.", "type":"string", "example":"US" }, "latitude":{ "description":"The property latitude. Latitude must be within range -90 to +90", "type":"string", "example":12.23 }, "longitude":{ "description":"The property longitude. Longitude must be between -180 and 180", "type":"string", "example":12.34 }, "comment":{ "description":"Additional information about the property.", "type":"string", "example":"Comment" }, "tZIndex":{ "description":"The index time zone of the property.", "type":"integer", "example":20 }, "localeInfoId":{ "description":"Unique reference of the locale for the property to determine the use of decimal or thousand separators.", "type":"integer", "example":1 }, "reportingLocName":{ "description":"The location name created in Simphony Reporting.", "type":"string", "example":"Location1" }, "locRef":{ "description":"The unique reference for the location in Simphony Reporting", "type":"string", "example":"Loc1" }, "laborEnabled":{ "description":"Flag indicating if enterprise labor is enabled.", "type":"boolean", "example":false }, "inventoryEnabled":{ "description":"Flag indicating if inventory is enabled.", "type":"boolean", "example":false }, "laborLogin":{ "description":"The username to use to connect to the Simphony Labor Service. Either both laborLogin and laborPassword have to be null or non-null.", "type":"string", "example":"user123" }, "laborPassword":{ "description":"The password to use to log on to the Simphony Labor Service. Either both laborLogin and laborPassword have to be null or non-null.", "type":"string", "example":"slkdrtj132@!#$1" }, "reportingParentEnterpriseLevelName":{ "description":"The name of the parent organization level under which this location is to be reported.", "type":"string", "example":"District" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } } }, "body.LocationResponse":{ "name":"Location Response", "in":"body", "description":"Response Object", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "description":"unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Location", "type":"integer", "example":1 } } } }, "body.LocationDeleteRequestBody":{ "name":"Delete Location Request Body", "in":"body", "description":"Request Body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId" ], "properties":{ "hierUnitId":{ "description":"unique hierarchy unit value", "type":"integer", "example":1 } } } }, "body.SingleEmployeeGetParameters":{ "name":"Get Employee Method", "required":true, "in":"body", "schema":{ "type":"object", "required":[ "objectNum" ], "properties":{ "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "objectNum":{ "type":"integer", "example":1, "description":"Unique ObjectNum reference of the Employee" } } } }, "body.SalesItemizersGetParametersv1":{ "name":"Get Sales Itemizer Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.SalesItemizersGetParametersv2":{ "name":"Get Sales Itemizer Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.SalesItemizerCUDRequest":{ "name":"Request body", "in":"body", "description":"A CUD request body for sales itemizer", "required":true, "schema":{ "$ref":"#/definitions/SalesItemizerCUDRequestBody" } }, "body.SalesItemizerCUDRequestv2":{ "name":"Request body", "in":"body", "description":"A CUD request body for sales itemizer", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "salesItmzrIndex", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "salesItmzrIndex":{ "description":"Sequence number of the Sales Itemizer. Acceptable values are 1-16, including 1 and 16\n", "type":"integer", "example":1 }, "name":{ "description":"Sales Itemizer Name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } } } } }, "body.SalesItemizer":{ "name":"Request body", "in":"body", "description":"A request body for sales itemizer", "required":true, "schema":{ "$ref":"#/definitions/SalesItemizerv1" } }, "body.SalesItemizerDeleteRequest":{ "name":"Request body", "in":"body", "description":"A request body for delete sales itemizer", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "salesItmzrIndex" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "salesItmzrIndex":{ "description":"Sequence number of sales itemizer", "type":"integer", "example":1 } } } }, "body.ServingPeriodsGetParameters":{ "name":"Get Record Parameters", "in":"body", "required":true, "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 1792)", "description":"If specified, returns records that match the criteria. Allowed fields are hierUnitId, name and objectNum." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order. Allowed fields are hierUnitId, name and objectNum.", "example":"hierUnitId:asc" } } } }, "body.ServingPeriodDeleteRequest":{ "name":"Delete Request Parameters", "in":"body", "description":"Serving period delete request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "objectNum":{ "description":"Object number of the serving period", "type":"integer", "example":1 } } } }, "body.ServingPeriodCURequest":{ "name":"Insert Update Request Body", "in":"body", "description":"Serving period insert and update request body", "required":true, "schema":{ "description":"Model for Serving Period Object Insert and Update Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "objectNum":{ "description":"Object number of the serving period.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the serving period is configured. ", "type":"integer", "example":3599 }, "name":{ "description":"Serving period name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "startTime":{ "description":"Start time of the serving period in 24-hour HH:MM format.", "type":"string", "example":"03:00" }, "endTime":{ "description":"End time of the serving period in 24-hour HH:MM format.", "type":"string", "example":"11:59" }, "activeDaysOfWeek":{ "description":"A string of values 0s and 1s of length 7 representing the days of the week when the serving period is active, starting with Sunday.", "type":"string", "example":"1111111" }, "tableCount":{ "description":"Determines the number of tables available during the serving period.", "type":"integer", "example":12 }, "defaultMainLevel":{ "description":"The object number of the Default Main Level to use when the serving period is active. Valid range is [0-8].", "type":"integer", "example":1 }, "defaultSubLevel":{ "description":"The object number of the Default Sub Level to use when the serving period is active. Valid range is [0-8].", "type":"integer", "example":1 }, "taxesEnabled":{ "description":"A string of values 0s and 1s of length 64 representing the tax rates used when the serving period is active.", "type":"string", "example":"1000000000000000000000000000000000000000000000000000000000000001" }, "dataExtensions":{ "description":"An array of data extensions for the serving period", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extention field", "type":"string", "example":"extension_Column" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"value1" } } } } } } }, "body.MenuItemGroupsLiteGetParametersv2":{ "name":"Get Menu Item Groups Method", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.MenuItemGroupLiteCUDRequestv2":{ "in":"body", "name":"Request Body", "description":"A Request body for Menu Item Group", "required":true, "schema":{ "type":"object", "required":[ "objectNum", "hierUnitId", "name" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "name":{ "type":"object", "description":"A string that contains translations into multiple languages", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "groupType":{ "type":"integer", "example":1, "description":"Group Type Values
    Description Value
    Discount 1 (Default Value)
    Tax Class 2
    " }, "thresholdQty":{ "type":"integer", "example":2, "description":"Specifies the threshold quantity for applying overriden tax class
    • For group type 1, the Threshold Quantity must be either NULL or 0.
    • For group type 2, the Threshold Quantity will use a default value of 1.
    " }, "taxClassObjNum":{ "type":"integer", "example":2, "description":"Specifies the tax class override.
    • For group type 1, the tax class override must be either NULL or 0.
    • For group type 2, the tax class override is required and cannot be NULL or 0.
    " } } } }, "body.MenuItemGroupLiteDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Delete Request body", "required":true, "schema":{ "type":"object", "required":[ "objectNum", "hierUnitId" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" } } } }, "body.KitchenDisplayControllersGetParametersv1":{ "description":"The input Body model that needs to be given.", "name":"Get Kitchen Display Controllers Method", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":100, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.KitchenDisplayControllersGetParametersv2":{ "name":"Get Kitchen Display Controllers Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.KDSControllerCUDRequest":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "$ref":"#/definitions/KDSControllersCUDRequestBody" }, "required":true }, "body.KDSControllerCUDRequestv2":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "description":"Model for KDS Controllers CUD Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the KDS Controller", "type":"integer", "example":1 }, "name":{ "description":"name of the KDS Controller", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "controllerId":{ "description":"The KDS Controller ID for troubleshooting purposes. This is auto-generated when adding the KDS Controller and cannot be edited.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 64 representing the enablement or disablement of the options associated with the KDS Controller.", "type":"string", "example":"0000000000000000000000000000000000000000000000000000000000000000" }, "dbUpdateFrequencyInSecs":{ "description":"The number of seconds the KDS Controller waits to retrieve updates from the database.", "type":"integer", "example":0 }, "waitForPrepSubOrderInSecs":{ "description":"The number of seconds the KDS waits for Prep Suborders before showing an expo order as All Prep Done.", "type":"integer", "example":0 }, "mediaViewerURL":{ "description":"The URL of the IIS website where the Media Viewer is defined.", "type":"string", "example":"https://viewer" }, "expoRecallOption":{ "description":"Indicator of where to show orders when they are recalled from an Expo or SOS Display.", "type":"integer", "example":0 }, "displayLanguage":{ "description":"The ISO code of the language used to display all non-configurable text in KDS. This includes messages, title bars, column headers, and chit elements.", "type":"string", "example":1 }, "enableResetAllTime":{ "description":"A Boolean flag indicating to enable and set the Reset All Time to determine when the KDS Controller will delete all order data daily. Typically done at start of day to prevent recalling the previous day's orders.", "type":"boolean", "example":false }, "numberOfZones":{ "description":"The number of kitchen zones to use for collecting food orders.", "type":"integer", "example":0 }, "maxItemsPerZone":{ "description":"The maximum number of items that can be added to a zone.", "type":"integer", "example":0 }, "prodCountIncrementType":{ "description":"Indicator of when to add ordered items to the production counter.", "type":"integer", "example":0 }, "prodCountDecrementType":{ "description":"Indicator of when to decrease the count of items from the production counter.", "type":"integer", "example":0 }, "autoBumpTimeInSecs":{ "description":"The wait time before automatically bumping all closed orders after reaching the Check Count.", "type":"integer", "example":0 }, "autoBumpCheckCount":{ "description":"The number of checks allowed to appear on the KDS before automatically bumping.", "type":"integer", "example":0 }, "svcHost":{ "description":"An object representing the service host details associated with the KDS controller.", "type":"object", "properties":{ "svcHostObjNum":{ "description":"Object number of the service host associated with the KDS Controller.", "type":"integer", "example":1 } } }, "bckupSVCHost":{ "description":"An object representing the backup service host details associated with the KDS controller.", "type":"object", "properties":{ "bckupSVCHostObjNum":{ "description":"Object number of the backup service host associated with the KDS Controller.", "type":"integer", "example":1 } } }, "itemStatusColors":{ "description":"An object containing an integer value representing the item status colors as per the below mapping. 0 - Default 1 - Black 2 - White 3 - Blue 4 - Cyan5 - Dark Gray 6 - Gray 7 - Light Gray 8 - Green 9 - Magenta 10 - Orange 11 - Pink 12 - Red 13 - Yellow", "type":"object", "properties":{ "statusSentColor":{ "description":"Integer value representing the color in which items appear when workstation operators send orders to the KDS.", "type":"integer", "example":0 }, "statusFiredColor":{ "description":"Integer value representing the color in which items appear when they fire to Prep Displays.", "type":"integer", "example":0 }, "statusBumpedColor":{ "description":"Integer value representing the color in which items appear when they are bumped from Prep Displays.", "type":"integer", "example":0 }, "statusStartedColor":{ "description":"Integer value representing the color in which items appear when they are Prep started.", "type":"integer", "example":0 }, "itemSelectColor":{ "description":"Integer value representing the color of the item status background.", "type":"integer", "example":0 }, "itemMarkColor":{ "description":"Integer value representing the color of the item Mark status background.", "type":"integer", "example":0 }, "itemRecallColor":{ "description":"Integer value representing the color of the item Recall status background.", "type":"integer", "example":0 }, "itemRecallableColor":{ "description":"Integer value representing the color of the item Recallable status background.", "type":"integer", "example":0 } } }, "layoutColorsOverride":{ "description":"An object representing the layout color override.", "type":"object", "properties":{ "alert1":{ "description":"Hexadecimal value representing the RBG combination of the background color for orders exceeding the first alert time.", "type":"string", "example":"000000" }, "alert2":{ "description":"Hexadecimal value representing the RBG combination of the background color for orders exceeding the second alert time.", "type":"string", "example":"000000" }, "background":{ "description":"Hexadecimal value representing the RBG combination of the background panel color for the KDS Display.", "type":"string", "example":"000000" }, "orderSelection":{ "description":"Hexadecimal value representing the RBG combination of the color in which the border of an order appears when selecting an item.", "type":"string", "example":"000000" }, "orderBackground":{ "description":"Hexadecimal value representing the RBG combination of the background color for orders on the KDS Display.", "type":"string", "example":"000000" }, "voidItem":{ "description":"Hexadecimal value representing the RBG combination of the color in which voided items appear on the KDS.", "type":"string", "example":"000000" }, "course1Item":{ "description":"Hexadecimal value representing the RBG combination of the color in which Course 1 items appear on the KDS.", "type":"string", "example":"000000" } } }, "extPostingFile1":{ "description":"File name and directory path for the text file where the KDS transaction information is stored.", "type":"string", "example":"file1.txt" }, "extPostingFile2":{ "description":"File name and directory path for the text file where the KDS transaction information is stored.", "type":"string", "example":"file2.txt" }, "extPostingFile3":{ "description":"File name and directory path for the text file where the KDS transaction information is stored.", "type":"string", "example":"file3.txt" } } }, "required":true }, "body.KDSControllers":{ "name":"KDSControllers", "in":"body", "description":"KDS Controller object of the organization.", "required":true, "schema":{ "$ref":"#/definitions/KDSControllersv1" } }, "body.KDSController":{ "description":"Minimum details to identify a record in the organization.", "name":"KDSController", "in":"body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Kitchen Display Controller", "type":"integer", "example":1 } } } }, "body.SystemEmployeePropertiesGetParameters":{ "name":"Get Record Parameters", "in":"body", "required":true, "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectnum, 1792)", "description":"If specified, returns records that match the criteria. Allowed fields are objectNum and hierUnitId" }, "include":{ "type":"string", "example":"objectNum, hierUnitId", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order. Allowed fields are objectNum and hierUnitId", "example":"objectNum:asc" } } } }, "body.SystemEmployeePropertyDeleteRequest":{ "name":"Delete Request Parameters", "in":"body", "description":"System employee property delete request body", "required":true, "schema":{ "type":"object", "required":[ "objectNum", "hierUnitId" ], "properties":{ "objectNum":{ "description":"Object number of the system employee", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Hierarchy unit value of the associated property", "type":"integer", "example":1 } } } }, "body.SystemEmployeePropertyCURequest":{ "name":"Insert Update Request Body", "in":"body", "description":"System Employee Property insert and update request body", "required":true, "schema":{ "description":"Model for System Employee Property Object Insert and Update Request", "type":"object", "required":[ "objectNum", "hierUnitId" ], "properties":{ "objectNum":{ "description":"Object number of the system employee.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Hierarchy unit value of property associated with employee.", "type":"integer", "example":3599 }, "employeeClassObjNum":{ "description":"Object number of the class of the system employee at the property.", "type":"integer", "example":1 }, "defaultRvcHierUnitId":{ "description":"Unique hierarchy unit value associated with the default RVC.", "type":"integer", "example":1 } } } }, "body.OrderTypeResourceObject":{ "name":"Request body", "in":"body", "description":"Order Type Resource Object", "schema":{ "$ref":"#/definitions/OrderTypeResourceObject" }, "required":true }, "body.OrderTypesNamesGetParametersv1":{ "name":"Get Order Type Names Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.OrderTypesNamesGetParametersv2":{ "name":"Get Order Type Names Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.OrderTypeCUDRequest":{ "name":"Request Body", "in":"body", "description":"CUD Request Body", "schema":{ "$ref":"#/definitions/OrderTypeCUDRequestBody" } }, "body.OrderTypeCUDRequestv2":{ "name":"Request Body", "in":"body", "description":"CUD Request Body", "schema":{ "description":"Model for Order Type CUD Request", "type":"object", "required":[ "hierUnitId", "lineNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "lineNum":{ "type":"integer", "example":1, "description":"Line number of the Order Types" }, "name":{ "type":"object", "description":"Order Type Name", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "dataExtensions":{ "description":"An array of data extensions for the Order Types", "type":"array", "items":{ "$ref":"#/definitions/OrderType_dataExtentions" } } } } }, "body.OrderTypeDeleteRequest":{ "name":"Request Body", "in":"body", "description":"Order Type Delete Request Body", "schema":{ "type":"object", "required":[ "hierUnitId", "lineNum" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit reference", "type":"integer", "example":1 }, "lineNum":{ "description":"Line number of the Order Types", "type":"integer", "example":2 } } }, "required":true }, "body.ServiceChargeGroupsGetParametersv1":{ "name":"Get Service Charge Groups Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.ServiceChargeGroupsGetParametersv2":{ "name":"Get Service Charge Groups Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.ServiceChargeGroupCURequestBody":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/ServiceChargeGroupCURequestBody" } }, "body.ServiceChargeGroupCURequestBodyv2":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "description":"Model for ServiceChargeGroup Object", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "name":{ "description":"Service Charge Group Name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 }, "details":{ "description":"An array of service charges that are part of the service charge group", "type":"array", "items":{ "type":"object", "properties":{ "sequenceNum":{ "description":"Sequence number of the service charge group detail in the service charge group", "type":"integer", "example":1 }, "svcObjNum":{ "description":"Object number of the service charge", "type":"integer", "example":1 } } } } } } }, "body.ServiceChargeGroupDeleteRequest":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 } } } }, "body.ServiceChargesGetParametersv1":{ "name":"Get Service Charges Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.ServiceChargesGetParametersv2":{ "name":"Get Service Charges Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.ServiceChargeCURequestBody":{ "name":"Request Body for Create/Update", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/ServiceChargeCURequestBody" } }, "body.ServiceChargeCURequestBodyv2":{ "name":"Request Body for Create/Update", "in":"body", "description":"Request body", "required":true, "schema":{ "description":"Model for Service Charge Object", "type":"object", "required":[ "hierUnitId", "name", "objectNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge", "type":"integer", "example":1 }, "name":{ "description":"Service Charge Name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "effGrpObjNum":{ "description":"Object number of the Effectivity Group for the current record", "type":"integer", "example":1 }, "consumerDisplayname":{ "description":"Consumer Display Name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "percent":{ "description":"Percentage for the manual ServiceCharge.", "type":"integer", "example":1 }, "amount":{ "description":"Maximum amount allowed for an open-priced or amount ServiceCharge", "type":"integer", "example":1 }, "taxClassObjNum":{ "description":"Tax Class object number for the ServiceCharge", "type":"integer", "example":1 }, "privilegeGroup":{ "description":"Privilege Group number to restrict the use of the ServiceCharge", "type":"integer", "example":1 }, "reportGroupObjNum":{ "description":"Report Group to associate with the ServiceCharge.", "type":"integer", "example":1 }, "printClassObjNum":{ "description":"Print Class object number for the service charge", "type":"integer", "example":1 }, "pickupTenderOrMediaObjNum":{ "description":"Pickup Tender Media object number for the service charge", "type":"integer", "example":1 }, "percentToTipsPaid":{ "description":"percentage of a charged tip that posts to the Tips Paid Tender/Media.", "type":"integer", "example":1 }, "halo":{ "description":"Maximum amount allowed for an open-priced or amount ServiceCharge", "type":"integer", "example":1 }, "options":{ "description":"A String of Values of 0s and 1s of length 56 representing the enablement or disablement of the options associated with ServiceCharges", "type":"string", "example":"00000000000000000000000000000000000000000000000000000000" }, "svcItmzr":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the ServiceCharge itemizers on which the ServiceCharge is computable", "type":"string", "example":"00000010" }, "menuLevels":{ "description":"An object containing the menu levels on which the ServiceCharge is active", "type":"object", "properties":{ "mainLevel":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the ServiceCharge on main levels", "type":"string", "example":"00000010" }, "sublevel":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the ServiceCharge on sub levels", "type":"string", "example":"00000010" } } }, "transDefaultMainLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Main Level after pressing the ServiceCharge", "type":"boolean", "example":false }, "mainLevelPopup":{ "description":"The Main Level that activates after pressing the ServiceCharge", "type":"integer", "example":1 }, "transDefaultSubLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Sub Level after pressing the ServiceCharge.", "type":"boolean", "example":false }, "subLevelPopup":{ "description":"The Sub Level that activates after pressing the ServiceCharge", "type":"integer", "example":1 }, "svcSLUNum":{ "description":"Object number of the Screen Lookup key for the ServiceCharge.", "type":"integer", "example":1 }, "nlu":{ "description":"A unique Number Lookup (0-9,999,999,999) for the ServiceCharge", "type":"integer", "example":1 }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } } }, "body.ServiceChargeDeleteRequest":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"Object number of the Effectivity Group for the current record", "type":"integer", "example":1 } } } }, "body.ServiceChargeGroupDetailCreateRequestBody":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "description":"Model for ServiceChargeGroupDetail Object", "type":"object", "required":[ "hierUnitId", "objectNum", "svcObjNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 }, "svcObjNum":{ "description":"Object number of the service charge", "type":"integer", "example":1 } } } }, "body.ServiceChargeGroupDetailUpdateRequestBody":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/ServiceChargeGroupDetailUpdateRequestBody" } }, "body.ServiceChargeGroupDetailUpdateRequestBodyv2":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "description":"Model for ServiceChargeGroupDetail Object", "type":"object", "required":[ "hierUnitId", "objectNum", "sequenceNum", "svcObjNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence number of the service charge group detail in the service charge group", "type":"integer", "example":1 }, "svcObjNum":{ "description":"Object number of the service charge", "type":"integer", "example":1 } } } }, "body.ServiceChargeGroupDetail":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/ServiceChargeGroupDetail" } }, "body.ServiceChargeGroupDetailsGetParametersv1":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/ServiceChargeGroupDetailGetRequest" } }, "body.ServiceChargeGroupDetailsGetParametersv2":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "description":"The input Body model that needs to be given.", "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 } } } }, "body.ServiceChargeGroupDetailDeleteRequest":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "sequenceNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence number of the service charge group detail in the service charge group", "type":"integer", "example":1 } } } }, "body.CALDeploymentSchedulesGetParametersv1":{ "name":"Get CAL Deployment Schedules Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.CALDeploymentSchedulesGetParametersv2":{ "name":"Get CAL Deployment Schedules Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.InsertDeploymentSchedule":{ "name":"InsertCALDeploymentSchedule", "in":"body", "description":"CAL Deployment Schedule Object", "schema":{ "description":"Model for Insert CAL Deployment Schedule Object", "type":"object", "required":[ "packageId", "deploymentId" ], "properties":{ "packageId":{ "description":"Unique reference of the CAL Package", "type":"integer", "example":101 }, "hierUnitId":{ "description":"Unique reference of hierarchy unit where the CAL package is to be downloaded. This could either the property where the package downloads or the Enterprise. Applicable only if the deploymentType = 1", "type":"integer", "example":3588 }, "svcHostObjNum":{ "description":"Object number of the service host or workstations where the package is downloaded. Applicable only if deploymentType = 2", "type":"integer", "example":141 }, "actionToTake":{ "description":"Action to take while downloading the package. \nSelect 0 for installations to proceed, Select 1 to Skip to prevent downloading a package.\n", "type":"integer", "example":0 }, "version":{ "description":"Version of the CAL deployment package", "type":"string", "example":"19.3.3" }, "deploymentType":{ "description":"The Type of the deployment. 1 - Property / Enterprise, 2 - Specific Service Host", "type":"integer", "example":1 }, "effectiveFrom":{ "description":"The start date when this package becomes active (also used to schedule upgrades).", "type":"string", "example":"14-04-2022T13:00:00" }, "effectiveTo":{ "description":"The end date when this package becomes inactive (also used to schedule upgrades).", "type":"string", "example":"14-04-2022T13:00:00" } } }, "required":true }, "body.UpdateDeploymentSchedule":{ "name":"UpdateCALDeploymentSchedule", "in":"body", "description":"CAL Deployment Schedule Object", "schema":{ "$ref":"#/definitions/UpdateDeploymentSchedule" }, "required":true }, "body.UpdateDeploymentSchedulev2":{ "name":"UpdateCALDeploymentSchedule", "in":"body", "description":"CAL Deployment Schedule Object", "schema":{ "description":"Model for Update CAL Deployment Schedule Object", "type":"object", "required":[ "packageId", "deploymentId" ], "properties":{ "deploymentId":{ "description":"Unique reference of the CAL deployment schedule.", "type":"integer", "example":111 }, "packageId":{ "description":"Unique reference of the CAL Package", "type":"integer", "example":101 }, "hierUnitId":{ "description":"Unique reference of hierarchy unit where the CAL package is to be downloaded. This could either the property where the package downloads or the Enterprise. Applicable only if the deploymentType = 1", "type":"integer", "example":3588 }, "svcHostObjNum":{ "description":"Object number of the service host or workstations where the package is downloaded. Applicable only if deploymentType = 2", "type":"integer", "example":141 }, "actionToTake":{ "description":"Action to take while downloading the package. \nSelect 0 for installations to proceed, Select 1 to Skip to prevent downloading a package.\n", "type":"integer", "example":0 }, "version":{ "description":"Version of the CAL deployment package", "type":"string", "example":"19.3.3" }, "deploymentType":{ "description":"The Type of the deployment. 1 - Property / Enterprise, 2 - Specific Service Host", "type":"integer", "example":1 }, "effectiveFrom":{ "description":"The start date when this package becomes active (also used to schedule upgrades).", "type":"string", "example":"14-04-2022T13:00:00" }, "effectiveTo":{ "description":"The end date when this package becomes inactive (also used to schedule upgrades).", "type":"string", "example":"14-04-2022T13:00:00" } } }, "required":true }, "body.DeleteDeploymentSchedule":{ "name":"DeleteDeploymentSchedule", "in":"body", "description":"Response object of CAL Deployment Schedule", "required":true, "schema":{ "description":"Model for CAL Deployment Schedule Request Body", "type":"object", "required":[ "deploymentId" ], "properties":{ "deploymentId":{ "description":"Unique reference of the CAL deployment schedule.", "type":"integer", "example":111 } } } }, "body.DiscountItemizersGetParametersv1":{ "name":"Get Discount Itemizers Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.DiscountItemizersGetParametersv2":{ "name":"Get Discount Itemizers Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.DiscountItmzrsCURequestBody":{ "name":"DiscountItmzrsCURequestBody", "in":"body", "description":"DiscountItmzrs object of the organization", "required":true, "schema":{ "$ref":"#/definitions/DiscountItmzrsCURequestBody" } }, "body.DiscountItmzrsCURequestBodyv2":{ "name":"DiscountItmzrsCURequestBody", "in":"body", "description":"DiscountItmzrs object of the organization", "required":true, "schema":{ "description":"Model for Discount Itmzrs", "type":"object", "required":[ "dscItmzrIndex", "hierUnitId", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "dscItmzrIndex":{ "description":"Object number of the Discount Itemizer", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Discounts Itmzrs in configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } } } } }, "body.DiscountItmzrs":{ "name":"DiscountItmzrs", "in":"body", "description":"DiscountItmzrs object of the organization", "required":true, "schema":{ "$ref":"#/definitions/DiscountItemizers" } }, "body.DiscountItemzrsResponse":{ "name":"DiscountItemzrsResponse", "in":"body", "description":"DiscountItemizer Response Object", "required":true, "schema":{ "type":"object", "required":[ "dscItmzrIndex", "hierUnitId" ], "properties":{ "dscItmzrIndex":{ "description":"Unique reference of the Discount Itemizer", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique Hierarchy Unit Value", "type":"integer", "example":1 } } } }, "body.ReportingHierarchyLevelsGetParameters":{ "name":"Get avaialble request body", "in":"body", "description":"Request body for get reporting hierarchy levels.", "schema":{ "description":"The input body model that needs to be given for get request.", "type":"object", "properties":{ "include":{ "type":"string", "description":"If specified, limits the data returned to these fields.", "example":"levels.name" }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":2 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":10 } } }, "required":true }, "body.ReportingHierarchyRelationshipsGetParameters":{ "name":"Get Request body", "in":"body", "description":"Request body for reporting hierarchy relationship request", "schema":{ "description":"The input body model that needs to be given for the get request.", "type":"object", "required":[ "locRef" ], "properties":{ "locRef":{ "type":"string", "description":"The unique reference for the reporting location", "example":"locRef1" }, "include":{ "type":"string", "description":"If specified, limits the data returned to these fields.", "example":"reportingHierarchyName" }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":10 } } }, "required":true }, "body.UpdateReportingHierarchyRelationshipRequest":{ "name":"Update request body", "in":"body", "description":"Request body for updating parent level within a reporting hierarchy", "schema":{ "description":"The input body model that needs to be given for the update request.", "type":"object", "required":[ "locRef", "reportingHierarchyName", "parentReportingLevelName" ], "properties":{ "locRef":{ "type":"string", "description":"The unique reference for the reporting location", "example":"locRef1" }, "reportingHierarchyName":{ "type":"string", "description":"The name of reporting hierarchy where the parent level needs to be assigned/ updated.", "example":"TestReportingHierarhy" }, "parentReportingLevelName":{ "type":"string", "description":"The name of parent enterprise level within the reporting hierarchy. Use 'No Parent' keyword to assign the highest level.", "example":"Corporate" } } }, "required":true }, "body.DeleteReportingHierarchyRelationshipRequest":{ "name":"Request body", "in":"body", "description":"Request body for removing location from a reporting hierarchy", "schema":{ "type":"object", "required":[ "locRef", "reportingHierarchyName" ], "properties":{ "locRef":{ "type":"string", "description":"The unique reference for the reporting location", "example":"locRef1" }, "reportingHierarchyName":{ "type":"string", "description":"The name of reporting hierarchy from where the location is to be removed.", "example":"TestReportingHierarhy" } } }, "required":true }, "body.MenuItemPricesGetParametersv1":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/MenuItemPriceGetRequestBody" } }, "body.MenuItemPricesGetParametersv2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "type":"integer", "example":1012, "description":"Unique Hierarchy unit reference. This is an optional field. Alternatively, searchCriteria can be used to get results for a particular hierUnitId." } } } }, "body.menuItemPricesInsertRequestBody":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "menuItemDefinitionId", "priceSequenceNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy unit unique reference" }, "menuItemMasterObjNum":{ "type":"integer", "example":101, "description":"Menu item master object number" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" }, "menuItemDefinitionId":{ "type":"integer", "example":501, "description":"Unique menu item definition reference" }, "defSequenceNum":{ "type":"integer", "example":5, "description":"Definition sequence number" }, "priceSequenceNum":{ "type":"integer", "example":3, "description":"Price record number" }, "activeOnMenuLevel":{ "type":"number", "example":0.18, "description":"Menu Level Value" }, "prepCost":{ "type":"number", "example":0.18, "description":"Preparation cost" }, "price":{ "type":"number", "example":0.18, "description":"Menu item price. Note that precision is determined by currency settings." }, "taxClassOverrideObjNum":{ "type":"number", "example":0.18, "description":"Overrides menu item tax class setting (main item only)" }, "condimentParentTaxClassOverrideObjNum":{ "type":"number", "example":0.18, "description":"Specifies the parent item's tax class override (condiment item only)" }, "serviceChargeGroupObjNum":{ "type":"number", "example":0.18, "description":"Service charge group object number" }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing enabled or disabled options" }, "effectivityGroupObjNum":{ "type":"number", "example":0.18, "description":"Effectivity group option numbers" }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" } }, "description":"Model for Menu Item Price object" } }, "body.menuItemPricesUpdateRequestBody":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/menuItemPricesUpdateRequestBody" } }, "body.menuItemPricesUpdateRequestBodyv2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "menuItemDefinitionId", "menuItemPriceId" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy unit unique reference" }, "menuItemMasterObjNum":{ "type":"integer", "example":101, "description":"Menu item master object number" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" }, "menuItemDefinitionId":{ "type":"integer", "example":501, "description":"Unique menu item definition reference" }, "defSequenceNum":{ "type":"integer", "example":5, "description":"Definition sequence number" }, "priceSequenceNum":{ "type":"integer", "example":3, "description":"Price record number" }, "menuItemPriceId":{ "type":"number", "example":5.16, "description":"Unique menu item price reference" }, "activeOnMenuLevel":{ "type":"number", "example":0.18, "description":"Menu Level Value" }, "prepCost":{ "type":"number", "example":0.18, "description":"Preparation cost" }, "price":{ "type":"number", "example":0.18, "description":"Menu item price. Note that precision is determined by currency settings." }, "taxClassOverrideObjNum":{ "type":"number", "example":0.18, "description":"Overrides menu item tax class setting (main item only)" }, "condimentParentTaxClassOverrideObjNum":{ "type":"number", "example":0.18, "description":"Specifies the parent item's tax class override (condiment item only)" }, "serviceChargeGroupObjNum":{ "type":"number", "example":0.18, "description":"Service charge group object number" }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing enabled or disabled options" }, "effectivityGroupObjNum":{ "type":"number", "example":0.18, "description":"Effectivity group option numbers" }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" } }, "description":"Model for Menu Item Price object" } }, "body.menuItemPricesDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "menuItemPriceId" ], "properties":{ "menuItemPriceId":{ "type":"integer", "example":1, "description":"Unique menu item price reference" } } } }, "formData.BulkInsertMenuItemPriceRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for inserting Menu Item Prices in bulk", "type":"file", "required":true }, "formData.BulkUpdateMenuItemPriceRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for inserting Menu Item Prices in bulk", "type":"file", "required":true }, "body.MenuItemDefinitionGetParametersv1":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/MenuItemDefinitionGetRequestBody" } }, "body.MenuItemDefinitionGetParametersv2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "type":"integer", "example":1012, "description":"Unique Hierarchy unit reference. This is an optional field. Alternatively, searchCriteria can be used to get results for a particular hierUnitId." } } } }, "body.MenuItemDefintionInsertRequestBody":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/MenuItemDefinitionInsertRequestBody" } }, "body.MenuItemDefintionUpdateRequestBody":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/MenuItemDefinitionUpdateRequestBody" } }, "body.MenuItemDefintionInsertRequestBodyV2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "menuItemMasterId", "defSequenceNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy unit unique reference" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"The unique reference for the Menu Item Master" }, "defSequenceNum":{ "type":"integer", "example":1, "description":"Indicates the definition sequence number, which is the number of the definition in the revenue center for this master record.Sequence Number should be with 1-64" }, "firstName":{ "type":"object", "description":"First Name", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "secondName":{ "type":"object", "description":"Second Name", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "thirdName":{ "type":"object", "description":"Third Name", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "longDescriptor":{ "type":"object", "description":"Long Descriptor", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "menuItemClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item Class" }, "overridePrintClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Print Class" }, "mainLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing main levels on which the definition is active." }, "subLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing Sub Levels on which the definition is active" }, "slu1ObjNum":{ "type":"integer", "example":200, "description":"Object number of SLU 1 to which the Menu Item Definition belongs" }, "slu2ObjNum":{ "type":"integer", "example":201, "description":"Object number of SLU 2 to which the Menu Item Definition belongs" }, "slu3ObjNum":{ "type":"integer", "example":202, "description":"Object number of SLU 3 to which the Menu Item Definition belongs" }, "slu4ObjNum":{ "type":"integer", "example":203, "description":"Object number of SLU 4 to which the Menu Item Definition belongs" }, "slu5ObjNum":{ "type":"integer", "example":204, "description":"Object number of SLU 5 to which the Menu Item Definition belongs" }, "slu6ObjNum":{ "type":"integer", "example":205, "description":"Object number of SLU 6 to which the Menu Item Definition belongs" }, "slu7ObjNum":{ "type":"integer", "example":206, "description":"Object number of SLU 7 to which the Menu Item Definition belongs" }, "slu8ObjNum":{ "type":"integer", "example":207, "description":"Object number of SLU 8 to which the Menu Item Definition belongs" }, "sluSortPriority":{ "type":"integer", "example":0, "description":"Use this field when Page Design Layout option" }, "nluGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the NLU Group associated with this menu item" }, "nluNum":{ "type":"integer", "example":1, "description":"Unique NLU number for this menu item (up to 12 digits)." }, "tareWeight":{ "type":"integer", "example":"1.23", "description":"Weight of the empty package for an item sold by weight" }, "surcharge":{ "type":"integer", "example":1, "description":"Surcharge for the menu item" }, "quantity":{ "type":"integer", "example":1, "description":"Quantity of a Menu Item" }, "overrideAllergenClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Allergen Class for the menu item definition to override its menu item class setting" }, "kdsPrepTime":{ "type":"integer", "example":"10.3", "description":"The number of minutes necessary to prepare this item" }, "prefixLevelOverride":{ "type":"integer", "example":1, "description":"Select to allow the condiment prefix to override the price level of the item it modifies." }, "guestCount":{ "type":"integer", "example":1, "description":"Guest count for the menu item to increment the check guest count when added." }, "consumerAdvisoryDesc":{ "type":"string", "example":"Menu Item 1", "description":"The consumer advisory description of the menu item" }, "consumerItemName":{ "type":"object", "description":"Consumer Item Name", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "consumerItemDescription":{ "type":"object", "description":"Consumer Item Description. Maximum length supported is 1024 characters.", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "images":{ "type":"array", "description":"An array of images associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_image" } }, "customMenuLevels":{ "type":"array", "description":"An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured", "items":{ "$ref":"#/definitions/MenuItem_customMenuLevel" } }, "defaultCondiments":{ "type":"array", "description":"An array of Default Condiment of a Menu Item", "items":{ "$ref":"#/definitions/MenuItem_defaultCondiment" } }, "productionItems":{ "type":"array", "description":"An array of production items associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_productionItem" } }, "components":{ "type":"array", "description":"An array of components associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_component" } }, "tags":{ "type":"array", "description":"An array of tags associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_tag" } }, "nutrients":{ "type":"array", "description":"An array of nutrients of the menu item", "items":{ "$ref":"#/definitions/MenuItem_nutrient" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item", "items":{ "$ref":"#/definitions/MenuItem_dataExtensions" } } } } }, "body.MenuItemDefintionUpdateRequestBodyV2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "menuItemDefinitionId" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy unit unique reference" }, "menuItemDefinitionId":{ "type":"integer", "example":1, "description":"The unique reference for the Menu Item Definition" }, "firstName":{ "type":"object", "description":"First Name", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "secondName":{ "type":"object", "description":"Second Name", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "thirdName":{ "type":"object", "description":"Third Name", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "longDescriptor":{ "type":"object", "description":"Long Descriptor", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "menuItemClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item Class" }, "overridePrintClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Print Class" }, "mainLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing main levels on which the definition is active." }, "subLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing Sub Levels on which the definition is active" }, "slu1ObjNum":{ "type":"integer", "example":200, "description":"Object number of SLU 1 to which the Menu Item Definition belongs" }, "slu2ObjNum":{ "type":"integer", "example":201, "description":"Object number of SLU 2 to which the Menu Item Definition belongs" }, "slu3ObjNum":{ "type":"integer", "example":202, "description":"Object number of SLU 3 to which the Menu Item Definition belongs" }, "slu4ObjNum":{ "type":"integer", "example":203, "description":"Object number of SLU 4 to which the Menu Item Definition belongs" }, "slu5ObjNum":{ "type":"integer", "example":204, "description":"Object number of SLU 5 to which the Menu Item Definition belongs" }, "slu6ObjNum":{ "type":"integer", "example":205, "description":"Object number of SLU 6 to which the Menu Item Definition belongs" }, "slu7ObjNum":{ "type":"integer", "example":206, "description":"Object number of SLU 7 to which the Menu Item Definition belongs" }, "slu8ObjNum":{ "type":"integer", "example":207, "description":"Object number of SLU 8 to which the Menu Item Definition belongs" }, "sluSortPriority":{ "type":"integer", "example":0, "description":"Use this field when Page Design Layout option" }, "nluGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the NLU Group associated with this menu item" }, "nluNum":{ "type":"integer", "example":1, "description":"Unique NLU number for this menu item (up to 12 digits)." }, "tareWeight":{ "type":"integer", "example":"1.23", "description":"Weight of the empty package for an item sold by weight" }, "surcharge":{ "type":"integer", "example":1, "description":"Surcharge for the menu item" }, "quantity":{ "type":"integer", "example":1, "description":"Quantity of a Menu Item" }, "overrideAllergenClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Allergen Class for the menu item definition to override its menu item class setting" }, "kdsPrepTime":{ "type":"integer", "example":"10.3", "description":"The number of minutes necessary to prepare this item" }, "prefixLevelOverride":{ "type":"integer", "example":1, "description":"Select to allow the condiment prefix to override the price level of the item it modifies." }, "guestCount":{ "type":"integer", "example":1, "description":"Guest count for the menu item to increment the check guest count when added." }, "consumerAdvisoryDesc":{ "type":"string", "example":"Menu Item 1", "description":"The consumer advisory description of the menu item" }, "consumerItemName":{ "type":"object", "description":"Consumer Item Name", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "consumerItemDescription":{ "type":"object", "description":"Consumer Item Description. Maximum length supported is 1024 characters.", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "images":{ "type":"array", "description":"An array of images associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_image" } }, "customMenuLevels":{ "type":"array", "description":"An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured", "items":{ "$ref":"#/definitions/MenuItem_customMenuLevel" } }, "defaultCondiments":{ "type":"array", "description":"An array of Default Condiment of a Menu Item", "items":{ "$ref":"#/definitions/MenuItem_defaultCondiment" } }, "productionItems":{ "type":"array", "description":"An array of production items associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_productionItem" } }, "components":{ "type":"array", "description":"An array of components associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_component" } }, "tags":{ "type":"array", "description":"An array of tags associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_tag" } }, "nutrients":{ "type":"array", "description":"An array of nutrients of the menu item", "items":{ "$ref":"#/definitions/MenuItem_nutrient" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item", "items":{ "$ref":"#/definitions/MenuItem_dataExtensions" } } } } }, "body.MenuItemDefintionDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "menuItemDefinitionId", "hierUnitId" ], "properties":{ "menuItemDefinitionId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" }, "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy unit unique reference" } } } }, "formData.BulkInsertMenuItemDefinitionRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for inserting Menu Item Definitions in bulk", "type":"file", "required":true }, "formData.BulkUpdateMenuItemDefinitionRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for updating Menu Item Definitions in bulk", "type":"file", "required":true }, "body.MenuLevelDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number the menu level" } } } }, "body.MenuLevelsGetParametersv1":{ "name":"Get Menu Level Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.MenuLevelsGetParametersv2":{ "name":"Get Menu Level Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.MenuLevelCUDRequestBody":{ "in":"body", "name":"Request Body", "description":"Request body", "required":false, "schema":{ "$ref":"#/definitions/MenuLevelCUDRequestBody" } }, "body.MenuLevelCUDRequestBodyv2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":false, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number the menu level" }, "name":{ "description":"Menu Level Name", "type":"object", "example":{ "1":"Property", "2":"Eigentum", "3":"Propiedad" } }, "menuLevelType":{ "type":"string", "example":"Main", "description":"Specifies whether the Menu Level Set refers to the Main Levels, Sub Levels, or to the levels defined within the record. Following values are supported Main, Sub and Custom" }, "defaultMIMstrGrpObjNum":{ "type":"integer", "example":1, "description":"Object number of default menu item master group associated with the Menu Level." }, "options":{ "type":"string", "example":"10000000", "description":"A string value of 0s and 1s of length 8 representing the enablement or disablement of the options associated." }, "menuLevelEntries":{ "type":"array", "items":{ "$ref":"#/definitions/MenuLevel_menuLevelEntries_CUDv2" } } }, "description":"Model for Menu Level for an organization" } }, "body.EmployeeClassOperatorGetRequestBody.Required":{ "name":"Request Body", "in":"body", "description":"A Request body", "schema":{ "$ref":"#/definitions/EmployeeClassOperatorGetRequestBody" }, "required":true }, "body.EmployeeClassOperatorGetRequestBodyv2":{ "name":"Request Body", "in":"body", "description":"A Request body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the Employee Class" }, "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value where the employee class is configured." } } }, "required":true }, "body.EmployeeClassOperator.Required":{ "name":"Request Body", "in":"body", "description":"Request body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "rvcObjNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the employee Class." }, "rvcObjNum":{ "type":"integer", "example":1, "description":"Object number of the revenue center." }, "options":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the Revenue Center Operator record" } } }, "required":true }, "body.DeviceStatusGetParameters":{ "name":"Get Device Status Parameters", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.RevenueCenterParameterGetParametersv1":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/RevenueCenterParameterGetRequestBody" } }, "body.RevenueCenterParameterGetParametersv2":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "type":"integer", "example":1, "description":"unique hierUnitId value of the revenue center" } } } }, "body.RevenueCenterParameterDeleteRequest.Required":{ "name":"Request Body", "in":"body", "description":"Delete Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"unique HierUnitId of the RVC" } } } }, "body.RevenueCenterParameterCUDRequestBody.Required":{ "name":"Request Body", "in":"body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value of the revenue center", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the revenue center", "type":"integer", "example":1 }, "defaultOrderTypeObjNum":{ "description":"Object number of the default Order Type for this revenue center.", "type":"integer", "example":1 }, "defaultMainLvlIndex":{ "description":"Object number of the default Main Level for this revenue center.", "type":"integer", "example":1 }, "defaultSubLevelIndex":{ "description":"Object number of the default sub level for this revenue center", "type":"integer", "example":1 }, "diningTableStatusSet":{ "description":"Default dining table status definitions to use in this revenue center.", "type":"integer", "example":1 }, "defaultCondimentOrderingPopup":{ "description":"Default Ordering Popup Condiment Orderer Page for the revenue center.", "type":"integer", "example":1 }, "defaultCondimentEditingPopup":{ "description":"Default Editing Popup Condiment Orderer Page for the revenue center.", "type":"integer", "example":0 }, "depositForfeitReturnMIObjNum":{ "description":"Deposit Forfeit Return Item for the revenue center", "type":"integer", "example":0 }, "minGuestCheckNum":{ "description":"The lowest check number allowed for checks in the revenue center", "type":"integer", "example":1 }, "maxGuestCheckNum":{ "description":"The highest check number allowed for checks in the revenue center. You can enter up to 8 digits from 1 to 99999999.When the maximum check number threshold is reached during transactions, the next check begins with the value in the Minimum Check Number field", "type":"integer", "example":99999999 }, "numGuestsBeforeAutoSVC":{ "description":"The number of guests required to trigger the automatic service charge for a transaction", "type":"integer", "example":1 }, "tableCount":{ "description":"The number of tables served by the revenue center.", "type":"integer", "example":1 }, "purgeOrderThresholdInMinutes":{ "description":"The purge order threshold in minutes for this revenue center. The minimum valid value is 30.", "type":"integer", "example":30 }, "orderRoutingThresholdAmount":{ "description":"An amount to determine if the Below Threshold Print Class of a Tender/Media will be used.", "type":"number", "example":0 }, "addOrTransferRVCs":{ "$ref":"#/definitions/RevenueCenterParameter_addOrTransferRVCs" }, "options":{ "type":"string", "example":"000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 96 representing the enablement or disablement of the options associated with the revenue center parameter. If not specified, this will represent the default options associated with the Revenue Center parameter" }, "postingOptions":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the posting options associated with the revenue center parameter." }, "interfaces":{ "$ref":"#/definitions/RevenueCenterParameter_interfaces" }, "tmsInterfaceOptions":{ "$ref":"#/definitions/RevenueCenterParameter_tmsInterfaceOptions" }, "enableUberEatsIntegration":{ "type":"boolean", "example":false, "description":"A flag indicating to enable delivery platform integration with Uber Eats." }, "enableDeliverooIntegration":{ "type":"boolean", "example":false, "description":"A flag indicating to enable delivery platform integrations with Deliveroo." }, "taxNumberPrefix":{ "type":"string", "example":"TW", "description":"Taiwanese tax number prefix for the revenue center." }, "endOfRangeThreshold":{ "type":"integer", "example":0, "description":"End of Range Threshold for the Revenue Center Serial Number, as required for the Taiwanese tax structure." }, "minRVCSerialNumber1":{ "type":"integer", "example":1, "description":"Minimum serial number 1 for the revenue center." }, "maxRVCSerialNumber1":{ "type":"integer", "example":99999, "description":"Maximum serial number 1 for the revenue center" }, "minRVCSerialNumber2":{ "type":"integer", "example":1, "description":"Minimum serial number 2 for the revenue center" }, "maxRVCSerialNumber2":{ "type":"integer", "example":99999, "description":"Maximum serial number 2 for the revenue center" }, "autoFireEmpObjNum":{ "type":"integer", "example":0, "description":"Object number of the employee whose totals are associated with Autofire checks when the check is fired." }, "autoFireWSNum":{ "type":"integer", "example":1, "description":"Object number of the workstation where Autofire checks are fired and printed." }, "defaultAutoFireTenderMediaNum":{ "type":"integer", "example":0, "description":"Object number of the default Tender/Media for Autofire checks in the revenue center." }, "backAutoFireDelayInMinutes":{ "type":"integer", "example":1, "description":"The amount of time (in minutes) that the specified Autofire workstation attempts to Autofire a check." }, "maximumDays":{ "type":"integer", "example":1, "description":"The maximum number of days (in the future) that Autofire checks can be scheduled." }, "autoFireOptions":{ "type":"string", "example":"000000000000000000000000", "description":"A string value of 0s & 1s of length 24 representing the enablement or disablement of the autofire options associated with the revenue center parameter." }, "creditCardOptions":{ "type":"string", "example":"000000000000000000000000", "description":"A string value of 0s & 1s of length 24 representing the enablement or disablement of the credit card options associated with the revenue center parameter." }, "currentBusinessDate":{ "type":"string", "example":"01/03/2022", "description":"A string representing the current business date at the revenue center" }, "startedAt":{ "type":"string", "example":"01/03/2022 03:00:00 AM", "description":"A string representing the date and time the current business date started at the revenue center" }, "dontResetEmpFinancialShiftsWithSOD":{ "type":"boolean", "example":false, "description":"A flag indicating to prevent Employee Financial Shifts from resetting with the start of each business day." }, "dontResetCashierFinancialShiftsWithSOD":{ "type":"boolean", "example":false, "description":"A flag indicating to prevent Cashier Financial Shifts from resetting with the start of each business day." }, "enableOverridePropertySODtimes":{ "type":"boolean", "example":false, "description":"A flag indicating to allow this revenue center to have its start of day run at a different time than the time set for the property." }, "overridenSODTimes":{ "type":"array", "description":"An array of overridden start of day times.", "items":{ "$ref":"#/definitions/RevenueCenterParameter_overridenSODTimes" } }, "defaultOrderChannelObjNum":{ "description":"Object number of the default Order Channel for this revenue center.", "type":"integer", "example":1 } } } }, "body.EMCVisibilityGetRequestv1":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "$ref":"#/definitions/EMCVisibilityGetRequestBodyv1" }, "required":true }, "body.EMCVisibilityGetRequestv2":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "description":"The input Body model that needs to be given.", "type":"object", "required":[ "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum, 1)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "objectNum":{ "type":"integer", "description":"Unique reference of the employee in the system.", "example":1 } } }, "required":true }, "body.EmployeeEMCVisibility":{ "name":"EmployeeEMCVisibility", "in":"body", "description":"Employee EMC Visibility Object", "required":true, "schema":{ "$ref":"#/definitions/EmployeeEMCVisibilityv1" } }, "body.EmployeeEMCVisibilityCUDRequest":{ "name":"Request body", "in":"body", "description":"A CUD request body", "required":true, "schema":{ "description":"Model for an Employee EMC Visibility CUD Request", "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "objectNum":{ "description":"Unique reference of the employee in the system.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the employee EMC visibility is configured", "type":"integer", "example":3599 }, "propagateToChildren":{ "description":"Boolean flag indicating if the EMC visibility is propagated to child nodes of the hierarchy unit", "type":"boolean", "example":true } } } }, "body.EmployeeEMCVisbilityResponse":{ "name":"EmployeeVisibilityResponse", "in":"body", "description":"Employee EMC Visibility Response Object", "required":true, "schema":{ "description":"Model for the response", "type":"object", "required":[ "objectNum", "hierUnitId" ], "properties":{ "objectNum":{ "description":"Unique reference of the Employee", "type":"integer" }, "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer" } } } }, "body.MenuItemMasterInsertRequestBody":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/menuItemMasterInsertRequestBody" } }, "body.MenuItemMasterUpdateRequestBody":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/menuItemMasterUpdateRequestBody" } }, "body.MenuItemMasterInsertRequestBodyV2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "objectNum", "hierUnitId" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "name":{ "type":"object", "description":"Name", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "name2":{ "type":"object", "description":"Menu Item Master Name2", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "familyGroupObjectNum":{ "type":"integer", "example":1, "description":"Family group object number" }, "majorGroupObjectNum":{ "type":"integer", "example":2, "description":"Major group object number" }, "masterGroupObjectNum":{ "type":"integer", "example":2, "description":"Master group object number" }, "reportGroupObjectNum":{ "type":"integer", "example":2, "description":"Report group object number" }, "miMasterOptions":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enabled or disabled options, default 00000000." }, "miMasterOptionsExt":{ "$ref":"#/definitions/MenuItem_miMasterOptionsExt" }, "dietaryLabels":{ "type":"array", "description":"An array of dietary labels for menu item", "items":{ "$ref":"#/definitions/MenuItemMaster_dietaryLabels" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item", "items":{ "$ref":"#/definitions/MenuItem_dataExtensions" } }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" } } } }, "body.MenuItemMasterUpdateRequestBodyV2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "objectNum", "hierUnitId" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "name":{ "type":"object", "description":"Name", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "name2":{ "type":"object", "description":"Menu Item Master Name2", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "familyGroupObjectNum":{ "type":"integer", "example":1, "description":"Family group object number" }, "majorGroupObjectNum":{ "type":"integer", "example":2, "description":"Major group object number" }, "masterGroupObjectNum":{ "type":"integer", "example":2, "description":"Master group object number" }, "reportGroupObjectNum":{ "type":"integer", "example":2, "description":"Report group object number" }, "miMasterOptions":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enabled or disabled options, default 00000000." }, "miMasterOptionsExt":{ "$ref":"#/definitions/MenuItem_miMasterOptionsExt" }, "dietaryLabels":{ "type":"array", "description":"An array of dietary labels for menu item", "items":{ "$ref":"#/definitions/MenuItemMaster_dietaryLabels" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item", "items":{ "$ref":"#/definitions/MenuItem_dataExtensions" } }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" } } } }, "body.MenuItemMasterDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "menuItemMasterId" ], "properties":{ "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" } } } }, "body.MenuItemMastersGetParametersv1":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/MenuItemMastersGetRequestBody" } }, "body.MenuItemMastersGetParametersv2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "type":"integer", "example":1012, "description":"Unique Hierarchy unit reference. This is an optional field. Alternatively, searchCriteria can be used to get results for a particular hierUnitId." } } } }, "formData.BulkInsertMenuItemMasterRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for inserting Menu Item Masters in bulk", "type":"file", "required":true }, "formData.BulkUpdateMenuItemMasterRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for updating Menu Item Masters in bulk", "type":"file", "required":true }, "body.EmployeeClassesGetParametersv1":{ "name":"Get Employee Classes Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.EmployeeClassesGetParametersv2":{ "name":"Get Employee Classes Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.EmployeeClass.Required":{ "name":"Request Body", "in":"body", "description":"Request body", "schema":{ "$ref":"#/definitions/EmployeeClassCUDRequestBody" }, "required":true }, "body.EmployeeClassCURequestv2":{ "name":"Request Body", "in":"body", "description":"Request body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "className" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee class." }, "className":{ "type":"object", "description":"Employee Class Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "islOptions":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the employee property assignment." }, "cmAccountingMethodObjNum":{ "type":"integer", "example":1, "description":"Object number of Cash Management session type the employee uses to record Cash Management related transactions within the revenue center" }, "serverBankingTemplateObjNum":{ "type":"integer", "example":1, "description":"Object number of the default template to use when opening a server bank." }, "rvcOperatorOptions":{ "type":"array", "description":"An array of revenue center operator options", "items":{ "$ref":"#/definitions/EmployeeClass_rvcOperatorOptionsCU" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for Employee Class Revenue Center Operator Options", "items":{ "$ref":"#/definitions/Employee_dataExtensions" } } } }, "required":true }, "body.EmployeeClassDeleteRequest.Required":{ "name":"Request Body", "in":"body", "description":"Request body", "schema":{ "type":"object", "required":[ "objectNum", "hierUnitId" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object number of the Employee Class" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value where the employee class is configured" } } }, "required":true }, "body.EmployeeJobCodesGetRequestv1":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "$ref":"#/definitions/EmployeeJobCodesGetRequestBodyv1" }, "required":true }, "body.EmployeeJobCodesGetRequestv2":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "description":"The input Body model that needs to be given.", "type":"object", "required":[ "propertyHierUnitId", "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum, 1)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "objectNum":{ "type":"integer", "description":"Object number of the employee", "example":1 }, "propertyHierUnitId":{ "type":"integer", "description":"Unique reference of the hierarchy unit associated with the property", "example":2 } } }, "required":true }, "body.EmployeeJobCode":{ "name":"EmployeeJobCode", "in":"body", "description":"Employee Job Code Object", "schema":{ "$ref":"#/definitions/EmployeeJobCodev1" } }, "body.EmployeeResponse.Required":{ "name":"Request body", "in":"body", "description":"Request body", "schema":{ "type":"object", "required":[ "objectNum" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" } } }, "required":true }, "body.EmployeesGetParametersv1":{ "name":"Get Employees Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.EmployeesGetParametersv2":{ "name":"Get Employees Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.Employee.Insert":{ "name":"Request Body", "in":"body", "description":"Employee Request Body", "schema":{ "type":"object", "required":[ "objectNum" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee in the system." }, "firstName":{ "type":"string", "example":"Employee", "description":"Employee's first name, which prints on reports." }, "lastName":{ "type":"string", "example":"Employee", "description":"Employee's last name, which prints on reports." }, "checkName":{ "type":"string", "example":"Employee Check Name", "description":"Name to print on guest checks." }, "languageObjNum":{ "type":"integer", "example":1, "description":"The object number of the default language for the employee on the EMC and the workstation." }, "payrollId":{ "type":"string", "example":"EMP-01", "description":"External payroll ID for the employee." }, "id":{ "type":"integer", "example":2021, "description":"ID number to identify the employee on workstations." }, "alternateId":{ "type":"integer", "example":2121, "description":"ID to use instead of the Employee ID when signing into the workstation." }, "pin":{ "type":"string", "example":2222, "description":"PIN for the employee." }, "level":{ "type":"integer", "example":1, "description":"The level of the employee. This value should be between 1-9." }, "group":{ "type":"integer", "example":1, "description":"The group of the employee." }, "terminationDate":{ "type":"string", "example":"2021-11-21T00:00:00.000Z", "description":"The date the employee was terminated.Format:YYYY-MM-DD. This value is set from Labor Management and cannot be added" }, "isDataPrivacyConsentGranted":{ "type":"boolean", "example":false, "description":"The consent status of the employee." }, "infoLine1":{ "type":"string", "example":"Information line 1", "description":"Information line 1" }, "infoLine2":{ "type":"string", "example":"Information line 2", "description":"Information line 2" }, "infoLine3":{ "type":"string", "example":"Information line 3", "description":"Information line 3" }, "infoLine4":{ "type":"string", "example":"Information line 4", "description":"Information line 4" }, "userName":{ "type":"string", "example":"empName", "description":"The login name for the EMC." }, "localeObjNum":{ "type":"integer", "example":1, "description":"The object number of the locale of the employee" }, "roles":{ "type":"array", "description":"An array of roles associated with the employee at different hierarchy levels", "items":{ "$ref":"#/definitions/Employee_roles_CUD" } }, "emcVisibility":{ "type":"array", "description":"Array of hierarchy units visible to the employee in EMC.", "items":{ "$ref":"#/definitions/Employee_emcVisibility_CUD" } }, "properties":{ "type":"array", "description":"Array of properties where the employee is assigned.", "items":{ "$ref":"#/definitions/Employee_properties_CUD" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for employees", "items":{ "$ref":"#/definitions/Employee_dataExtensions" } } } }, "required":true }, "body.Employee.Update":{ "name":"Request Body", "in":"body", "description":"Employee Request Body", "schema":{ "type":"object", "required":[ "objectNum" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee in the system." }, "firstName":{ "type":"string", "example":"Employee", "description":"Employee's first name, which prints on reports." }, "lastName":{ "type":"string", "example":"Employee", "description":"Employee's last name, which prints on reports." }, "checkName":{ "type":"string", "example":"Employee Check Name", "description":"Name to print on guest checks." }, "languageObjNum":{ "type":"integer", "example":1, "description":"The object number of the default language for the employee on the EMC and the workstation." }, "payrollId":{ "type":"string", "example":"EMP-01", "description":"External payroll ID for the employee." }, "id":{ "type":"integer", "example":2021, "description":"ID number to identify the employee on workstations." }, "alternateId":{ "type":"integer", "example":2121, "description":"ID to use instead of the Employee ID when signing into the workstation." }, "pin":{ "type":"string", "example":2222, "description":"PIN for the employee." }, "level":{ "type":"integer", "example":1, "description":"The level of the employee. This value should be between 1-9." }, "group":{ "type":"integer", "example":1, "description":"The group of the employee." }, "terminationDate":{ "type":"string", "example":"2021-11-21T00:00:00.000Z", "description":"The date the employee was terminated.Format:YYYY-MM-DD. This value is set from Labor Management and cannot be added" }, "isDataPrivacyConsentGranted":{ "type":"boolean", "example":false, "description":"The consent status of the employee." }, "infoLine1":{ "type":"string", "example":"Information line 1", "description":"Information line 1" }, "infoLine2":{ "type":"string", "example":"Information line 2", "description":"Information line 2" }, "infoLine3":{ "type":"string", "example":"Information line 3", "description":"Information line 3" }, "infoLine4":{ "type":"string", "example":"Information line 4", "description":"Information line 4" }, "userName":{ "type":"string", "example":"empName", "description":"The login name for the EMC." }, "localeObjNum":{ "type":"integer", "example":1, "description":"The object number of the locale of the employee" }, "roles":{ "type":"array", "description":"An array of roles associated with the employee at different hierarchy levels", "items":{ "$ref":"#/definitions/Employee_roles_CUD" } }, "emcVisibility":{ "type":"array", "description":"Array of hierarchy units visible to the employee in EMC.", "items":{ "$ref":"#/definitions/Employee_emcVisibility_CUD" } }, "properties":{ "type":"array", "description":"Array of properties where the employee is assigned.", "items":{ "$ref":"#/definitions/Employee_properties_CUD" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for employees", "items":{ "$ref":"#/definitions/Employee_dataExtensions" } } } }, "required":true }, "body.DeleteRequest.Required":{ "name":"Request Body", "in":"body", "description":"Request body", "schema":{ "type":"object", "required":[ "objectNum" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" } } }, "required":true }, "body.ReactivateRequest.Required":{ "name":"Request Body", "in":"body", "description":"Request body", "schema":{ "type":"object", "required":[ "objectNum" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" } } }, "required":true }, "body.EmployeePropertyDeleteRequest.Required":{ "name":"Request Body", "in":"body", "description":"Request body", "schema":{ "type":"object", "required":[ "objectNum", "propertyHierUnitId" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" }, "propertyHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value of the property" } } }, "required":true }, "body.EmployeePropertiesGetParametersv1":{ "name":"Request Body", "in":"body", "description":"Request body", "schema":{ "$ref":"#/definitions/EmployeePropertyGetRequestBody" }, "required":true }, "body.EmployeePropertiesGetParametersv2":{ "name":"Request Body", "in":"body", "description":"Request body", "schema":{ "type":"object", "required":[ "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum, 1)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" } } }, "required":true }, "body.EmployeeProperty.Required":{ "name":"Request Body", "in":"body", "description":"Request body", "schema":{ "type":"object", "required":[ "objectNum", "propertyHierUnitId" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee in the system." }, "propertyHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value associated with the property" }, "empClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the class of the employee at the property." }, "rvcHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value associated with the RVC." }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the employee property assignment." }, "inTraining":{ "type":"boolean", "example":false, "description":"Flag indicating if employee is in training at the property." }, "ldsId":{ "type":"integer", "example":1, "description":"unique ID number to identify the employee in a Liquor Dispensing System." }, "lateClockInGrace":{ "type":"integer", "example":1, "description":"The number of minutes that the employee can clock in late without being prompted or requiring authorization." }, "operators":{ "type":"array", "description":"Array of revenue center operators records for the employees", "items":{ "$ref":"#/definitions/Employee_properties_operators_CUD" } } } }, "required":true }, "body.EmployeePropertyOperatorsGetParametersv1":{ "name":"Request Body", "in":"body", "description":"Request body", "schema":{ "$ref":"#/definitions/EmployeePropertyJobCodeGetRequestBody" }, "required":true }, "body.EmployeePropertyOperatorsGetParametersv2":{ "name":"Request Body", "in":"body", "description":"Request body", "schema":{ "type":"object", "required":[ "objectNum", "propertyHierUnitId" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(active, 1)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"propertyHierUnitId:asc" }, "propertyHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value of the property" } } }, "required":true }, "body.EmployeePropertyOperator.Required":{ "name":"Request Body", "in":"body", "description":"Request body", "schema":{ "type":"object", "required":[ "objectNum", "propertyHierUnitId", "rvcHierUnitId" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee in the system." }, "propertyHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value associated with the property" }, "rvcHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value of the revenue center" }, "cashierObjNum":{ "type":"integer", "example":1, "description":"Object number of the cashier linked to the workstation operator." }, "overrideEmployeeClassOptions":{ "type":"boolean", "example":true, "description":"A flag indicating whether the workstation operator record uses Employee Class Options or Operator Options to determine transaction behavior." }, "options":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the employee operator record at the property." }, "cmAccountingMethodObjNum":{ "type":"integer", "example":1, "description":"Object number of Cash Management session type the employee uses to record Cash Management related transactions within the revenue center" }, "serverBankingTemplateObjNum":{ "type":"integer", "example":1, "description":"Object number of the default template to use when opening a server bank." }, "cashDrawerObjNum":{ "type":"integer", "example":1, "description":"Object number of the cash drawer that is permanently assigned to each workstation operator." }, "tableCount":{ "type":"integer", "example":1, "description":"The number of tables each operator serves." }, "tmsColorObjNum":{ "type":"integer", "example":1, "description":"Object number of the color to distinguish the employee from others when using TMS." }, "serverEfficiency":{ "type":"integer", "example":1, "description":"Efficiency of the server." } } }, "required":true }, "body.EmployeePropertyOperatorDeleteRequest.Required":{ "name":"Request Body", "in":"body", "description":"Request body", "schema":{ "type":"object", "required":[ "objectNum", "propertyHierUnitId", "rvcHierUnitId" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" }, "propertyHierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value of the property" }, "rvcHierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value of the revenue center." } } }, "required":true }, "body.SystemEmployeesGetParameters":{ "name":"Get Record Parameters", "in":"body", "required":true, "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectnum, 1792)", "description":"If specified, returns records that match the criteria. Allowed fields are objectNum, firstName, lastName and checkName." }, "include":{ "type":"string", "example":"objectNum, firstName", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order. Allowed fields are objectNum, firstName, lastName and checkName.", "example":"objectNum:asc" } } } }, "body.SystemEmployeeDeleteRequest":{ "name":"Delete Request Parameters", "in":"body", "description":"System employee delete request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the system employee is configured.", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the system employee", "type":"integer", "example":1 } } } }, "body.SystemEmployeeCURequest":{ "name":"Insert Update Request Body", "in":"body", "description":"System Employee insert and update request body", "required":true, "schema":{ "description":"Model for System Employee Object Insert and Update Request", "type":"object", "required":[ "hierUnitId", "objectNum", "langId" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the system employee is configured.", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object number of the system employee.", "type":"integer", "example":1 }, "firstName":{ "description":"System employee's first name, which prints on reports.", "type":"string", "example":"Employee" }, "lastName":{ "description":"System employee's last name, which prints on reports.", "type":"string", "example":"Employee" }, "checkName":{ "description":"Name to print on guest checks.", "type":"string", "example":"SystemEmpCheckName" }, "langId":{ "description":"LangId of default language for the system employee", "type":"integer", "example":1 } } } }, "body.MenuItemClass2GetRequestBody":{ "name":"Request Body", "in":"body", "description":"GET Request body", "required":true, "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 1792)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specificied, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"serviceHostId:asc" } } } }, "body.MenuItemClass2CUDRequest":{ "name":"Request Body", "in":"body", "description":"CUD Request body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the menu item Class." }, "name":{ "type":"object", "description":"Menu Item Class Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "taxClassObjNum":{ "type":"integer", "example":1, "description":"Tax Class object for the Menu Item class" }, "mainLevelPopupIndex":{ "type":"integer", "example":1, "description":"Main Level of the transaction to become active after adding an item from this Menu Item Class." }, "mainLevelDefault":{ "type":"boolean", "example":false, "description":"Select Main Level Dflt to return the Main Level of the transaction to the default Main Level after adding an item from this Menu Item Class." }, "subLevelPopupIndex":{ "type":"integer", "example":1, "description":"Sub Level of the transaction to become active after adding an item from this Menu Item Class." }, "subLevelDefault":{ "type":"boolean", "example":false, "description":"Select Sub Level Dflt to return the Sub Level of the transaction to the default Sub Level after adding an item from this Menu Item Class." }, "privilegeGroup":{ "type":"integer", "example":1, "description":"Privilege Group number to restrict the use of items in this Menu Item Class to employees who are linked to the same Privilege Group" }, "slsItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Sales Itemizer used to sort Menu Item Classes." }, "dscItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Discount Itemizer associated with this Menu Item Class." }, "svcItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Service Charge Itemizer associated with menus items assigned to this Menu item Class." }, "halo":{ "type":"integer", "example":1, "description":"High Amount Lock Out (HALO) value for items in this Menu Item Class." }, "kdsCourseObjNum":{ "type":"integer", "example":1, "description":"Object number of the course to which items in this Menu Item Class belong." }, "defaultMasterGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the default parent item for a condiment during conversational ordering." }, "condimentOrderType":{ "type":"integer", "example":1, "description":"Method for adding a condiment to a check. Value should be between 0-4." }, "condimentOrderPopup":{ "type":"integer", "example":1, "description":"Popup Condiment Orderer page to automatically pop up when adding a menu item with required condiments." }, "condimentEditPopup":{ "type":"integer", "example":0, "description":"Condiment Orderer page to automatically pop up when selecting a menu item with required condiments in the check detail." }, "priceCalculation":{ "type":"integer", "example":0, "description":"Calculation method to use for pricing menu items in the class when entering a decimal count." }, "countDisplay":{ "type":"integer", "example":1, "description":"Count that appear on the workstation and printers." }, "countEntry":{ "type":"integer", "example":1, "description":"Select the operator entry method for item sales count." }, "printGroup":{ "type":"integer", "example":1, "description":"The sorting mechanism uses this value for receipt printing, check detail, and order output devices." }, "printClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Print Class for the menu item class." }, "kdsHighlightScheme":{ "type":"integer", "example":1, "description":"Object number of the KDS Highlight Scheme color to display menu items on the KDS." }, "condimentPrefixType":{ "type":"integer", "example":1, "description":"Prefix Type associated with a Condiment type." }, "condimentHandlingWithParentItemSwitching":{ "type":"integer", "example":0, "description":"Condiment behavior to use for Default and other Condiments when the parent item is switched in Conversational Ordering." }, "nextPage":{ "type":"integer", "example":0, "description":"Next screen or page to which the workstation user is directed." }, "nextPanel":{ "type":"integer", "example":0, "description":"Panel specifies which Tab to navigate." }, "maxRefillCount":{ "type":"integer", "example":1, "description":"Maximum number of Refills allowed for a Menu item." }, "refillDescriptor":{ "type":"object", "description":"Refill Descriptor", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "svcGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the Service Charge Group to apply to this Menu Item Class." }, "preProdChitPrintClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Pre Production Chit Print Class for the Menu Item Class." }, "allergenClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Allergen Class for the Menu Item Class." }, "options":{ "type":"string", "example":"010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 96 representing the enablement or disablement of the options associated with the Menu Item Class." }, "condimentGroups":{ "$ref":"#/definitions/MenuItemClass2_condimentGroups" }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item class", "items":{ "$ref":"#/definitions/MenuItemClass2_dataExtensions" } } } }, "required":true }, "body.MenuItemClass2DeleteRequest.Required":{ "name":"Delete Request Body", "in":"body", "description":"Delete Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Menu Item Class" } } } }, "body.HeadersTrailersByChannelTypeGetParameters":{ "name":"Get Record Parameters", "in":"body", "required":true, "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 1792)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.HeadersTrailersByChannelTypeDeleteRequest":{ "name":"Delete Request Parameters", "in":"body", "description":"Headers Trailers by Channel Type delete request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "descriptorTypeNum" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "objectNum":{ "description":"Object number of the descriptor", "type":"integer", "example":1 }, "descriptorTypeNum":{ "description":"Descriptor type number. The valid values are - 55 => Check Header - Order Type/Order Channel, 56 => Check Trailer - Order Type/Order Channel, 57 => Receipt Header - Order Type/Order Channel.", "type":"integer", "example":55 } } } }, "body.HeadersTrailersByChannelTypeCURequest":{ "name":"Insert Update Request Body", "in":"body", "description":"Headers Trailers by Channel Type insert and update request body", "required":true, "schema":{ "description":"Model for Headers Trailers by Channel Type Object Insert and Update Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name", "descriptorTypeNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the descriptor is configured.", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object number of the descriptor.", "type":"integer", "example":1 }, "name":{ "description":"Descriptor Name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "descriptorTypeNum":{ "description":"Descriptor type number. The valid values are - 55 => Check Header - Order Type/Order Channel, 56 => Check Trailer - Order Type/Order Channel, 57 => Receipt Header - Order Type/Order Channel.", "type":"integer", "example":55 }, "descriptorLines":{ "description":"An array of descriptor lines", "type":"array", "items":{ "properties":{ "lineNum":{ "description":"Line Number of the Header/Trailer. The valid range for lineNum for headers is 1-6 and for trailers is 1-12.", "type":"integer", "example":55 }, "useLogo":{ "description":"Boolean flag for using either logoObjectNum(true) or text(false) for the specified lineNum. Automatically set to false if value is not specified.", "type":"boolean", "example":false }, "text":{ "description":"A string that contains the text of a line in multiple languages.", "type":"object", "example":{ "1":"Please visit again!", "2":"Bitte schauen Sie noch einmal vorbei!", "3":"Por favor visite de nuevo!" } }, "logoObjectNum":{ "description":"Object Number of the logo.", "type":"integer", "example":0 } } } } } } }, "body.ReasonCodesGetParameters":{ "name":"Get Reason Codes Method", "description":"The input body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria. Allowed fields are hierUnitId, objectNum, descriptorTypeNum and text." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, descriptorTypeNum", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order. Allowed fields are hierUnitId, objectNum, descriptorTypeNum and text.", "example":"hierUnitId:asc" } } } }, "body.ReasonCodesInsertRequest":{ "name":"Insert Request Body", "in":"body", "description":"Reason Codes insert request body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "descriptorTypeNum", "text" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the reason code is configured.", "type":"integer", "example":7 }, "objectNum":{ "description":"Object Number of the Reason Code.", "type":"integer", "example":2 }, "descriptorTypeNum":{ "description":"

    Descriptor type number of the reason code.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Descriptor Type NameDescriptor Type NumMax Count
    Payment 30 32
    Loan 28 32
    Pickup 27 32
    Service total 29 32
    Void/Return/Waste 48 64
    Cash Management
    Adjust Starting Amount: 38
    Adjust Count: 39
    Adjust Paid-in: 40
    Adjust Paid-out: 41
    Transfer: 42
    Adjust Cash Deposit: 43
    Over/Short: 44
    Adjust Bank Deposit Reference: 45
    No Sale Reason: 49
    \n", "type":"integer", "example":30 }, "text":{ "type":"object", "description":"Name of the Reason Code.", "maxLength":128, "example":{ "1":"Inventory purchase", "2":"Inventory purchase", "3":"Inventory purchase" } } } } }, "body.ReasonCodesUpdateRequest":{ "name":"Update Request Body", "in":"body", "description":"Reason Codes update request body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "descriptorTypeNum", "text" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the reason code is configured.", "type":"integer", "example":7 }, "objectNum":{ "description":"Object Number of the Reason Code.", "type":"integer", "example":2 }, "descriptorTypeNum":{ "description":"

    Descriptor type number of the reason code.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Descriptor Type NameDescriptor Type NumMax Count
    Payment 30 32
    Loan 28 32
    Pickup 27 32
    Service total 29 32
    Void/Return/Waste 48 64
    Cash Management
    Adjust Starting Amount: 38
    Adjust Count: 39
    Adjust Paid-in: 40
    Adjust Paid-out: 41
    Transfer: 42
    Adjust Cash Deposit: 43
    Over/Short: 44
    Adjust Bank Deposit Reference: 45
    No Sale Reason: 49
    \n", "type":"integer", "example":30 }, "text":{ "type":"object", "description":"Name of the Reason Code.", "maxLength":128, "example":{ "1":"Inventory purchase", "2":"Inventory purchase", "3":"Inventory purchase" } }, "options":{ "description":"A string value of 0s & 1s of length 16 indicating the use of Reasons for Voids/Returns and Waste. Supported only for Void /Return /Waste.", "type":"integer", "example":"1100000000000000" } } } }, "body.ReasonCodesDeleteRequest":{ "name":"Delete Request Parameters", "in":"body", "description":"Reason Codes Delete Request Body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "descriptorTypeNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the reason code is configured.", "type":"integer", "example":7 }, "objectNum":{ "description":"Object Number of the Reason Code.", "type":"integer", "example":2 }, "descriptorTypeNum":{ "description":"Descriptor type number of the reason code.", "type":"integer", "example":30 } } } }, "body.RevenueCentersGetParametersv1":{ "name":"Get Revenue Centers Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.RevenueCentersGetParametersv2":{ "name":"Get Revenue Centers Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.RevenueCenterDelete":{ "name":"Delete request body", "in":"body", "description":"Revenue Center Delete Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the revenue center", "type":"integer", "example":1 } } } }, "body.RevenueCenterInsert":{ "name":"RevenueCenterInsert", "in":"body", "description":"RevenueCenter object of the organization", "required":true, "schema":{ "$ref":"#/definitions/RevenueCenterInsert" } }, "body.RevenueCenterUpdate":{ "name":"RevenueCenterUpdate", "in":"body", "description":"RevenueCenter object of the organization", "required":true, "schema":{ "$ref":"#/definitions/RevenueCenterUpdate" } }, "body.RevenueCenterInsertv2":{ "name":"RevenueCenterInsert", "in":"body", "description":"RevenueCenter object of the organization", "required":true, "schema":{ "required":[ "locHierUnitId", "objectNum", "name" ], "description":"Model for RevenueCenter Object", "type":"object", "properties":{ "locHierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the revenue center", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the revenue center configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "ConsumerFacingName":{ "description":"A group of string objects representing the consumer facing name of the revenue center in the configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "phoneCountryCode":{ "description":"The phone number country code of the revenue center. It cannot be null when assigning a phone number to the property.", "type":"string", "example":"US" }, "phone":{ "description":"The phone number of the revenue center. If it is not null, the phoneCountryCode is required.", "type":"string", "example":"1234567890" }, "address1":{ "description":"The address line 1 for the revenue center.", "type":"string", "example":"Address Line 1" }, "address2":{ "description":"The address line 2 for the revenue center.", "type":"string", "example":"Address Line 2" }, "address3":{ "description":"The address line 3 for the revenue center.", "type":"string", "example":"Address Line 3" }, "city":{ "description":"The city for the revenue center.", "type":"string", "example":"City" }, "stateOrRegionCode":{ "description":"The state or region code for the revenue center. It cannot be null when stateOrRegion is not null.", "type":"string", "example":"NY" }, "stateOrRegion":{ "description":"The state or region for the revenue center. It cannot be null when stateOrRegionCode is not null.", "type":"string", "example":"New York" }, "zipOrPostalCode":{ "description":"The ZIP or postal code for the revenue center.", "type":"string", "example":"YXA123" }, "countryCode":{ "description":"The country code for the revenue center.", "type":"string", "example":"US" }, "latitude":{ "description":"The revenue center latitude. Latitude must be within range -90 to +90", "type":"string", "example":12.23 }, "longitude":{ "description":"The revenue center longitude. Longitude must be between -180 and 180", "type":"string", "example":12.34 }, "floor":{ "description":"The floor of the building.", "type":"string", "example":"1st Floor" }, "kdsControllerId":{ "description":"The unique reference of the KDS Controller that controls the KDS Display Order Devices in this revenue center. Oracle recommends using no more than 15 KDS Display Order Devices on a single KDS Controller", "type":"integer", "example":2 }, "isLDSActive":{ "description":"A flag indicating if LDS is activated for this revenue center.", "type":"boolean", "example":false }, "rvcTypes":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the revenue center types associated with the revenue center. If not specified, this will represent the default options associated with the revenue center", "type":"string", "example":"11111111111111111111111111111111" }, "rvcGroups":{ "description":"An object containing the descriptive options list associated with the revenue center groups associated with this revenue center", "type":"array", "items":{ "type":"object", "properties":{ "rvcGroupNum":{ "type":"integer", "description":"The object number of the revenue center group associated with the revenue center", "example":1 } } }, "example":{ "rvcGroupNum":1 } }, "dataExtensions":{ "description":"An array of extension data associated with the revenue center", "type":"array", "items":{ "type":"object", "properties":{ "columnName":{ "type":"string", "description":"The name of the extension data column", "example":"extension column 1" }, "value":{ "type":"string", "description":"The value associated with the extension data column", "example":"value 1" } } }, "example":{ "columnName":"extension column 1", "value":"value 1" } } } } }, "body.RevenueCenterUpdatev2":{ "name":"RevenueCenterUpdate", "in":"body", "description":"RevenueCenter object of the organization", "required":true, "schema":{ "required":[ "hierUnitId", "name" ], "description":"Model for RevenueCenter Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the revenue center", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the revenue center configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "locHierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the revenue center", "type":"integer", "example":1 }, "ConsumerFacingName":{ "description":"A group of string objects representing the consumer facing name of the revenue center in the configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "phoneCountryCode":{ "description":"The phone number country code of the revenue center. It cannot be null when assigning a phone number to the property.", "type":"string", "example":"US" }, "phone":{ "type":"string", "description":"The phone number of the revenue center. If it is not null, the phoneCountryCode is required.", "example":"1234567890" }, "address1":{ "description":"The address line 1 for the revenue center.", "type":"string", "example":"Address Line 1" }, "address2":{ "description":"The address line 2 for the revenue center.", "type":"string", "example":"Address Line 2" }, "address3":{ "description":"The address line 3 for the revenue center.", "type":"string", "example":"Address Line 3" }, "city":{ "description":"The city for the revenue center.", "type":"string", "example":"City" }, "stateOrRegionCode":{ "description":"The state or region code for the revenue center. It cannot be null when stateOrRegion is not null.", "type":"string", "example":"NY" }, "stateOrRegion":{ "description":"The state or region for the revenue center. It cannot be null when stateOrRegionCode is not null.", "type":"string", "example":"New York" }, "zipOrPostalCode":{ "description":"The ZIP or postal code for the revenue center.", "type":"string", "example":"YXA123" }, "countryCode":{ "description":"The country code for the revenue center.", "type":"string", "example":"US" }, "latitude":{ "description":"The revenue center latitude. Latitude must be within range -90 to +90", "type":"string", "example":12.23 }, "longitude":{ "description":"The revenue center longitude. Longitude must be between -180 and 180", "type":"string", "example":12.34 }, "floor":{ "description":"The floor of the building.", "type":"string", "example":"1st Floor" }, "kdsControllerId":{ "description":"The unique reference of the KDS Controller that controls the KDS Display Order Devices in this revenue center. Oracle recommends using no more than 15 KDS Display Order Devices on a single KDS Controller", "type":"integer", "example":2 }, "isLDSActive":{ "description":"A flag indicating if LDS is activated for this revenue center.", "type":"boolean", "example":false }, "rvcTypes":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the revenue center types associated with the revenue center. If not specified, this will represent the default options associated with the revenue center", "type":"string", "example":"11111111111111111111111111111111" }, "rvcGroups":{ "description":"An object containing the descriptive options list associated with the revenue center groups associated with this revenue center", "type":"array", "items":{ "type":"object", "properties":{ "rvcGroupNum":{ "type":"integer", "description":"The object number of the revenue center group associated with the revenue center", "example":1 } } }, "example":{ "rvcGroupNum":1 } }, "dataExtensions":{ "description":"An array of extension data associated with the revenue center", "type":"array", "items":{ "type":"object", "properties":{ "columnName":{ "type":"string", "description":"The name of the extension data column", "example":"extension column 1" }, "value":{ "type":"string", "description":"The value associated with the extension data column", "example":"value 1" } } }, "example":{ "columnName":"extension column 1", "value":"value 1" } } } } }, "body.ZonesGetParametersv1":{ "name":"Get Zones Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US,es-ES,es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.ZonesGetParametersv2":{ "name":"Get Zones Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "formData.BulkDeleteZoneRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for deleting a zone and hierarchies beneath it in bulk", "type":"file", "required":true }, "formData.BulkPreDeleteZoneRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for checking the count of configuration data linked to a zone before deleting", "type":"file", "required":true }, "body.MenuLevelEntriesGetParametersv1":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/MenuLevelEntryGetRequestBody" } }, "body.MenuLevelEntriesGetParametersv2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" }, "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the menu level set" } } } }, "body.MenuLevelEntryCUDRequestBody":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "$ref":"#/definitions/MenuLevelEntryCUDRequestBody" } }, "body.MenuLevelEntryCUDRequestBodyv2":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "index", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the menu level set" }, "index":{ "type":"integer", "example":1, "description":"Object number of the menu level entry" }, "name":{ "type":"object", "description":"Menu Level Entry Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "prefix":{ "type":"object", "description":"Prefix for Menu Level Entry", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "suffix":{ "type":"object", "description":"Suffix for Menu Level Entry", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated" } }, "description":"Model for a Menu Level Entry CUD Request" } }, "body.MenuLevelEntryDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "index" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the menu level set" }, "index":{ "type":"integer", "example":1, "description":"Object number of the menu level entry" } }, "description":"Model for a Menu Level Entry Response" } }, "body.ComboGroupItemsLiteCURequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "comboMealGroupId", "itemObjNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit where the side group item is located" }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" }, "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "quantity":{ "type":"integer", "example":1, "description":"The quantity of the item" }, "options":{ "type":"string", "example":"000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the Combo Meal Group Item." }, "size1ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 1 function key (663)." }, "size2ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 2 function key (664)." }, "size3ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 3 function key (665)." }, "size4ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 4 function key (666)." }, "size1MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 1. Valid range is between 1 and 8." }, "size2MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 2. Valid range is between 1 and 8." }, "size3MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 3. Valid range is between 1 and 8." }, "size4MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 4. Valid range is between 1 and 8." }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group" } }, "description":"Model for Combo Group Item Object" } }, "body.ComboSideGroupItemsLiteGetParameters":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "comboMealGroupId" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" } } } }, "body.ComboGroupItemsLiteDeleteRequest":{ "in":"body", "name":"Request Body", "description":"Request body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "itemObjNum", "comboMealGroupId" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit where the side group item is located" }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" }, "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" } } } }, "body.NutrientSetNutrientsGetParameters":{ "name":"Get Record Parameters", "in":"body", "required":true, "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(nutrientSetNutrientId, 45)", "description":"If specified, returns records that match the criteria. Allowed fields are nutrientSetNutrientId, nutrientSetObjNum, nutritionNameObjNum." }, "include":{ "type":"string", "example":"hierUnitId, nutrientSetNutrientId", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order. Allowed fields are nutrientSetNutrientId, nutrientSetObjNum, nutritionNameObjNum.", "example":"nutrientSetNutrientId:asc" } } } }, "body.NutrientSetNutrientDeleteRequest":{ "name":"Delete Request Body", "in":"body", "description":"Nutrient delete request body.", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "nutrientSetNutrientId" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit. Only Enterprise hierarchy is allowed.", "type":"integer", "example":3599 }, "nutrientSetNutrientId":{ "description":"Unique Id of the nutrient.", "type":"integer", "example":101 } } } }, "body.NutrientSetNutrientInsertRequest":{ "name":"Insert Request Body", "in":"body", "description":"Nutrient insert request body.", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "nutrientSetObjNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit. Only Enterprise hierarchy is allowed.", "type":"integer", "example":3599 }, "nutrientSetObjNum":{ "description":"Object number of the nutrient set.", "type":"integer", "example":50 }, "nutritionNameObjNum":{ "description":"Object number of the nutrition name.", "default":0, "type":"integer", "example":8 }, "unitOfMeasure":{ "description":"An integer representing the unit of measurement for quantity. Acceptable values range from 1 to 4 (both inclusive).
    Unit Of MeasurementDescription
    1 Calories
    2 KiloJoules
    3 Grams
    4 Milligrams
    ", "type":"integer", "minimum":1, "maximum":4, "default":1, "example":2 }, "quantity":{ "description":"quantity of the nutrient.", "default":0, "type":"integer", "example":10 } } } }, "body.NutrientSetNutrientUpdateRequest":{ "name":"Update Request Body", "in":"body", "description":"Nutrient update request body.", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "nutrientSetNutrientId" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit. Only Enterprise hierarchy is allowed.", "type":"integer", "example":3599 }, "nutrientSetNutrientId":{ "description":"Unique Id of the nutrient.", "type":"integer", "example":101 }, "nutritionNameObjNum":{ "description":"Object number of the nutrition name.", "default":0, "type":"integer", "example":8 }, "unitOfMeasure":{ "description":"An integer representing the unit of measurement for quantity. Acceptable values range from 1 to 4 (both inclusive).
    Unit Of MeasurementDescription
    1 Calories
    2 KiloJoules
    3 Grams
    4 Milligrams
    ", "type":"integer", "minimum":1, "maximum":4, "default":1, "example":2 }, "quantity":{ "description":"quantity of the nutrient.", "default":0, "type":"integer", "example":10 } } } }, "body.LocalesCUDRequestParametersv2":{ "name":"Get Locales Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "required":[ "objectNum", "name", "decimalSeparator", "thousandsSeparator" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the Locale" }, "name":{ "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" }, "description":"name of the Locale" }, "decimalSeparator":{ "type":"string", "example":",", "description":"Decimal Separator for the Locale. \n\nAcceptable values are : Dot \".\" and Comma \",\"\n" }, "thousandsSeparator":{ "type":"string", "example":".", "description":"Thousands Separator for the Locale\n\nAcceptable values are : Dot \".\" and Comma \",\"\n" } }, "description":"Model for Locale Object" } }, "body.LocalesDeleteRequestParameters":{ "name":"Get Locales Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "required":[ "objectNum" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object Number of Locale" } } } }, "body.LocalesGetParametersv1":{ "name":"Get Locales Method", "description":"The input Body model that needs to be given.", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.LocalesGetParametersv2":{ "name":"Get Locales Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum, 1)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"objectNum:asc" } } } }, "body.BulkProcessingStatusRequest":{ "name":"Get bulk processing status request", "in":"body", "required":true, "schema":{ "type":"object", "required":[ "requestId" ], "properties":{ "requestId":{ "type":"integer", "description":"Bulk processing request ID", "example":1012 } } } }, "body.Zones2GetParameters":{ "name":"Get Zones2 Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":12, "description":"Integer to filter results based on hierUnitId." }, "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria. Allowed fields are hierUnitId, name, hierStrucId, parentHierUnitId, parentHierStrucId." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order. Allowed fields are hierUnitId, name, hierStrucId, parentHierUnitId, parentHierStrucId.", "example":"hierUnitId:asc" } } } }, "body.EMCModulesGetParameters":{ "name":"Get Record Parameters", "in":"body", "required":true, "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierStrucId, 1792)", "description":"If specified, returns records that match the criteria. Allowed field is hierStrucId" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order. Allowed field is hierStrucId.", "example":"hierStrucId:asc" } } } }, "body.EMCModuleRequest":{ "name":"Request Parameters", "in":"body", "description":"Enable / Disable EMC Module request body", "required":true, "schema":{ "type":"object", "required":[ "hierStrucId", "EMCModule" ], "properties":{ "hierStrucId":{ "description":"Unique reference of the hierarchy structure where the EMC Module is enabled.", "type":"integer", "example":3599 }, "EMCModule":{ "description":"

    EMC module at the corresponding hierarchy to enable/disable. If AllModules(1) is enabled, then all other EMC Modules at that hierarchy are automatically disabled.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Module NameValue
    AllModules 1
    AlphanumericKeyboard 2143
    ApplicationText 2138
    AutoMenuLevels 1150
    AutofireCheckOfflineHeader 2646
    BarcodeFormatStatus 1131
    Barcodes 2104
    Browser 2657
    CanadianGST 1146
    CanadianPST 1147
    CanadianTaxTrailers 2618
    CMAccount 6005
    CMCashCountThreshold 6011
    CMCashPullThreashold 6007
    CMClass 6003
    CMClassBehavior 6012
    CMCountSheet 6002
    CMPARLevel 6008
    CMParameters 6010
    CMReason 6009
    CMReceptacle 6004
    CMTemplate 6001
    CMVendor 6006
    CheckAlert 2643
    CheckSummaryDescriptors 2602
    ComboMealGroups 2123
    ComboMeals 2122
    Components 2158
    CondimentGroupNames 2627
    CondimentSets 2128
    Content 2126
    ControlParameters 1148
    CheckHeaderOrderTypeChannel 7110
    CheckTrailerOrderTypeChannel 7111
    CreditCardHeader 2616
    CreditCardTrailers 2617
    Currency 1113
    CurrencyAvailability 1144
    CurrencyConversion 1142
    CurrencyParameters 1145
    CustomReport 2137
    CustomerReceiptHeaders 2614
    DataExtensions 2129
    DiningTableClass 2140
    DiningTableStatusDefSet 2141
    DiscountGroups 2609
    DiscountItemizers 2624
    DiscountSLUNames 2629
    Discounts 1120
    EffectivityGroups 131
    ExtentionApplication 2139
    FormatParamters 1143
    GiftCardProvider 1175
    GuestCheckHeaders 2612
    GuestCheckTrailers 2613
    GuestInformationPrompts 2603
    KDSBumpBars 1129
    KDSHighlightSchemes 1137
    KDSToolBars 1130
    KDSDiningCourse 2641
    LoanReasons 2606
    LoyaltyConfig 1157
    LoyaltyCardProvider 1176
    LoyaltyDriver 1160
    LoyaltyModule 1159
    MenuItemClasses 2101
    MenuItemDefinitions 2102
    MenuItemGroups 1133
    MenuItemMasterGroupSLUNames 2652
    MenuItemMasterGroups 1138
    MenuItemMasters 1123
    MenuItemPrices 2103
    MenuItemSLUNames 2631
    MenuLevelSets 2127
    NLUNames 2623
    Operators 2100
    OrderChannelParameters 7107
    OrderTypeParameters 1141
    Pages 2124
    PageAssignment 2135
    PageTemplate 2125
    PaymentDevice 1164
    PaymentDriver 1161
    PaymentReasons 2605
    Payments 1155
    PickupReasons 2607
    POSKeyboard 2655
    PriceGroups 124
    PrintClasses 2146
    ProductionItem 2150
    PropertyEmployeeRecords 1101
    ReceiptHeaderOrderTypeChannel 7113
    ReportGroups 120
    ReportHeaders 7103
    ReportTrailers 7104
    ReportParameters 1149
    RoutingGroups 2639
    RVCTypeNames 2610
    SalesItemizers 2625
    SeatingSectionTemplate 2147
    Section 2148
    ServiceAlert 2642
    ServiceChargeGroup 7002
    ServiceChargeItemizers 2626
    ServiceChargeSLUNames 2633
    ServiceCharges 1121
    ServiceTotalReasons 2608
    StoredValueConfiguration 1158
    StoredValueDriver 1163
    StoredValueModule 1162
    SystemTemplate 2136
    TaskSchedules 133
    TaxClasses 1118
    TaxParameters 1139
    TaxRates 1117
    TenderMedia 1119
    TenderParameters 1140
    TenderMediaSLUNames 2635
    ThemeAssignment 2156
    TimeClockReasons 2621
    TMSParameters 2149
    TMSreasons 2644
    TMSTableAttributes 2155
    TrainingHeaders 2615
    VoidReturnWasteReason 2649
    WaitQuoteConfiguration 2645
    WasteReceiptHeaders 2647
    WasteReceiptTrailers 2648
    \n", "type":"integer", "example":1124 } } } }, "formData.BulkEnableEMCModuleRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for enabling EMC Modules in bulk", "type":"file", "required":true }, "formData.BulkDisableEMCModuleRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for disabling EMC Modules in bulk", "type":"file", "required":true }, "body.NodeCreateRequest":{ "name":"Insert Request Body", "in":"body", "description":"Hierarchy Node insert request body", "required":true, "schema":{ "description":"Model for Node Object Insert Request", "type":"object", "required":[ "nodeType", "parentHierUnitId" ], "properties":{ "nodeType":{ "description":"Type of the node to be inserted (Location/RVC/Zone)", "type":"string", "example":"Zone" }, "parentHierUnitId":{ "description":"HierUnitId of the zone/enterprise under which the node is to be inserted.", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object Number of the zone. This field is only supported and required for nodeType 'Zone'.", "type":"integer", "example":12 }, "name":{ "description":"Name of the zone. This field is only supported and required for nodeType 'Zone'.", "type":"object", "example":{ "1":"Currency", "2":"W??hrung", "3":"Divisa" } }, "zoneType":{ "description":"

    Type of the zone. This field is only supported for nodeType 'Zone'.

    \n\n\n\n\n\n\n
    zoneType Eligible Child Nodes
    NULL NA
    1 Locations and RVCs
    2 RVCs only
    \n", "type":"integer", "default":"null", "example":1 }, "hierUnitId":{ "description":"Hierarchy Unit Id of the node. This field is supported for nodeTypes 'Location' and 'RVC'.", "type":"integer", "example":1 }, "options":{ "type":"string", "example":"0000000000000000", "description":"

    A string of values 0s and 1s of length 16 representing the options for the hierarchy node

    \n \n \n \n \n \n \n \n \n
    Position(starts from 1) Description
    1 EnforceUniquePropertiesWithinZone
    2 EnforceUniqueRVCsWithinZone
    3 restrictModulesInChildZones
    4 allRVCsfromSameLocation
    5 sortAlphabetically
    \n
    \n\n

    List of bits that can be set for a particular zoneType

    \n\n\n \n \n \n \n
    ZoneType List of valid bits (starts from 1)
    NULL 3, 5
    1 1, 2, 3, 5
    2 2, 3, 4, 5
    \n" } } } }, "body.NodeUpdateRequest":{ "name":"Update Request Parameters", "in":"body", "description":"Hierarchy Node update request body", "required":true, "schema":{ "type":"object", "required":[ "hierStrucId" ], "properties":{ "hierStrucId":{ "type":"integer", "description":"Unique hierarchy structure value.", "example":1 }, "name":{ "description":"Name of the zone. This field is only supported and required for nodeType 'Zone'.", "type":"object", "example":{ "1":"Currency", "2":"W??hrung", "3":"Divisa" } }, "options":{ "type":"string", "example":"0000000000000000", "description":"

    A string of values 0s and 1s of length 16 representing the options for the hierarchy node

    \n \n \n \n \n \n \n \n \n
    Position(starts from 1) Description
    1 EnforceUniquePropertiesWithinZone
    2 EnforceUniqueRVCsWithinZone
    3 restrictModulesInChildZones
    4 allRVCsfromSameLocation
    5 sortAlphabetically
    \n
    \n\n

    List of bits that can be set for a particular zoneType

    \n\n\n \n \n \n \n
    ZoneType List of valid bits (starts from 1)
    NULL 3, 5
    1 1, 2, 3, 5
    2 2, 3, 4, 5
    \n" } } } }, "body.NodeDeleteRequest":{ "name":"Delete Request Parameters", "in":"body", "description":"Hierarchy Node delete request body", "required":true, "schema":{ "type":"object", "required":[ "hierStrucId" ], "properties":{ "hierStrucId":{ "type":"integer", "description":"Unique hierarchy structure value.", "example":1 } } } }, "formData.BulkUpdateNodeRequest":{ "in":"formData", "name":"BulkImportFile", "description":"Request body for updating hierarchy nodes in bulk", "type":"file", "required":true }, "body.WorkstationClassesGetParametersv1":{ "description":"The input Body model that needs to be given.", "name":"Get Workstation Classes Method", "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported.", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." } } } }, "body.WorkstationClassesGetParametersv2":{ "name":"Get Workstation Classes Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.WorkstationClassCUDRequest":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "$ref":"#/definitions/WorkstationClassCUDRequestBody" }, "required":true }, "body.WorkstationClassCUDRequestv2":{ "name":"Request body", "in":"body", "description":"A request body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value. The hierUnitId should be only of a location or the enterprise.", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the workstation class", "type":"integer", "example":1 }, "name":{ "description":"Workstation Class Name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } } } }, "required":true }, "body.WorkstationClass":{ "name":"WorkstationClass", "in":"body", "description":"Workstation Class Object", "required":true, "schema":{ "$ref":"#/definitions/WorkstationClassv1" } }, "body.WorkstationClassBody":{ "name":"Workstation Class", "in":"body", "description":"Workstation Class minimal body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Workstation class", "type":"integer", "example":1 } } } }, "body.DiningTablesGetParameters":{ "name":"Get Dining Tables Method", "description":"The input Body model that needs to be given.", "required":true, "in":"body", "schema":{ "type":"object", "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId, 7)", "description":"If specified, returns records that match the criteria." }, "include":{ "type":"string", "example":"hierUnitId, objectNum, name", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"If this value is specified, the include parameter is ignored.\n\n\n \n \n\n\n \n \n\n\n \n \n\n
    ValueDescription
    basicForces the response to include all fields except option string details
    detailedForces the response to include all fields including option string details
    \n" }, "langIds":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"1,2,3" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"hierUnitId:asc" } } } }, "body.DiningTablesCURequest":{ "name":"Insert Update Request Body", "in":"body", "description":"Dining Table insert and update request body", "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Hier Unit Id of the RVC", "type":"integer", "example":7 }, "objectNum":{ "description":"Object Number of the Dining Table.", "type":"integer", "example":2 }, "name":{ "type":"object", "description":"Name of Dining Table.", "maxLength":4, "example":{ "1":"Entp", "2":"Untm", "3":"Emp" } }, "diningTableClassObjNum":{ "description":"Object Number of the Dining Table class.", "type":"integer", "example":244 } } } }, "body.DiningTablesDeleteRequest":{ "name":"Delete Request Parameters", "in":"body", "description":"Dining Tables Delete Request Body", "required":true, "schema":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":7, "description":"Hier Unit Id of RVC" }, "objectNum":{ "type":"integer", "example":2, "description":"Object Number of Dining Table" } } } } }, "definitions":{ "OrderChannelResourceObject":{ "description":"Model for Order Channel Object", "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"A string that contains translations of hierarchy unit name into multiple languages", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "objectNum":{ "type":"integer", "example":2, "description":"Object number of the Order Channel" }, "name":{ "type":"object", "description":"A string that contains translations into multiple languages\n", "example":{ "en-US":"Order Channel", "de-DE":"Bestellkanal", "es-MX":"Canal de pedidos" } }, "active":{ "type":"boolean", "example":true, "description":"A Boolean flag indicating the order channel is active" } } }, "OrderChannelv2":{ "description":"Model for Order Channel Object", "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":2, "description":"Object number of the Order Channel" }, "name":{ "type":"object", "description":"A string that contains translations into multiple languages\n", "example":{ "1":"Order Channel", "2":"Bestellkanal", "3":"Canal de pedidos" } }, "active":{ "type":"boolean", "example":true, "description":"A Boolean flag indicating the order channel is active" } } }, "OrderChannelCURequestBody":{ "description":"Order Channel Request Body for Create and Update Requests", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "objectNum":{ "type":"integer", "example":2, "description":"Object number of the Order Channel" }, "name":{ "type":"object", "description":"A string that contains translations into multiple languages\n", "example":{ "en-US":"Order Channel", "de-DE":"Bestellkanal", "es-MX":"Canal de pedidos" } }, "active":{ "type":"boolean", "example":true, "description":"A Boolean flag indicating the order channel is active" } } }, "OrderChannelGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Order Channel objects of the organization.", "items":{ "$ref":"#/definitions/OrderChannelResourceObject" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "OrderChannelResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Order Channel" } } }, "menuItemMasterEffectivityResponsev1":{ "type":"object", "properties":{ "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Menu item master effectivity group object number" }, "hierUnitId":{ "type":"integer", "example":662, "description":"Unique hierarchy unit reference" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" }, "effectivityGroupName":{ "type":"object", "description":"Effectivity Group Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"hierarchy unit object number" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } } } }, "menuItemMasterEffectivityGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Master Effectivity objects of the organization.", "items":{ "$ref":"#/definitions/menuItemMasterEffectivityResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "MenuItemMasterEffectivityv2":{ "type":"object", "properties":{ "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Menu item master effectivity group object number" }, "hierUnitId":{ "type":"integer", "example":662, "description":"Unique hierarchy unit reference" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"hierarchy unit object number" } } }, "menuItemMasterEffectivityResponse":{ "type":"object", "properties":{ "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Menu item master effectivity group object number" }, "hierUnitId":{ "type":"integer", "example":662, "description":"Unique hierarchy unit reference" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" } } }, "DeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "EmployeeRoleGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Employee Role objects of the organization.", "items":{ "$ref":"#/definitions/EmployeeRolev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "EmployeeRolev1":{ "description":"Model for an Employee Role Object", "type":"object", "properties":{ "objectNum":{ "description":"Unique reference of the employee in the system.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the employee role is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the employee role is configured", "type":"integer", "example":26 }, "hierUnitName":{ "description":"Hier Unit Name", "type":"object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "roleEmployeeId":{ "description":"Unique reference of Employee Role Association", "type":"integer", "example":1 }, "roleObjNum":{ "description":"The object number of the role assigned to the employee", "type":"integer", "example":1000 }, "roleName":{ "type":"object", "description":"Role Name", "example":{ "en-US":"Cashier", "de-DE":"Kassierer", "es-MX":"Cajero" } } } }, "EmployeeRolev2":{ "description":"Model for an Employee Role Object", "type":"object", "properties":{ "objectNum":{ "description":"Unique reference of the employee in the system.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the employee role is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the employee role is configured", "type":"integer", "example":26 }, "roleEmployeeId":{ "description":"Unique reference of Employee Role Association", "type":"integer", "example":1 }, "roleObjNum":{ "description":"The object number of the role assigned to the employee", "type":"integer", "example":1000 } } }, "EmployeeRoleResponse":{ "description":"Model for Employee Role Insert and Update Response Body", "type":"object", "properties":{ "objectNum":{ "description":"Unique reference of the employee in the system.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the employee role is configured", "type":"integer", "example":3599 }, "roleEmployeeId":{ "description":"Unique reference of Employee Role Association", "type":"integer", "example":1 }, "roleObjNum":{ "description":"The object number of the role assigned to the employee", "type":"integer", "example":1000 } } }, "RolesResourceObjectv1":{ "description":"Model for Roles Object", "type":"object", "properties":{ "objectNum":{ "description":"Object Number of the Role.", "type":"integer", "example":1 }, "name":{ "description":"A group of strings representing the name of the role", "type":"object", "example":{ "en-US":"Routing Group", "de-DE":"Routing-Gruppe" } }, "emcControlLevel":{ "type":"integer", "example":0, "description":"Security Level of the role." }, "comment":{ "type":"string", "example":"Comment", "description":"Description of the role in no more than 2000 characters" }, "emcModules":{ "description":"An array of privileges for access to EMC modules by the role", "type":"array", "items":{ "$ref":"#/definitions/Role_emcModule" } }, "flmModules":{ "description":"An array of privileges for access to FLM modules by the role", "type":"array", "items":{ "$ref":"#/definitions/Role_flmModule" } }, "actions":{ "description":"An array of enablement of actions that can be performed by the role's users", "type":"array", "items":{ "$ref":"#/definitions/Role_actions" } }, "operations":{ "description":"An array of enablement of operations that can be performed by the role's users", "type":"array", "items":{ "$ref":"#/definitions/Role_operations" } }, "visibility":{ "description":"An array of hierarchy units where the role is visible", "type":"array", "items":{ "$ref":"#/definitions/Role_visibility" } }, "enableRVCLevelSecurity":{ "type":"boolean", "example":false, "description":"A Boolean flag to restrict employees with this role to perform workstation operations only in revenue centers in which they are an operator." }, "fields":{ "description":"An array of objects containing the access control to specific fields of the EMC module", "type":"array", "items":{ "$ref":"#/definitions/Role_fields" } }, "dataExtensions":{ "description":"An array of data extensions for the Roles", "type":"array", "items":{ "$ref":"#/definitions/Role_dataExtensions" } } } }, "RolesResourceObjectv2":{ "description":"Model for Roles Object", "type":"object", "properties":{ "objectNum":{ "description":"Object Number of the Role.", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Role Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "emcControlLevel":{ "type":"integer", "example":0, "description":"Security Level of the role." }, "comment":{ "type":"string", "example":"Comment", "description":"Description of the role in no more than 2000 characters" }, "emcModules":{ "description":"An array of privileges for access to EMC modules by the role", "type":"array", "items":{ "$ref":"#/definitions/Role_emcModule" } }, "flmModules":{ "description":"An array of privileges for access to FLM modules by the role", "type":"array", "items":{ "$ref":"#/definitions/Role_flmModule" } }, "actions":{ "description":"An array of enablement of actions that can be performed by the role's users", "type":"array", "items":{ "$ref":"#/definitions/Role_actions" } }, "operations":{ "description":"An array of enablement of operations that can be performed by the role's users", "type":"array", "items":{ "$ref":"#/definitions/Role_operations" } }, "visibility":{ "description":"An array of hierarchy units where the role is visible", "type":"array", "items":{ "$ref":"#/definitions/Role_visibilityv2" } }, "enableRVCLevelSecurity":{ "type":"boolean", "example":false, "description":"A Boolean flag to restrict employees with this role to perform workstation operations only in revenue centers in which they are an operator." }, "fields":{ "description":"An array of objects containing the access control to specific fields of the EMC module", "type":"array", "items":{ "$ref":"#/definitions/Role_fields" } }, "dataExtensions":{ "description":"An array of data extensions for the Roles", "type":"array", "items":{ "$ref":"#/definitions/Role_dataExtensions" } } } }, "RolesCURequestBody":{ "description":"Model for Roles Object", "type":"object", "required":[ "objectNum", "name" ], "properties":{ "objectNum":{ "description":"Object Number of the Role.", "type":"integer", "example":1 }, "name":{ "description":"A group of strings representing the name of the role", "type":"object", "example":{ "en-US":"Routing Group", "de-DE":"Routing-Gruppe" } }, "emcControlLevel":{ "type":"integer", "example":0, "description":"Security Level of the role." }, "comment":{ "type":"string", "example":"Comment", "description":"Description of the role in no more than 2000 characters" }, "emcModules":{ "description":"An array of privileges for access to EMC modules by the role", "type":"array", "items":{ "$ref":"#/definitions/Role_emcModuleCU" } }, "flmModules":{ "description":"An array of privileges for access to FLM modules by the role", "type":"array", "items":{ "$ref":"#/definitions/Role_flmModuleCU" } }, "actions":{ "description":"An array of enablement of actions that can be performed by the role's users", "type":"array", "items":{ "$ref":"#/definitions/Role_actionsCU" } }, "operations":{ "description":"An array of enablement of operations that can be performed by the role's users", "type":"array", "items":{ "$ref":"#/definitions/Role_operationsCU" } }, "visibility":{ "description":"An array of hierarchy units where the role is visible", "type":"array", "items":{ "$ref":"#/definitions/Role_visibilityCU" } }, "enableRVCLevelSecurity":{ "type":"boolean", "example":false, "description":"A Boolean flag to restrict employees with this role to perform workstation operations only in revenue centers in which they are an operator." }, "fields":{ "description":"An array of objects containing the access control to specific fields of the EMC module", "type":"array", "items":{ "$ref":"#/definitions/Role_fieldsCU" } }, "dataExtensions":{ "description":"An array of data extensions for the Roles", "type":"array", "items":{ "$ref":"#/definitions/Role_dataExtensionsCU" } } } }, "Role_emcModule_privilegesExt":{ "type":"object", "description":"An object containing the descriptive options list associated with the EMC module's access associated with the role", "properties":{ "view":{ "type":"boolean", "example":true, "description":"A Boolean flag to allow the viewing of records of the EMC module for the role's users" }, "edit":{ "type":"boolean", "example":true, "description":"A Boolean flag to allow the editing of records of the EMC module for the role's users" }, "add":{ "type":"boolean", "example":false, "description":"A Boolean flag to allow the addition of records of the EMC module for the role's users" }, "delete":{ "type":"boolean", "example":true, "description":"A Boolean flag representing the enablement of the delete records of the EMC module for the role's users" }, "addOverride":{ "type":"boolean", "example":false, "description":"A Boolean flag representing to allow override of records of the EMC module for the role's users" }, "allowDuplicateObjNum":{ "type":"boolean", "example":false, "description":"A Boolean flag representing to allow duplicate object numbers in records for the EMC module for the role's users" }, "allowDuplicateName":{ "type":"boolean", "example":false, "description":"A Boolean flag representing to allow duplicate names in records for the EMC module for the role's users" }, "fieldLevelSecurity":{ "type":"boolean", "example":false, "description":"A Boolean flag representing the enablement of the field level security for the EMC module for the role's users" } } }, "Role_emcModule":{ "type":"object", "properties":{ "moduleNum":{ "type":"integer", "example":1, "description":"The unique reference of the EMC module" }, "moduleName":{ "type":"string", "example":"Global Access", "description":"The name of the EMC module" }, "privileges":{ "type":"string", "example":"00000000000", "description":"A string value of 0s & 1s of length 11 representing the enablement or disablement of the privileges associated with the EMC module's access associated with the role" }, "privilegesExt":{ "$ref":"#/definitions/Role_emcModule_privilegesExt" } } }, "Role_emcModuleCU":{ "type":"object", "properties":{ "moduleNum":{ "type":"integer", "example":1, "description":"The unique reference of the EMC module" }, "privileges":{ "type":"string", "example":"00000000000", "description":"A string value of 0s & 1s of length 11 representing the enablement or disablement of the privileges associated with the EMC module's access associated with the role" } } }, "Role_flmModule_privilegesExt":{ "type":"object", "description":"An object containing the descriptive options list associated with the FLM module's access associated with the role", "properties":{ "view":{ "type":"boolean", "example":true, "description":"A Boolean flag to allow the viewing of records of the FLM module for the role's users" }, "edit":{ "type":"boolean", "example":true, "description":"A Boolean flag to allow the editing of records of the FLM module for the role's users" }, "add":{ "type":"boolean", "example":false, "description":"A Boolean flag to allow the addition of records of the FLM module for the role's users" }, "delete":{ "type":"boolean", "example":true, "description":"A Boolean flag representing the enablement of the delete records of the FLM module for the role's users" }, "addOverride":{ "type":"boolean", "example":false, "description":"A Boolean flag representing to allow override of records of the FLM module for the role's users" } } }, "Role_flmModule":{ "type":"object", "properties":{ "moduleNum":{ "type":"integer", "example":1, "description":"The unique reference of the FLM module" }, "moduleName":{ "type":"string", "example":"Global Access", "description":"The name of the FLM module" }, "privileges":{ "type":"string", "example":"11110001000", "description":"A string value of 0s & 1s of length 11 representing the enablement or disablement of the privileges associated with the FLM module's access associated with the role. Bit positions 1, 2, 3, 4 and 8 represent view, edit, add, delete and addOverride respectively." }, "privilegesExt":{ "$ref":"#/definitions/Role_flmModule_privilegesExt" } } }, "Role_flmModuleCU":{ "type":"object", "properties":{ "moduleNum":{ "type":"integer", "example":1, "description":"The unique reference of the FLM module" }, "privileges":{ "type":"string", "example":"11110001000", "description":"A string value of 0s & 1s of length 11 representing the enablement or disablement of the privileges associated with the FLM module's access associated with the role. Bit positions 1, 2, 3, 4 and 8 represent view, edit, add, delete and addOverride respectively." } } }, "Role_actions":{ "type":"object", "properties":{ "privilegeNum":{ "type":"integer", "example":3, "description":"A unique reference of the privilege associated with the action" }, "name":{ "type":"string", "example":"key action", "description":"The name of the action" }, "enable":{ "type":"boolean", "example":false, "description":"A Boolean flag representing the enablement of the action for the role's users" } } }, "Role_actionsCU":{ "type":"object", "properties":{ "privilegeNum":{ "type":"integer", "example":3, "description":"A unique reference of the privilege associated with the action" }, "enable":{ "type":"boolean", "example":false, "description":"A Boolean flag representing the enablement of the action for the role's users" } } }, "Role_operations":{ "type":"object", "properties":{ "privilegeNum":{ "type":"integer", "example":3, "description":"A unique reference of the privilege associated with the operation" }, "name":{ "type":"string", "example":"key action", "description":"The name of the operation" }, "enable":{ "type":"boolean", "example":false, "description":"A Boolean flag representing the enablement of the operation for the role's users" } } }, "Role_operationsCU":{ "type":"object", "properties":{ "privilegeNum":{ "type":"integer", "example":3, "description":"A unique reference of the privilege associated with the operation" }, "enable":{ "type":"boolean", "example":false, "description":"A Boolean flag representing the enablement of the operation for the role's users" } } }, "Role_visibility":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number" }, "hierUnitName":{ "description":"Hier Unit Name", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "propagateToChildren":{ "type":"integer", "example":1, "description":"A Boolean flag to make the role visible in the selected zones/locations and all children. Deselect to make the role visible only in the selected zone/location" } } }, "Role_visibilityv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number" }, "propagateToChildren":{ "type":"integer", "example":1, "description":"A Boolean flag to make the role visible in the selected zones/locations and all children. Deselect to make the role visible only in the selected zone/location" } } }, "Role_visibilityCU":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." }, "propagateToChildren":{ "type":"integer", "example":1, "description":"A Boolean flag to make the role visible in the selected zones/locations and all children. Deselect to make the role visible only in the selected zone/location" } } }, "Role_controls_privilegesExt":{ "type":"object", "description":"An object containing the descriptive options list associated with the EMC module's access associated with the role", "properties":{ "editable":{ "type":"boolean", "example":true, "description":"A Boolean flag indicating the field is editable" }, "viewOnly":{ "type":"boolean", "example":true, "description":"A Boolean flag indicating the field is only for Viewing" }, "exclude":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating if the field is excluded." } } }, "Role_fields_controls":{ "type":"object", "properties":{ "controlNum":{ "type":"integer", "example":1, "description":"Unique reference of the field control" }, "controlName":{ "type":"string", "example":"Global Access", "description":"Name of the field control" }, "privileges":{ "type":"string", "example":"00000000", "description":"A string value of 0's & 1's representing the enablement or disablement of the privileges associated with the field control" }, "privilegesExt":{ "$ref":"#/definitions/Role_controls_privilegesExt" } } }, "Role_fields_controlsCU":{ "type":"object", "properties":{ "controlName":{ "type":"string", "example":"Global Access", "description":"Name of the field control" }, "privileges":{ "type":"string", "example":"00000000", "description":"A string value of 0's & 1's representing the enablement or disablement of the privileges associated with the field control" } } }, "Role_fields":{ "type":"object", "properties":{ "moduleNum":{ "type":"integer", "example":1, "description":"Unique reference of the module" }, "moduleName":{ "type":"string", "example":"Menu Item Masters", "description":"Name of the EMC module." }, "controls":{ "type":"array", "description":"An array of controls for each EMC module\n", "items":{ "$ref":"#/definitions/Role_fields_controls" } } } }, "Role_fieldsCU":{ "type":"object", "properties":{ "moduleNum":{ "type":"integer", "example":1, "description":"Unique reference of the module" }, "controls":{ "type":"array", "description":"An array of controls for each EMC module\n", "items":{ "$ref":"#/definitions/Role_fields_controlsCU" } } } }, "Role_dataExtensions":{ "type":"object", "properties":{ "value":{ "type":"string", "example":"Value 1", "description":"Value of the extention field" }, "columnName":{ "type":"string", "example":"Name of the extention field", "description":"Name of the extention field" } } }, "Role_dataExtensionsCU":{ "type":"object", "properties":{ "value":{ "type":"string", "example":"Value 1", "description":"Value of the extention field" }, "columnName":{ "type":"string", "example":"Name of the extention field", "description":"Name of the extention field" } } }, "RolesGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of role objects of the organization.", "items":{ "$ref":"#/definitions/RolesResourceObjectv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "RolesResponse":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object number of the role" } } }, "RolesDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "HeadersTrailersCURequestBody":{ "type":"object", "required":[ "hierUnitId", "lineNum", "descriptorTypeNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":6384, "description":"Unique hierarchy unit reference" }, "lineNum":{ "type":"integer", "example":1, "description":"Line Number of the Header/Trailer\n\n| descriptorTypeNum | Max Number of Lines Allowed |\n|-------------------|---------------------------------|\n| 1 | 6 |\n| 2 | 6 |\n| 3 | 3 | \n| 5 | 12 |\n| 7 | 6 |\n| 8 | 12 |\n| 37 | 6 |\n| 46 | 3 |\n| 47 | 12 |\n| 52 | 12 |\n| 53 | 12 |\n" }, "descriptorTypeNum":{ "type":"integer", "example":2, "description":"

    Descriptor Type Number assigned to the Header/Trailer

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    descriptorTypeNum descriptorTypeName
    1 Customer Receipt Header
    2 Check Header
    3 Training Header
    5 Check Trailer
    7 Credit Card Header
    8 Credit Card Trailer
    37 Autofire Check Offline Header
    46 Waste Header
    47 Waste Trailer
    52 Report Header
    53 Report Trailer
    \n" }, "useLogo":{ "type":"boolean", "example":true, "description":"Boolean flag for using either logoObjectNum(true) or text(false) for the specified lineNum. Automatically set to false if value is not specified." }, "text":{ "type":"object", "description":"A string that contains the text of a line in multiple languages.\n", "example":{ "en-US":"Please visit again!", "de-DE":"Bitte schauen Sie noch einmal vorbei!", "es-MX":"Por favor visite de nuevo!" } }, "logoObjectNum":{ "type":"integer", "example":1, "description":"Object Number of the logo." } } }, "HeadersTrailersResourceObject":{ "description":"Model for Headers Trailers Object", "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":6384, "description":"Unique hierarchy unit reference" }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "lineNum":{ "type":"integer", "example":1, "description":"Line Number of the Header/Trailer\n\n| descriptorTypeNum | Max Number of Lines Allowed |\n|-------------------|---------------------------------|\n| 1 | 6 |\n| 2 | 6 |\n| 3 | 3 | \n| 5 | 12 |\n| 7 | 6 |\n| 8 | 12 |\n| 37 | 6 |\n| 46 | 3 |\n| 47 | 12 |\n| 52 | 12 |\n| 53 | 12 |\n" }, "descriptorTypeNum":{ "type":"integer", "example":2, "description":"

    Descriptor Type Number assigned to the Header/Trailer

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    descriptorTypeNum descriptorTypeName
    1 Customer Receipt Header
    2 Check Header
    3 Training Header
    5 Check Trailer
    7 Credit Card Header
    8 Credit Card Trailer
    37 Autofire Check Offline Header
    46 Waste Header
    47 Waste Trailer
    52 Report Header
    53 Report Trailer
    \n" }, "desciptorTypeName":{ "type":"string", "example":"Check Trailer", "description":"Descriptor Type Name assigned to the Header/Trailer" }, "useLogo":{ "type":"boolean", "example":true, "description":"Boolean flag for using either logoObjectNum(true) or text(false) for the specified line. Automatically set to false if value is not specified." }, "text":{ "type":"object", "description":"A string that contains the text of a line in multiple languages.\n", "example":{ "en-US":"Please visit again!", "de-DE":"Bitte schauen Sie noch einmal vorbei!", "es-MX":"Por favor visite de nuevo!" } }, "logoObjectNum":{ "type":"integer", "example":1, "description":"Object Number of the logo." }, "logoName":{ "type":"object", "description":"A group of string objects representing the name of the corresponding logo in multiple languages", "example":{ "en-US":"Circle logo", "de-DE":"Kreis-Logo", "es-MX":"logotipo del c??rculo" } } } }, "HeadersTrailersv2":{ "description":"Model for Headers Trailers Object", "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":6384, "description":"Unique hierarchy unit reference" }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "lineNum":{ "type":"integer", "example":1, "description":"Line Number of the Header/Trailer\n\n| descriptorTypeNum | Max Number of Lines Allowed |\n|-------------------|---------------------------------|\n| 1 | 6 |\n| 2 | 6 |\n| 3 | 3 | \n| 5 | 12 |\n| 7 | 6 |\n| 8 | 12 |\n| 37 | 6 |\n| 46 | 3 |\n| 47 | 12 |\n| 52 | 12 |\n| 53 | 12 |\n" }, "descriptorTypeNum":{ "type":"integer", "example":2, "description":"

    Descriptor Type Number assigned to the Header/Trailer

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    descriptorTypeNum descriptorTypeName
    1 Customer Receipt Header
    2 Check Header
    3 Training Header
    5 Check Trailer
    7 Credit Card Header
    8 Credit Card Trailer
    37 Autofire Check Offline Header
    46 Waste Header
    47 Waste Trailer
    52 Report Header
    53 Report Trailer
    \n" }, "desciptorTypeName":{ "type":"string", "example":"Check Trailer", "description":"Descriptor Type Name assigned to the Header/Trailer" }, "useLogo":{ "type":"boolean", "example":true, "description":"Boolean flag for using either logoObjectNum(true) or text(false) for the specified line. Automatically set to false if value is not specified." }, "text":{ "type":"object", "description":"A string that contains the text of a line in multiple languages.\n", "example":{ "1":"Please visit again!", "2":"Bitte schauen Sie noch einmal vorbei!", "3":"Por favor visite de nuevo!" } }, "logoObjectNum":{ "type":"integer", "example":1, "description":"Object Number of the logo." } } }, "HeadersTrailersGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of language objects of the organization.", "items":{ "$ref":"#/definitions/HeadersTrailersResourceObject" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "HeadersTrailersResponse":{ "type":"object", "properties":{ "lineNum":{ "type":"integer", "example":1, "description":"line number added" }, "descriptorTypeNum":{ "description":"

    Descriptor Type Number assigned to the Header/Trailer

    \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    descriptorTypeNum descriptorTypeName
    1 Customer Receipt Header
    2 Check Header
    3 Training Header
    5 Check Trailer
    7 Credit Card Header
    8 Credit Card Trailer
    37 Autofire Check Offline Header
    46 Waste Header
    47 Waste Trailer
    52 Report Header
    53 Report Trailer
    \n", "type":"integer", "example":2 }, "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" } } }, "HeadersTrailersDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "CMTemplateGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of cash management template objects of the organization.", "items":{ "$ref":"#/definitions/CMTemplates" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "CMTemplates":{ "description":"Model for Cash Management Template Object", "type":"object", "properties":{ "objectNum":{ "description":"Object Number of the Cash Management Template.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Cash Management Template is configured. ", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Hier Unit 1", "de-DE":"Hier Unit 1", "es-MX":"Hier Unit 1" } }, "name":{ "type":"object", "description":"Name of Cash Management Receptacle", "example":{ "en-US":"Template 1", "de-DE":"Template 1", "es-MX":"Template 1" } }, "description":{ "type":"object", "description":"Description of Cash Management Receptacle", "example":{ "en-US":"Template 1", "de-DE":"Template 1", "es-MX":"Template 1" } }, "recepatacleType":{ "description":"Type of receptacle template. Range=>[0-5] | Receptacle Type | Receptacle Name | | 0 | None | | 1 | Safe | | 2 | Till | | 3 | Server Bank | | 4 | Bank Deposit | | 5 | Petty Cash |", "type":"integer", "example":1 }, "startingAmount":{ "description":"The initial currency value of the session upon opening. Range => [0 - 999999999999]. It only affects the behavior of types 2 and 3", "type":"integer", "example":10000 }, "startingAmountSourceObjNum":{ "description":"Determines where the starting amount for the session originates. The source receptacle session should be active session of type 1 - Safe. It only affects the behavior of types 2 and 3. Required for type 2.", "type":"integer", "example":1 }, "promptForStartingAmount":{ "description":"Select this option to prompt the workstation operator to enter the starting amount for the receptacle session upon opening. When you select this option, the application ignores the value in the starting amount field. It only affects the behavior of types 2 and 3.", "type":"boolean", "example":true }, "cashPullThresholdObjNum":{ "description":"Determines object number the Cash Pull Threshold Set that a receptacle session uses. It only affects the behavior of types 2 and 3.", "type":"integer", "example":1 }, "cashPullDestinationObjNum":{ "description":"Object number of destination receptacle into which funds from cash pull operations will transfer; if you select None, funds do not transfer and ownership remains with the receptacle session.It only affects the behavior of types 2 and 3.", "type":"integer", "example":1 }, "countSheetObjNum":{ "description":"Determines the Count Sheet object number that is used to count the receptacle.It only affects the behavior of types 1, 2 and 3 and 5.", "type":"integer", "example":1 }, "cashCountThresholdObjNum":{ "description":"Determines Cash Count Threshold Set Object number that a receptacle session uses.It only affects the behavior of types 1, 2 and 3 and 5.", "type":"integer", "example":1 }, "closeOnCountCompletion":{ "description":"Select this option to have the application attempt to automatically reconcile the receptacle session upon completion of the count. This process transfers funds from the receptacle session to the sessions designated under Starting Amount Source and Cash Deposit Routing to bring the session to zero. Deselect this option to leave the session open after the count completes. The workstation operator must then manually reconcile all funds and close the receptacle.It only affects the behavior of types 2 and 3.", "type":"boolean", "example":true }, "parLevelObjNum":{ "description":"Defines the object number of PAR Level Set (quantity to maintain of each currency denomination) to use for the safe session. It only affects the behavior of type 1.", "type":"integer", "example":1 }, "minimum":{ "description":"Determines the lowest amount of funds permitted as part of a receptacle session. If you do not set a minimum balance, the application defaults to 0. It only affects the behavior of type 5.", "type":"number", "example":10 }, "maximum":{ "description":"Determines the largest amount of funds permitted as part of a receptacle session. If you do not set a minimum balance, the application defaults to 0. It only affects the behavior of types 4 and 5.", "type":"number", "example":100 }, "cashDepositRoutingObjNum":{ "description":"Object number of the destination receptacle (safe or bank deposit) session to receive funds that transfer from a receptacle session as part of a cash deposit operation. It only affects the behavior of types 2 and 3.", "type":"number", "example":1 }, "classDetails":{ "description":"Used to create additional currency classes (alternate currency such as Dollar, Peso, Euro, or Pounds, or non-currency such as gift cards) for a receptacle session or operation. You can add/modify alternate classes for types 0, 2, 3, 4 and 5 only. You cannot add a duplicate class entry.", "type":"array", "items":{ "$ref":"#/definitions/ClassDetails" } }, "parLevels":{ "description":"Used to add additional PAR Levelsation. You can add/ modify alternate PAR Levels for type 1 only. You cannot add a duplicate PAR Level entry.", "type":"array", "items":{ "$ref":"#/definitions/PARLevels" } }, "classExclusions":{ "description":"To specify currency classes that cannot be used in till(Type 2) and server bank(Type 3) receptacles created with the receptacle template. You cannot add a duplicate class exclusion entry.", "type":"array", "items":{ "$ref":"#/definitions/ClassExclusions" } } } }, "CMReceptacleTemplatev2":{ "description":"Model for Cash Management Template Object", "type":"object", "properties":{ "objectNum":{ "description":"Object Number of the Cash Management Template.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Cash Management Template is configured. ", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "name":{ "description":"Cash Management Template Name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "description":{ "description":"Cash Management Template Description", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "recepatacleType":{ "description":"Type of receptacle template. Range=>[0-5] | Receptacle Type | Receptacle Name | | 0 | None | | 1 | Safe | | 2 | Till | | 3 | Server Bank | | 4 | Bank Deposit | | 5 | Petty Cash |", "type":"integer", "example":1 }, "startingAmount":{ "description":"The initial currency value of the session upon opening. Range => [0 - 999999999999]. It only affects the behavior of types 2 and 3", "type":"integer", "example":10000 }, "startingAmountSourceObjNum":{ "description":"Determines where the starting amount for the session originates. The source receptacle session should be active session of type 1 - Safe. It only affects the behavior of types 2 and 3. Required for type 2.", "type":"integer", "example":1 }, "promptForStartingAmount":{ "description":"Select this option to prompt the workstation operator to enter the starting amount for the receptacle session upon opening. When you select this option, the application ignores the value in the starting amount field. It only affects the behavior of types 2 and 3.", "type":"boolean", "example":true }, "cashPullThresholdObjNum":{ "description":"Determines object number the Cash Pull Threshold Set that a receptacle session uses. It only affects the behavior of types 2 and 3.", "type":"integer", "example":1 }, "cashPullDestinationObjNum":{ "description":"Object number of destination receptacle into which funds from cash pull operations will transfer; if you select None, funds do not transfer and ownership remains with the receptacle session.It only affects the behavior of types 2 and 3.", "type":"integer", "example":1 }, "countSheetObjNum":{ "description":"Determines the Count Sheet object number that is used to count the receptacle.It only affects the behavior of types 1, 2 and 3 and 5.", "type":"integer", "example":1 }, "cashCountThresholdObjNum":{ "description":"Determines Cash Count Threshold Set Object number that a receptacle session uses.It only affects the behavior of types 1, 2 and 3 and 5.", "type":"integer", "example":1 }, "closeOnCountCompletion":{ "description":"Select this option to have the application attempt to automatically reconcile the receptacle session upon completion of the count. This process transfers funds from the receptacle session to the sessions designated under Starting Amount Source and Cash Deposit Routing to bring the session to zero. Deselect this option to leave the session open after the count completes. The workstation operator must then manually reconcile all funds and close the receptacle.It only affects the behavior of types 2 and 3.", "type":"boolean", "example":true }, "parLevelObjNum":{ "description":"Defines the object number of PAR Level Set (quantity to maintain of each currency denomination) to use for the safe session. It only affects the behavior of type 1.", "type":"integer", "example":1 }, "minimum":{ "description":"Determines the lowest amount of funds permitted as part of a receptacle session. If you do not set a minimum balance, the application defaults to 0. It only affects the behavior of type 5.", "type":"number", "example":10 }, "maximum":{ "description":"Determines the largest amount of funds permitted as part of a receptacle session. If you do not set a minimum balance, the application defaults to 0. It only affects the behavior of types 4 and 5.", "type":"number", "example":100 }, "cashDepositRoutingObjNum":{ "description":"Object number of the destination receptacle (safe or bank deposit) session to receive funds that transfer from a receptacle session as part of a cash deposit operation. It only affects the behavior of types 2 and 3.", "type":"number", "example":1 }, "classDetails":{ "description":"Used to create additional currency classes (alternate currency such as Dollar, Peso, Euro, or Pounds, or non-currency such as gift cards) for a receptacle session or operation. You can add/modify alternate classes for types 0, 2, 3, 4 and 5 only. You cannot add a duplicate class entry.", "type":"array", "items":{ "$ref":"#/definitions/ClassDetails" } }, "parLevels":{ "description":"Used to add additional PAR Levelsation. You can add/ modify alternate PAR Levels for type 1 only. You cannot add a duplicate PAR Level entry.", "type":"array", "items":{ "$ref":"#/definitions/PARLevels" } }, "classExclusions":{ "description":"To specify currency classes that cannot be used in till(Type 2) and server bank(Type 3) receptacles created with the receptacle template. You cannot add a duplicate class exclusion entry.", "type":"array", "items":{ "$ref":"#/definitions/ClassExclusions" } } } }, "CMTemplateRequestBody":{ "description":"Model for Cash Management Template Object Insert and Update Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "objectNum":{ "description":"Object Number of the Cash Management Template.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Cash Management Template is configured. ", "type":"integer", "example":3599 }, "name":{ "type":"object", "description":"Name of Cash Management Receptacle", "example":{ "en-US":"Template 1", "de-DE":"Template 1", "es-MX":"Template 1" } }, "description":{ "type":"object", "description":"Description of Cash Management Receptacle", "example":{ "en-US":"Template 1", "de-DE":"Template 1", "es-MX":"Template 1" } }, "recepatacleType":{ "description":"Type of receptacle template. Range=>[0-5]. Default type is 0. | Receptacle Type | Receptacle Name | |-----------------|-----------------| | 0 | None | | 1 | Safe | | 2 | Till | | 3 | Server Bank | | 4 | Bank Deposit | | 5 | Petty Cash |", "type":"integer", "example":1 }, "startingAmount":{ "description":"The initial currency value of the session upon opening. Range => [0 - 999999999999]. It only affects the behavior of types 2 and 3", "type":"integer", "example":10000 }, "startingAmountSourceObjNum":{ "description":"Determines where the starting amount for the session originates. The source receptacle session should be active session of type 1 - Safe. It only affects the behavior of types 2 and 3. Required for type 2.", "type":"integer", "example":1 }, "promptForStartingAmount":{ "description":"Select this option to prompt the workstation operator to enter the starting amount for the receptacle session upon opening. When you select this option, the application ignores the value in the starting amount field. It only affects the behavior of types 2 and 3.", "type":"boolean", "example":true }, "cashPullThresholdObjNum":{ "description":"Determines object number the Cash Pull Threshold Set that a receptacle session uses. It only affects the behavior of types 2 and 3.", "type":"integer", "example":1 }, "cashPullDestinationObjNum":{ "description":"Object number of destination receptacle into which funds from cash pull operations will transfer; if you select None, funds do not transfer and ownership remains with the receptacle session. It only affects the behavior of types 2 and 3.", "type":"integer", "example":1 }, "countSheetObjNum":{ "description":"Determines the Count Sheet object number that is used to count the receptacle. It only affects the behavior of types 1, 2 and 3 and 5.", "type":"integer", "example":1 }, "cashCountThresholdObjNum":{ "description":"Determines Cash Count Threshold Set Object number that a receptacle session uses. It only affects the behavior of types 1, 2 and 3 and 5.", "type":"integer", "example":1 }, "closeOnCountCompletion":{ "description":"Select this option to have the application attempt to automatically reconcile the receptacle session upon completion of the count. This process transfers funds from the receptacle session to the sessions designated under Starting Amount Source and Cash Deposit Routing to bring the session to zero. Deselect this option to leave the session open after the count completes. The workstation operator must then manually reconcile all funds and close the receptacle.It only affects the behavior of types 2 and 3.", "type":"boolean", "example":true }, "parLevelObjNum":{ "description":"Defines the object number of PAR Level Set (quantity to maintain of each currency denomination) to use for the safe session. It only affects the behavior of type 1.", "type":"integer", "example":1 }, "minimum":{ "description":"Determines the lowest amount of funds permitted as part of a receptacle session. If you do not set a minimum balance, the application defaults to 0. It only affects the behavior of type 5.", "type":"number", "example":10 }, "maximum":{ "description":"Determines the largest amount of funds permitted as part of a receptacle session. If you do not set a minimum balance, the application defaults to 0. It only affects the behavior of types 4 and 5.", "type":"number", "example":100 }, "cashDepositRoutingObjNum":{ "description":"Object number of the destination receptacle (safe or bank deposit) session to receive funds that transfer from a receptacle session as part of a cash deposit operation. It only affects the behavior of types 2 and 3", "type":"number", "example":1 }, "classDetails":{ "description":"Used to create additional currency classes (alternate currency such as Dollar, Peso, Euro, or Pounds, or non-currency such as gift cards) for a receptacle session or operation. You can add/ modify alternate classes for types 0, 2, 3, 4 and 5 only. You cannot add a duplicate class entry.", "type":"array", "items":{ "$ref":"#/definitions/ClassDetails" } }, "parLevels":{ "description":"Used to add additional PAR Levelsation. You can add/modify alternate PAR Levels for type 1 only. You cannot add a duplicate PAR Level entry.", "type":"array", "items":{ "$ref":"#/definitions/PARLevels" } }, "classExclusions":{ "description":"To specify currency classes that cannot be used in till(Type 2) and server bank(Type 3) receptacles created with the receptacle template. You cannot add a duplicate class exclusion entry.", "type":"array", "items":{ "$ref":"#/definitions/ClassExclusions" } } } }, "ClassDetails":{ "type":"object", "required":[ "classObjNum" ], "properties":{ "classObjNum":{ "description":"Object number of additional currency class.", "type":"integer", "example":1 }, "startingAmount":{ "description":"The initial currency value of the session upon opening. Range => [0 - 9999999999]. It only affects the behavior of types 2 and 3", "type":"integer", "example":10000 }, "startingAmountSourceObjNum":{ "description":"Determines where the starting amount for the session originates. The source receptacle session should be active session of type 1 - Safe. It only affects the behavior of types 2 and 3. Required for type 2.", "type":"integer", "example":1 }, "promptForStartingAmount":{ "description":"Select this option to prompt the workstation operator to enter the starting amount for the receptacle session upon opening. When you select this option, the application ignores the value in the starting amount field. It only affects the behavior of types 2 and 3.", "type":"boolean", "example":true }, "cashPullThresholdObjNum":{ "description":"Determines object number the Cash Pull Threshold Set that a receptacle session uses. It only affects the behavior of types 2 and 3.", "type":"integer", "example":1 }, "cashPullDestinationObjNum":{ "description":"Object number of destination receptacle into which funds from cash pull operations will transfer; if you select None, funds do not transfer and ownership remains with the receptacle session.It only affects the behavior of types 2 and 3.", "type":"integer", "example":1 }, "minimum":{ "description":"Determines the lowest amount of funds permitted as part of a receptacle session. If you do not set a minimum balance, the application defaults to 0. It only affects the behavior of type 5.", "type":"number", "example":10 }, "maximum":{ "description":"Determines the largest amount of funds permitted as part of a receptacle session. If you do not set a minimum balance, the application defaults to 0. It only affects the behavior of types 4 and 5.", "type":"number", "example":100 }, "cashDepositRoutingObjNum":{ "description":"Object number of the destination receptacle (safe or bank deposit) session to receive funds that transfer from a receptacle session as part of a cash deposit operation. It only affects the behavior of types 2 and 3", "type":"number", "example":1 } } }, "PARLevels":{ "type":"object", "required":[ "parLevelObjNum" ], "properties":{ "parLevelObjNum":{ "description":"Object number of PAR Level Set", "type":"integer", "example":1 } } }, "ClassExclusions":{ "type":"object", "required":[ "classObjNum" ], "properties":{ "classObjNum":{ "description":"Object number of currency class to be excluded", "type":"integer", "example":1 } } }, "CMTemplateDeleteBodyAndCUResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "objectNum":{ "description":"Object number of the cash management template", "type":"integer", "example":1 } } }, "AllergenName":{ "description":"Allergen Name record", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the allergen is configured.", "type":"integer", "example":3599 }, "allergenId":{ "description":"Allergen Id", "type":"integer", "example":364 }, "name":{ "description":"Allergen Name", "type":"object", "example":{ "1":"Apple", "2":"Pomme", "3":"Manzana" } }, "allergenCode":{ "description":"Allergen Code. It should be unique for any allergen.", "type":"string", "example":"Apple" } } }, "AuditTrail":{ "description":"Audit Trail", "type":"object", "properties":{ "auditTrailId":{ "description":"Unique id of the audit trail record", "type":"integer", "example":3 }, "employeeObjNum":{ "description":"Object number of the employee who performed the operation.", "type":"integer", "example":2 }, "employeeFirstName":{ "description":"First name of the employee who performed the operation.", "type":"string", "example":"EmpFirstName1" }, "employeeLastName":{ "description":"Last name of the employee who performed the operation.", "type":"string", "example":"EmpLastName1" }, "userName":{ "description":"User name of the employee who performed the operation.", "type":"string", "example":"EmpUserName1" }, "auditTime":{ "description":"Date and time when the operation was performed", "type":"string", "example":"2025-04-15T10:40:15" }, "subSystem":{ "description":"A unique reference of the application where the operation was performed. Refer to the List Values section of the C&C API documentation for an explanation of the values.", "type":"integer", "example":109 }, "operation":{ "description":"A unique reference of the operation performed. Refer to the List Values section of the C&C API documentation for an explanation of the values.", "type":"integer", "example":2 }, "fileNum":{ "description":"Unique reference of the object where operation was performed. Refer to the List Values section of the C&C API documentation for an explanation of the values.", "type":"integer", "example":31 }, "hierStrucId":{ "description":"Hierarchy Structure Id of the hierarchy where the operation was performed.", "type":"integer", "example":7 }, "hierUnitId":{ "description":"Hierarchy Unit Id of the hierarchy where the operation was performed.", "type":"integer", "example":7 }, "objectNumber":{ "description":"Object number of the record which was modified.", "type":"integer", "example":1 }, "itemNumber":{ "description":"Item number of the record which was modified.", "type":"integer", "example":3 }, "defSeqNum":{ "description":"Definition sequence number of the record which was modified.", "type":"integer", "example":1 }, "prSeqNum":{ "description":"Price sequence number of the record which was modified.", "type":"integer", "example":1 }, "field":{ "description":"Name of the field which was modified.", "type":"string", "example":"name" }, "subRecordObjNum":{ "description":"Object number of the sub record which was modified.", "type":"integer", "example":4 }, "subRecordName":{ "description":"Name of the sub record which was modified.", "type":"string", "example":"Condiment Groups" }, "subRecordField":{ "description":"Name of the field within the sub record which was modified.", "type":"string", "example":"consumerDisplayname" }, "distSourceHierStrucId":{ "description":"The hierstrucid of the data distribution source.", "type":"integer", "example":1 }, "distSourceIsRemote":{ "description":"A boolean flag indicating if the distribution source used was remote.", "type":"boolean", "example":false }, "comments":{ "description":"Comments added to the Audit Trail record. Some applications record comments to help clarify the change or the activity being audited.", "type":"string", "example":"Update item name" }, "stringLangId":{ "description":"Language Id corresponding to the language which was used to modify the text value.", "type":"integer", "example":3 }, "changeSetObjNum":{ "description":"Effectivity group object number of the record which was modified.", "type":"integer", "example":4 }, "newValue":{ "description":"The value of a field after it was changed on a changed record.", "type":"string", "example":"Cheesy Fries" }, "oldValue":{ "description":"The value of a field before it was changed on a changed record.", "type":"string", "example":"Fries" } } }, "GetAvailableObjNumResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "objectNumbers":{ "description":"List of available object numbers", "type":"array", "items":{ "type":"integer" }, "example":[ 1001, 1002, 1004, 1005 ] } } }, "SystemEmployeePropertyOperator":{ "description":"System employee property operator record", "type":"object", "properties":{ "objectNum":{ "description":"Object number of the system employee.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Hierarchy unit value of operator associated with employee.", "type":"integer", "example":3599 }, "cashierObjNum":{ "description":"Object number of the cashier linked to the workstation operator..", "type":"integer", "example":1 } } }, "FamilyGroupConsumerFacingContentAddResponse":{ "description":"Response object for Content related Objects", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the family group", "type":"integer", "example":1 }, "imageIndex":{ "description":"Number of the image. Values range from 1-10.", "type":"integer", "example":1 }, "url":{ "description":"Object storage url of the uploaded image, can be used for downloading the uploaded image.", "type":"string", "example":"https://objectstorage.oracle.com/xyz.jpg" } } }, "FamilyGroupConsumerFacingContentGetRequest":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order" }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations", "description":"Objects included in response" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned" }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the family group", "type":"integer", "example":1 } } }, "FamilyGroupConsumerFacingContentGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Family Group Consumer Facing Content objects of the organization.", "items":{ "$ref":"#/definitions/FamilyGroupConsumerFacingContentResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "FamilyGroupConsumerFacingContentResponsev1":{ "description":"Model for Family Group Facing Content Object Get Response", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object Number of the Family Group", "type":"integer", "example":1 }, "images":{ "type":"array", "description":"An array containing images of the Family Group.", "items":{ "type":"object", "properties":{ "imageIndex":{ "description":"Number of the image. Values range from 1-10.", "type":"integer", "example":1 }, "title":{ "description":"Title of the image", "type":"string", "example":"Image of appetizers" }, "comments":{ "description":"Description of the image.", "type":"string", "example":"Image of Appetizers" }, "size":{ "description":"The size of an image", "type":"string", "example":"Size: 12 kb, png: 100 x 100 px" }, "fileName":{ "description":"The name of the image file", "type":"string", "example":"ImageAppetizers.jpg" }, "url":{ "$ref":"#/definitions/URL" }, "imageUrl":{ "description":"The object storage url of the uploaded image, this url can be used to download the uploaded image.", "type":"string", "example":"https://objectstorage.oracle.com/xyz.jpg" } } } } } }, "FamilyGroupConsumerFacingContentv2":{ "description":"Model for Family Group Facing Content Object Get Response", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the Family Group", "type":"integer", "example":1 }, "images":{ "type":"array", "description":"An array containing images of the Family Group.", "items":{ "type":"object", "properties":{ "imageIndex":{ "description":"Number of the image. Values range from 1-10.", "type":"integer", "example":1 }, "title":{ "description":"Title of the image", "type":"string", "example":"Image of appetizers" }, "comments":{ "description":"Description of the image.", "type":"string", "example":"Image of Appetizers" }, "size":{ "description":"The size of an image", "type":"string", "example":"Size: 12 kb, png: 100 x 100 px" }, "fileName":{ "description":"The name of the image file", "type":"string", "example":"ImageAppetizers.jpg" }, "url":{ "$ref":"#/definitions/URL" }, "imageUrl":{ "description":"The object storage url of the uploaded image, this url can be used to download the uploaded image.", "type":"string", "example":"https://objectstorage.oracle.com/xyz.jpg" } } } } } }, "FamilyGroupConsumerFacingContentUpdateResponse":{ "description":"Response object for Content related Objects", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the family group", "type":"integer", "example":1 }, "imageIndex":{ "description":"Image number of the family group", "type":"integer", "example":1 }, "url":{ "description":"Object storage url of the uploaded image, can be used for downloading the uploaded image.", "type":"string", "example":"https://objectstorage.oracle.com/xyz.jpg" } } }, "URL":{ "type":"object", "description":"The URL of the download API which needs to be used to download the actual content file. This is auto-generated and does not need to be provided during add/update calls.", "properties":{ "params":{ "$ref":"#/definitions/params" }, "endpoint":{ "type":"string", "example":"https://abc.com/content/sim/v1/menuItems/downloadConsumerContent" } } }, "params":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the family group", "type":"integer", "example":1 }, "imageIndex":{ "description":"Number of the image. Values range from 1-10.", "type":"integer", "example":1 } } }, "LanguageResourceObject":{ "description":"Model for Language Object", "type":"object", "properties":{ "objectNum":{ "description":"Object Number of the language.", "type":"integer", "example":1 }, "name":{ "description":"name of the language", "type":"object", "example":{ "en-US":"US", "de-DE":"de" } }, "reportFont":{ "type":"string", "description":"The font to use for the language in the Extensible Client local reports.", "example":"Microsoft Sans Serif" }, "reportFontSize":{ "type":"integer", "example":23, "description":"The font size to use for the language in the Extensible Client local reports." }, "customerDisplayFont":{ "description":"The font for the customer display.", "type":"string", "example":"Courier New" }, "textFileName":{ "description":"The file name that contains the translated version of the XML text files.", "type":"string", "example":"translations.xml" }, "keyboardLayoutObjNum":{ "description":"The object number of the keyboard layout", "type":"integer", "example":1033 }, "keyBoardLayoutName":{ "description":"The name of the keyboard layout", "type":"object", "example":{ "en-US":"US", "de-DE":"de" } }, "rightToLeftOrientation":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to have the check detail area and customer receipts appear in right-to-left orientation." }, "reverseWOrientation":{ "description":"A Boolean flag to using Hebrew language in printing. Setting this option will reverse the order of the characters in the word so that the words read correctly.", "type":"boolean", "example":false }, "customNumerals":{ "description":"The digit to print in place of the value shown. Leave blank to use the hard-coded values shown.", "type":"string", "example":"0123456789" }, "printOptions":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the print options associated with the language.", "type":"string", "example":"00000000" }, "printOptionsExt":{ "description":"An object containing the descriptive print options list associated with the language.", "type":"array", "items":{ "$ref":"#/definitions/Language_PrintOptionsExt" } }, "mappingFont":{ "description":"Use Vmap for Thai and Japanese. Use Amap otherwise.", "type":"string", "example":"Amap" }, "textFileConfigurations":{ "description":"An array of all the translated XML text files for the language.", "type":"array", "items":{ "$ref":"#/definitions/Language_textFileConfigurations" } }, "localeString":{ "description":"The language string.", "type":"string", "example":"English (US)" }, "localeId":{ "description":"Locale ID of the language. Refer to Language Codes under Additional Information chapter for more details.\n", "type":"integer", "example":1033 }, "localeKey":{ "description":"A unique key that is used to identify the language in the content and configuration API.", "type":"string", "example":"en-US" }, "compareFlag":{ "description":"This field is used for comparison of strings when strings are to be sorted.", "type":"integer", "example":1 }, "languageCulture":{ "description":"The abbreviated language code.", "type":"string", "example":"en-US" } } }, "Languagev2":{ "description":"Model for Language Object V2", "type":"object", "properties":{ "langId":{ "description":"Lang Id of the language.", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the language.", "type":"integer", "example":1 }, "name":{ "description":"name of the language", "type":"object", "example":{ "1":"US", "2":"de" } }, "reportFont":{ "type":"string", "description":"The font to use for the language in the Extensible Client local reports.", "example":"Microsoft Sans Serif" }, "reportFontSize":{ "type":"integer", "example":23, "description":"The font size to use for the language in the Extensible Client local reports." }, "customerDisplayFont":{ "description":"The font for the customer display.", "type":"string", "example":"Courier New" }, "textFileName":{ "description":"The file name that contains the translated version of the XML text files.", "type":"string", "example":"translations.xml" }, "keyboardLayoutObjNum":{ "description":"The object number of the keyboard layout", "type":"integer", "example":1033 }, "keyBoardLayoutName":{ "description":"The name of the keyboard layout", "type":"object", "example":{ "1":"US", "2":"de" } }, "rightToLeftOrientation":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to have the check detail area and customer receipts appear in right-to-left orientation." }, "reverseWOrientation":{ "description":"A Boolean flag to using Hebrew language in printing. Setting this option will reverse the order of the characters in the word so that the words read correctly.", "type":"boolean", "example":false }, "customNumerals":{ "description":"The digit to print in place of the value shown. Leave blank to use the hard-coded values shown.", "type":"string", "example":"0123456789" }, "printOptions":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the print options associated with the language.", "type":"string", "example":"00000000" }, "printOptionsExt":{ "description":"An object containing the descriptive print options list associated with the language.", "type":"array", "items":{ "$ref":"#/definitions/Language_PrintOptionsExt" } }, "mappingFont":{ "description":"Use Vmap for Thai and Japanese. Use Amap otherwise.", "type":"string", "example":"Amap" }, "localeString":{ "description":"The language string.", "type":"string", "example":"English (US)" }, "localeId":{ "description":"Locale ID of the language. Refer to Language Codes under Additional Information chapter for more details.\n", "type":"integer", "example":1033 }, "localeKey":{ "description":"A unique key that is used to identify the language in the content and configuration API.", "type":"string", "example":"en-US" }, "compareFlag":{ "description":"This field is used for comparison of strings when strings are to be sorted.", "type":"integer", "example":1 }, "languageCulture":{ "description":"The abbreviated language code.", "type":"string", "example":"en-US" } } }, "LanguageCUDRequestBody":{ "description":"Model for Language Object", "type":"object", "required":[ "objectNum", "name" ], "properties":{ "objectNum":{ "description":"Object Number of the language.", "type":"integer", "example":1 }, "name":{ "description":"name of the language", "type":"object", "example":{ "en-US":"US", "de-DE":"de" } }, "reportFont":{ "type":"string", "description":"The font to use for the language in the Extensible Client local reports.", "example":"Microsoft Sans Serif" }, "reportFontSize":{ "type":"integer", "example":23, "description":"The font size to use for the language in the Extensible Client local reports." }, "customerDisplayFont":{ "description":"The font for the customer display.", "type":"string", "example":"Courier New" }, "textFileName":{ "description":"The file name that contains the translated version of the XML text files.", "type":"string", "example":"translations.xml" }, "keyboardLayoutObjNum":{ "description":"The object number of the keyboard layout", "type":"integer", "example":1033 }, "rightToLeftOrientation":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to have the check detail area and customer receipts appear in right-to-left orientation." }, "reverseWOrientation":{ "description":"A Boolean flag to using Hebrew language in printing. Setting this option will reverse the order of the characters in the word so that the words read correctly.", "type":"boolean", "example":false }, "customNumerals":{ "description":"The digit to print in place of the value shown. Leave blank to use the hard-coded values shown.", "type":"string", "example":"0123456789" }, "printOptions":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the print options associated with the language.", "type":"string", "example":"00000000" }, "mappingFont":{ "description":"Use Vmap for Thai and Japanese. Use Amap otherwise.", "type":"string", "example":"Amap" }, "textFileConfigurations":{ "description":"An array of all the translated XML text files for the language.", "type":"array", "items":{ "$ref":"#/definitions/Language_textFileConfigurations" } }, "localeId":{ "description":"Locale ID of the language. It must be unique across all the languages of the organization. Refer to Language Codes under Additional Information chapter for more details.", "type":"integer", "example":1034, "default":1033 }, "compareFlag":{ "description":"This field is used for comparison of strings when strings are to be sorted.", "type":"integer", "example":1 }, "languageCulture":{ "description":"The abbreviated language code.", "type":"string", "example":"en-US" } } }, "Language_PrintOptionsExt":{ "type":"object", "properties":{ "printCustomNumerals":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to print custom numerals defined for the language." }, "isIMETouchscreenHandling":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to enable IME Touchscreen handling" }, "asianCharacters":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to print picture based languages, such as Chinese, Japanese, Thai, and Korean, double-wide for easier reading." } } }, "Language_textFileConfigurations":{ "type":"object", "properties":{ "fileType":{ "type":"integer", "example":0, "description":"The file type of the translated XML file. Select 0 - Custom for any file type not listed." }, "baseFileName":{ "type":"string", "example":"trans_file.xml", "description":"The base file name for the translated XML file." }, "languageText":{ "type":"string", "example":"language text", "description":"The contents of the translated XML file." } } }, "LanguageGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of language objects of the organization.", "items":{ "$ref":"#/definitions/LanguageResourceObject" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "LanguageResponse":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object number of the language" } } }, "LanguagesDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "WorkstationResponse":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the workstation", "type":"integer", "example":1 } } }, "WorkstationGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Workstations objects of the organization.", "items":{ "$ref":"#/definitions/Workstationv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "Workstationv1":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the property", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages. type: object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "objectNum":{ "description":"Object number of the workstation", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the KDS Display in configured languages.", "type":"object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "wsId":{ "description":"Unique Id of the workstation. This is auto generated by the system and cannot be added/updated", "type":"integer", "example":19281 }, "type":{ "description":"The type of the workstation.
    Description Value
    Mobile 1
    Workstation Client 2
    POSAPI Client 3
    Tablet Client 6
    Castle Device 7
    ", "type":"integer", "example":2 }, "languageObjNum":{ "description":"Object number of the default language for the workstation sign-on screen.", "type":"integer", "example":1 }, "languageName":{ "description":"Name of the primary language for the order device. Applicable only if primaryDeviceType = 0", "type":"string", "example":"English" }, "logVerbosity":{ "description":"The logging verbosity for the Workstation. Select 0 (zero) for minimal logging. Higher settings cause the workstation's disk or flash drive to fill more quickly.", "type":"integer", "example":0 }, "wsClassObjNum":{ "description":"Object number of the Workstation Class for this workstation.", "type":"integer", "example":0 }, "wsClassName":{ "type":"object", "description":"WS ClassName", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "enableSTSGen1":{ "description":"A Boolean flag indicating to enable Simphony Transaction Services Gen 1 for the workstation", "type":"boolean", "example":false }, "enableSTSGen2Loc":{ "description":"A Boolean flag indicating to enable Simphony Transaction Services Gen 2 for location for the workstation", "type":"boolean", "example":false }, "enableSTSGen2Cloud":{ "description":"A Boolean flag indicating to enable Simphony Transaction Services Gen 2 for Cloud for the workstation", "type":"boolean", "example":false }, "svcHostID":{ "description":"The service host where the workstation application runs.", "type":"integer", "example":17121 }, "hostName":{ "description":"The IP address or host name of the service host where the workstation application runs.", "type":"string", "example":"0.0.0.0" }, "subnetMask":{ "description":"The Subnet Mask of the service host where the workstation application runs.", "type":"string", "example":"0.0.0.0" }, "defaultGateway":{ "description":"The Default Gateway of the service host where the workstation application runs.", "type":"string", "example":"0.0.0.0" }, "isWindowsService":{ "description":"A Boolean flag indicating to run the service host as a Windows service (without GUI).", "type":"boolean", "example":false }, "dbUpdateFrequencyInSecs":{ "description":"The number of seconds the workstation waits to retrieve updates from the database. This field overrides the Property Parameters Database Update Frequency setting.", "type":"integer", "example":0 }, "checkInactivtyTimeoutInSecs":{ "description":"the number of seconds the workstation waits before showing a message (Do you need more time?), prompting the workstation operator to cancel the transaction. If set to 0, the prompt does not appear. If RVC Parameter Follow Me is enabled, the check is automatically suspended rather than canceled.", "type":"integer", "example":0 }, "chkInactiveDialogTimeoutInSecs":{ "description":"The number of seconds the workstation shows the Inactivity Dialog before automatically canceling the transaction. If set to 0, the transaction does not automatically cancel.", "type":"integer", "example":0 }, "reportTimeoutInSecs":{ "description":"The number of seconds the workstation waits to retrieve reporting information before failing. The gateway report service uses a separate timeout while waiting for a response from the Reporting and Analytics server.", "type":"integer", "example":0 }, "wlsStrengthOfflineThreshold":{ "description":"The percentage amount to be used to determine if communications should be suspended for wireless workstations, until network signal strength is improved.", "type":"integer", "example":0 }, "wlsStrengthReconnectThreshold":{ "description":"The percentage amount of signal strength to be used to determine at which point the system attempts to reconnect wireless workstations to the network. This setting must be a higher value than the Offline Threshold setting.", "type":"integer", "example":0 }, "reslCols":{ "description":"the number of resolution columns for the workstation's display. This must correspond to one of the resolutions defined in the workstation's INI file or leave it at 0 (zero) as a default.", "type":"integer", "example":0 }, "reslRows":{ "description":"the number of resolution rows for the workstation's display. This must correspond to one of the resolutions defined in the workstation's INI file or leave it at 0 (zero) as a default.", "type":"integer", "example":0 }, "locFromTop":{ "description":"Specify how far from the top (in pixels) the workstation window should be placed on the display screen.", "type":"integer", "example":0 }, "locFromLeft":{ "description":"Specify how far from the left (in pixels) the workstation window should be placed on the display screen.", "type":"integer", "example":0 }, "svcHosts":{ "description":"An array of services that are running on the workstation's service host", "type":"array", "items":{ "properties":{ "svcHostNum":{ "description":"The sequence number of the service running of", "type":"integer", "example":57261 }, "svcHostType":{ "description":"The Service Record Type for each service. Search operation using this field is not allowed.", "type":"string", "example":"Workstation" }, "svcHostRecord":{ "description":"The object number and name of the service record. For example, if a workstation, KDS Controller, and credit card driver are all running on the same Service Host, this column shows their object numbers and names.", "type":"string", "example":"1-1" }, "port":{ "description":"The port number for each service on the selected service host.", "type":"string", "example":8080 }, "url":{ "description":"The URL of the service (informational only). It is used when constructing the full path to connect to the service. For example, Simphony Services are connected using a path such as http://ServiceHostName:Port/URL.", "type":"string", "example":"egateway/egateway.asmx" }, "ttlClearedThrough":{ "description":"Datastamp up to which the totals were cleared up on this workstation.", "type":"string", "example":1 } } } }, "minGuestCheckNum":{ "description":"the minimum check number to use when The workstation is in offline mode. The workstation is used in revenue centers without the RVC Parameters option Use Revenue Center Check Numbers. In these revenue centers, each workstation determines its own check number range.", "type":"integer", "example":1 }, "maxGuestCheckNum":{ "description":"the maximum check number to use when The workstation is in offline mode. The workstation is used in revenue centers without the RVC Parameters option Use Revenue Center Check Numbers. In these revenue centers, each workstation determines its own check number range.", "type":"integer", "example":99999999 }, "defltOrderTypeObjNum":{ "description":"Object number of the order type to remain active on the workstation, unless changed manually.", "type":"integer", "example":1 }, "dfltOrderTypeName":{ "type":"object", "description":"Default Order Type Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "barcodeFormatSetObjNum":{ "description":"Object number of the barcode format to use for the workstation.", "type":"integer", "example":0 }, "barcodeFormatSetName":{ "type":"object", "description":"Barcode Format Set Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "cashierLinkObjNum":{ "description":"Object number of the cashier record to link to the workstation. You must also select 8 - On = Link Cashier Totals to Workstation; Off = Link to Operator in the Workstations module.", "type":"integer", "example":0 }, "cashierLinkName":{ "type":"object", "description":"Cashier Link Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "merchantGroupNum":{ "description":"The Merchant Group for the workstation or select 0 (zero) to use the settings from the revenue center in which the transaction occurs.", "type":"integer", "example":0 }, "thaiTaxRDNum":{ "description":"The number to print on Thai Tax trailers. The name RD NUM must be included as part of the descriptor line to be printed in the trailer.", "type":"string", "example":"TU1" }, "macroLoopCount":{ "description":"The maximum number of times that a macro can loop over itself before breaking out of the loop. This field is generally used for testing purposes only. You must also select 35 -Enable Macro Loop Count in the Workstations module. Override this field by deselecting Do Not Check for Macro Loop Limit in the Property Parameters module (limit is 20 iterations).", "type":"integer", "example":0 }, "cashDrawers":{ "description":"The number of cash drawers that are physically installed at this workstation. Maximum of 2 cash drawers can be installed at the workstation", "type":"integer", "example":0 }, "cdBeepTimeoutInSecs":{ "description":"The number of seconds the cash drawer can stay open before the workstation begins beeping. If set to 0, no beeping occurs. You must also select option 3 - Require Cash Drawer to be Closed Before New Transaction in the Workstations module.", "type":"integer", "example":0 }, "cdNotifyTimeoutInSecs":{ "description":"The number of seconds the cash drawer can stay opened before the workstation posts a message to the journal log. If set to 0, no message posts to the journal log. This function only works when Workstations option 3 - Require Cash Drawer to be Closed Before New Transaction is enabled.", "type":"integer", "example":0 }, "displayOptions":{ "description":"A string value of 0s & 1s of length 13 representing the enablement or disablement of the display options associated with the workstation. Search operation using this field is not allowed.", "type":"string", "example":"0000000000000" }, "displayOptionsExt":{ "description":"An object containing the descriptive options list associated with the workstation. Search operation using this field is not allowed.", "type":"object", "properties":{ "dontClearScreenAfterTrans":{ "description":"A flag indicating to cause the last screen of a transaction to remain on the display after the transaction is complete.", "type":"boolean", "example":false }, "enableRearLineDisplay":{ "description":"A flag indicating to enable output to a rear customer display attached to the workstation.", "type":"boolean", "example":false }, "showCursor":{ "description":"A flag indicating to show the mouse cursor for this workstation when workstations are installed on PCs (such as a hostess desk). This option is usually disabled for WS4 and other Oracle MICROS hardware platforms.", "type":"boolean", "example":false }, "floatingTablet":{ "description":"A flag indicating if this is an Oracle Tablet that is not docked to a Base Station. When enabled, the tablet cannot configure or use the majority of the hardware devices that traditional workstations support.", "type":"boolean", "example":false }, "displayDiscOnCustDisplay":{ "description":"A flag indicating to show discount totals and amount due on the second line of the customer display. Deselect to show only the amount due.", "type":"boolean", "example":false }, "autoPickupNextCheck":{ "description":"A flag indicating to allow the Payment Window workstation to automatically pick up the oldest open check (that has this workstation's order type) as soon as the current check is paid. When no more checks are open, the workstation prompts to check again or to exit the Auto-Pickup functionality. This option is intended for drive-thru environments that have an Ordering Window and a Payment Window.", "type":"boolean", "example":false }, "useLCDCustomerLineDisplay":{ "description":"A flag indicating to use an LCD customer display. Deselect to use a pole display. This option is dimmed if Enable Rear Display is deselected.", "type":"boolean", "example":false }, "dontDisplayCurrencyOnRearCustDisplay":{ "description":"A flag indicating to suppress the currency symbol appearance on the rear/customer display.", "type":"boolean", "example":false }, "displayNonRoundedAmtOnRearCustDisplay":{ "description":"A flag indicating to show a non-rounded value for the total amount due on a customer display. You must also select Round Currency in the Currency Parameters module.", "type":"boolean", "example":false }, "displayChangeToDispenseInBills":{ "description":"A flag indicating to show the Change to Dispense in bills in the Change Due dialog so workstation operators can easily determine the change due in bills while the coin dispenser dispenses the rest of the amount.", "type":"boolean", "example":false }, "alwaysHideFrame":{ "description":"A flag indicating to hide the OPS window frame when the OPS UI is not in full-screen mode.", "type":"boolean", "example":false }, "promptDestPrinterWhenDocked":{ "description":"A flag indicating to indicate that the workstation should prompt for a Destination Printer (if defined) when docked.", "type":"boolean", "example":false }, "enableCustomerFacingDisplay":{ "description":"A flag to indicate that the Customer Facing Display is enabled/disabled.", "type":"boolean", "example":false } } }, "securityOptions":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the security options associated with the workstation. Search operation using this field is not allowed.", "type":"string", "example":"00000000" }, "securityOptionsExt":{ "description":"An object containing the descriptive security options list associated with the workstation. Search operation using this field is not allowed.", "type":"object", "properties":{ "requireMagCardEntryForEmpId":{ "description":"A flag indicating to require that all employee ID entries at the workstation be made using a magnetic employee ID card. Deselect to allow employee ID entry by magnetic card, keyboard, or touchscreen.", "type":"boolean", "example":false }, "disableEmpAutoSignOut":{ "description":"A flag indicating to disable the Automatic Operator Popup Interval programmed in Control Parameters. Deselect to sign out workstation operators from this workstation after the Automatic Operator Popup Interval expires.", "type":"boolean", "example":false }, "useAlternateIdForSignIn":{ "description":"A flag indicating to allow workstation operators to sign on to the workstation using the four-digit Alternate ID set in the employee record.", "type":"boolean", "example":false }, "requireFingerprintScanForEmpId":{ "description":"A flag indicating to require a scanned fingerprint for all employee ID entries at the workstation. This applies to signing in, authorizing privileged operations, and so on. Deselect to allow the workstation to accept employee ID numbers entered through keyboards or touchscreens.", "type":"boolean", "example":false }, "requireEmpIdOrFingerprintForEmpId":{ "description":"A flag indicating to allow the workstation to accept employee ID entries made through the keyboard, touchscreen, or fingerprint scans. This applies to signing in, authorizing privileged operations, and so on", "type":"boolean", "example":false }, "requireEmpIdAndFingerprintForEmpId":{ "description":"A flag indicating to require a scanned fingerprint and keyboard or touchscreen entry of an employee ID number. This applies to signing in, authorizing privileged operations, and so on.", "type":"boolean", "example":false }, "requireMagCardOrFingerprintForEmpId":{ "description":"A flag indicating to require a scanned fingerprint or a magnetic card swipe for all employee ID entries at the workstation. This applies to signing in, authorizing privileged operations, and so on.", "type":"boolean", "example":false }, "requireMagCardAndFingerprintForEmpId":{ "description":"A flag indicating to require a scanned fingerprint and a magnetic card swipe for all employee ID entries at the workstation. This applies to signing in, authorizing privileged operations, and so on.", "type":"boolean", "example":false } } }, "hardwareOptions":{ "description":"A string value of 0s & 1s of length 4 representing the enablement or disablement of the 4 hardware options associated with the workstation. Search operation using this field is not allowed.", "type":"string", "example":"0000" }, "hardwareOptionsExt":{ "description":"An object containing the descriptive hardware options list associated with the workstation. Search operation using this field is not allowed.", "type":"object", "properties":{ "enableKeyboardOrScreenBeeper":{ "description":"A flag indicating to produce a beep tone each time an employee presses a key on the workstation.", "type":"boolean", "example":false }, "enableEncryptedMagneticStripReaderSupport":{ "description":"A flag indicating to use an encrypted magnetic stripe reader. Once enabled, this option cannot be turned off. Before enabling this option, ensure that the credit card processor/gateway supports encryption.", "type":"boolean", "example":false }, "onlyUseDynaProAsCreditCardReader":{ "description":"A flag indicating to only allow credit card swipes to occur on a DynaPro reader and to turn off the internal reader. When enabled, if there is either no reader configured in the workstation's device table or the reader is not attached to the workstation, it is not possible to process credit cards through this workstation.", "type":"boolean", "example":false }, "thirdPartyManagedDevice":{ "description":"A flag indicating bit value for the Mobile Device Management(MDM) for POS Client Distribution . When disabled, Oracle is responsible for the support. When enabled, a third party company manages the required support activities on this device.\n This field is available only for these workstation types \"1 - Mobile\",\"2 - Workstation Client\" and \"6 - Tablet Client\" ", "type":"boolean", "example":false } } }, "cashDrawerOptions":{ "description":"A string value of 0s & 1s of length 4 representing the enablement or disablement of the cash drawer options associated with the workstation. Search operation using this field is not allowed.", "type":"string", "example":"0000" }, "cashDrawerOptionsExt":{ "description":"An object containing the descriptive cash drawer options list associated with the workstation. Search operation using this field is not allowed.", "type":"object", "properties":{ "requireClosedCashDrawerBeforeNewTrans":{ "description":"A flag indicating to require that cash drawers attached to this workstation are closed before a new transaction can begin. Deselect to allow transactions to begin while a cash drawer is open.", "type":"boolean", "example":false }, "assignCashDrawerByWS":{ "description":"A flag indicating to require workstation operators to assign themselves to a cash drawer using one of these function keys Assign Cash Drawer, Assign Cash Drawer 1, or Assign Cash Drawer 2.", "type":"boolean", "example":false }, "useOtherCashDrawerForOtherCurrency":{ "description":"A flag indicating to dedicate one cash drawer for foreign currency if two cash drawers are in use for the workstation. The foreign currency must allow change to be computed in that currency. This option is not available when Enterprise Cash Management is enabled.", "type":"boolean", "example":false }, "requireCashDrawerAssignmentBeforeNewTrans":{ "description":"A flag indicating to require an employee to have a cash drawer assigned prior to beginning a transaction. Deselect to allow any workstation operator to begin a transaction at the workstation.", "type":"boolean", "example":false } } }, "offlineOptions":{ "description":"A string value of 0s & 1s of length 3 representing the enablement or disablement of the offline options associated with the workstation. Search operation using this field is not allowed.", "type":"string", "example":"000" }, "offlineOptionsExt":{ "description":"An object containing the descriptive offline options list associated with the workstation. Search operation using this field is not allowed.", "type":"object", "properties":{ "allowOfflineOperations":{ "description":"A flag indicating to allow this workstation to operate in Offline Mode", "type":"boolean", "example":false }, "disableAutoOnline":{ "description":"A flag indicating to prompt workstation operators to return online. Deselect to allow this workstation to automatically return to Online Mode when communications are reestablished.", "type":"boolean", "example":false }, "goOfflineWithoutPrompting":{ "description":"A flag indicating to allow the workstation to go offline automatically when communication with the server is lost. Deselect to prompt the workstation operator to work offline.", "type":"boolean", "example":false } } }, "miscOptions":{ "description":"A string value of 0s & 1s of length 6 representing the enablement or disablement of the miscellaneous options associated with the workstation. Search operation using this field is not allowed.", "type":"string", "example":"000000" }, "miscOptionsExt":{ "description":"An object containing the descriptive miscellaneous options list associated with the workstation. Search operation using this field is not allowed.", "type":"object", "properties":{ "linkCashierTtlsToWS":{ "description":"A flag indicating to allow the workstation to link to a single cashier record. Deselect to post totals to the workstation operator's cashier record, if existing.", "type":"boolean", "example":false }, "excludeThisWSFromEMCVersionValidation":{ "description":"A flag indicating if a workstation is configured, but is not actually a physical device. Do not select this option if a workstation is just turned off. There are instances where certain configuration parameters are not allowed unless all workstations in the Enterprise have been upgraded to the latest version.", "type":"boolean", "example":false }, "disableAutoComboItemsOnFly":{ "description":"A flag indicating to override RVC Parameters option 58- Auto Combo Items on the Fly option for the workstation. This option does nothing if the RVC Parameters option is deselected.", "type":"boolean", "example":false }, "isConcessionsTerminal":{ "description":"A flag indicating to indicate that the workstation is a concessions terminal.", "type":"boolean", "example":false }, "launchKDSDisplay":{ "description":"A flag indicating to start the KDS Display application when OPS starts.", "type":"boolean", "example":false }, "enableCashback":{ "description":"A flag indicating to enable Cashback. This configuration is in conjunction with the Enable Cashback option within Employee Classes.", "type":"boolean", "example":false } } }, "enabledOrderDevices":{ "description":"A string of 0s and 1s of length 32 representing the enablement of the order devices outputs from the workstation. Search operation using this field is not allowed.", "type":"string", "example":"00000000000000000000000000000000" }, "routingGroups":{ "description":"An array of objects representing the routing groups associated with the workstation", "type":"array", "items":{ "properties":{ "routingGroupObjNum":{ "description":"Object number of the routing group", "type":"integer", "example":1 }, "routingGroupName":{ "description":"A group of strings representing the name of the routing group", "type":"string", "example":null } } } }, "printJobConfiguration":{ "description":"A group of objects representing the printer configuration for the workstation", "type":"array", "items":{ "properties":{ "printerType":{ "description":"The type of the printer", "type":"integer", "example":1 }, "printerObjNum":{ "description":"Object number of the printer", "type":"integer", "example":1 }, "printerName":{ "type":"object", "description":"Printer Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "destPrinterGroupObjNum":{ "description":"Object number of the Printer Group to be displayed to allow a printer to be chosen.", "type":"integer", "example":1 }, "destPrinterGroupName":{ "type":"object", "description":"Dest Printer group Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } } } } }, "revenueCenters":{ "description":"An array of revenue centers that are available from this workstation when signing on.", "type":"array", "items":{ "properties":{ "index":{ "description":"Index of the revenue center. There can be only a maximum of 8 revenue center available to a workstation. Index =1 indicates the default revenue center for the workstation", "type":"integer", "example":1 }, "rvcObjNum":{ "description":"Object number of the revenue center", "type":"integer", "example":1 }, "rvcName":{ "type":"object", "description":"RVC Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } } } } }, "devices":{ "description":"An array of peripheral devices associated with the workstation", "type":"array", "items":{ "required":[ "deviceNum" ], "properties":{ "deviceNum":{ "description":"Sequence number of the device", "type":"integer", "example":1 }, "deviceType":{ "description":"Type of the peripheral device. Valid device types are 1, 2, 3, 5, 8, 10, 12, 13, 14, 15, 16, 17, 18, 20.", "type":"integer", "example":1 }, "comPort":{ "description":"COM Port of the device", "type":"integer", "example":1 }, "baudRate":{ "description":"Baud Rate of the device.", "type":"integer", "example":9600 }, "parity":{ "description":"Parity of the device", "type":"string", "example":"N" }, "dataBits":{ "description":"Data bits of the device", "type":"integer", "example":8 }, "stopBits":{ "description":"Stop Bits of the device", "type":"integer", "example":2 }, "customDeviceSettingsConfig":{ "description":"Configuration parameters of the peripheral device", "type":"string", "example":"Custom Settings" }, "customDevice":{ "description":"Device type of the custom peripheral device", "type":"integer", "example":1 }, "progId":{ "description":"Prog Id of the custom peripheral device", "type":"string", "example":1 }, "configuration":{ "description":"Configuration parameters of the custom peripheral device", "type":"string", "example":"config" }, "clientCertCommonName":{ "description":"Client certificate common name of the payment interface", "type":"string", "example":"certificate" }, "clientCertEffectiveDt":{ "description":"Client Certificate effective date of the payment interface", "type":"string", "example":"2020-10-11" }, "clientCertExpDt":{ "description":"Expiration date of the client certificate of the payment interface", "type":"string", "example":"2020-10-11" }, "clientCertPassword":{ "description":"Client Certificate password", "type":"string", "example":"passw0rd" }, "deleteCertificate":{ "description":"A flag indicating if the certificates need to be deleted. Applicable for type=20 and for SPI only", "type":"boolean", "example":false }, "hostTimeoutInSecs":{ "description":"Timeout in seconds if request is abandoned", "type":"integer", "example":180 }, "clientCertificate":{ "description":"Client Certificate object. Applicable only for type=20 and SPI", "type":"string", "example":"Cert" }, "serverCertificate":{ "description":"Server certificate object", "type":"string", "example":"Cert" }, "primaryHost":{ "description":"URL of the endpoint. Format http(s)://host:port number", "type":"string", "example":"http://url.domain.com:443" }, "securitySettings":{ "description":"Security settings for the interface", "type":"integer", "example":1 }, "serverCertCommonName":{ "description":"Common name of the Server Certificate", "type":"string", "example":"certificate" }, "serverCertEffectiveDt":{ "description":"Effective date of the server certificate", "type":"string", "example":"2020-10-11" }, "serverCertExpDt":{ "description":"Expiration date of the server certificate", "type":"string", "example":"2020-10-11T00:00:00.000Z" }, "validateXMLAgainstSchema":{ "description":"A Boolean flag indicating if the XML message is validated against schema and log errors. Applicable only for type=20 and SPI", "type":"boolean", "example":false } } } }, "dataExtensions":{ "description":"An array of data extensions for the menu item", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } }, "defaultOrderChannelObjNum":{ "description":"Object number of the order channel to remain active on the workstation, unless changed manually.", "type":"integer", "example":1 }, "defaultOrderChannelName":{ "type":"object", "description":"Default order channel Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } } } }, "WorkstationCUDRequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name", "type" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the workstation", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "type":{ "description":"The type of the workstation.
    Description Value
    Mobile 1
    Workstation Client 2
    POSAPI Client 3
    Tablet Client 6
    Castle Device 7
    ", "type":"integer", "example":2 }, "languageObjNum":{ "description":"Object number of the default language for the workstation sign-on screen.", "type":"integer", "example":1 }, "logVerbosity":{ "description":"The logging verbosity for the Workstation. Select 0 (zero) for minimal logging. Higher settings cause the workstation's disk or flash drive to fill more quickly.", "type":"integer", "example":0 }, "wsClassObjNum":{ "description":"Object number of the Workstation Class for this workstation.", "type":"integer", "example":0 }, "enableSTSGen1":{ "description":"A Boolean flag indicating to enable Simphony Transaction Services Gen 1 for the workstation", "type":"boolean", "example":false }, "enableSTSGen2Loc":{ "description":"A Boolean flag indicating to enable Simphony Transaction Services Gen 2 for location for the workstation", "type":"boolean", "example":false }, "enableSTSGen2Cloud":{ "description":"A Boolean flag indicating to enable Simphony Transaction Services Gen 2 for Cloud for the workstation", "type":"boolean", "example":false }, "svcHostID":{ "description":"The service host where the workstation application runs. It is auto-generated, except for workstation type 3. For type 3, the service host of existing workstation can be assigned.", "type":"integer", "example":17121 }, "hostName":{ "description":"The IP address or host name of the service host where the workstation application runs.", "type":"string", "example":"0.0.0.0" }, "subnetMask":{ "description":"The Subnet Mask of the service host where the workstation application runs.", "type":"string", "example":"0.0.0.0" }, "defaultGateway":{ "description":"The Default Gateway of the service host where the workstation application runs.", "type":"string", "example":"0.0.0.0" }, "isWindowsService":{ "description":"A Boolean flag indicating to run the service host as a Windows service (without GUI).", "type":"boolean", "example":false }, "dbUpdateFrequencyInSecs":{ "description":"The number of seconds the workstation waits to retrieve updates from the database. This field overrides the Property Parameters Database Update Frequency setting.", "type":"integer", "example":0 }, "checkInactivtyTimeoutInSecs":{ "description":"the number of seconds the workstation waits before showing a message (Do you need more time?), prompting the workstation operator to cancel the transaction. If set to 0, the prompt does not appear. If RVC Parameter Follow Me is enabled, the check is automatically suspended rather than canceled.", "type":"integer", "example":0 }, "chkInactiveDialogTimeoutInSecs":{ "description":"The number of seconds the workstation shows the Inactivity Dialog before automatically canceling the transaction. If set to 0, the transaction does not automatically cancel.", "type":"integer", "example":0 }, "reportTimeoutInSecs":{ "description":"The number of seconds the workstation waits to retrieve reporting information before failing. The gateway report service uses a separate timeout while waiting for a response from the Reporting and Analytics server.", "type":"integer", "example":0 }, "wlsStrengthOfflineThreshold":{ "description":"The percentage amount to be used to determine if communications should be suspended for wireless workstations, until network signal strength is improved.", "type":"integer", "example":0 }, "wlsStrengthReconnectThreshold":{ "description":"The percentage amount of signal strength to be used to determine at which point the system attempts to reconnect wireless workstations to the network. This setting must be a higher value than the Offline Threshold setting.", "type":"integer", "example":0 }, "reslCols":{ "description":"the number of resolution columns for the workstation's display. This must correspond to one of the resolutions defined in the workstation's INI file or leave it at 0 (zero) as a default.", "type":"integer", "example":0 }, "reslRows":{ "description":"the number of resolution rows for the workstation's display. This must correspond to one of the resolutions defined in the workstation's INI file or leave it at 0 (zero) as a default.", "type":"integer", "example":0 }, "locFromTop":{ "description":"Specify how far from the top (in pixels) the workstation window should be placed on the display screen.", "type":"integer", "example":0 }, "locFromLeft":{ "description":"Specify how far from the left (in pixels) the workstation window should be placed on the display screen.", "type":"integer", "example":0 }, "svcHosts":{ "description":"An array of services that are running on the workstation's service host", "type":"array", "items":{ "properties":{ "svcHostType":{ "description":"The Service Record Type for each service", "type":"string", "example":"Workstation" }, "port":{ "description":"The port number for each service on the selected service host.", "type":"string", "example":8080 } } } }, "minGuestCheckNum":{ "description":"the minimum check number to use when The workstation is in offline mode. The workstation is used in revenue centers without the RVC Parameters option Use Revenue Center Check Numbers. In these revenue centers, each workstation determines its own check number range.", "type":"integer", "example":1 }, "maxGuestCheckNum":{ "description":"the maximum check number to use when The workstation is in offline mode. The workstation is used in revenue centers without the RVC Parameters option Use Revenue Center Check Numbers. In these revenue centers, each workstation determines its own check number range.", "type":"integer", "example":99999999 }, "defltOrderTypeObjNum":{ "description":"Object number of the order type to remain active on the workstation, unless changed manually.", "type":"integer", "example":1 }, "barcodeFormatSetObjNum":{ "description":"Object number of the barcode format to use for the workstation.", "type":"integer", "example":0 }, "cashierLinkObjNum":{ "description":"Object number of the cashier record to link to the workstation. You must also select 8 - On = Link Cashier Totals to Workstation; Off = Link to Operator in the Workstations module.", "type":"integer", "example":0 }, "thaiTaxRDNum":{ "description":"The number to print on Thai Tax trailers. The name RD NUM must be included as part of the descriptor line to be printed in the trailer.", "type":"string", "example":"TU1" }, "cashDrawers":{ "description":"The number of cash drawers that are physically installed at this workstation. Maximum of 2 cash drawers can be installed at the workstation", "type":"integer", "example":0 }, "cdBeepTimeoutInSecs":{ "description":"The number of seconds the cash drawer can stay open before the workstation begins beeping. If set to 0, no beeping occurs. You must also select option 3 - Require Cash Drawer to be Closed Before New Transaction in the Workstations module.", "type":"integer", "example":0 }, "cdNotifyTimeoutInSecs":{ "description":"The number of seconds the cash drawer can stay opened before the workstation posts a message to the journal log. If set to 0, no message posts to the journal log. This function only works when Workstations option 3 - Require Cash Drawer to be Closed Before New Transaction is enabled.", "type":"integer", "example":0 }, "displayOptions":{ "description":"A string value of 0s & 1s of length 13 representing the enablement or disablement of the display options associated with the workstation", "type":"string", "example":"0000000000000" }, "securityOptions":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the security options associated with the workstation", "type":"string", "example":"00000000" }, "hardwareOptions":{ "description":"A string value of 0s & 1s of length 4 representing the enablement or disablement of the 4 hardware options associated with the workstation", "type":"string", "example":"0000" }, "cashDrawerOptions":{ "description":"A string value of 0s & 1s of length 4 representing the enablement or disablement of the cash drawer options associated with the workstation", "type":"string", "example":"0000" }, "offlineOptions":{ "description":"A string value of 0s & 1s of length 3 representing the enablement or disablement of the offline options associated with the workstation", "type":"string", "example":"000" }, "miscOptions":{ "description":"A string value of 0s & 1s of length 6 representing the enablement or disablement of the miscellaneous options associated with the workstation", "type":"string", "example":"000000" }, "enabledOrderDevices":{ "description":"A string of 0s and 1s of length 32 representing the enablement of the order devices outputs from the workstation", "type":"string", "example":"00000000000000000000000000000000" }, "routingGroups":{ "description":"An array of objects representing the routing groups associated with the workstation", "type":"array", "items":{ "properties":{ "routingGroupObjNum":{ "description":"Object number of the routing group", "type":"integer", "example":1 } } } }, "printJobConfiguration":{ "description":"A group of objects representing the printer configuration for the workstation", "type":"array", "items":{ "properties":{ "printerType":{ "description":"The type of the printer", "type":"integer", "example":1 }, "printerObjNum":{ "description":"Object number of the printer", "type":"integer", "example":1 }, "destPrinterGroupObjNum":{ "description":"Object number of the Printer Group to be displayed to allow a printer to be chosen.", "type":"integer", "example":1 } } } }, "revenueCenters":{ "description":"An array of revenue centers that are available from this workstation when signing on.", "type":"array", "items":{ "properties":{ "index":{ "description":"Index of the revenue center. There can be only a maximum of 8 revenue center available to a workstation. Index =1 indicates the default revenue center for the workstation", "type":"integer", "example":1 }, "rvcObjNum":{ "description":"Object number of the revenue center", "type":"integer", "example":1 } } } }, "devices":{ "description":"An array of peripheral devices associated with the workstation", "type":"array", "items":{ "required":[ "deviceNum" ], "properties":{ "deviceNum":{ "description":"Sequence number of the device", "type":"integer", "example":1 }, "deviceType":{ "description":"Type of the peripheral device. Valid device types are 1, 2, 3, 5, 8, 10, 12, 13, 14, 15, 16, 17, 18, 20.", "type":"integer", "example":1 }, "comPort":{ "description":"COM Port of the device", "type":"integer", "example":1 }, "baudRate":{ "description":"Baud Rate of the device.", "type":"integer", "example":9600 }, "parity":{ "description":"Parity of the device", "type":"string", "example":"N" }, "dataBits":{ "description":"Data bits of the device", "type":"integer", "example":8 }, "stopBits":{ "description":"Stop Bits of the device", "type":"integer", "example":2 }, "customDeviceSettingsConfig":{ "description":"Configuration parameters of the peripheral device", "type":"string", "example":"Custom Settings" }, "customDevice":{ "description":"Device type of the custom peripheral device", "type":"integer", "example":1 }, "progId":{ "description":"Prog Id of the custom peripheral device", "type":"string", "example":1 }, "configuration":{ "description":"Configuration parameters of the custom peripheral device", "type":"string", "example":"config" }, "clientCertCommonName":{ "description":"Client certificate common name of the payment interface", "type":"string", "example":"certificate" }, "clientCertEffectiveDt":{ "description":"Client Certificate effective date of the payment interface", "type":"string", "example":"2020-10-11" }, "clientCertExpDt":{ "description":"Expiration date of the client certificate of the payment interface", "type":"string", "example":"2020-10-11" }, "clientCertPassword":{ "description":"Client Certificate password", "type":"string", "example":"passw0rd" }, "deleteCertificate":{ "description":"A flag indicating if the certificates need to be deleted. Applicable for type=20 and for SPI only", "type":"boolean", "example":false }, "hostTimeoutInSecs":{ "description":"Timeout in seconds if request is abandoned", "type":"integer", "example":180 }, "clientCertificate":{ "description":"Client Certificate object. Applicable only for type=20 and SPI", "type":"string", "example":"Cert" }, "serverCertificate":{ "description":"Server certificate object", "type":"string", "example":"Cert" }, "primaryHost":{ "description":"URL of the endpoint. Format http(s)://host:port number", "type":"string", "example":"http://url.domain.com:443" }, "securitySettings":{ "description":"Security settings for the interface", "type":"integer", "example":1 }, "serverCertCommonName":{ "description":"Common name of the Server Certificate", "type":"string", "example":"certificate" }, "serverCertEffectiveDt":{ "description":"Effective date of the server certificate", "type":"string", "example":"2020-10-11" }, "serverCertExpDt":{ "description":"Expiration date of the server certificate", "type":"string", "example":"2020-10-11T00:00:00.000Z" }, "validateXMLAgainstSchema":{ "description":"A Boolean flag indicating if the XML message is validated against schema and log errors. Applicable only for type=20 and SPI", "type":"boolean", "example":false } } } }, "dataExtensions":{ "description":"An array of data extensions for the menu item", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } }, "defaultOrderChannelObjNum":{ "description":"Object number of the order channel to remain active on the workstation, unless changed manually.", "type":"integer", "example":1 } } }, "WorkstationGetRequestBody":{ "description":"The input Body model that needs to be given.", "type":"object", "required":[ "hierUnitId" ], "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "description":"Objects included in response", "example":"hierUnitId" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "description":"If specified, limits translated strings returned.", "example":"en-US, es-ES, es-MX" }, "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 } } }, "Workstationv2":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the workstation", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Workstation Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "wsId":{ "description":"Unique Id of the workstation. This is auto generated by the system and cannot be added/updated", "type":"integer", "example":19281 }, "type":{ "description":"The type of the workstation.
    Description Value
    Mobile 1
    Workstation Client 2
    POSAPI Client 3
    Tablet Client 6
    Castle Device 7
    ", "type":"integer", "example":2 }, "languageObjNum":{ "description":"Object number of the default language for the workstation sign-on screen.", "type":"integer", "example":1 }, "paymentTerminalSerialNumber":{ "description":"Serial number of the paymentTerminal assigned to a workstation.", "type":"string", "example":"S1F2-000000000000000" }, "logVerbosity":{ "description":"The logging verbosity for the Workstation. Select 0 (zero) for minimal logging. Higher settings cause the workstation's disk or flash drive to fill more quickly.", "type":"integer", "example":0 }, "wsClassObjNum":{ "description":"Object number of the Workstation Class for this workstation.", "type":"integer", "example":0 }, "enableSTSGen1":{ "description":"A Boolean flag indicating to enable Simphony Transaction Services Gen 1 for the workstation", "type":"boolean", "example":false }, "enableSTSGen2Loc":{ "description":"A Boolean flag indicating to enable Simphony Transaction Services Gen 2 for location for the workstation", "type":"boolean", "example":false }, "enableSTSGen2Cloud":{ "description":"A Boolean flag indicating to enable Simphony Transaction Services Gen 2 for Cloud for the workstation", "type":"boolean", "example":false }, "svcHostID":{ "description":"The service host where the workstation application runs.", "type":"integer", "example":17121 }, "hostName":{ "description":"The IP address or host name of the service host where the workstation application runs.", "type":"string", "example":"0.0.0.0" }, "subnetMask":{ "description":"The Subnet Mask of the service host where the workstation application runs.", "type":"string", "example":"0.0.0.0" }, "defaultGateway":{ "description":"The Default Gateway of the service host where the workstation application runs.", "type":"string", "example":"0.0.0.0" }, "isWindowsService":{ "description":"A Boolean flag indicating to run the service host as a Windows service (without GUI).", "type":"boolean", "example":false }, "dbUpdateFrequencyInSecs":{ "description":"The number of seconds the workstation waits to retrieve updates from the database. This field overrides the Property Parameters Database Update Frequency setting.", "type":"integer", "example":0 }, "checkInactivtyTimeoutInSecs":{ "description":"the number of seconds the workstation waits before showing a message (Do you need more time?), prompting the workstation operator to cancel the transaction. If set to 0, the prompt does not appear. If RVC Parameter Follow Me is enabled, the check is automatically suspended rather than canceled.", "type":"integer", "example":0 }, "chkInactiveDialogTimeoutInSecs":{ "description":"The number of seconds the workstation shows the Inactivity Dialog before automatically canceling the transaction. If set to 0, the transaction does not automatically cancel.", "type":"integer", "example":0 }, "reportTimeoutInSecs":{ "description":"The number of seconds the workstation waits to retrieve reporting information before failing. The gateway report service uses a separate timeout while waiting for a response from the Reporting and Analytics server.", "type":"integer", "example":0 }, "wlsStrengthOfflineThreshold":{ "description":"The percentage amount to be used to determine if communications should be suspended for wireless workstations, until network signal strength is improved.", "type":"integer", "example":0 }, "wlsStrengthReconnectThreshold":{ "description":"The percentage amount of signal strength to be used to determine at which point the system attempts to reconnect wireless workstations to the network. This setting must be a higher value than the Offline Threshold setting.", "type":"integer", "example":0 }, "reslCols":{ "description":"the number of resolution columns for the workstation's display. This must correspond to one of the resolutions defined in the workstation's INI file or leave it at 0 (zero) as a default.", "type":"integer", "example":0 }, "reslRows":{ "description":"the number of resolution rows for the workstation's display. This must correspond to one of the resolutions defined in the workstation's INI file or leave it at 0 (zero) as a default.", "type":"integer", "example":0 }, "locFromTop":{ "description":"Specify how far from the top (in pixels) the workstation window should be placed on the display screen.", "type":"integer", "example":0 }, "locFromLeft":{ "description":"Specify how far from the left (in pixels) the workstation window should be placed on the display screen.", "type":"integer", "example":0 }, "svcHosts":{ "description":"An array of services that are running on the workstation's service host", "type":"array", "items":{ "properties":{ "svcHostNum":{ "description":"The sequence number of the service running of", "type":"integer", "example":57261 }, "svcHostType":{ "description":"The Service Record Type for each service", "type":"string", "example":"Workstation" }, "svcHostRecord":{ "description":"The object number and name of the service record. For example, if a workstation, KDS Controller, and credit card driver are all running on the same Service Host, this column shows their object numbers and names.", "type":"string", "example":"1-1" }, "port":{ "description":"The port number for each service on the selected service host.", "type":"string", "example":8080 }, "url":{ "description":"The URL of the service (informational only). It is used when constructing the full path to connect to the service. For example, Simphony Services are connected using a path such as http://ServiceHostName:Port/URL.", "type":"string", "example":"egateway/egateway.asmx" }, "ttlClearedThrough":{ "description":"Datastamp up to which the totals were cleared up on this workstation.", "type":"string", "example":1 } } } }, "minGuestCheckNum":{ "description":"the minimum check number to use when The workstation is in offline mode. The workstation is used in revenue centers without the RVC Parameters option Use Revenue Center Check Numbers. In these revenue centers, each workstation determines its own check number range.", "type":"integer", "example":1 }, "maxGuestCheckNum":{ "description":"the maximum check number to use when The workstation is in offline mode. The workstation is used in revenue centers without the RVC Parameters option Use Revenue Center Check Numbers. In these revenue centers, each workstation determines its own check number range.", "type":"integer", "example":99999999 }, "defltOrderTypeObjNum":{ "description":"Object number of the order type to remain active on the workstation, unless changed manually.", "type":"integer", "example":1 }, "barcodeFormatSetObjNum":{ "description":"Object number of the barcode format to use for the workstation.", "type":"integer", "example":0 }, "cashierLinkObjNum":{ "description":"Object number of the cashier record to link to the workstation. You must also select 8 - On = Link Cashier Totals to Workstation; Off = Link to Operator in the Workstations module.", "type":"integer", "example":0 }, "merchantGroupNum":{ "description":"The Merchant Group for the workstation or select 0 (zero) to use the settings from the revenue center in which the transaction occurs.", "type":"integer", "example":0 }, "thaiTaxRDNum":{ "description":"The number to print on Thai Tax trailers. The name RD NUM must be included as part of the descriptor line to be printed in the trailer.", "type":"string", "example":"TU1" }, "macroLoopCount":{ "description":"The maximum number of times that a macro can loop over itself before breaking out of the loop. This field is generally used for testing purposes only. You must also select 35 -Enable Macro Loop Count in the Workstations module. Override this field by deselecting Do Not Check for Macro Loop Limit in the Property Parameters module (limit is 20 iterations).", "type":"integer", "example":0 }, "cashDrawers":{ "description":"The number of cash drawers that are physically installed at this workstation. Maximum of 2 cash drawers can be installed at the workstation", "type":"integer", "example":0 }, "cdBeepTimeoutInSecs":{ "description":"The number of seconds the cash drawer can stay open before the workstation begins beeping. If set to 0, no beeping occurs. You must also select option 3 - Require Cash Drawer to be Closed Before New Transaction in the Workstations module.", "type":"integer", "example":0 }, "cdNotifyTimeoutInSecs":{ "description":"The number of seconds the cash drawer can stay opened before the workstation posts a message to the journal log. If set to 0, no message posts to the journal log. This function only works when Workstations option 3 - Require Cash Drawer to be Closed Before New Transaction is enabled.", "type":"integer", "example":0 }, "displayOptions":{ "description":"A string value of 0s & 1s of length 13 representing the enablement or disablement of the display options associated with the workstation", "type":"string", "example":"0000000000000" }, "displayOptionsExt":{ "description":"An object containing the descriptive options list associated with the workstation", "type":"object", "properties":{ "dontClearScreenAfterTrans":{ "description":"A flag indicating to cause the last screen of a transaction to remain on the display after the transaction is complete.", "type":"boolean", "example":false }, "enableRearLineDisplay":{ "description":"A flag indicating to enable output to a rear customer display attached to the workstation.", "type":"boolean", "example":false }, "showCursor":{ "description":"A flag indicating to show the mouse cursor for this workstation when workstations are installed on PCs (such as a hostess desk). This option is usually disabled for WS4 and other Oracle MICROS hardware platforms.", "type":"boolean", "example":false }, "floatingTablet":{ "description":"A flag indicating if this is an Oracle Tablet that is not docked to a Base Station. When enabled, the tablet cannot configure or use the majority of the hardware devices that traditional workstations support.", "type":"boolean", "example":false }, "displayDiscOnCustDisplay":{ "description":"A flag indicating to show discount totals and amount due on the second line of the customer display. Deselect to show only the amount due.", "type":"boolean", "example":false }, "autoPickupNextCheck":{ "description":"A flag indicating to allow the Payment Window workstation to automatically pick up the oldest open check (that has this workstation's order type) as soon as the current check is paid. When no more checks are open, the workstation prompts to check again or to exit the Auto-Pickup functionality. This option is intended for drive-thru environments that have an Ordering Window and a Payment Window.", "type":"boolean", "example":false }, "useLCDCustomerLineDisplay":{ "description":"A flag indicating to use an LCD customer display. Deselect to use a pole display. This option is dimmed if Enable Rear Display is deselected.", "type":"boolean", "example":false }, "dontDisplayCurrencyOnRearCustDisplay":{ "description":"A flag indicating to suppress the currency symbol appearance on the rear/customer display.", "type":"boolean", "example":false }, "displayNonRoundedAmtOnRearCustDisplay":{ "description":"A flag indicating to show a non-rounded value for the total amount due on a customer display. You must also select Round Currency in the Currency Parameters module.", "type":"boolean", "example":false }, "displayChangeToDispenseInBills":{ "description":"A flag indicating to show the Change to Dispense in bills in the Change Due dialog so workstation operators can easily determine the change due in bills while the coin dispenser dispenses the rest of the amount.", "type":"boolean", "example":false }, "alwaysHideFrame":{ "description":"A flag indicating to hide the OPS window frame when the OPS UI is not in full-screen mode.", "type":"boolean", "example":false }, "promptDestPrinterWhenDocked":{ "description":"A flag indicating to indicate that the workstation should prompt for a Destination Printer (if defined) when docked.", "type":"boolean", "example":false }, "enableCustomerFacingDisplay":{ "description":"A flag to indicate that the Customer Facing Display is enabled/disabled.", "type":"boolean", "example":false } } }, "securityOptions":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the security options associated with the workstation", "type":"string", "example":"00000000" }, "securityOptionsExt":{ "description":"An object containing the descriptive security options list associated with the workstation", "type":"object", "properties":{ "requireMagCardEntryForEmpId":{ "description":"A flag indicating to require that all employee ID entries at the workstation be made using a magnetic employee ID card. Deselect to allow employee ID entry by magnetic card, keyboard, or touchscreen.", "type":"boolean", "example":false }, "disableEmpAutoSignOut":{ "description":"A flag indicating to disable the Automatic Operator Popup Interval programmed in Control Parameters. Deselect to sign out workstation operators from this workstation after the Automatic Operator Popup Interval expires.", "type":"boolean", "example":false }, "useAlternateIdForSignIn":{ "description":"A flag indicating to allow workstation operators to sign on to the workstation using the four-digit Alternate ID set in the employee record.", "type":"boolean", "example":false }, "requireFingerprintScanForEmpId":{ "description":"A flag indicating to require a scanned fingerprint for all employee ID entries at the workstation. This applies to signing in, authorizing privileged operations, and so on. Deselect to allow the workstation to accept employee ID numbers entered through keyboards or touchscreens.", "type":"boolean", "example":false }, "requireEmpIdOrFingerprintForEmpId":{ "description":"A flag indicating to allow the workstation to accept employee ID entries made through the keyboard, touchscreen, or fingerprint scans. This applies to signing in, authorizing privileged operations, and so on", "type":"boolean", "example":false }, "requireEmpIdAndFingerprintForEmpId":{ "description":"A flag indicating to require a scanned fingerprint and keyboard or touchscreen entry of an employee ID number. This applies to signing in, authorizing privileged operations, and so on.", "type":"boolean", "example":false }, "requireMagCardOrFingerprintForEmpId":{ "description":"A flag indicating to require a scanned fingerprint or a magnetic card swipe for all employee ID entries at the workstation. This applies to signing in, authorizing privileged operations, and so on.", "type":"boolean", "example":false }, "requireMagCardAndFingerprintForEmpId":{ "description":"A flag indicating to require a scanned fingerprint and a magnetic card swipe for all employee ID entries at the workstation. This applies to signing in, authorizing privileged operations, and so on.", "type":"boolean", "example":false } } }, "hardwareOptions":{ "description":"A string value of 0s & 1s of length 4 representing the enablement or disablement of the 4 hardware options associated with the workstation", "type":"string", "example":"0000" }, "hardwareOptionsExt":{ "description":"An object containing the descriptive hardware options list associated with the workstation", "type":"object", "properties":{ "enableKeyboardOrScreenBeeper":{ "description":"A flag indicating to produce a beep tone each time an employee presses a key on the workstation.", "type":"boolean", "example":false }, "enableEncryptedMagneticStripReaderSupport":{ "description":"A flag indicating to use an encrypted magnetic stripe reader. Once enabled, this option cannot be turned off. Before enabling this option, ensure that the credit card processor/gateway supports encryption.", "type":"boolean", "example":false }, "onlyUseDynaProAsCreditCardReader":{ "description":"A flag indicating to only allow credit card swipes to occur on a DynaPro reader and to turn off the internal reader. When enabled, if there is either no reader configured in the workstation's device table or the reader is not attached to the workstation, it is not possible to process credit cards through this workstation.", "type":"boolean", "example":false }, "thirdPartyManagedDevice":{ "description":"A flag indicating bit value for the Mobile Device Management(MDM) for POS Client Distribution . When disabled, Oracle is responsible for the support. When enabled, a third party company manages the required support activities on this device.\n This field is available only for these workstation types \"1 - Mobile\",\"2 - Workstation Client\" and \"6 - Tablet Client\" ", "type":"boolean", "example":false } } }, "cashDrawerOptions":{ "description":"A string value of 0s & 1s of length 4 representing the enablement or disablement of the cash drawer options associated with the workstation", "type":"string", "example":"0000" }, "cashDrawerOptionsExt":{ "description":"An object containing the descriptive cash drawer options list associated with the workstation", "type":"object", "properties":{ "requireClosedCashDrawerBeforeNewTrans":{ "description":"A flag indicating to require that cash drawers attached to this workstation are closed before a new transaction can begin. Deselect to allow transactions to begin while a cash drawer is open.", "type":"boolean", "example":false }, "assignCashDrawerByWS":{ "description":"A flag indicating to require workstation operators to assign themselves to a cash drawer using one of these function keys Assign Cash Drawer, Assign Cash Drawer 1, or Assign Cash Drawer 2.", "type":"boolean", "example":false }, "useOtherCashDrawerForOtherCurrency":{ "description":"A flag indicating to dedicate one cash drawer for foreign currency if two cash drawers are in use for the workstation. The foreign currency must allow change to be computed in that currency. This option is not available when Enterprise Cash Management is enabled.", "type":"boolean", "example":false }, "requireCashDrawerAssignmentBeforeNewTrans":{ "description":"A flag indicating to require an employee to have a cash drawer assigned prior to beginning a transaction. Deselect to allow any workstation operator to begin a transaction at the workstation.", "type":"boolean", "example":false } } }, "offlineOptions":{ "description":"A string value of 0s & 1s of length 3 representing the enablement or disablement of the offline options associated with the workstation", "type":"string", "example":"000" }, "offlineOptionsExt":{ "description":"An object containing the descriptive offline options list associated with the workstation", "type":"object", "properties":{ "allowOfflineOperations":{ "description":"A flag indicating to allow this workstation to operate in Offline Mode", "type":"boolean", "example":false }, "disableAutoOnline":{ "description":"A flag indicating to prompt workstation operators to return online. Deselect to allow this workstation to automatically return to Online Mode when communications are reestablished.", "type":"boolean", "example":false }, "goOfflineWithoutPrompting":{ "description":"A flag indicating to allow the workstation to go offline automatically when communication with the server is lost. Deselect to prompt the workstation operator to work offline.", "type":"boolean", "example":false } } }, "miscOptions":{ "description":"A string value of 0s & 1s of length 6 representing the enablement or disablement of the miscellaneous options associated with the workstation", "type":"string", "example":"000000" }, "miscOptionsExt":{ "description":"An object containing the descriptive miscellaneous options list associated with the workstation", "type":"object", "properties":{ "linkCashierTtlsToWS":{ "description":"A flag indicating to allow the workstation to link to a single cashier record. Deselect to post totals to the workstation operator's cashier record, if existing.", "type":"boolean", "example":false }, "excludeThisWSFromEMCVersionValidation":{ "description":"A flag indicating if a workstation is configured, but is not actually a physical device. Do not select this option if a workstation is just turned off. There are instances where certain configuration parameters are not allowed unless all workstations in the Enterprise have been upgraded to the latest version.", "type":"boolean", "example":false }, "disableAutoComboItemsOnFly":{ "description":"A flag indicating to override RVC Parameters option 58- Auto Combo Items on the Fly option for the workstation. This option does nothing if the RVC Parameters option is deselected.", "type":"boolean", "example":false }, "isConcessionsTerminal":{ "description":"A flag indicating to indicate that the workstation is a concessions terminal.", "type":"boolean", "example":false }, "launchKDSDisplay":{ "description":"A flag indicating to start the KDS Display application when OPS starts.", "type":"boolean", "example":false }, "enableCashback":{ "description":"A flag indicating to enable Cashback. This configuration is in conjunction with the Enable Cashback option within Employee Classes.", "type":"boolean", "example":false } } }, "enabledOrderDevices":{ "description":"A string of 0s and 1s of length 32 representing the enablement of the order devices outputs from the workstation", "type":"string", "example":"00000000000000000000000000000000" }, "routingGroups":{ "description":"An array of objects representing the routing groups associated with the workstation", "type":"array", "items":{ "properties":{ "routingGroupObjNum":{ "description":"Object number of the routing group", "type":"integer", "example":1 } } } }, "printJobConfiguration":{ "description":"A group of objects representing the printer configuration for the workstation", "type":"array", "items":{ "properties":{ "printerType":{ "description":"The type of the printer", "type":"integer", "example":1 }, "printerObjNum":{ "description":"Object number of the printer", "type":"integer", "example":1 }, "destPrinterGroupObjNum":{ "description":"Object number of the Printer Group to be displayed to allow a printer to be chosen.", "type":"integer", "example":1 } } } }, "revenueCenters":{ "description":"An array of revenue centers that are available from this workstation when signing on.", "type":"array", "items":{ "properties":{ "index":{ "description":"Index of the revenue center. There can be only a maximum of 8 revenue center available to a workstation. Index =1 indicates the default revenue center for the workstation", "type":"integer", "example":1 }, "rvcObjNum":{ "description":"Object number of the revenue center", "type":"integer", "example":1 } } } }, "devices":{ "description":"An array of peripheral devices associated with the workstation", "type":"array", "items":{ "required":[ "deviceNum" ], "properties":{ "deviceNum":{ "description":"Sequence number of the device", "type":"integer", "example":1 }, "deviceType":{ "description":"Type of the peripheral device. Valid device types are 1, 2, 3, 5, 8, 10, 12, 13, 14, 15, 16, 17, 18, 20.", "type":"integer", "example":1 }, "comPort":{ "description":"COM Port of the device", "type":"integer", "example":1 }, "baudRate":{ "description":"Baud Rate of the device.", "type":"integer", "example":9600 }, "parity":{ "description":"Parity of the device", "type":"string", "example":"N" }, "dataBits":{ "description":"Data bits of the device", "type":"integer", "example":8 }, "stopBits":{ "description":"Stop Bits of the device", "type":"integer", "example":2 }, "customDeviceSettingsConfig":{ "description":"Configuration parameters of the peripheral device", "type":"string", "example":"Custom Settings" }, "customDevice":{ "description":"Device type of the custom peripheral device", "type":"integer", "example":1 }, "progId":{ "description":"Prog Id of the custom peripheral device", "type":"string", "example":1 }, "configuration":{ "description":"Configuration parameters of the custom peripheral device", "type":"string", "example":"config" }, "clientCertCommonName":{ "description":"Client certificate common name of the payment interface", "type":"string", "example":"certificate" }, "clientCertEffectiveDt":{ "description":"Client Certificate effective date of the payment interface", "type":"string", "example":"2020-10-11" }, "clientCertExpDt":{ "description":"Expiration date of the client certificate of the payment interface", "type":"string", "example":"2020-10-11" }, "clientCertPassword":{ "description":"Client Certificate password", "type":"string", "example":"passw0rd" }, "deleteCertificate":{ "description":"A flag indicating if the certificates need to be deleted. Applicable for type=20 and for SPI only", "type":"boolean", "example":false }, "hostTimeoutInSecs":{ "description":"Timeout in seconds if request is abandoned", "type":"integer", "example":180 }, "clientCertificate":{ "description":"Client Certificate object. Applicable only for type=20 and SPI", "type":"string", "example":"Cert" }, "serverCertificate":{ "description":"Server certificate object", "type":"string", "example":"Cert" }, "primaryHost":{ "description":"URL of the endpoint. Format http(s)://host:port number", "type":"string", "example":"http://url.domain.com:443" }, "securitySettings":{ "description":"Security settings for the interface", "type":"integer", "example":1 }, "serverCertCommonName":{ "description":"Common name of the Server Certificate", "type":"string", "example":"certificate" }, "serverCertEffectiveDt":{ "description":"Effective date of the server certificate", "type":"string", "example":"2020-10-11" }, "serverCertExpDt":{ "description":"Expiration date of the server certificate", "type":"string", "example":"2020-10-11T00:00:00.000Z" }, "validateXMLAgainstSchema":{ "description":"A Boolean flag indicating if the XML message is validated against schema and log errors. Applicable only for type=20 and SPI", "type":"boolean", "example":false } } } }, "dataExtensions":{ "description":"An array of data extensions for the menu item", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } }, "defaultOrderChannelObjNum":{ "description":"Object number of the order channel to remain active on the workstation, unless changed manually.", "type":"integer", "example":1 } } }, "PrintClasses":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the printer", "type":"integer", "example":1 } } }, "PrintClassv1":{ "description":"Model for Print Class Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the print class is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the print class is configured", "type":"integer", "example":26 }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "objectNum":{ "description":"Object Number of the Print Class.", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Hotline PC", "de-DE":"Hotline-PC" } }, "options":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the Print Class", "type":"string", "example":"11010101" }, "optionsExt":{ "$ref":"#/definitions/OptionsExt" }, "routingGroupObjNum":{ "description":"Select the routing group to use for each print class if Routing Group Printing is enabled.", "type":"integer", "example":3 }, "routingGroupName":{ "type":"object", "description":"Routing Group Name", "example":{ "en-US":"Routing Group", "de-DE":"Routing-Gruppe" } }, "orderDeviceOutput":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device output associated with the Print Class", "type":"string", "example":"11010101110101011101010111010101" }, "orderDeviceDisabled":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order devices associated with the Print Class", "type":"string", "example":"11010101110101011101010111010101" } } }, "PrintClassv2":{ "description":"Model for Print Class Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the print class is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the print class is configured", "type":"integer", "example":26 }, "objectNum":{ "description":"Object Number of the Print Class.", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Print Class Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "options":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the Print Class", "type":"string", "example":"11010101" }, "optionsExt":{ "$ref":"#/definitions/OptionsExt" }, "routingGroupObjNum":{ "description":"Select the routing group to use for each print class if Routing Group Printing is enabled.", "type":"integer", "example":3 }, "routingGroupName":{ "type":"object", "description":"Routing Group Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "orderDeviceOutput":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device output associated with the Print Class", "type":"string", "example":"11010101110101011101010111010101" }, "orderDeviceDisabled":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order devices associated with the Print Class", "type":"string", "example":"11010101110101011101010111010101" } } }, "OptionsExt":{ "description":"An object containing the descriptive options list associated with the Print Class", "type":"object", "example":{ "printOnCustomerReceipt":false, "printOnJournal":false, "printOnGuestCheck":false, "printInRed":false } }, "PrintClassGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Print Class objects of the organization.", "items":{ "$ref":"#/definitions/PrintClassv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "PrintClassCUDRequestBody":{ "description":"Model for Print CUD Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the print class is configured", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object Number of the Print Class.", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Hotline PC", "de-DE":"Hotline-PC" } }, "options":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the Print Class", "type":"string", "example":"11010101" }, "routingGroupObjNum":{ "description":"Select the routing group to use for each print class if Routing Group Printing is enabled.", "type":"integer", "example":3 }, "orderDeviceOutput":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device output associated with the Print Class", "type":"string", "example":"11010101110101011101010111010101" }, "orderDeviceDisabled":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order devices associated with the Print Class", "type":"string", "example":"11010101110101011101010111010101" } } }, "PrintLogosBody":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Print Logos is configured", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object Number of the Print Logos.", "type":"integer", "example":1 } } }, "PrintLogosGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Print Logo objects of the organization.", "items":{ "$ref":"#/definitions/PrintLogosResponse" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "PrintLogosResponse":{ "description":"Model for Print Logos Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Print Logos is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the Print Logos is configured", "type":"integer", "example":26 }, "hierUnitName":{ "description":"A string that contains translations of hierarchy unit name into multiple languages", "type":"object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "objectNum":{ "description":"Object Number of the Print Logos.", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Print Logos in configured languages", "type":"object", "example":{ "en-US":"Print Logos", "de-DE":"Print Logos" } }, "size":{ "description":"The size of the image in bytes.Maximum file size - 2 MB", "type":"integer", "example":1 }, "filename":{ "description":"The name of the image file, including its extension. Supported extension - .bmp", "type":"string", "example":"ImageAppetizers.bmp" }, "url":{ "description":"The URL of the download API which needs to be used to download the actual content file. This is auto generated and does not need to be provided during Add/Update API calls.", "type":"string", "example":"baseURL/content/sim/v1/orgidentifier/printLogos/{hierUnitId}/download" } } }, "PrintLogov2":{ "description":"Model for Print Logos Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Print Logos is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the Print Logos is configured", "type":"integer", "example":26 }, "objectNum":{ "description":"Object Number of the Print Logos.", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Print Logos in configured languages", "type":"object", "example":{ "1":"Print Logos", "2":"Print Logos" } }, "size":{ "description":"The size of the image in bytes.Maximum file size - 2 MB", "type":"integer", "example":1 }, "filename":{ "description":"The name of the image file, including its extension. Supported extension - .bmp", "type":"string", "example":"ImageAppetizers.bmp" }, "url":{ "description":"The URL of the download API which needs to be used to download the actual content file. This is auto generated and does not need to be provided during Add/Update API calls.", "type":"string", "example":"baseURL/content/sim/v1/orgidentifier/printLogos/{hierUnitId}/download" } } }, "PrintLogosCURequestBody":{ "description":"Model for Print Logos Object", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Print Logos is configured", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object Number of the Print Logos.", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Print Logos in configured languages", "type":"object", "example":{ "en-US":"Print Logos", "de-DE":"Print Logos" } }, "size":{ "description":"The size of the image in bytes.Maximum file size - 2 MB", "type":"integer", "example":1 }, "filename":{ "description":"The name of the image file, including its extension. Supported extension - .bmp", "type":"string", "example":"ImageAppetizers.bmp" } } }, "NutrientSet":{ "description":"Nutrient Set record", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit. Only Enterprise hierarchy is allowed.", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object number of the nutrient set.", "type":"integer", "example":10 }, "name":{ "type":"object", "description":"Name of the Nutrient Set", "example":{ "1":"Entp", "2":"Untm", "3":"Emp" } }, "nutrients":{ "type":"array", "description":"An array of nutrients belonging to the nutrient set.", "items":{ "type":"object", "description":"A nutrient belonging to the nutrient set.", "properties":{ "nutrientSetNutrientId":{ "description":"Unique Id of the nutrient.", "type":"integer", "example":101 }, "nutritionNameObjNum":{ "description":"Object number of the nutrition name.", "type":"integer", "example":8 }, "unitOfMeasure":{ "description":"An integer representing the unit of measurement for quantity.
    Unit Of MeasurementDescription
    1 Calories
    2 KiloJoules
    3 Grams
    4 Milligrams
    ", "type":"integer", "example":2 }, "quantity":{ "description":"quantity of the nutrient.", "type":"integer", "example":10 } } } } } }, "CALPackageInstallStatus":{ "description":"A model for the CAL Packages Install Status objects", "type":"object", "properties":{ "installStatusId":{ "description":"Installation status record ID", "type":"integer", "example":7000 }, "installClientId":{ "description":"Client ID. Postive values are service hosts and workstation. Negative values are Kitchen Display Clients.", "type":"integer", "example":-244 }, "workstationPlatform":{ "type":"string", "description":"Workstation platform", "example":"WIN32" }, "calPackageName":{ "type":"string", "description":"CAL package name", "example":"McrsCAL" }, "calPackageVersion":{ "type":"string", "description":"CAL package version", "example":"108.1.4.16" }, "actionTime":{ "type":"string", "description":"The record timestamp", "example":"2022-01-23T09:21:00" }, "actionType":{ "type":"string", "description":"CAL package installation stage - either \"Begin\" or \"End\"", "example":"Begin" }, "actionStatus":{ "type":"string", "description":"CAL package installation status - either \"Succeeded\" or \"Failed\"", "example":"Failed" }, "actionParam":{ "type":"integer", "description":"The offset from the beginning of the Setup.dat file in the package where the installation stopped.", "example":20 }, "dcalServiceId":{ "type":"integer", "description":"Distributed CAL service ID.", "example":540 }, "sendStatus":{ "type":"integer", "description":"Indicates if the package installation status has been sent to the Enterprise. It is either 1 (package status has been sent) or 0 (package status hasn't been sent)", "example":0 } } }, "PrinterResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the printer", "type":"integer", "example":1 } } }, "PrintersGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Printer objects of the organization.", "items":{ "$ref":"#/definitions/Printersv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "Printersv1":{ "description":"Model for the Printers object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Hierarchy unit object number", "type":"integer", "example":1 }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "objectNum":{ "description":"Object number of the Printer", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Hotline PC", "de-DE":"Hotline-PC" } }, "wsObjNum":{ "description":"Object number of the workstation to function as the print controller.", "type":"integer", "example":1 }, "wsName":{ "description":"Name of the workstation to function as the print controller.in configured languages", "type":"integer", "example":1 }, "printerType":{ "description":"The type of the printer. The value must lie between 1 and 16 (both inclusive).", "type":"integer", "example":1 }, "trailingLineFeeds":{ "description":"The number of trailing line feeds, normally used in guest check and customer receipt.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 6 representing the enablement or disablement of the options associated with the Printer", "type":"string", "example":"000000" }, "optionsExt":{ "$ref":"#/definitions/PrinterOptionsExt" }, "printerConfiguration":{ "$ref":"#/definitions/PrinterConfiguration" } } }, "Printersv2":{ "description":"Model for the Printers object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Hierarchy unit object number", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Printer", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Printer in configured languages.", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "wsObjNum":{ "description":"Object number of the workstation to function as the print controller.", "type":"integer", "example":1 }, "printerType":{ "description":"The type of the printer. The value must lie between 1 and 16 (both inclusive).", "type":"integer", "example":1 }, "trailingLineFeeds":{ "description":"The number of trailing line feeds, normally used in guest check and customer receipt.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 6 representing the enablement or disablement of the options associated with the Printer", "type":"string", "example":"000000" }, "optionsExt":{ "$ref":"#/definitions/PrinterOptionsExt" }, "printerConfiguration":{ "$ref":"#/definitions/PrinterConfiguration" } } }, "PrinterConfiguration":{ "description":"An object containing the configuration settings for the printer", "type":"object", "properties":{ "comPort":{ "description":"The COM port for the printer. Applicable only if printerType = 1 / 6 / 7 / 8 / 9/ 10 / 12 / 14", "type":"string", "example":"COM4" }, "baudRate":{ "description":"The baud rate for the printer. Applicable only if printerType = 1/ 6 / 7 / 8 / 9 / 10 / 12 / 14", "type":"integer", "example":1 }, "parity":{ "description":"The parity for the printer.0 - None 1 - Even 2 - Odd Applicable only if printerType = 1 / 6 / 7 / 8 / 9 / 10 / 12 / 14", "type":"integer", "example":1 }, "dataBits":{ "description":"The data bits for the printer. Applicable only if printerType = 1 / 6 / 7 / 8 / 9 / 10 / 12 / 14", "type":"integer", "example":8 }, "stopBits":{ "description":"The stop bits for this printer. Applicable only if printerType = 1 / 6/ / 7 / 8 / 9 / 10 / 12 / 14", "type":"integer", "example":1 }, "address":{ "description":"The IP address or hostname for the printer. If using the printer for banquet checks, enter the hostname. Applicable only if printerType = 2 / 3 / 4 / 11", "type":"string", "example":"127.0.0.0" }, "port":{ "description":"The port number for the IP printer. Applicable only if printerType = 2 / 3 / 4 / 11", "type":"integer", "example":9100 }, "centerLogoUsing":{ "description":"The appropriate paper size for the printer to center the logo. 1 - 3 (1/8) (80mm) Paper 2 - 2 (1/4) (58mm) Paper. Applicable only if printerType = 3 / 11", "type":"integer", "example":1 }, "firstPageMargins":{ "$ref":"#/definitions/FirstPageMargins" }, "otherPageMargins":{ "$ref":"#/definitions/FirstPageMargins" }, "bluetoothSettings":{ "$ref":"#/definitions/BluetoothSettings" }, "idnId":{ "description":"The IDN ID for the printer. Applicable only if printerType = 12", "type":"integer", "example":1 }, "fileName":{ "description":"The directory and file name to store the local disk file. Applicable only if printerType = 13", "type":"string", "example":"/local/config.txt" }, "oposPrinterConfig":{ "$ref":"#/definitions/OposPrinterConfig" }, "serialNumber":{ "description":"The Serial Number of S1F2 terminal. Applicable only if printerType = 16", "type":"integer", "example":"123456789012345" } } }, "BluetoothSettings":{ "description":"Bluetooth settings", "type":"object", "properties":{ "pin":{ "description":"The Bluetooth PIN of the printer.", "type":"integer", "example":1 }, "id":{ "description":"The Bluetooth ID of the printer or leave the field blank to allow configuration from a Mobile client when using different printers per event.", "type":"string", "example":"11:22:33:44:55:66" }, "numberOfColumns":{ "description":"The column width of the printer.", "type":"integer", "example":32 } } }, "OposPrinterConfig":{ "description":"An object containing the configuration settings for the OPOS Printer. Applicable only if printerType = 15", "type":"object", "properties":{ "deviceName":{ "description":"The name of the device", "type":"string", "example":"DeviceName" }, "printerColumns":{ "description":"The number of columns in the printer", "type":"integer", "example":1 }, "printerId":{ "description":"The identifier of the printer", "type":"integer", "example":1 }, "useNearEmptyAsEmpty":{ "description":"A Boolean flag indicating to use near empty as empty", "type":"boolean", "example":false }, "bufferOutput":{ "description":"A Boolean flag indicating to enable faster printing for printers other than Epson printers.", "type":"boolean", "example":false }, "bufferAllDateBeforePrint":{ "description":"A Boolean flag indicating to enable fast OPOS printing. Does not work with all printers as it depends on OPOS printing implementation.", "type":"boolean", "example":false }, "printPlainText":{ "description":"A Boolean flag indicating to remove all OPOS commands and send plain text to the printer.", "type":"boolean", "example":false } } }, "FirstPageMargins":{ "description":"An object containing the Bluetooth configuration settings for the printer. Applicable only if printerType = 4", "type":"object", "properties":{ "top":{ "description":"The top margin, in inches, for the page.", "type":"integer", "example":0 }, "bottom":{ "description":"The bottom margin, in inches, for the page.", "type":"integer", "example":0 }, "left":{ "description":"The left margin, in inches, for the page.", "type":"integer", "example":0 } } }, "PrinterOptionsExt":{ "description":"An object containing the descriptive options list associated with the Print Class", "type":"object", "example":{ "isMultiLingualCardInstalled":false, "isThermalPrinter":false, "isQuebecSRMDevice":false, "printInLowRes":false, "enableLoopPrinting":false, "isDestinationPrinter":false } }, "PrinterCUDRequestBody":{ "description":"Model for the Printer CUD Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Printer", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Hotline PC", "de-DE":"Hotline-PC" } }, "wsObjNum":{ "description":"Object number of the workstation to function as the print controller.", "type":"integer", "example":1 }, "printerType":{ "description":"The type of the printer. The value must lie between 1 and 16 (both inclusive).", "type":"integer", "example":1 }, "trailingLineFeeds":{ "description":"The number of trailing line feeds, normally used in guest check and customer receipt.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 6 representing the enablement or disablement of the options associated with the Printer", "type":"string", "example":"000000" }, "printerConfiguration":{ "$ref":"#/definitions/PrinterConfiguration" } } }, "VersionInformation":{ "description":"Model for Version Information", "type":"object", "properties":{ "simphonyEnterpriseVersion":{ "description":"Installed Simphony Enterprise Version", "type":"string", "example":"19.4.1.0.49" }, "C&CVersion":{ "description":"Configuration & Content API Cloud Service Release Version", "type":"string", "example":"23.2.0.0" } } }, "GetEnterpriseLevelsResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":1, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":false, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Enterprise Levels.", "items":{ "$ref":"#/definitions/EnterpriseLevels" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "EnterpriseLevels":{ "type":"object", "required":[ "name" ], "properties":{ "name":{ "description":"Name of enterprise level", "type":"array", "items":{ "type":"string" }, "example":"District" } } }, "WorkstationDeviceResponse":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the workstation", "type":"integer", "example":1 }, "deviceNum":{ "description":"The sequence number of the device", "type":"integer", "example":1 } } }, "WorkstationDeviceGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Workstation Device objects of the organization.", "items":{ "$ref":"#/definitions/WorkstationDevicev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "WorkstationDevicev1":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the property", "type":"integer", "example":1 }, "hierUnitName":{ "description":"name of the property in configured languages", "type":"object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "objectNum":{ "description":"Object number of the workstation", "type":"integer", "example":1 }, "name":{ "description":"name of the workstation", "type":"object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "deviceNum":{ "description":"Sequence number of the device", "type":"integer", "example":1 }, "deviceType":{ "description":"Type of the peripheral device", "type":"integer", "example":1 }, "comPort":{ "description":"COM Port of the device. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.", "type":"integer", "example":1 }, "baudRate":{ "description":"Baud Rate of the device. Allowed values - 1200, 2400, 4800, 9600, 19200, 38400. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.", "type":"integer", "example":9600 }, "parity":{ "description":"Parity of the device. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.", "type":"string", "example":"N" }, "dataBits":{ "description":"Data bits of the device. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.", "type":"integer", "example":1 }, "stopBits":{ "description":"Stop Bits of the device. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.", "type":"integer", "example":1 }, "customDeviceSettingsConfig":{ "description":"Configuration parameters of the peripheral device", "type":"string", "example":"Custom Settings" }, "customDevice":{ "description":"Device type of the custom peripheral device", "type":"integer", "example":1 }, "progId":{ "description":"Prog Id of the custom peripheral device", "type":"string", "example":"Micros.Devices.BarCodeReader.RS232" }, "configuration":{ "description":"Configuration parameters of the custom peripheral device", "type":"string", "example":"config" }, "clientCertCommonName":{ "description":"Client certificate common name of the payment interface", "type":"string", "example":"Certificate" }, "clientCertEffectiveDt":{ "description":"Client Certificate effective date of the payment interface", "type":"string", "example":"2020-10-11" }, "clientCertExpDt":{ "description":"Expiration date of the client certificate of the payment interface", "type":"string", "example":"2020-10-11" }, "clientCertPassword":{ "description":"Client Certificate password", "type":"string", "example":"password" }, "deleteCertificate":{ "description":"A flag indicating if the certificates need to be deleted. Applicable for type=20 and for SPI only.", "type":"boolean", "example":false }, "hostTimeoutInSecs":{ "description":"Timeout in seconds if request is abandoned. This is a required field for device type 20.", "type":"integer", "example":180 }, "clientCertificate":{ "description":"Client Certificate object. Applicable only for type=20 and SPI", "type":"string", "example":"Cert" }, "serverCertificate":{ "description":"Server certificate object", "type":"string", "example":"cert" }, "primaryHost":{ "description":"URL of the endpoint. Format http(s)://host:port number. This is a required field for device type 20.", "type":"string", "example":"http://url.domain.com:443" }, "securitySettings":{ "description":"Security settings for the interface. This is a required field for device type 20.", "type":"integer", "example":1 }, "serverCertCommonName":{ "description":"Common name of the Server Certificate", "type":"string", "example":"cert" }, "serverCertEffectiveDt":{ "description":"Effective date of the server certificate", "type":"string", "example":"2020-10-11" }, "serverCertExpDt":{ "description":"Expiration date of the server certificate", "type":"string", "example":"2020-10-11" }, "validateXMLAgainstSchema":{ "description":"A Boolean flag indicating if xml message is validated against schema and log errors. Applicable only for type=20 and SPI.", "type":"boolean", "example":false } } }, "WorkstationDevicev2":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the workstation", "type":"integer", "example":1 }, "deviceNum":{ "description":"Sequence number of the device", "type":"integer", "example":1 }, "deviceType":{ "description":"Type of the peripheral device", "type":"integer", "example":1 }, "comPort":{ "description":"COM Port of the device. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.", "type":"integer", "example":1 }, "baudRate":{ "description":"Baud Rate of the device. Allowed values - 1200, 2400, 4800, 9600, 19200, 38400. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.", "type":"integer", "example":9600 }, "parity":{ "description":"Parity of the device. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.", "type":"string", "example":"N" }, "dataBits":{ "description":"Data bits of the device. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.", "type":"integer", "example":1 }, "stopBits":{ "description":"Stop Bits of the device. This is a required field for the following device types - 1, 2, 3, 5, 8, 10, 12, 13, 14, 15(progId - Micros.Devices.FingerPrintReader.Opos), 16 and 17.", "type":"integer", "example":1 }, "customDeviceSettingsConfig":{ "description":"Configuration parameters of the peripheral device", "type":"string", "example":"Custom Settings" }, "customDevice":{ "description":"Device type of the custom peripheral device", "type":"integer", "example":1 }, "progId":{ "description":"Prog Id of the custom peripheral device", "type":"string", "example":"Micros.Devices.BarCodeReader.RS232" }, "configuration":{ "description":"Configuration parameters of the custom peripheral device", "type":"string", "example":"config" }, "clientCertCommonName":{ "description":"Client certificate common name of the payment interface", "type":"string", "example":"Certificate" }, "clientCertEffectiveDt":{ "description":"Client Certificate effective date of the payment interface", "type":"string", "example":"2020-10-11" }, "clientCertExpDt":{ "description":"Expiration date of the client certificate of the payment interface", "type":"string", "example":"2020-10-11" }, "clientCertPassword":{ "description":"Client Certificate password", "type":"string", "example":"password" }, "deleteCertificate":{ "description":"A flag indicating if the certificates need to be deleted. Applicable for type=20 and for SPI only.", "type":"boolean", "example":false }, "hostTimeoutInSecs":{ "description":"Timeout in seconds if request is abandoned. This is a required field for device type 20.", "type":"integer", "example":180 }, "clientCertificate":{ "description":"Client Certificate object. Applicable only for type=20 and SPI", "type":"string", "example":"Cert" }, "serverCertificate":{ "description":"Server certificate object", "type":"string", "example":"cert" }, "primaryHost":{ "description":"URL of the endpoint. Format http(s)://host:port number. This is a required field for device type 20.", "type":"string", "example":"http://url.domain.com:443" }, "securitySettings":{ "description":"Security settings for the interface. This is a required field for device type 20.", "type":"integer", "example":1 }, "serverCertCommonName":{ "description":"Common name of the Server Certificate", "type":"string", "example":"cert" }, "serverCertEffectiveDt":{ "description":"Effective date of the server certificate", "type":"string", "example":"2020-10-11" }, "serverCertExpDt":{ "description":"Expiration date of the server certificate", "type":"string", "example":"2020-10-11" }, "validateXMLAgainstSchema":{ "description":"A Boolean flag indicating if xml message is validated against schema and log errors. Applicable only for type=20 and SPI.", "type":"boolean", "example":false } } }, "WorkstationDeviceGetRequestBody":{ "description":"The input Body model that needs to be given.", "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "description":"Objects included in response", "example":"hierUnitId" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "description":"If specified, limits translated strings returned.", "example":"en-US, es-ES, es-MX" }, "hierUnitId":{ "description":"Unique hierarchy unit value of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the workstation", "type":"integer", "example":1 } } }, "OrderTypeParametersGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of language objects of the organization.", "items":{ "$ref":"#/definitions/OrderTypeParametersResourceObject" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "OrderTypeParameters_OptionsExt":{ "type":"object", "properties":{ "printOnCustomerReceiptAndCheck":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to print the Order Type name on customer receipts and guest checks." }, "printOnOrderPrinter":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to print the Order Type name on order printers." }, "enableGuesTCountByMenuItemInTransService":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to enable transaction services to count guests like POS operations." }, "dontPostTransToTipReportTotals":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to prevent posting sales for this Order Type to the Gross Receipts and Charged Receipts totals on Tip Reports." }, "performAutoComboRecognition":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to automatically perform Auto-Combo Recognition when a workstation operator changes the workstation to this Order Type." }, "transCancelDefault":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to apply this Order Type to transactions that are canceled before declaring an Order Type." }, "enableRoutingOrderByOrderType":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to control order routing by Order Type." }, "kdsAllowItemPrintOnAllPrepDone":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to allow printing a runner chit for each item in the all prep done state." }, "supressDiningCourse":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to ignore Dining Courses for orders using this Order Type." }, "forgiveInclTax":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to forgive the Inclusive Tax for eligible Menu Items, Australian GST only." }, "alwaysUseKDSPrepTime":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to suppress Menu Item Class | Options | 83 and 84." }, "hideCustomTipButton":{ "type":"boolean", "example":false, "description":"Guest Pay - disable the ability to enter custom tips" }, "hideNoTipButton":{ "type":"boolean", "example":false, "description":"Guest Pay - disable the \"No Tip\" button" }, "useAmountForTip":{ "type":"boolean", "example":false, "description":"Guest Pay - Use amounts instead of percentages for preconfigured tipping options" }, "useDynamicTip":{ "type":"boolean", "example":false, "description":"Guest Pay - Use use dynamic tipping" }, "applyOrderTypeHighlightSchemeToChitHeader":{ "type":"boolean", "example":false, "description":"Select to apply the Order Type Highlight Scheme to the entire chit header. This option bit is supported starting from Simphony version 19.9." } } }, "OrderTypeParameters_taxMaskExt":{ "type":"object", "properties":{ "taxObjNum":{ "type":"integer", "example":1, "description":"Object number of the tax that is to be masked with the Order Type." }, "mask":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to mask the tax for the order type." } } }, "OrderTypeParameters_orderDeviceMaskExt":{ "type":"object", "properties":{ "orderDeviceNum":{ "type":"integer", "example":1, "description":"Object number of the order device that is to be masked with the Order Type." }, "mask":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to mask the order device for the order type." } } }, "OrderTypeParametersResourceObject":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the Order Type Parameter" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s, representing enabled or disabled options.
    Simphony Version Length of options
    19.8.x 16
    19.9.x 24
    " }, "optionsExt":{ "$ref":"#/definitions/OrderTypeParameters_OptionsExt" }, "taxMask":{ "type":"string", "example":"1000000000000000000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 64 representing the enablement or disablement of the tax mask associated with the Order Type parameter" }, "taxMaskExt":{ "$ref":"#/definitions/OrderTypeParameters_taxMaskExt" }, "active":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating the order type is active" }, "orderDeviceMask":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device mask associated with the Order Type parameter" }, "orderDeviceMaskExt":{ "$ref":"#/definitions/OrderTypeParameters_orderDeviceMaskExt" }, "kdsHighlightSchemeObjNum":{ "type":"integer", "example":0, "description":"Object number of the KDS Highlight Scheme to use for the order type parameter" }, "kdsHighlightSchemeName":{ "type":"object", "description":"KDS Highlight Scheme Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "slaTime":{ "type":"integer", "example":0, "description":"Service Level Agreement Time" }, "tipPercent1":{ "type":"integer", "example":10, "description":"Guest Pay - Suggested Tip Percentage 1. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false." }, "tipPercent2":{ "type":"integer", "example":15, "description":"Guest Pay - Suggested Tip Percentage 2. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false." }, "tipPercent3":{ "type":"integer", "example":5, "description":"Guest Pay - Suggested Tip Percentage 3. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false." }, "tipAmount1":{ "type":"number", "example":21.22, "description":"Guest Pay - Suggested Tip Amount 1. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true." }, "tipAmount2":{ "type":"number", "example":4.87, "description":"Guest Pay - Suggested Tip Amount 2. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true." }, "tipAmount3":{ "type":"number", "example":51.11, "description":"Guest Pay - Suggested Tip Amount 3. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true." } } }, "OrderTypeParametersv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the Order Type Parameter" }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s, representing enabled or disabled options.
    Simphony Version Length of options
    19.8.x 16
    19.9.x 24
    " }, "optionsExt":{ "$ref":"#/definitions/OrderTypeParameters_OptionsExt" }, "taxMask":{ "type":"string", "example":"1000000000000000000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 64 representing the enablement or disablement of the tax mask associated with the Order Type parameter" }, "taxMaskExt":{ "$ref":"#/definitions/OrderTypeParameters_taxMaskExt" }, "active":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating the order type is active" }, "orderDeviceMask":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device mask associated with the Order Type parameter" }, "orderDeviceMaskExt":{ "$ref":"#/definitions/OrderTypeParameters_orderDeviceMaskExt" }, "kdsHighlightSchemeObjNum":{ "type":"integer", "example":0, "description":"Object number of the KDS Highlight Scheme to use for the order type parameter" }, "slaTime":{ "type":"integer", "example":0, "description":"Service Level Agreement Time" }, "tipPercent1":{ "type":"integer", "example":10, "description":"Guest Pay - Suggested Tip Percentage 1. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false." }, "tipPercent2":{ "type":"integer", "example":15, "description":"Guest Pay - Suggested Tip Percentage 2. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false." }, "tipPercent3":{ "type":"integer", "example":5, "description":"Guest Pay - Suggested Tip Percentage 3. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false." }, "tipAmount1":{ "type":"number", "example":21.22, "description":"Guest Pay - Suggested Tip Amount 1. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true." }, "tipAmount2":{ "type":"number", "example":4.87, "description":"Guest Pay - Suggested Tip Amount 2. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true." }, "tipAmount3":{ "type":"number", "example":51.11, "description":"Guest Pay - Suggested Tip Amount 3. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true." }, "guestCheckHeaderObjNum":{ "type":"integer", "example":2, "description":"Object Number of check header descriptor. It is available from Simphony version 19.8 and above." }, "guestCheckTrailerObjNum":{ "type":"integer", "example":2, "description":"Object Number of check trailer descriptor. It is available from Simphony version 19.8 and above." }, "receiptHeaderObjNum":{ "type":"integer", "example":2, "description":"Object Number of receipt header descriptor. It is available from Simphony version 19.8 and above." }, "defaultOrderChannelObjNum":{ "type":"integer", "example":2, "description":"Object Number of order channel. It is available from Simphony version 19.8 and above." } } }, "OrderTypeParameterCUDRequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the Order Type Parameter" }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s, representing enabled or disabled options.
    Simphony Version Length of options
    19.8.x 16
    19.9.x 24
    " }, "taxMask":{ "type":"string", "example":"1000000000000000000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 64 representing the enablement or disablement of the tax mask associated with the Order Type parameter" }, "active":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating the order type is active" }, "orderDeviceMask":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device mask associated with the Order Type parameter" }, "kdsHighlightSchemeObjNum":{ "type":"integer", "example":0, "description":"Object number of the KDS Highlight Scheme to use for the order type parameter" }, "kdsHighlightSchemeName":{ "type":"object", "description":"KDS Highlight Scheme Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "slaTime":{ "type":"integer", "example":0, "description":"Service Level Agreement Time" }, "tipPercent1":{ "type":"integer", "example":10, "description":"Guest Pay - Suggested Tip Percentage 1. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false." }, "tipPercent2":{ "type":"integer", "example":15, "description":"Guest Pay - Suggested Tip Percentage 2. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false." }, "tipPercent3":{ "type":"integer", "example":5, "description":"Guest Pay - Suggested Tip Percentage 3. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is false." }, "tipAmount1":{ "type":"number", "example":21.22, "description":"Guest Pay - Suggested Tip Amount 1. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true." }, "tipAmount2":{ "type":"number", "example":4.87, "description":"Guest Pay - Suggested Tip Amount 2. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true." }, "tipAmount3":{ "type":"number", "example":51.11, "description":"Guest Pay - Suggested Tip Amount 3. If set to 0, Guest Pay will not display the button. Used when useAmountForTip is true." } } }, "OrderTypeParameterResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the Order Type Parameter" } } }, "OrderTypeParameterDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "TextFileConfiguration":{ "description":"Model for Text File Configuration Object", "type":"object", "properties":{ "langId":{ "description":"Unique identifier of the language.", "type":"integer", "example":1 }, "baseFileName":{ "description":"Base File Name of the Text File Configuration.", "type":"string", "example":"Micros.Payment.Cash" }, "fileType":{ "description":"File Type of the Text File Configuration.", "type":"integer", "example":3 } } }, "OrderChannelParametersGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Order Channel Parameter objects of the organization.", "items":{ "$ref":"#/definitions/OrderChannelParametersResourceObject" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "OrderChannelParameters_OptionsExt":{ "type":"object", "properties":{ "printOnCustomerReceiptAndCheck":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to print the Order Channel name on customer receipts and guest checks." }, "printOnOrderPrinter":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to print the Order Channel name on order printers." }, "enableRoutingOrderByOrderChannel":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to control order routing by Order Channel." } } }, "OrderChannelParameters_orderDeviceMaskExt":{ "type":"object", "properties":{ "orderDeviceNum":{ "type":"integer", "example":1, "description":"Object number of the order device that is to be masked with the Order Channel." }, "mask":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to mask the order device for the order channel." } } }, "OrderChannelParametersResourceObject":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"A string that contains translations of hierarchy unit name into multiple languages", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Order Channel Parameter" }, "name":{ "type":"object", "description":"A string that contains translations into multiple languages\n", "example":{ "en-US":"Order Channel", "de-DE":"Bestellkanal", "es-MX":"Canal de pedidos" } }, "orderChannelId":{ "type":"integer", "example":1, "description":"Unique reference of the Order Channel" }, "options":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing enabled or disabled options" }, "optionsExt":{ "$ref":"#/definitions/OrderChannelParameters_OptionsExt" }, "active":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating the order channel is active" }, "orderDeviceMask":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device mask associated with the Order Channel parameter" }, "orderDeviceMaskExt":{ "$ref":"#/definitions/OrderChannelParameters_orderDeviceMaskExt" } } }, "OrderChannelParametersv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Order Channel Parameter" }, "orderChannelId":{ "type":"integer", "example":1, "description":"Unique reference of the Order Channel" }, "options":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing enabled or disabled options" }, "optionsExt":{ "$ref":"#/definitions/OrderChannelParameters_OptionsExt" }, "active":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating the order channel is active" }, "guestCheckHeaderObjNum":{ "type":"integer", "example":2, "description":"Object Number of check header descriptor. It is available from Simphony version 19.8 and above." }, "guestCheckTrailerObjNum":{ "type":"integer", "example":2, "description":"Object Number of check trailer descriptor. It is available from Simphony version 19.8 and above." }, "receiptHeaderObjNum":{ "type":"integer", "example":2, "description":"Object Number of receipt header descriptor. It is available from Simphony version 19.8 and above." }, "slaTime":{ "type":"integer", "example":10, "description":"Service Level Agreement Time. Allowed values are from 0-999. It is available from Simphony version 19.8 and above." }, "orderDeviceMask":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device mask associated with the Order Channel parameter" }, "orderDeviceMaskExt":{ "$ref":"#/definitions/OrderChannelParameters_orderDeviceMaskExt" } } }, "OrderChannelParameterCUResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Order Channel Parameter" } } }, "OrderChannelParameterDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted", "description":"A message depicting the number of records deleted" } } }, "DefaultCondimentGetRequestBody":{ "type":"object", "required":[ "hierUnitId", "miMstrObjNum", "miDefSequence" ], "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." }, "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "miMstrObjNum":{ "type":"integer", "example":1, "description":"Object Number of the menu item master for which the condiments are associated." }, "miDefSequence":{ "type":"integer", "example":1, "description":"Sequence number of the menu item definition to which the condiments are associated" } } }, "defaultcondimentGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of default condiment objects of the organization.", "items":{ "$ref":"#/definitions/defaultcondimentResponseBodyv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "MenuItemDefinitionDefaultCondimentv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "miMstrObjNum":{ "type":"integer", "example":1, "description":"Object Number of the menu item master for which the condiments are associated." }, "miDefSequence":{ "type":"integer", "example":1, "description":"Sequence number of the menu item definition to which the condiments are associated" }, "menuItemDefaultCondimentId":{ "type":"integer", "example":1000, "description":"Unique reference of the Menu Item Default Condiment" }, "condimentSetObjNum":{ "type":"integer", "example":1, "description":"Object number of the Condiment Set items that are to be assigned as the default condiments when the associated Menu Item is ordered." }, "sortGroup":{ "type":"integer", "example":1, "description":"Sort Group number for the Condiment Set." }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment set associated with the menu item" }, "optionsExt":{ "$ref":"#/definitions/defaultcondiment_optionsExt" } }, "description":"Model for a Default Condiment Object" }, "defaultcondimentResponseBodyv1":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "miMstrObjNum":{ "type":"integer", "example":1, "description":"Object Number of the menu item master for which the condiments are associated." }, "miDefSequence":{ "type":"integer", "example":1, "description":"Sequence number of the menu item definition to which the condiments are associated" }, "menuItemDefaultCondimentId":{ "type":"integer", "example":1000, "description":"Unique reference of the Menu Item Default Condiment" }, "condimentSetObjNum":{ "type":"integer", "example":1, "description":"Object number of the Condiment Set items that are to be assigned as the default condiments when the associated Menu Item is ordered." }, "sortGroup":{ "type":"integer", "example":1, "description":"Sort Group number for the Condiment Set." }, "condimentSetName":{ "type":"object", "description":"Condiment Set Name", "example":{ "en-US":"Condiment Set Items", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment set associated with the menu item" }, "optionsExt":{ "$ref":"#/definitions/defaultcondiment_optionsExt" } }, "description":"Model for a Default Condiment Object" }, "DefaultCondimentResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "miMstrObjNum":{ "type":"integer", "example":1, "description":"Object Number of the menu item master for which the condiments are associated." }, "miDefSequence":{ "type":"integer", "example":1, "description":"Sequence number of the menu item definition to which the condiments are associated" }, "menuItemDefaultCondimentId":{ "type":"integer", "example":1000, "description":"Unique reference of the Menu Item Default Condiment" } } }, "defaultcondiment_optionsExt":{ "type":"object", "description":"An object containing the descriptive options list associated with the default condiments of the menu item definition. This value is excluded by default in GET response.", "properties":{ "displayWhenInDefaultState":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to display the condiments in default state" }, "chargeForEntireSalesCount":{ "type":"boolean", "example":false, "description":"A Boolean flag indicating to charge for the guests for entire condiment count" } } }, "DefaultCondimentDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "MenuItemGroupDetailGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Group Detail objects of the organization.", "items":{ "$ref":"#/definitions/MenuItemGroupDetailResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "MenuItemGroupDetailResponsev1":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "menuItemGroupObjNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "seq":{ "type":"integer", "example":1, "description":"Sequence number of the Menu Item Group Detail entry. Value must lie between 1 and 32767." }, "exclude":{ "type":"boolean", "example":false, "description":"Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not active" } } }, "MenuItemGroupDetailResponsev2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "menuItemGroupObjNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "seq":{ "type":"integer", "example":1, "description":"Sequence number of the Menu Item Group Detail entry. Value must lie between 1 and 32767." }, "type":{ "type":"integer", "example":1, "description":"Group type to include or exclude for the Menu Item Group Detail entry\n\n**Below is a list of accetable values for this field**\n| # | Type Description|\n|---------------|-----------------|\n| 0 | None |\n| 1 | All |\n| 2 | By Major Group |\n| 3 | By Family Group |\n| 4 | By Menu Item |\n" }, "exclude":{ "type":"boolean", "example":false, "description":"Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not active" }, "startObjNum":{ "type":"integer", "example":1, "description":"Starting object number for the selected type" }, "endObjNum":{ "type":"integer", "example":100, "description":"Ending object number for the selected type" }, "overridePricePercent":{ "type":"number", "example":10.5, "description":"Indicates the amount off, percent off, or amount substitution based on the discount configuration. This is only active for Group Type 1- Discount when exclude is set to false." } } }, "MenuItemGroupDetailUpdateResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "menuItemGroupObjNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "seq":{ "type":"integer", "example":1, "description":"Sequence number of the Menu Item Group Detail entry. Value must lie between 1 and 32767." }, "exclude":{ "type":"boolean", "example":false, "description":"Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not active" } } }, "DeleteRequestBody":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Currency Conversion", "type":"integer", "example":1 } } }, "CurrencyConversionGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Currency Conversion objects of the organization.", "items":{ "$ref":"#/definitions/CurrencyConversionResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "CurrencyConversionResponsev1":{ "description":"Model for Currency Conversion Object", "type":"object", "properties":{ "objectNum":{ "description":"Object number of the currency conversion.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Currency Conversion is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the Currency Conversion is configured", "type":"integer", "example":26 }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "currencyObjectNum":{ "description":"Object number of the currency.", "type":"integer", "example":31 }, "currencyName":{ "type":"object", "description":"Currency Name", "example":{ "en-US":"USD Dollar", "de-DE":"USD-Dollar" } }, "conversionCurrencyObjectNum":{ "description":"Object number of the conversion currency.", "type":"integer", "example":31 }, "conversionCurrencyName":{ "type":"object", "description":"Conversion Currency Name", "example":{ "en-US":"USD Dollar", "de-DE":"USD-Dollar" } }, "rate":{ "description":"Rate of conversion between currency and conversion currency", "type":"number", "example":1.3 } } }, "CurrencyConversionv2":{ "description":"Model for Currency Conversion Object", "type":"object", "properties":{ "objectNum":{ "description":"Object number of the currency conversion.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Currency Conversion is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the Currency Conversion is configured", "type":"integer", "example":26 }, "currencyObjectNum":{ "description":"Object number of the currency.", "type":"integer", "example":31 }, "conversionCurrencyObjectNum":{ "description":"Object number of the conversion currency.", "type":"integer", "example":31 }, "rate":{ "description":"Rate of conversion between currency and conversion currency", "type":"number", "example":1.3 } } }, "CurrencyAvailabilityCUResponseBody":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Currency Availability", "type":"integer", "example":1 } } }, "CurrencyAvailabilityGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Currency Availability objects of the organization.", "items":{ "$ref":"#/definitions/CurrencyAvailabilityResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "CurrencyAvailabilityResponsev1":{ "description":"Model for Currency Availability Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":26 }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "objectNum":{ "description":"Object number of the currency availability.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currency availability", "type":"string", "example":"11010101" }, "currencyObjectNum":{ "description":"Object number of the currency.", "type":"integer", "example":1 }, "currencyName":{ "type":"object", "description":"Currency Name", "example":{ "en-US":"USD Dollar", "de-DE":"USD-Dollar" } }, "optionsExt":{ "$ref":"#/definitions/CurrencyAvailabilityOptionsExt" } } }, "CurrencyAvailabilityv2":{ "description":"Model for Currency Availability Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":26 }, "objectNum":{ "description":"Object number of the currency availability.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currency availability", "type":"string", "example":"11010101" }, "currencyObjectNum":{ "description":"Object number of the currency.", "type":"integer", "example":1 }, "optionsExt":{ "$ref":"#/definitions/CurrencyAvailabilityOptionsExt" } } }, "CurrencyAvailabilityOptionsExt":{ "description":"An object containing the descriptive options list associated with the currency availability.", "type":"object", "properties":{ "issueChangeInOtherCurrency":{ "type":"boolean", "example":false, "description":"Select to issue change in any other currency" }, "promptForIssuingChange":{ "type":"boolean", "example":false, "description":"Select if change in other currency is needed" }, "roundCurrency":{ "type":"boolean", "example":false, "description":"Select to round value in currency" }, "roundToNearestZero":{ "type":"boolean", "example":false, "description":"Select if value is to be rounded off to nearest zero" }, "roundToSecondLeastSignificantDigit":{ "type":"boolean", "example":false, "description":"Select if value is to be rounded off to second least significant digit" } } }, "RequestDetails":{ "description":"Model for the Get Status", "type":"object", "required":[ "requestId" ], "properties":{ "requestId":{ "description":"Unique reference of the clone request.", "type":"integer", "example":1 } } }, "CreateCloneRequest":{ "description":"Model for Create Clone Config", "type":"object", "required":[ "cloneName" ], "properties":{ "cloneName":{ "description":"A user-friendly name for the clone configuration for the organization. This should be unique per organization.", "type":"string", "example":"MyClone" } } }, "CreateCloneResponse":{ "description":"Model for Create Clone Response Object", "type":"object", "properties":{ "requestId":{ "description":"Unique reference of the clone request. This attribute can be used to track the status of the clone request.", "type":"integer", "example":1 }, "requestTimeStampUTC":{ "description":"The time stamp in UTC format for when the request was submitted.", "type":"string", "example":"2022-10-10T00:00:00" } } }, "ImportCloneResponse":{ "description":"Response body for import clone.", "type":"object", "properties":{ "requestId":{ "description":"Unique reference of the clone request. This attribute can be used to track the status of the clone request.", "type":"integer", "example":1 }, "requestTimeStampUTC":{ "description":"The time stamp in UTC format for when the request was submitted.", "type":"string", "example":"2022-10-10T00:00:00" } } }, "GetCloneStatusResponse":{ "description":"Model for Get Clone Status Response", "type":"object", "properties":{ "id":{ "description":"The unique identifier of the request.", "type":"integer", "example":1 }, "currDateTimeUTC":{ "description":"The current date time of the system in the UTC format.", "type":"string", "example":"2022-01-23T09:00:00" }, "requestedDatetimeUTC":{ "description":"The date time when the clone request was submitted in UTC format.", "type":"string", "example":"2022-01-23T09:00:00" }, "status":{ "description":"Status of the clone request. 1- Queued 2- In Progress 3- Completed 4- Failed", "example":3, "type":"integer" }, "expectedEndDateTimeUTC":{ "description":"The expected date and time for the request to be completed.", "type":"string", "example":"2022-01-23T09:21:00" }, "actualEndDateTimeUTC":{ "description":"The actual end date and time when the clone request was completed in UTC Format.", "type":"string", "example":"2022-01-23T09:21:00" }, "posDBVersion":{ "description":"The version of the Simphony POS database for which the clone was created.", "type":"string", "example":34001 }, "configFileURL":{ "description":"The pre-authenticated URL of the object store from where the configuration can be cloned.", "type":"string", "example":"https://objectstore. oracle.com/files/1" }, "errorMsg":{ "description":"The error details if the clone process failed.", "type":"string", "example":"Validation Failed" } } }, "GetAvailableCloneResponse":{ "description":"Model for Get Available Clone Response", "type":"object", "properties":{ "cloneName":{ "description":"A user-friendly name for the clone configuration for the organization. This should be unique per organization.", "type":"string", "example":"MyClone" }, "actualEndDateTimeUTC":{ "description":"The actual end date time when the clone request was completed in UTC Format.", "type":"string", "example":"2022-01-23T09:21:00" }, "currDateTimeUTC":{ "description":"Current Date and Time in UTC Format", "type":"string", "example":"2022-01-23T09:21:00" }, "requestedDateTimeUTC":{ "description":"The date and time when clone request was made in UTC Format", "type":"string", "example":"2022-01-23T09:21:00" }, "posDBVersion":{ "description":"The version of the Simphony POS database for which the clone was created.", "type":"string", "example":34001 }, "configFileURL":{ "description":"The pre-authenticated URL of the object store from where the configuration can be cloned.", "type":"string", "example":"https://objectstore. oracle.com/files/1" } } }, "TagGroupsGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Tag Group objects of the organization.", "items":{ "$ref":"#/definitions/TagGroups" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "TagGroups":{ "description":"Model for Tag Groups Object", "type":"object", "properties":{ "objectNum":{ "description":"Object Number of the Tag Groups.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Tag Groups is configured. Only root hierUnitId is allowed.", "type":"integer", "example":3599 }, "tagGroupName":{ "description":"A string representing the name of the Tag Group", "type":"string", "example":"Tag Group 1" } } }, "TagGroupsResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value. Only enterprise hierUnitId is allowed", "example":1 }, "objectNum":{ "description":"Object number of the tag groups", "type":"integer", "example":1 } } }, "MenuItemGroup":{ "type":"object", "required":[ "objectNum", "hierUnitId", "name" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "name":{ "type":"object", "description":"A string that contains translations into multiple languages", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "groupType":{ "type":"integer", "example":1, "description":"Group Type of Menu Item Group" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"A group of string objects representing the name of the hierarchy unit configured languages", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "thresholdQty":{ "type":"integer", "example":2, "description":"Specifies the threshold quantity for applying overriden tax class" }, "taxClassObjNum":{ "type":"integer", "example":2, "description":"Specifies the tax class override for the threshold quantity" }, "detail":{ "type":"array", "description":"An array of menu items to be included/excluded in the defined group", "items":{ "type":"object", "properties":{ "seq":{ "type":"integer", "example":1, "description":"Sequence number of the Menu Item Group Detail entry" }, "type":{ "type":"integer", "example":1, "description":"Group type to include or exclude for the Menu Item Group Detail entry\n\n**Below is a list of accetable values for this field**\n| # | Type Description|\n|---------------|-----------------|\n| 0 | None |\n| 1 | All |\n| 2 | By Major Group |\n| 3 | By Family Group |\n| 4 | By Menu Item |\n" }, "exclude":{ "type":"boolean", "example":false, "description":"Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not active" }, "startObjNum":{ "type":"integer", "example":1, "description":"Starting object number for the selected type" }, "endObjNum":{ "type":"integer", "example":100, "description":"Ending object number for the selected type" }, "overridePricePercent":{ "type":"number", "example":10.5, "description":"Indicates the amount off, percent off, or amount substitution based on the discount configuration. This is only active for Group Type 1- Discount when exclude is set to false." } } } } } }, "MenuItemGroupGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Group objects of the organization.", "items":{ "$ref":"#/definitions/MenuItemGroupResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "MenuItemGroupResponsev1":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "name":{ "type":"object", "description":"A string that contains translations into multiple languages", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "groupType":{ "type":"integer", "example":1, "description":"Group Type of Menu Item Group" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"A group of string objects representing the name of the hierarchy unit configured languages", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "thresholdQty":{ "type":"integer", "example":2, "description":"Specifies the threshold quantity for applying overriden tax class" }, "taxClassObjNum":{ "type":"integer", "example":2, "description":"Specifies the tax class override for the threshold quantity" }, "detail":{ "type":"array", "description":"An array of menu items to be included/excluded in the defined group", "items":{ "type":"object", "properties":{ "seq":{ "type":"integer", "example":1, "description":"Sequence number of the Menu Item Group Detail entry" }, "type":{ "type":"integer", "example":1, "description":"Group type to include or exclude for the Menu Item Group Detail entry\n\n**Below is a list of accetable values for this field**\n| # | Type Description|\n|---------------|-----------------|\n| 0 | None |\n| 1 | All |\n| 2 | By Major Group |\n| 3 | By Family Group |\n| 4 | By Menu Item |\n" }, "exclude":{ "type":"boolean", "example":false, "description":"Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not active" }, "startObjNum":{ "type":"integer", "example":1, "description":"Starting object number for the selected type" }, "endObjNum":{ "type":"integer", "example":100, "description":"Ending object number for the selected type" }, "overridePricePercent":{ "type":"number", "example":10.5, "description":"Indicates the amount off, percent off, or amount substitution based on the discount configuration. This is only active for Group Type 1- Discount when exclude is set to false." } } } } } }, "MenuItemGroupv2":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "name":{ "type":"object", "description":"A string that contains translations into multiple languages", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "groupType":{ "type":"integer", "example":1, "description":"Group Type of Menu Item Group" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "thresholdQty":{ "type":"integer", "example":2, "description":"Specifies the threshold quantity for applying overriden tax class" }, "taxClassObjNum":{ "type":"integer", "example":2, "description":"Specifies the tax class override for the threshold quantity" }, "detail":{ "type":"array", "description":"An array of menu items to be included/excluded in the defined group", "items":{ "type":"object", "properties":{ "seq":{ "type":"integer", "example":1, "description":"Sequence number of the Menu Item Group Detail entry" }, "type":{ "type":"integer", "example":1, "description":"Group type to include or exclude for the Menu Item Group Detail entry\n\n**Below is a list of accetable values for this field**\n| # | Type Description|\n|---------------|-----------------|\n| 0 | None |\n| 1 | All |\n| 2 | By Major Group |\n| 3 | By Family Group |\n| 4 | By Menu Item |\n" }, "exclude":{ "type":"boolean", "example":false, "description":"Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not active" }, "startObjNum":{ "type":"integer", "example":1, "description":"Starting object number for the selected type" }, "endObjNum":{ "type":"integer", "example":100, "description":"Ending object number for the selected type" }, "overridePricePercent":{ "type":"number", "example":10.5, "description":"Indicates the amount off, percent off, or amount substitution based on the discount configuration. This is only active for Group Type 1- Discount when exclude is set to false." } } } } } }, "MenuItemGroupCUDRequestBody":{ "type":"object", "required":[ "objectNum", "hierUnitId", "name" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "name":{ "type":"object", "description":"A string that contains translations into multiple languages", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "groupType":{ "type":"integer", "example":1, "description":"Group Type of Menu Item Group" }, "thresholdQty":{ "type":"integer", "example":2, "description":"Specifies the threshold quantity for applying overriden tax class" }, "taxClassObjNum":{ "type":"integer", "example":2, "description":"Specifies the tax class override for the threshold quantity" }, "detail":{ "type":"array", "description":"An array of menu items to be included/excluded in the defined group", "items":{ "type":"object", "properties":{ "seq":{ "type":"integer", "example":1, "description":"Sequence number of the Menu Item Group Detail entry" }, "type":{ "type":"integer", "example":1, "description":"Group type to include or exclude for the Menu Item Group Detail entry\n\n**Below is a list of accetable values for this field**\n| # | Type Description|\n|---------------|-----------------|\n| 0 | None |\n| 1 | All |\n| 2 | By Major Group |\n| 3 | By Family Group |\n| 4 | By Menu Item |\n" }, "exclude":{ "type":"boolean", "example":false, "description":"Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not active" }, "startObjNum":{ "type":"integer", "example":1, "description":"Starting object number for the selected type" }, "endObjNum":{ "type":"integer", "example":100, "description":"Ending object number for the selected type" }, "overridePricePercent":{ "type":"number", "example":10.5, "description":"Indicates the amount off, percent off, or amount substitution based on the discount configuration. This is only active for Group Type 1- Discount when exclude is set to false." } } } } } }, "MenuItemGroupResponse":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" } } }, "MenuItemMasterGroup":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "name":{ "type":"object", "description":"A string that contains translations into multiple languages\n", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "hierUnitObjNum":{ "type":"integer", "example":2, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"A string that contains translations into multiple languages\n", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "sluObjNum":{ "type":"integer", "example":4, "description":"Associated SLU index. Valid range is between 1 and 32. By default, it is null." } } }, "MenuItemMasterGroupGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Master Group objects of the organization.", "items":{ "$ref":"#/definitions/MenuItemMasterGroupResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "MenuItemMasterGroupResponsev1":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "name":{ "type":"object", "description":"A string that contains translations into multiple languages\n", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "hierUnitObjNum":{ "type":"integer", "example":2, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"A string that contains translations into multiple languages\n", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "sluObjNum":{ "type":"integer", "example":4, "description":"Associated SLU index. Valid range is between 1 and 32. By default, it is null." } } }, "MenuItemMasterGroupResponsev2":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "name":{ "type":"object", "description":"A string that contains translations into multiple languages\n", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "hierUnitObjNum":{ "type":"integer", "example":2, "description":"Object number of the hierarchy unit" }, "sluObjNum":{ "type":"integer", "example":4, "description":"Associated SLU index. Valid range is between 1 and 32. By default, it is null." } } }, "MenuItemMasterGroupCUDRequestBody":{ "type":"object", "required":[ "objectNum", "hierUnitId", "name" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "name":{ "type":"object", "description":"A string that contains translations into multiple languages\n", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "sluObjNum":{ "type":"integer", "example":4, "description":"Associated SLU index. Valid range is between 1 and 32. By default, it is null." } } }, "MenuItemMasterGroupResponse":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master group object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" } } }, "SPICertificateResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the workstation" }, "deviceNum":{ "type":"integer", "example":1, "description":"Sequence number of the device" } } }, "TenderMediaResponse":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the tender media", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"Effectivity Group object number", "type":"integer", "example":1 } } }, "TenderMediaCURequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the tender media", "type":"integer", "example":1 }, "name":{ "description":"Tender Media name", "type":"object", "example":{ "en-US":"Order Device 1", "es-MX":"Dispositivo de pedido 1" } }, "effGrpObjNum":{ "description":"Effectivity Group object number", "type":"integer", "example":1 }, "consumerDisplayName":{ "description":"Consumer Display Name", "type":"object", "example":{ "en-US":"Order Device 1", "es-MX":"Dispositivo de pedido 1" } }, "privilegeGroup":{ "description":"Select a privilege group (0-3) to restrict this Tender/Media to only employees who are assigned to the same privilege group. Set to 0 to allow all employees to use the tender.", "type":"integer", "example":1 }, "reportGroupObjnum":{ "description":"Object number of the Report Group to which this Tender/Media record belongs.", "type":"integer", "example":1 }, "printClassObjNum":{ "description":"Object number of the Print Class for the Tender Media.", "type":"integer", "example":1 }, "belowThresholdPrintClassObjNum":{ "description":"Object number of the Print Class for the Tender Media when the check total amount is less than the RVC Order Routing Threshold Amount, in this case it will override the Print Class of the Tender Media.", "type":"integer", "example":1 }, "tmSLUNum":{ "description":"Object number the Screen Lookup key on which to show the Tender/Media.Applicable only for keyType = 2 / 3 / 4", "type":"integer", "example":1 }, "nlu":{ "description":"A unique NLU number (0-255) for this Tender/Media record", "type":"integer", "example":1 }, "keyType":{ "description":"The Key Type for this Tender/Media. 1 - Payment 2 - Service Total 3 - Pickup 4 - Loan. The default value for keyType is 1.", "type":"integer", "example":1 }, "srmPaymentType":{ "description":"The SRM Payment Type for the Tender/Media 0 - None 1 - ARG 2 - CRE 3 - DEB 4 - AUT 5 - PKG", "type":"integer", "example":1 }, "printOptions":{ "description":"A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the print options associated with Tender Media", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "interfaceOptions":{ "description":"An object containing the interface link and options associated with the Tender / Media", "type":"object", "properties":{ "interfaceLinkNum":{ "description":"Object number of the interface", "type":"integer", "example":1 }, "options":{ "description":"A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the interface options associated with Tender Media", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" } } }, "creditCardOptions":{ "description":"An object containing the credit card options associated with the Tender / Media", "type":"object", "properties":{ "estimatedTipPercent":{ "description":"The percentage amount (above the check amount) to authorize. Use this field to obtain an authorization that includes the potential tip amount. Override this setting at the revenue center by selecting Do Not Estimate Tips of Credit Card Authorizations.", "type":"number", "example":0 }, "baseLimit":{ "description":"The amount that can be charged on a credit card before sending an authorization request to a credit card processor.", "type":"number", "example":0 }, "secondLimit":{ "description":"The amount above the initial authorization that must be exceeded before a second authorization is required. You must also select the credit card option Use Amount Secondary Floor Limits in the RVC Parameters module", "type":"number", "example":0 }, "secondLimitPercent":{ "description":"The percentage above the initial authorization amount that must be exceeded before a second authorization is required. You must also select the credit card option Use Percent Secondary Floor Limits in the RVC Parameters module.", "type":"number", "example":0 }, "initialAuthAmt":{ "description":"A charge amount to be authorized before sales begin. Enter 0.00 to prompt for an amount. This field is used at sites that require a credit card to have a certain amount available, so the workstation operator can begin a tab.", "type":"number", "example":0 }, "offlineEstTipPercent":{ "description":"The percentage amount (above the check amount) to authorize. Use this field to obtain an authorization that includes the potential tip amount. Override this setting at the revenue center by selecting Do Not Estimate Tips of Credit Card Authorizations.", "type":"number", "example":0 }, "unAuthorizedAuthThreshold":{ "description":"The limit for which credit cards are considered to have a good authorization when the workstation is offline. When this limit is exceeded, only employees with the Role privilege to exceed the threshold can pay transactions.", "type":"number", "example":0 }, "caOfflineLimit":{ "description":"The limit for which credit cards are considered to have a good authorization when the credit card service is offline. You must also select Use CA Offline Base Limit when CA Offline in the RVC Parameters module", "type":"number", "example":0 }, "noSignatureLimit":{ "description":"the amount to be charged on a credit card before a voucher includes a signature line.", "type":"number", "example":0 }, "quickServiceLimit":{ "description":"The amount that is checked by the system to determine if credit card vouchers are printed or not if Quick Service Transactions are enabled for an RVC (RVC Parameters Option 18 Enable Quick Service Transactions),. If the check total on the transaction is higher than the number in this field, a credit card voucher prints.", "type":"number", "example":0 }, "options":{ "description":"A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the credit card options associated with Tender Media", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "preambles":{ "description":"An array of preambles defined for the tender/ media.", "properties":{ "start":{ "description":"a preamble number for the credit card. If the preamble record defines a range (3050 to 3090), this field represents the begin range (3050*). The start field cannot be empty, and will only have numeric characters followed by a single * character.", "type":"string", "example":"3050*" }, "end":{ "description":"the end range of a preamble number for the credit card. If the preamble record defines a range (3050 to 3090), this field represents the end range (3090*). The end field, if specified, will only have numeric characters followed by a single * character. The length of start and end fields should be same. Value of start field has to be strictly lower than value of end field.", "type":"string", "example":"3090*" }, "length":{ "description":"the number of digits in the credit card number that is associated with the preamble record. If the length field is specified, then both start and end fields' length before * should be less than or equal to the specified value of length field.", "type":"integer", "example":4 } } } } }, "exemptTaxes":{ "description":"A string value of 0s and 1s of length 64 representing tax rates", "type":"string", "example":"0000000000000000000000000000000000000000000000000000000000000000" }, "opsOptions":{ "description":"A string value of 0s and 1s of length 128 representing POS client behavior options", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "holdType":{ "description":"the Hold Type for the tender 0 - Fire Order 1 - Keep Hold Status 2 - Hold Order", "type":"integer", "example":1 }, "svcObjNum":{ "description":"Object Number of the service charge to post charged tips. Use this field with Charge Payment keys (Credit Cards and Room Charges).", "type":"integer", "example":1 }, "paymentChargeTipOptions":{ "description":"A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the payment charge tip options associated with Tender Media", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "miscOptions":{ "description":"An array of miscellaneous options associated with the tender media", "type":"object", "properties":{ "haloCode":{ "description":"the High Amount Lock Out value for the Tender/Media. The value must contain all zeroes except for the first digit.", "type":"integer", "example":1 }, "defaultTipPercent":{ "description":"The percentage amount to which the tip screen (on Signature Capture pads) defaults when using the Tender/Media.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s and 1s of length 128 representing Miscellaneous options", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" } } }, "menuLevels":{ "description":"An object containing the menu levels on which the Tender / Media is active", "type":"object", "properties":{ "mainLevel":{ "description":"A string value of 0s and 1s of length 8 representing Main Levels", "type":"string", "example":"00001011" }, "sublevel":{ "description":"A string value of 0s and 1s of length 8 representing Sub levels", "type":"string", "example":"00001011" } } }, "transDefaultMainLevel":{ "description":"return the transaction to the default transaction Main Level after pressing this Tender/Media", "type":"boolean", "example":false }, "mainLevelPopup":{ "description":"The Main Level that becomes active after pressing this Tender/Media. Enable Transaction Default to return the transaction to the default Main Level, select 0-Stay Down to retain the current transaction levels, or select a level 1-8 to become active.", "type":"integer", "example":1 }, "transDefaultSubLevel":{ "description":"return the transaction to the default transaction Sub Level after pressing this Tender/Media.", "type":"boolean", "example":false }, "subLevelPopup":{ "description":"The Sub Level that becomes active after pressing this Tender/Media. Enable Transaction Default to return the transaction to the default Sub Level, select 0-Stay Down to retain the current transaction levels, or select a level 1-8 to become active", "type":"integer", "example":1 }, "dataExtensions":{ "description":"An array of data extensions for the tender / media", "type":"object", "properties":{ "columnName":{ "description":"Name of the extention field", "type":"string", "example":"Extention Column 1" }, "value":{ "description":"Value of the extention field", "type":"string", "example":"Value 1" } } }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" } } }, "TenderMediaResponsev1":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Hierarchy unit object number", "type":"integer", "example":1 }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "objectNum":{ "description":"Object number of the tender media", "type":"integer", "example":1 }, "name":{ "description":"Name", "type":"object", "example":{ "en-US":"Order Device 1", "es-MX":"Dispositivo de pedido 1" } }, "transDefaultMainLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Main Level after pressing the discount", "type":"boolean", "example":false }, "mainLevelPopup":{ "description":"The Main Level that activates after pressing the discount", "type":"integer", "example":1 }, "subLevelPopup":{ "description":"The Sub Level that activates after pressing the discount", "type":"integer", "example":1 }, "transDefaultSubLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Sub Level after pressing the discount.", "type":"boolean", "example":false }, "effGrpObjNum":{ "description":"Effectivity Group object number", "type":"integer", "example":1 }, "effGrpName":{ "description":"Effectivity group name", "type":"object", "example":{ "en-US":"Effectivity Group 1", "es-MX":"Grupo de efectividad 1" } }, "consumerDisplayName":{ "description":"Consumer Display Name", "type":"object", "example":{ "en-US":"Order Device 1", "es-MX":"Dispositivo de pedido 1" } }, "privilegeGroup":{ "description":"Select a privilege group (0-3) to restrict this Tender/Media to only employees who are assigned to the same privilege group. Set to 0 to allow all employees to use the tender.", "type":"integer", "example":1 }, "reportGroupObjnum":{ "description":"Object number of the Report Group to which this Tender/Media record belongs.", "type":"integer", "example":1 }, "reportGroupName":{ "type":"object", "description":"Report Group Name", "example":{ "en-US":"Routing Group", "de-DE":"Routing-Gruppe" } }, "printClassObjNum":{ "description":"Object number of the Print Class for the Tender Media.", "type":"integer", "example":1 }, "printClassName":{ "type":"object", "description":"Print Class Name", "example":{ "en-US":"Hotline PC", "de-DE":"Hotline-PC" } }, "belowThresholdPrintClassObjNum":{ "description":"Object number of the Print Class for the Tender Media when the check total amount is less than the RVC Order Routing Threshold Amount, in this case it will override the Print Class of the Tender Media.", "type":"integer", "example":1 }, "belowThresholdPrintClassObjName":{ "type":"object", "description":"Below Threshold Print Class Object Name", "example":{ "en-US":"Hotline PC", "de-DE":"Hotline-PC" } }, "tmSLUObjNum":{ "description":"Object number the Screen Lookup key on which to show the Tender/Media.Applicable only for keyType = 2 / 3 / 4", "type":"integer", "example":1 }, "tmSLUObjName":{ "type":"object", "description":"Tender Media SLU Object Name", "example":{ "en-US":"Hotline PC", "de-DE":"Hotline-PC" } }, "nlu":{ "description":"A unique NLU number (0-255) for this Tender/Media record", "type":"integer", "example":1 }, "keyType":{ "description":"The Key Type for this Tender/Media. 1 - Payment 2 - Service Total 3 - Pickup 4 - Loan. The default value for keyType is 1.", "type":"integer", "example":1 }, "srmPaymentType":{ "description":"The SRM Payment Type for the Tender/Media 0 - None 1 - ARG 2 - CRE 3 - DEB 4 - AUT 5 - PKG", "type":"integer", "example":1 }, "printOptions":{ "description":"A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the print options associated with Tender Media", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "printOptionsExt":{ "description":"An object containing the descriptive print option list for the Tender Media", "type":"object", "properties":{ "validationRequired":{ "description":"A Boolean flag indicating to print a validation chit when using this key", "type":"boolean", "example":false }, "printCustomerReceipt":{ "description":"A Boolean flag indicating to cause this key to force the printing of a customer receipt. Customer receipts do not print in revenue centers where the On Demand Customer Receipts option is enabled", "type":"boolean", "example":false }, "printMemoChecks":{ "description":"A Boolean flag indicating to allow this key to print memo checks.", "type":"boolean", "example":false }, "incrementActiveSeatAfterPrint":{ "description":"A Boolean flag indicating to increment the active seat number or active memo check number to the next number each time this key is used to print. This allows the workstation operator to tender, in succession, all seat checks or memo checks active for one transaction. Use this option with seat filtering or memo checks, and when a single seat is active in the filter of the current guest check.", "type":"boolean", "example":false }, "printSalesItemizers":{ "description":"A Boolean flag indicating to print sales itemizer lines on checks, receipts, and memo checks when using this Tender/Media. You must also select 21 - Print Summary Totals. Sales itemizer lines include the sales itemizer name and the sales itemizer total.", "type":"boolean", "example":false }, "printSummaryTotals":{ "description":"A Boolean flag indicating to print summary totals (subtotal, tax, amount due, and change due) on checks, receipts, and memo checks when using this key.", "type":"boolean", "example":false }, "printCheckTrailer":{ "description":"A Boolean flag indicating to print trailer lines at the end of the check.", "type":"boolean", "example":false }, "printCheckOnDemand":{ "description":"A Boolean flag indicating to print the check when tendered with this key (required for on-demand operators).", "type":"boolean", "example":false }, "printInclTaxOrVATLines":{ "description":"A Boolean flag indicating to print inclusive tax or VAT lines on the guest check or customer receipt.", "type":"boolean", "example":false }, "printCheckTrailerOnFastTransCustReciept":{ "description":"A Boolean flag indicating to print the trailer on the receipt when using the tender to close a fast transaction. This option is unaffected by the setting of the Print Check Trailer option", "type":"boolean", "example":false }, "sendPrintCheckMsgtoTMSOnFinalTenderOnly":{ "description":"A Boolean flag indicating to send a Print Check message to the TMS on a final tender only. For use with the PROHOST Table Management System.", "type":"boolean", "example":false }, "promptOperatortoSendPrintCheckMsg":{ "description":"A Boolean flag indicating to send a Print Check message to the TMS. For use with the PROHOST Table Management System.", "type":"boolean", "example":false }, "print2ChecksOrReceipts":{ "description":"A Boolean flag indicating to print two checks or receipts for the Tender/Media. For use when credit card authorization vouchers print on a thermal printer", "type":"boolean", "example":false }, "promptFor2ChecksOrReceipts":{ "description":"A Boolean flag that indicates whether or not to prompt to confirm printing two checks or receipts when using this Tender/Media. Commonly used when credit card authorization vouchers print on a thermal printer.", "type":"boolean", "example":false }, "reprintOrders":{ "description":"A Boolean flag that indicates whether or not to reprint orders to the order printers for this Tender/Media. For use when a kitchen printer stops and an order is lost.", "type":"boolean", "example":false }, "notAllowedWithIncompleteMeals":{ "description":"A Boolean flag that indicates whether or not to allow this tender for meals with a placeholder item.", "type":"boolean", "example":false }, "printBanquetChecks":{ "description":"A Boolean flag that indicates whether or not to print a banquet check..", "type":"boolean", "example":false } } }, "interfaceOptions":{ "description":"An object containing the interface link and options associated with the Tender / Media", "type":"object", "properties":{ "interfaceLinkNum":{ "description":"Object number of the interface", "type":"integer", "example":1 }, "interfaceLinkName":{ "type":"object", "description":"Interface Link Name", "example":{ "en-US":"Effectivity Group 1", "es-MX":"Grupo de efectividad 1" } }, "options":{ "description":"A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the interface options associated with Tender Media", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "optionsExt":{ "description":"An object containing the descriptive interface option list for the Tender Media", "type":"object", "properties":{ "post0TransactionsToPMS":{ "description":"A Boolean flag indicating to post 0.00 transactions to the interface for this tender.", "type":"boolean", "example":false }, "printPMSResponseAndPostingMsg":{ "description":"A Boolean flag indicating to print the PMS Response and the Posting Message on checks.", "type":"boolean", "example":false }, "doPMSAndCCUse19Digits":{ "description":"A Boolean flag indicating to allow a 19-digit reference entry for PMS posting or a 19-digit account number for credit cards.", "type":"boolean", "example":false }, "postAmtTenderedToPMS":{ "description":"A Boolean flag indicating to post the gross amount tendered by this key to the PMS. This also exempts the specific tax type when using the Tender/Media.", "type":"boolean", "example":false }, "useISLTMedProcedureInsteadOfPMS":{ "description":"A Boolean flag indicating to use the Tender/Media key to initiate an Interface Script Language (ISL) procedure instead of a PMS posting. Deselect if using a standard PMS interface.", "type":"boolean", "example":false }, "reversePMSItmzrOnVoidPostings":{ "description":"A Boolean flag indicating to reverse the itemizers sent to the PMS when posting the Tender/Media as a void. You must also select Partial Tender Not Allowed.", "type":"boolean", "example":false }, "switchToAlternateTendersIfPMSTimeout":{ "description":"A Boolean flag indicating to search for an alternate tender when an attempted PMS posting times out. If a PMS posting times out, the system searches for another Tender/Media with the same NLU number as the first, and posts to that key instead. When the system posts to an alternate Tender/Media key after a PMS timeout, the alternate Tender/Media uses the Key Type and Output options of the original Tender/Media. If an establishment wants the alternate key to follow its own Key Type and Output options, a SIM script can be written to redefine these fields for the alternate Tender/Media. If the posting required credit authorization, previous CA entries change to reflect the new Tender/Media.", "type":"boolean", "example":false } } } } }, "creditCardOptions":{ "description":"An object containing the credit card options associated with the Tender / Media", "type":"object", "properties":{ "estimatedTipPercent":{ "description":"The percentage amount (above the check amount) to authorize. Use this field to obtain an authorization that includes the potential tip amount. Override this setting at the revenue center by selecting Do Not Estimate Tips of Credit Card Authorizations.", "type":"number", "example":0 }, "baseLimit":{ "description":"The amount that can be charged on a credit card before sending an authorization request to a credit card processor.", "type":"number", "example":0 }, "secondLimit":{ "description":"The amount above the initial authorization that must be exceeded before a second authorization is required. You must also select the credit card option Use Amount Secondary Floor Limits in the RVC Parameters module", "type":"number", "example":0 }, "secondLimitPercent":{ "description":"The percentage above the initial authorization amount that must be exceeded before a second authorization is required. You must also select the credit card option Use Percent Secondary Floor Limits in the RVC Parameters module.", "type":"number", "example":0 }, "initialAuthAmt":{ "description":"A charge amount to be authorized before sales begin. Enter 0.00 to prompt for an amount. This field is used at sites that require a credit card to have a certain amount available, so the workstation operator can begin a tab.", "type":"number", "example":0 }, "offlineEstTipPercent":{ "description":"The percentage amount (above the check amount) to authorize. Use this field to obtain an authorization that includes the potential tip amount. Override this setting at the revenue center by selecting Do Not Estimate Tips of Credit Card Authorizations.", "type":"number", "example":0 }, "unAuthorizedAuthThreshold":{ "description":"The limit for which credit cards are considered to have a good authorization when the workstation is offline. When this limit is exceeded, only employees with the Role privilege to exceed the threshold can pay transactions.", "type":"number", "example":0 }, "caOfflineLimit":{ "description":"The limit for which credit cards are considered to have a good authorization when the credit card service is offline. You must also select Use CA Offline Base Limit when CA Offline in the RVC Parameters module", "type":"number", "example":0 }, "noSignatureLimit":{ "description":"the amount to be charged on a credit card before a voucher includes a signature line.", "type":"number", "example":0 }, "quickServiceLimit":{ "description":"The amount that is checked by the system to determine if credit card vouchers are printed or not if Quick Service Transactions are enabled for an RVC (RVC Parameters Option 18 Enable Quick Service Transactions),. If the check total on the transaction is higher than the number in this field, a credit card voucher prints.", "type":"number", "example":0 }, "options":{ "description":"A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the credit card options associated with Tender Media", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "optionsExt":{ "description":"An object containing the descriptive credit card option list for the Tender Media", "type":"object", "properties":{ "useWithCCRecall":{ "description":"A Boolean flag indicating to allow this key to use the Credit Card Recall feature. Credit Card Recall is not used with Credit Authorization.", "type":"boolean", "example":false }, "checkCCExpirationDate":{ "description":"A Boolean flag indicating to compare the date entered in the system clock with the expiration date of credit cards presented for payment. Expired credit cards are not accepted for payment. If using a magnetic card reader, the credit card date is entered automatically when the card is read; otherwise, the workstation operator must enter the expiration date. Deselect for tendering keys that do not check expiration dates.", "type":"boolean", "example":false }, "ccValidatyTest":{ "description":"A Boolean flag indicating to use the Mod-10 algorithm to test for a valid credit card number.", "type":"boolean", "example":false }, "requireCreditAuthBeforeServiceTtl":{ "description":"A Boolean flag indicating to require payment submittal to a credit card processor for approval when using the CA/EDC option. This option also prints a credit authorization voucher, unless the Do Not Print Credit Card Voucher option is set.", "type":"boolean", "example":false }, "dontPrintCCVoucher":{ "description":"A Boolean flag indicating to suppress printing of a credit card voucher when the Require Credit Authorization option is selected. Use this option with a Personal Check tender type and a check authorization system. A voucher is usually not needed in this situation as the guest's signature is on the check.", "type":"boolean", "example":false }, "requireCCStartDate":{ "description":"A Boolean flag indicating to enable the start date prompt for the EAME credit card driver.", "type":"boolean", "example":false }, "requireAVSOnManualEntry":{ "description":"A Boolean flag indicating to require Address Verification Service (AVS) entry when manually entering a credit card number.", "type":"boolean", "example":false }, "requireAVSOnAutoSwipe":{ "description":"A Boolean flag indicating to require Address Verification Service (AVS) entry when swiping a credit card.", "type":"boolean", "example":false }, "requireAVSMustBeFullAddress":{ "description":"A Boolean flag indicating to require the cardholder's full address with Address Verification Service (AVS). Deselect to prompt for the cardholder's 5-digit zip code.", "type":"boolean", "example":false }, "requireCVVOnManualEntry":{ "description":"A Boolean flag indicating to require Card Verification Value (CVV) entry or card present number entry when manually entering a credit card number.", "type":"boolean", "example":false }, "requireCVVOnAutoSwipe":{ "description":"A Boolean flag indicating to require Card Verification Value (CVV) entry or card present number entry when swiping a credit card.", "type":"boolean", "example":false }, "enableQuickServiceTransactions":{ "description":"A Boolean flag indicating to authorize a credit card without printing a voucher (in revenue centers that allow Quick Service Transactions), when the check total is under the amount set in the Quick Service Limit field", "type":"boolean", "example":false }, "enablePartialAuth":{ "description":"A Boolean flag indicating if the card supports prepaid credit cards. This allows a partial authorization when the remaining card balance is less than the requested authorization amount.", "type":"boolean", "example":false }, "enableTokenPosting":{ "description":"A Boolean flag indicating to post token information to the reporting database for credit card transactions with the TV2G driver.", "type":"boolean", "example":false } } }, "preambles":{ "description":"An array of preambles defined for the tender/ media.", "properties":{ "start":{ "description":"a preamble number for the credit card. If the preamble record defines a range (3050 to 3090), this field represents the begin range (3050*). The start field cannot be empty, and will only have numeric characters followed by a single * character.", "type":"string", "example":"3050*" }, "end":{ "description":"the end range of a preamble number for the credit card. If the preamble record defines a range (3050 to 3090), this field represents the end range (3090*). The end field, if specified, will only have numeric characters followed by a single * character. The length of start and end fields should be same. Value of start field has to be strictly lower than value of end field.", "type":"string", "example":"3090*" }, "length":{ "description":"the number of digits in the credit card number that is associated with the preamble record. If the length field is specified, then both start and end fields' length before * should be less than or equal to the specified value of length field.", "type":"integer", "example":4 } } } } }, "exemptTaxes":{ "description":"A string value of 0s and 1s of length 64 representing tax rates", "type":"string", "example":"0000000000000000000000000000000000000000000000000000000000000000" }, "exemptTaxesExt":{ "description":"Exempted Tax Rates", "type":"object", "properties":{ "taxRate1":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 1 is exempted" }, "taxRate2":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 2 is exempted" }, "taxRate3":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 3 is exempted" }, "taxRate4":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 4 is exempted" }, "taxRate5":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 5 is exempted" }, "taxRate6":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 6 is exempted" }, "taxRate7":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 7 is exempted" }, "taxRate8":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 8 is exempted" }, "taxRate9":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 9 is exempted" }, "taxRate10":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 10 is exempted" }, "taxRate11":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 11 is exempted" }, "taxRate12":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 12 is exempted" }, "taxRate13":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 13 is exempted" }, "taxRate14":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 14 is exempted" }, "taxRate15":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 15 is exempted" }, "taxRate16":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 16 is exempted" }, "taxRate17":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 17 is exempted" }, "taxRate18":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 18 is exempted" }, "taxRate19":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 19 is exempted" }, "taxRate20":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 20 is exempted" }, "taxRate21":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 21 is exempted" }, "taxRate22":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 22 is exempted" }, "taxRate23":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 23 is exempted" }, "taxRate24":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 24 is exempted" }, "taxRate25":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 25 is exempted" }, "taxRate26":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 26 is exempted" }, "taxRate27":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 27 is exempted" }, "taxRate28":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 28 is exempted" }, "taxRate29":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 29 is exempted" }, "taxRate30":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 30 is exempted" }, "taxRate31":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 31 is exempted" }, "taxRate32":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 32 is exempted" }, "taxRate33":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 33 is exempted" }, "taxRate34":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 34 is exempted" }, "taxRate35":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 35 is exempted" }, "taxRate36":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 36 is exempted" }, "taxRate37":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 37 is exempted" }, "taxRate38":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 38 is exempted" }, "taxRate39":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 39 is exempted" }, "taxRate40":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 40 is exempted" }, "taxRate41":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 41 is exempted" }, "taxRate42":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 42 is exempted" }, "taxRate43":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 43 is exempted" }, "taxRate44":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 44 is exempted" }, "taxRate45":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 45 is exempted" }, "taxRate46":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 46 is exempted" }, "taxRate47":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 47 is exempted" }, "taxRate48":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 48 is exempted" }, "taxRate49":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 49 is exempted" }, "taxRate50":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 50 is exempted" }, "taxRate51":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 51 is exempted" }, "taxRate52":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 52 is exempted" }, "taxRate53":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 53 is exempted" }, "taxRate54":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 54 is exempted" }, "taxRate55":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 55 is exempted" }, "taxRate56":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 56 is exempted" }, "taxRate57":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 57 is exempted" }, "taxRate58":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 58 is exempted" }, "taxRate59":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 59 is exempted" }, "taxRate60":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 60 is exempted" }, "taxRate61":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 61 is exempted" }, "taxRate62":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 62 is exempted" }, "taxRate63":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 63 is exempted" }, "taxRate64":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 64 is exempted" } } }, "isTaxExemptCoupon":{ "description":"use this Tender/Media key to forgive the appropriate amount of tax according to the amount entered for this tender and the amount due on the check.", "type":"boolean", "example":true }, "opsOptions":{ "description":"A string value of 0s and 1s of length 128 representing POS client behavior options", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "opsOptionsExt":{ "description":"Expanded POS client behavior options", "type":"object", "properties":{ "openCashDrawer":{ "description":"Open the cash drawer when pressing this key. This option is ignored if you select Open Drawer Only if Balance Due is 0.00 for the revenue center. Override these settings for transactions that do not change the transaction balance from 0.00, by selecting Do Not Open Drawer if Subtotal is 0.00 for the revenue center.", "type":"boolean", "example":true }, "isAmountRequired":{ "description":"require an amount when using this tender. When pressing this tender button without entering an amount, the workstation prompts, Enter [Tender] Amount. If you deselect this option and select Assume Paid in Full, the tender is used for 0.00, unless the workstation operator enters an amount before pressing the tender key.", "type":"boolean", "example":true }, "assumePaidInFull":{ "description":"record the exact amount due as the entry. You must also deselect Amount Required. If you deselect both this option and Amount Required, the system records 0.00 as the entry.", "type":"boolean", "example":true }, "useWithCurrencyConversion":{ "description":"post payment amounts entered through a currency key to this payment key", "type":"boolean", "example":true }, "referenceEntryRequired":{ "description":"A boolean value to determine whether or not a reference entry is required when using this key.", "type":"boolean", "example":true }, "dontAllowPartialTender":{ "description":"prevent the Tender/Media from being used to partially tender a transaction.", "type":"boolean", "example":true }, "roundTenderToNextHighestNumber":{ "description":"round the Tender/Media up to the next-highest whole number amount. You must also select Assume Paid in Full.", "type":"boolean", "example":true }, "roundChangeDue":{ "description":"accept payments to the exact amount and to round change due. This overrides option 87-Rounded Payments and Change. If you select 88-Round Payments and Change To the Nearest 0, the least significant decimal digit is rounded to 0 or 10. Deselect option 88 to round the least significant decimal digit to 0 or 5.", "type":"boolean", "example":true }, "dontIncludeSVCWhileProratingTender":{ "description":"for tax exempt coupon tenders that exclude service charges, but prorate other sales itemizers when applying a tax exempt coupon to the transaction. Deselect to prorate the comp amount equally between the sales itemizers and the service charge.", "type":"boolean", "example":true }, "roundPaymentsAndChange":{ "description":"round change due resulting from an overtender. If you deselect 88-Round Payments and Change To the Nearest 0, the least significant decimal digit rounds to 0 or 5. If you select option 88, the least significant decimal digit rounds to 0 or 10.", "type":"boolean", "example":true }, "roundPaymentsAndChangeToNearest0":{ "description":"round payments and change to the nearest 0 or 10. You must also select 56-Round Change Due or 87-Rounded Payments and Change.", "type":"boolean", "example":true }, "roundtoSecondLastSignificantDigit":{ "description":"round payments and change to the nearest 50 or 100 (depending on the setting of option 88). You must also select 56-Round Change Due or 87-Rounded Payments and Change.", "type":"boolean", "example":true }, "roundChangeChangeDueDown":{ "description":"round the change due down instead of up if rounding has been enabled and the unrounded change due is exactly half of the rounding number.", "type":"boolean", "example":true }, "maskAccountNumber":{ "description":"mask the account number (gift card number or other reference entry) on workstations, checks, and receipts. For use with tenders that do not require credit card authorizations.", "type":"boolean", "example":true }, "promptForReason":{ "description":"prompt for a tender usage reason.", "type":"boolean", "example":true }, "exemptAutoSVC":{ "description":"exempt the automatic service charge when pressing this key, and to print an X near the tender key line on checks, receipts, and the journal.", "type":"boolean", "example":true }, "isEmployeeMeal":{ "description":"post transaction amounts tendered with this key to the Employee Meal totals on reports. This requires entry of an employee number or ID representing the employee eating the meal. You must also set On = Use Employee Number with Employee Meal; Off = Use ID Number to determine whether the employee number or ID is used", "type":"boolean", "example":true }, "useForStoredValueTransaction":{ "description":"use the Tender/Media for stored value transactions", "type":"boolean", "example":true }, "mealAppliesToScheduledEmployeesOnly":{ "description":"use the Tender/Media as an employee meal for employees scheduled to work. You must use timekeeping and select the Employee Meal tender option. Deselect to ignore the time schedule before applying the Tender/Media", "type":"boolean", "example":true }, "mealAppliesToEmployeesOnBreakOnly":{ "description":"use the Tender/Media as an employee meal for employees on breaks. You must use timekeeping and select the Employee Meal tender option. Deselect to ignore the time schedule before applying the Tender/Media", "type":"boolean", "example":true }, "notAllowedWithIncompleteMeals":{ "description":"disallow this tender for meals with a placeholder item", "type":"boolean", "example":true }, "isCMTransactionItem":{ "description":"include the tender in Cash Management tracking and reporting", "type":"boolean", "example":true }, "affectsCashPullThreshold":{ "description":"have transactions performed for this tender affect the Cash Pull Threshold Sets balance. Set this option only for tenders that present a loss if lost or stolen", "type":"boolean", "example":true }, "isItemShareable":{ "description":"allow the Tender/Media to be shared between two or more seats, or two or more checks when using Touch Split or Touch Edit", "type":"boolean", "example":true } } }, "holdType":{ "description":"the Hold Type for the tender 0 - Fire Order 1 - Keep Hold Status 2 - Hold Order", "type":"integer", "example":1 }, "svcObjNum":{ "description":"Object Number of the service charge to post charged tips. Use this field with Charge Payment keys (Credit Cards and Room Charges).", "type":"integer", "example":1 }, "svcName":{ "type":"object", "description":"SVC Name", "example":{ "en-US":"Order Device 1", "es-MX":"Dispositivo de pedido 1" } }, "paymentChargeTipOptions":{ "description":"A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the payment charge tip options associated with Tender Media", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "paymentChargeTipOptionsExt":{ "description":"An object containing the descriptive payment charge tip option list for the Tender Media", "type":"object", "properties":{ "ChargedTipRequired":{ "description":"Cause the system to assume that overpayment of the amount due is a Charged Tip", "type":"boolean", "example":false }, "postAmtToGrossReceiptsOnTipReports":{ "description":"is Amount is posted to gross receipts on tip reports", "type":"boolean", "example":false }, "postAmtToChargedReceiptsOnTipReports":{ "description":"if Amount is posted to charged receipts on tip reports", "type":"boolean", "example":false }, "chargedTipMustBeLessThanPmt":{ "description":"Checking if charged tip is less than pmt.", "type":"boolean", "example":false } } }, "miscOptions":{ "description":"An array of miscellaneous options associated with the tender media", "type":"object", "properties":{ "haloCode":{ "description":"the High Amount Lock Out value for the Tender/Media. The value must contain all zeroes except for the first digit.", "type":"integer", "example":1 }, "defaultTipPercent":{ "description":"The percentage amount to which the tip screen (on Signature Capture pads) defaults when using the Tender/Media.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s and 1s of length 128 representing Miscellaneous options", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "optionsExt":{ "description":"Expanded Miscellaneous options", "type":"object", "properties":{ "enableHALO":{ "description":"enable the High Amount Lock Out for this Tender/Media.", "type":"boolean", "example":false }, "useHALOOnAmtEntered":{ "description":"compute the HALO for this Tender/Media on the amount entered. You must also select Enable HALO. Deselect to apply the HALO to the overtender amount. Set the HALO Code to 0 and deselect this option to prevent the workstation operator from issuing change for this Tender/Media.", "type":"boolean", "example":false }, "printQubecSRMDuplicate":{ "description":"print a receipt (without a barcode) for the merchant when using this tender. Use this option with the Quebec SRM Printer.", "type":"boolean", "example":false } } } } }, "menuLevels":{ "description":"An object containing the menu levels on which the Tender / Media is active", "type":"object", "properties":{ "mainLevel":{ "description":"A string value of 0s and 1s of length 8 representing Main Levels", "type":"string", "example":"00001011" }, "mainLevelExt":{ "description":"Main level descriptions", "type":"object", "properties":{ "mainLevel1":{ "description":"if the Tender / Media is active at main level 1", "type":"boolean", "example":false }, "mainLevel2":{ "description":"if the Tender / Media is active at main level 2", "type":"boolean", "example":false }, "mainLevel3":{ "description":"if the Tender / Media is active at main level 3", "type":"boolean", "example":false }, "mainLevel4":{ "description":"if the Tender / Media is active at main level 4", "type":"boolean", "example":false }, "mainLevel5":{ "description":"if the Tender / Media is active at main level 5", "type":"boolean", "example":false }, "mainLevel6":{ "description":"if the Tender / Media is active at main level 6", "type":"boolean", "example":false }, "mainLevel7":{ "description":"if the Tender / Media is active at main level 7", "type":"boolean", "example":false }, "mainLevel8":{ "description":"if the Tender / Media is active at main level 8", "type":"boolean", "example":false } } }, "sublevel":{ "description":"A string value of 0s and 1s of length 8 representing Sub levels", "type":"string", "example":"00001011" }, "sublevelExt":{ "description":"Sub levels names", "type":"object", "properties":{ "subLevel1":{ "description":"if the Tender / Media is active at sub level 1", "type":"boolean", "example":false }, "subLevel2":{ "description":"if the Tender / Media is active at sub level 2", "type":"boolean", "example":false }, "subLevel3":{ "description":"if the Tender / Media is active at sub level 3", "type":"boolean", "example":false }, "subLevel4":{ "description":"if the Tender / Media is active at sub level 4", "type":"boolean", "example":false }, "subLevel5":{ "description":"if the Tender / Media is active at sub level 5", "type":"boolean", "example":false }, "subLevel6":{ "description":"if the Tender / Media is active at sub level 6", "type":"boolean", "example":false }, "subLevel7":{ "description":"if the Tender / Media is active at sub level 7", "type":"boolean", "example":false }, "subLevel8":{ "description":"if the Tender / Media is active at sub level 8", "type":"boolean", "example":false } } }, "transDefaultMainLevel":{ "description":"return the transaction to the default transaction Main Level after pressing this Tender/Media", "type":"boolean", "example":false }, "mainLevelPopup":{ "description":"The Main Level that becomes active after pressing this Tender/Media. Enable Transaction Default to return the transaction to the default Main Level, select 0-Stay Down to retain the current transaction levels, or select a level 1-8 to become active.", "type":"integer", "example":1 }, "transDefaultSubLevel":{ "description":"return the transaction to the default transaction Sub Level after pressing this Tender/Media.", "type":"boolean", "example":false }, "subLevelPopup":{ "description":"The Sub Level that becomes active after pressing this Tender/Media. Enable Transaction Default to return the transaction to the default Sub Level, select 0-Stay Down to retain the current transaction levels, or select a level 1-8 to become active", "type":"integer", "example":1 } } }, "dataExtensions":{ "description":"An array of data extensions for the tender / media", "type":"object", "properties":{ "columnName":{ "description":"Name of the extention field", "type":"string", "example":"Extention Column 1" }, "value":{ "description":"Value of the extention field", "type":"string", "example":"Value 1" } } }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" } } }, "TenderMediaGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of tender media objects of the organization.", "items":{ "$ref":"#/definitions/TenderMediaResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "TenderMediav2":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Hierarchy unit object number", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the tender media", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Tender Media in configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "effGrpObjNum":{ "description":"Effectivity Group object number", "type":"integer", "example":1 }, "consumerDisplayName":{ "description":"A group of string objects representing the consumer display name of the Tender Media in configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "privilegeGroup":{ "description":"Select a privilege group (0-3) to restrict this Tender/Media to only employees who are assigned to the same privilege group. Set to 0 to allow all employees to use the tender.", "type":"integer", "example":1 }, "reportGroupObjnum":{ "description":"Object number of the Report Group to which this Tender/Media record belongs.", "type":"integer", "example":1 }, "printClassObjNum":{ "description":"Object number of the Print Class for the Tender Media.", "type":"integer", "example":1 }, "belowThresholdPrintClassObjNum":{ "description":"Object number of the Print Class for the Tender Media when the check total amount is less than the RVC Order Routing Threshold Amount, in this case it will override the Print Class of the Tender Media.", "type":"integer", "example":1 }, "tmSLUObjNum":{ "description":"Object number the Screen Lookup key on which to show the Tender/Media.Applicable only for keyType = 2 / 3 / 4", "type":"integer", "example":1 }, "nlu":{ "description":"A unique NLU number (0-255) for this Tender/Media record", "type":"integer", "example":1 }, "keyType":{ "description":"The Key Type for this Tender/Media. 1 - Payment 2 - Service Total 3 - Pickup 4 - Loan. The default value for keyType is 1.", "type":"integer", "example":1 }, "srmPaymentType":{ "description":"The SRM Payment Type for the Tender/Media 0 - None 1 - ARG 2 - CRE 3 - DEB 4 - AUT 5 - PKG", "type":"integer", "example":1 }, "printOptions":{ "description":"A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the print options associated with Tender Media", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "printOptionsExt":{ "description":"An object containing the descriptive print option list for the Tender Media", "type":"object", "properties":{ "validationRequired":{ "description":"A Boolean flag indicating to print a validation chit when using this key", "type":"boolean", "example":false }, "printCustomerReceipt":{ "description":"A Boolean flag indicating to cause this key to force the printing of a customer receipt. Customer receipts do not print in revenue centers where the On Demand Customer Receipts option is enabled", "type":"boolean", "example":false }, "printMemoChecks":{ "description":"A Boolean flag indicating to allow this key to print memo checks.", "type":"boolean", "example":false }, "incrementActiveSeatAfterPrint":{ "description":"A Boolean flag indicating to increment the active seat number or active memo check number to the next number each time this key is used to print. This allows the workstation operator to tender, in succession, all seat checks or memo checks active for one transaction. Use this option with seat filtering or memo checks, and when a single seat is active in the filter of the current guest check.", "type":"boolean", "example":false }, "printSalesItemizers":{ "description":"A Boolean flag indicating to print sales itemizer lines on checks, receipts, and memo checks when using this Tender/Media. You must also select 21 - Print Summary Totals. Sales itemizer lines include the sales itemizer name and the sales itemizer total.", "type":"boolean", "example":false }, "printSummaryTotals":{ "description":"A Boolean flag indicating to print summary totals (subtotal, tax, amount due, and change due) on checks, receipts, and memo checks when using this key.", "type":"boolean", "example":false }, "printCheckTrailer":{ "description":"A Boolean flag indicating to print trailer lines at the end of the check.", "type":"boolean", "example":false }, "printCheckOnDemand":{ "description":"A Boolean flag indicating to print the check when tendered with this key (required for on-demand operators).", "type":"boolean", "example":false }, "printInclTaxOrVATLines":{ "description":"A Boolean flag indicating to print inclusive tax or VAT lines on the guest check or customer receipt.", "type":"boolean", "example":false }, "printCheckTrailerOnFastTransCustReciept":{ "description":"A Boolean flag indicating to print the trailer on the receipt when using the tender to close a fast transaction. This option is unaffected by the setting of the Print Check Trailer option", "type":"boolean", "example":false }, "sendPrintCheckMsgtoTMSOnFinalTenderOnly":{ "description":"A Boolean flag indicating to send a Print Check message to the TMS on a final tender only. For use with the PROHOST Table Management System.", "type":"boolean", "example":false }, "promptOperatortoSendPrintCheckMsg":{ "description":"A Boolean flag indicating to send a Print Check message to the TMS. For use with the PROHOST Table Management System.", "type":"boolean", "example":false }, "print2ChecksOrReceipts":{ "description":"A Boolean flag indicating to print two checks or receipts for the Tender/Media. For use when credit card authorization vouchers print on a thermal printer", "type":"boolean", "example":false }, "promptFor2ChecksOrReceipts":{ "description":"A Boolean flag that indicates whether or not to prompt to confirm printing two checks or receipts when using this Tender/Media. Commonly used when credit card authorization vouchers print on a thermal printer.", "type":"boolean", "example":false }, "reprintOrders":{ "description":"A Boolean flag that indicates whether or not to reprint orders to the order printers for this Tender/Media. For use when a kitchen printer stops and an order is lost.", "type":"boolean", "example":false }, "notAllowedWithIncompleteMeals":{ "description":"A Boolean flag that indicates whether or not to allow this tender for meals with a placeholder item.", "type":"boolean", "example":false }, "printBanquetChecks":{ "description":"A Boolean flag that indicates whether or not to print a banquet check..", "type":"boolean", "example":false } } }, "transDefaultMainLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Main Level after pressing the discount", "type":"boolean", "example":false }, "mainLevelPopup":{ "description":"The Main Level that activates after pressing the discount", "type":"integer", "example":1 }, "subLevelPopup":{ "description":"The Sub Level that activates after pressing the discount", "type":"integer", "example":1 }, "transDefaultSubLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Sub Level after pressing the discount.", "type":"boolean", "example":false }, "interfaceOptions":{ "description":"An object containing the interface link and options associated with the Tender / Media", "type":"object", "properties":{ "interfaceLinkNum":{ "description":"Object number of the interface", "type":"integer", "example":1 }, "interfaceLinkName":{ "type":"object", "description":"Interface Link Name", "example":{ "en-US":"Effectivity Group 1", "es-MX":"Grupo de efectividad 1" } }, "options":{ "description":"A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the interface options associated with Tender Media", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "optionsExt":{ "description":"An object containing the descriptive interface option list for the Tender Media", "type":"object", "properties":{ "post0TransactionsToPMS":{ "description":"A Boolean flag indicating to post 0.00 transactions to the interface for this tender.", "type":"boolean", "example":false }, "printPMSResponseAndPostingMsg":{ "description":"A Boolean flag indicating to print the PMS Response and the Posting Message on checks.", "type":"boolean", "example":false }, "doPMSAndCCUse19Digits":{ "description":"A Boolean flag indicating to allow a 19-digit reference entry for PMS posting or a 19-digit account number for credit cards.", "type":"boolean", "example":false }, "postAmtTenderedToPMS":{ "description":"A Boolean flag indicating to post the gross amount tendered by this key to the PMS. This also exempts the specific tax type when using the Tender/Media.", "type":"boolean", "example":false }, "useISLTMedProcedureInsteadOfPMS":{ "description":"A Boolean flag indicating to use the Tender/Media key to initiate an Interface Script Language (ISL) procedure instead of a PMS posting. Deselect if using a standard PMS interface.", "type":"boolean", "example":false }, "reversePMSItmzrOnVoidPostings":{ "description":"A Boolean flag indicating to reverse the itemizers sent to the PMS when posting the Tender/Media as a void. You must also select Partial Tender Not Allowed.", "type":"boolean", "example":false }, "switchToAlternateTendersIfPMSTimeout":{ "description":"A Boolean flag indicating to search for an alternate tender when an attempted PMS posting times out. If a PMS posting times out, the system searches for another Tender/Media with the same NLU number as the first, and posts to that key instead. When the system posts to an alternate Tender/Media key after a PMS timeout, the alternate Tender/Media uses the Key Type and Output options of the original Tender/Media. If an establishment wants the alternate key to follow its own Key Type and Output options, a SIM script can be written to redefine these fields for the alternate Tender/Media. If the posting required credit authorization, previous CA entries change to reflect the new Tender/Media.", "type":"boolean", "example":false } } } } }, "creditCardOptions":{ "description":"An object containing the credit card options associated with the Tender / Media", "type":"object", "properties":{ "estimatedTipPercent":{ "description":"The percentage amount (above the check amount) to authorize. Use this field to obtain an authorization that includes the potential tip amount. Override this setting at the revenue center by selecting Do Not Estimate Tips of Credit Card Authorizations.", "type":"number", "example":0 }, "baseLimit":{ "description":"The amount that can be charged on a credit card before sending an authorization request to a credit card processor.", "type":"number", "example":0 }, "secondLimit":{ "description":"The amount above the initial authorization that must be exceeded before a second authorization is required. You must also select the credit card option Use Amount Secondary Floor Limits in the RVC Parameters module", "type":"number", "example":0 }, "secondLimitPercent":{ "description":"The percentage above the initial authorization amount that must be exceeded before a second authorization is required. You must also select the credit card option Use Percent Secondary Floor Limits in the RVC Parameters module.", "type":"number", "example":0 }, "initialAuthAmt":{ "description":"A charge amount to be authorized before sales begin. Enter 0.00 to prompt for an amount. This field is used at sites that require a credit card to have a certain amount available, so the workstation operator can begin a tab.", "type":"number", "example":0 }, "offlineEstTipPercent":{ "description":"The percentage amount (above the check amount) to authorize. Use this field to obtain an authorization that includes the potential tip amount. Override this setting at the revenue center by selecting Do Not Estimate Tips of Credit Card Authorizations.", "type":"number", "example":0 }, "unAuthorizedAuthThreshold":{ "description":"The limit for which credit cards are considered to have a good authorization when the workstation is offline. When this limit is exceeded, only employees with the Role privilege to exceed the threshold can pay transactions.", "type":"number", "example":0 }, "caOfflineLimit":{ "description":"The limit for which credit cards are considered to have a good authorization when the credit card service is offline. You must also select Use CA Offline Base Limit when CA Offline in the RVC Parameters module", "type":"number", "example":0 }, "noSignatureLimit":{ "description":"the amount to be charged on a credit card before a voucher includes a signature line.", "type":"number", "example":0 }, "quickServiceLimit":{ "description":"The amount that is checked by the system to determine if credit card vouchers are printed or not if Quick Service Transactions are enabled for an RVC (RVC Parameters Option 18 Enable Quick Service Transactions),. If the check total on the transaction is higher than the number in this field, a credit card voucher prints.", "type":"number", "example":0 }, "options":{ "description":"A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the credit card options associated with Tender Media", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "optionsExt":{ "description":"An object containing the descriptive credit card option list for the Tender Media", "type":"object", "properties":{ "useWithCCRecall":{ "description":"A Boolean flag indicating to allow this key to use the Credit Card Recall feature. Credit Card Recall is not used with Credit Authorization.", "type":"boolean", "example":false }, "checkCCExpirationDate":{ "description":"A Boolean flag indicating to compare the date entered in the system clock with the expiration date of credit cards presented for payment. Expired credit cards are not accepted for payment. If using a magnetic card reader, the credit card date is entered automatically when the card is read; otherwise, the workstation operator must enter the expiration date. Deselect for tendering keys that do not check expiration dates.", "type":"boolean", "example":false }, "ccValidatyTest":{ "description":"A Boolean flag indicating to use the Mod-10 algorithm to test for a valid credit card number.", "type":"boolean", "example":false }, "requireCreditAuthBeforeServiceTtl":{ "description":"A Boolean flag indicating to require payment submittal to a credit card processor for approval when using the CA/EDC option. This option also prints a credit authorization voucher, unless the Do Not Print Credit Card Voucher option is set.", "type":"boolean", "example":false }, "dontPrintCCVoucher":{ "description":"A Boolean flag indicating to suppress printing of a credit card voucher when the Require Credit Authorization option is selected. Use this option with a Personal Check tender type and a check authorization system. A voucher is usually not needed in this situation as the guest's signature is on the check.", "type":"boolean", "example":false }, "requireCCStartDate":{ "description":"A Boolean flag indicating to enable the start date prompt for the EAME credit card driver.", "type":"boolean", "example":false }, "requireAVSOnManualEntry":{ "description":"A Boolean flag indicating to require Address Verification Service (AVS) entry when manually entering a credit card number.", "type":"boolean", "example":false }, "requireAVSOnAutoSwipe":{ "description":"A Boolean flag indicating to require Address Verification Service (AVS) entry when swiping a credit card.", "type":"boolean", "example":false }, "requireAVSMustBeFullAddress":{ "description":"A Boolean flag indicating to require the cardholder's full address with Address Verification Service (AVS). Deselect to prompt for the cardholder's 5-digit zip code.", "type":"boolean", "example":false }, "requireCVVOnManualEntry":{ "description":"A Boolean flag indicating to require Card Verification Value (CVV) entry or card present number entry when manually entering a credit card number.", "type":"boolean", "example":false }, "requireCVVOnAutoSwipe":{ "description":"A Boolean flag indicating to require Card Verification Value (CVV) entry or card present number entry when swiping a credit card.", "type":"boolean", "example":false }, "enableQuickServiceTransactions":{ "description":"A Boolean flag indicating to authorize a credit card without printing a voucher (in revenue centers that allow Quick Service Transactions), when the check total is under the amount set in the Quick Service Limit field", "type":"boolean", "example":false }, "enablePartialAuth":{ "description":"A Boolean flag indicating if the card supports prepaid credit cards. This allows a partial authorization when the remaining card balance is less than the requested authorization amount.", "type":"boolean", "example":false }, "enableTokenPosting":{ "description":"A Boolean flag indicating to post token information to the reporting database for credit card transactions with the TV2G driver.", "type":"boolean", "example":false } } }, "preambles":{ "description":"An array of preambles defined for the tender/ media.", "properties":{ "start":{ "description":"a preamble number for the credit card. If the preamble record defines a range (3050 to 3090), this field represents the begin range (3050*). The start field cannot be empty, and will only have numeric characters followed by a single * character.", "type":"string", "example":"3050*" }, "end":{ "description":"the end range of a preamble number for the credit card. If the preamble record defines a range (3050 to 3090), this field represents the end range (3090*). The end field, if specified, will only have numeric characters followed by a single * character. The length of start and end fields should be same. Value of start field has to be strictly lower than value of end field.", "type":"string", "example":"3090*" }, "length":{ "description":"the number of digits in the credit card number that is associated with the preamble record. If the length field is specified, then both start and end fields' length before * should be less than or equal to the specified value of length field.", "type":"integer", "example":4 } } } } }, "exemptTaxes":{ "description":"A string value of 0s and 1s of length 64 representing tax rates", "type":"string", "example":"0000000000000000000000000000000000000000000000000000000000000000" }, "exemptTaxesExt":{ "description":"Exempted Tax Rates", "type":"object", "properties":{ "taxRate1":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 1 is exempted" }, "taxRate2":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 2 is exempted" }, "taxRate3":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 3 is exempted" }, "taxRate4":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 4 is exempted" }, "taxRate5":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 5 is exempted" }, "taxRate6":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 6 is exempted" }, "taxRate7":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 7 is exempted" }, "taxRate8":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 8 is exempted" }, "taxRate9":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 9 is exempted" }, "taxRate10":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 10 is exempted" }, "taxRate11":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 11 is exempted" }, "taxRate12":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 12 is exempted" }, "taxRate13":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 13 is exempted" }, "taxRate14":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 14 is exempted" }, "taxRate15":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 15 is exempted" }, "taxRate16":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 16 is exempted" }, "taxRate17":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 17 is exempted" }, "taxRate18":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 18 is exempted" }, "taxRate19":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 19 is exempted" }, "taxRate20":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 20 is exempted" }, "taxRate21":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 21 is exempted" }, "taxRate22":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 22 is exempted" }, "taxRate23":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 23 is exempted" }, "taxRate24":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 24 is exempted" }, "taxRate25":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 25 is exempted" }, "taxRate26":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 26 is exempted" }, "taxRate27":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 27 is exempted" }, "taxRate28":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 28 is exempted" }, "taxRate29":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 29 is exempted" }, "taxRate30":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 30 is exempted" }, "taxRate31":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 31 is exempted" }, "taxRate32":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 32 is exempted" }, "taxRate33":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 33 is exempted" }, "taxRate34":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 34 is exempted" }, "taxRate35":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 35 is exempted" }, "taxRate36":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 36 is exempted" }, "taxRate37":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 37 is exempted" }, "taxRate38":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 38 is exempted" }, "taxRate39":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 39 is exempted" }, "taxRate40":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 40 is exempted" }, "taxRate41":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 41 is exempted" }, "taxRate42":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 42 is exempted" }, "taxRate43":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 43 is exempted" }, "taxRate44":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 44 is exempted" }, "taxRate45":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 45 is exempted" }, "taxRate46":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 46 is exempted" }, "taxRate47":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 47 is exempted" }, "taxRate48":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 48 is exempted" }, "taxRate49":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 49 is exempted" }, "taxRate50":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 50 is exempted" }, "taxRate51":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 51 is exempted" }, "taxRate52":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 52 is exempted" }, "taxRate53":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 53 is exempted" }, "taxRate54":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 54 is exempted" }, "taxRate55":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 55 is exempted" }, "taxRate56":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 56 is exempted" }, "taxRate57":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 57 is exempted" }, "taxRate58":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 58 is exempted" }, "taxRate59":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 59 is exempted" }, "taxRate60":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 60 is exempted" }, "taxRate61":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 61 is exempted" }, "taxRate62":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 62 is exempted" }, "taxRate63":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 63 is exempted" }, "taxRate64":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 64 is exempted" } } }, "isTaxExemptCoupon":{ "description":"use this Tender/Media key to forgive the appropriate amount of tax according to the amount entered for this tender and the amount due on the check.", "type":"boolean", "example":true }, "opsOptions":{ "description":"A string value of 0s and 1s of length 128 representing POS client behavior options", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "opsOptionsExt":{ "description":"Expanded POS client behavior options", "type":"object", "properties":{ "openCashDrawer":{ "description":"Open the cash drawer when pressing this key. This option is ignored if you select Open Drawer Only if Balance Due is 0.00 for the revenue center. Override these settings for transactions that do not change the transaction balance from 0.00, by selecting Do Not Open Drawer if Subtotal is 0.00 for the revenue center.", "type":"boolean", "example":true }, "isAmountRequired":{ "description":"require an amount when using this tender. When pressing this tender button without entering an amount, the workstation prompts, Enter [Tender] Amount. If you deselect this option and select Assume Paid in Full, the tender is used for 0.00, unless the workstation operator enters an amount before pressing the tender key.", "type":"boolean", "example":true }, "assumePaidInFull":{ "description":"record the exact amount due as the entry. You must also deselect Amount Required. If you deselect both this option and Amount Required, the system records 0.00 as the entry.", "type":"boolean", "example":true }, "useWithCurrencyConversion":{ "description":"post payment amounts entered through a currency key to this payment key", "type":"boolean", "example":true }, "referenceEntryRequired":{ "description":"A boolean value to determine whether or not a reference entry is required when using this key.", "type":"boolean", "example":true }, "dontAllowPartialTender":{ "description":"prevent the Tender/Media from being used to partially tender a transaction.", "type":"boolean", "example":true }, "roundTenderToNextHighestNumber":{ "description":"round the Tender/Media up to the next-highest whole number amount. You must also select Assume Paid in Full.", "type":"boolean", "example":true }, "roundChangeDue":{ "description":"accept payments to the exact amount and to round change due. This overrides option 87-Rounded Payments and Change. If you select 88-Round Payments and Change To the Nearest 0, the least significant decimal digit is rounded to 0 or 10. Deselect option 88 to round the least significant decimal digit to 0 or 5.", "type":"boolean", "example":true }, "dontIncludeSVCWhileProratingTender":{ "description":"for tax exempt coupon tenders that exclude service charges, but prorate other sales itemizers when applying a tax exempt coupon to the transaction. Deselect to prorate the comp amount equally between the sales itemizers and the service charge.", "type":"boolean", "example":true }, "roundPaymentsAndChange":{ "description":"round change due resulting from an overtender. If you deselect 88-Round Payments and Change To the Nearest 0, the least significant decimal digit rounds to 0 or 5. If you select option 88, the least significant decimal digit rounds to 0 or 10.", "type":"boolean", "example":true }, "roundPaymentsAndChangeToNearest0":{ "description":"round payments and change to the nearest 0 or 10. You must also select 56-Round Change Due or 87-Rounded Payments and Change.", "type":"boolean", "example":true }, "roundtoSecondLastSignificantDigit":{ "description":"round payments and change to the nearest 50 or 100 (depending on the setting of option 88). You must also select 56-Round Change Due or 87-Rounded Payments and Change.", "type":"boolean", "example":true }, "roundChangeChangeDueDown":{ "description":"round the change due down instead of up if rounding has been enabled and the unrounded change due is exactly half of the rounding number.", "type":"boolean", "example":true }, "maskAccountNumber":{ "description":"mask the account number (gift card number or other reference entry) on workstations, checks, and receipts. For use with tenders that do not require credit card authorizations.", "type":"boolean", "example":true }, "promptForReason":{ "description":"prompt for a tender usage reason.", "type":"boolean", "example":true }, "exemptAutoSVC":{ "description":"exempt the automatic service charge when pressing this key, and to print an X near the tender key line on checks, receipts, and the journal.", "type":"boolean", "example":true }, "isEmployeeMeal":{ "description":"post transaction amounts tendered with this key to the Employee Meal totals on reports. This requires entry of an employee number or ID representing the employee eating the meal. You must also set On = Use Employee Number with Employee Meal; Off = Use ID Number to determine whether the employee number or ID is used", "type":"boolean", "example":true }, "useForStoredValueTransaction":{ "description":"use the Tender/Media for stored value transactions", "type":"boolean", "example":true }, "mealAppliesToScheduledEmployeesOnly":{ "description":"use the Tender/Media as an employee meal for employees scheduled to work. You must use timekeeping and select the Employee Meal tender option. Deselect to ignore the time schedule before applying the Tender/Media", "type":"boolean", "example":true }, "mealAppliesToEmployeesOnBreakOnly":{ "description":"use the Tender/Media as an employee meal for employees on breaks. You must use timekeeping and select the Employee Meal tender option. Deselect to ignore the time schedule before applying the Tender/Media", "type":"boolean", "example":true }, "notAllowedWithIncompleteMeals":{ "description":"disallow this tender for meals with a placeholder item", "type":"boolean", "example":true }, "isCMTransactionItem":{ "description":"include the tender in Cash Management tracking and reporting", "type":"boolean", "example":true }, "affectsCashPullThreshold":{ "description":"have transactions performed for this tender affect the Cash Pull Threshold Sets balance. Set this option only for tenders that present a loss if lost or stolen", "type":"boolean", "example":true }, "isItemShareable":{ "description":"allow the Tender/Media to be shared between two or more seats, or two or more checks when using Touch Split or Touch Edit", "type":"boolean", "example":true } } }, "holdType":{ "description":"the Hold Type for the tender 0 - Fire Order 1 - Keep Hold Status 2 - Hold Order", "type":"integer", "example":1 }, "svcObjNum":{ "description":"Object Number of the service charge to post charged tips. Use this field with Charge Payment keys (Credit Cards and Room Charges).", "type":"integer", "example":1 }, "paymentChargeTipOptions":{ "description":"A String of Values of 0s and 1s of length 128 representing the enablement or disablement of the payment charge tip options associated with Tender Media", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "paymentChargeTipOptionsExt":{ "description":"An object containing the descriptive payment charge tip option list for the Tender Media", "type":"object", "properties":{ "ChargedTipRequired":{ "description":"Cause the system to assume that overpayment of the amount due is a Charged Tip", "type":"boolean", "example":false }, "postAmtToGrossReceiptsOnTipReports":{ "description":"is Amount is posted to gross receipts on tip reports", "type":"boolean", "example":false }, "postAmtToChargedReceiptsOnTipReports":{ "description":"if Amount is posted to charged receipts on tip reports", "type":"boolean", "example":false }, "chargedTipMustBeLessThanPmt":{ "description":"Checking if charged tip is less than pmt.", "type":"boolean", "example":false } } }, "miscOptions":{ "description":"An array of miscellaneous options associated with the tender media", "type":"object", "properties":{ "haloCode":{ "description":"the High Amount Lock Out value for the Tender/Media. The value must contain all zeroes except for the first digit.", "type":"integer", "example":1 }, "defaultTipPercent":{ "description":"The percentage amount to which the tip screen (on Signature Capture pads) defaults when using the Tender/Media.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s and 1s of length 128 representing Miscellaneous options", "type":"string", "example":"11000111110100001110111101011100000010110000001111001000100011101000000000000000010010100111000110000000000000000000000000000000" }, "optionsExt":{ "description":"Expanded Miscellaneous options", "type":"object", "properties":{ "enableHALO":{ "description":"enable the High Amount Lock Out for this Tender/Media.", "type":"boolean", "example":false }, "useHALOOnAmtEntered":{ "description":"compute the HALO for this Tender/Media on the amount entered. You must also select Enable HALO. Deselect to apply the HALO to the overtender amount. Set the HALO Code to 0 and deselect this option to prevent the workstation operator from issuing change for this Tender/Media.", "type":"boolean", "example":false }, "printQubecSRMDuplicate":{ "description":"print a receipt (without a barcode) for the merchant when using this tender. Use this option with the Quebec SRM Printer.", "type":"boolean", "example":false } } } } }, "menuLevels":{ "description":"An object containing the menu levels on which the Tender / Media is active", "type":"object", "properties":{ "mainLevel":{ "description":"A string value of 0s and 1s of length 8 representing Main Levels", "type":"string", "example":"00001011" }, "mainLevelExt":{ "description":"Main level descriptions", "type":"object", "properties":{ "mainLevel1":{ "description":"if the Tender / Media is active at main level 1", "type":"boolean", "example":false }, "mainLevel2":{ "description":"if the Tender / Media is active at main level 2", "type":"boolean", "example":false }, "mainLevel3":{ "description":"if the Tender / Media is active at main level 3", "type":"boolean", "example":false }, "mainLevel4":{ "description":"if the Tender / Media is active at main level 4", "type":"boolean", "example":false }, "mainLevel5":{ "description":"if the Tender / Media is active at main level 5", "type":"boolean", "example":false }, "mainLevel6":{ "description":"if the Tender / Media is active at main level 6", "type":"boolean", "example":false }, "mainLevel7":{ "description":"if the Tender / Media is active at main level 7", "type":"boolean", "example":false }, "mainLevel8":{ "description":"if the Tender / Media is active at main level 8", "type":"boolean", "example":false } } }, "sublevel":{ "description":"A string value of 0s and 1s of length 8 representing Sub levels", "type":"string", "example":"00001011" }, "sublevelExt":{ "description":"Sub levels names", "type":"object", "properties":{ "subLevel1":{ "description":"if the Tender / Media is active at sub level 1", "type":"boolean", "example":false }, "subLevel2":{ "description":"if the Tender / Media is active at sub level 2", "type":"boolean", "example":false }, "subLevel3":{ "description":"if the Tender / Media is active at sub level 3", "type":"boolean", "example":false }, "subLevel4":{ "description":"if the Tender / Media is active at sub level 4", "type":"boolean", "example":false }, "subLevel5":{ "description":"if the Tender / Media is active at sub level 5", "type":"boolean", "example":false }, "subLevel6":{ "description":"if the Tender / Media is active at sub level 6", "type":"boolean", "example":false }, "subLevel7":{ "description":"if the Tender / Media is active at sub level 7", "type":"boolean", "example":false }, "subLevel8":{ "description":"if the Tender / Media is active at sub level 8", "type":"boolean", "example":false } } }, "transDefaultMainLevel":{ "description":"return the transaction to the default transaction Main Level after pressing this Tender/Media", "type":"boolean", "example":false }, "mainLevelPopup":{ "description":"The Main Level that becomes active after pressing this Tender/Media. Enable Transaction Default to return the transaction to the default Main Level, select 0-Stay Down to retain the current transaction levels, or select a level 1-8 to become active.", "type":"integer", "example":1 }, "transDefaultSubLevel":{ "description":"return the transaction to the default transaction Sub Level after pressing this Tender/Media.", "type":"boolean", "example":false }, "subLevelPopup":{ "description":"The Sub Level that becomes active after pressing this Tender/Media. Enable Transaction Default to return the transaction to the default Sub Level, select 0-Stay Down to retain the current transaction levels, or select a level 1-8 to become active", "type":"integer", "example":1 } } }, "dataExtensions":{ "description":"An array of data extensions for the tender / media", "type":"object", "properties":{ "columnName":{ "description":"Name of the extention field", "type":"string", "example":"Extention Column 1" }, "value":{ "description":"Value of the extention field", "type":"string", "example":"Value 1" } } }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" } } }, "TaxBrkPointResponse":{ "description":"Model for the tax break point response", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Tax rate", "type":"integer", "example":1 }, "index":{ "description":"index of the breakpoint", "type":"integer", "example":1 } } }, "TaxBreakpointsGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Tax Breakpoint objects of the organization.", "items":{ "$ref":"#/definitions/TaxBreakpointsResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "TaxBreakpointv2":{ "description":"Model for Tax Breakpoint object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the Tax rate", "type":"integer", "example":1 }, "index":{ "description":"Tax breakpoint index", "type":"integer", "example":2 }, "breakpoint":{ "description":"Tax Breakpoint", "type":"integer", "example":2 }, "repeatStart":{ "description":"The field (1-32) when the incrementing pattern begins. Applicable only if type = 1", "type":"integer", "example":2 }, "repeatEnd":{ "description":"The field (1-32) when the incrementing pattern ends. Applicable only if type = 1", "type":"integer", "example":2 } } }, "TaxBreakpointsResponsev1":{ "description":"Model for Tax Breakpoint object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object Number of the Tax rate", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "index":{ "description":"Tax breakpoint index", "type":"integer", "example":2 }, "breakpoint":{ "description":"Tax Breakpoint", "type":"integer", "example":2 }, "repeatStart":{ "description":"The field (1-32) when the incrementing pattern begins. Applicable only if type = 1", "type":"integer", "example":2 }, "repeatEnd":{ "description":"The field (1-32) when the incrementing pattern ends. Applicable only if type = 1", "type":"integer", "example":2 } } }, "TaxBrkPointBodyv1":{ "description":"The input Body model that needs to be given.", "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"en-US, de-DE" }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":100, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." }, "hierUnitId":{ "description":"Unique hierarchy unit value", "example":2, "type":"integer" }, "objectNum":{ "description":"Object number of the Tax rate", "example":2, "type":"integer" } } }, "CalPackageGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of CAL Package objects of the organization.", "items":{ "$ref":"#/definitions/CalPackage" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "CalPackage":{ "description":"Model for an CAL Package Object", "type":"object", "properties":{ "packageId":{ "description":"Unique reference of the CAL package", "type":"integer", "example":1 }, "packageName":{ "description":"Name of the package", "type":"string", "example":"CAPSOnISS" }, "version":{ "description":"Version of the package", "type":"string", "example":"19.3.3" }, "deploymentOrder":{ "description":"Deployment Order of the package. Enter a number that prioritizes the order of package downloads. CAL Packages with a value of 0 are loaded before packages with a value of 1.", "type":"integer", "example":20 }, "platformType":{ "description":"The type of platform that receives the CAL Package", "type":"integer", "example":20 }, "limitOptions":{ "description":"A string value of 0s & 1s of length 8 representing the deployment of the CAL package to service hosts. If no service host is specified, then the package gets deployed to all service hosts", "type":"string", "example":"00000000" }, "limitOptionsExt":{ "description":"An object containing the descriptive service hosts list where the package can be deployed", "type":"object", "properties":{ "checkAndPosting":{ "description":"A Boolean flag indicating to deploy package to Check and Posting related service host", "type":"boolean", "example":false }, "checkAndPostingBackup":{ "description":"A Boolean flag indicating to deploy package to Check and Posting Backup related service host", "type":"boolean", "example":false }, "creditCard":{ "description":"A Boolean flag indicating to deploy package to Credit Card related service host", "type":"boolean", "example":false }, "interfaces":{ "description":"A Boolean flag indicating to deploy package to interfaces related service host", "type":"boolean", "example":false }, "kdsController":{ "description":"A Boolean flag indicating to deploy package to KDS Controller related service host", "type":"boolean", "example":false }, "kdsControllerBackup":{ "description":"A Boolean flag indicating to deploy package to KDS Controller Backup related service host", "type":"boolean", "example":false }, "sim":{ "description":"A Boolean flag indicating to deploy package to SIM related service host", "type":"boolean", "example":false }, "workstation":{ "description":"A Boolean flag indicating to deploy package to Workstation related service host", "type":"boolean", "example":false } } } } }, "SLUDeleteRequestBody":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the SLU", "type":"integer", "example":1 }, "type":{ "description":"

    Slu Type Number assigned to the SLU

    \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    Slu TypeSLU NameAllowed Hierarchy LevelAllowed objectNum
    1Discount SLUZone/Location1-64
    2Service Charges SLUZone/Location1-64
    3Tender Media SLUZone/Location1-64
    6Menu Items SLUEnterprise/Zone/Location/RVC1-999999999
    7Menu Item Master Groups SLUZone/Location1-32
    \n", "type":"integer", "example":1 } } }, "SLUUpdateResponseBody":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the SLU", "type":"integer", "example":1 }, "type":{ "description":"

    Slu Type Number assigned to the SLU

    \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    Slu TypeSLU NameAllowed Hierarchy LevelAllowed objectNum
    1Discount SLUZone/Location1-64
    2Service Charges SLUZone/Location1-64
    3Tender Media SLUZone/Location1-64
    6Menu Items SLUEnterprise/Zone/Location/RVC1-999999999
    7Menu Item Master Groups SLUZone/Location1-32
    \n", "type":"integer", "example":1 } } }, "SLU":{ "description":"Model for an SLU Object", "type":"object", "required":[ "hierUnitId", "objectNum", "name", "type" ], "properties":{ "hierUnitId":{ "description":"Hierarchy Unit Id of the root node of the hierarchy", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit.", "type":"integer", "example":1 }, "hierUnitname":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object number of the SLU", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "type":{ "description":"

    Slu Type Number assigned to the SLU

    \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    Slu TypeSLU Name
    1Discount SLU
    2Service Charges SLU
    3Tender Media SLU
    6Menu Items SLU
    7Menu Item Master Groups SLU
    \n", "type":"integer", "example":1 }, "images":{ "type":"array", "description":"An array of images associated with the SLU", "items":{ "$ref":"#/definitions/SLU_image" } } } }, "SLUGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of SLU objects of the organization.", "items":{ "$ref":"#/definitions/SLUv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "SLUv2":{ "description":"Model for an SLU Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Hierarchy Unit Id of the root node of the hierarchy", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit.", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the SLU", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"SLU Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "type":{ "description":"

    Slu Type Number assigned to the SLU

    \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    Slu TypeSLU Name
    1Discount SLU
    2Service Charges SLU
    3Tender Media SLU
    6Menu Items SLU
    7Menu Item Master Groups SLU
    \n", "type":"integer", "example":1 }, "images":{ "type":"array", "description":"An array of images associated with the SLU", "items":{ "$ref":"#/definitions/SLU_image" } } } }, "SLUv1":{ "description":"Model for an SLU Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Hierarchy Unit Id of the root node of the hierarchy", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit.", "type":"integer", "example":1 }, "hierUnitname":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object number of the SLU", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "type":{ "description":"

    Slu Type Number assigned to the SLU

    \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    Slu TypeSLU Name
    1Discount SLU
    2Service Charges SLU
    3Tender Media SLU
    6Menu Items SLU
    7Menu Item Master Groups SLU
    \n", "type":"integer", "example":1 }, "images":{ "type":"array", "description":"An array of images associated with the SLU", "items":{ "$ref":"#/definitions/SLU_image" } } } }, "SLUInsertRequestBody":{ "description":"Model for an SLU CUD Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name", "type" ], "properties":{ "hierUnitId":{ "description":"Hierarchy Unit Id of the root node of the hierarchy", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the SLU", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "type":{ "description":"

    Slu Type Number assigned to the SLU

    \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    Slu TypeSLU NameAllowed Hierarchy LevelAllowed objectNum
    1Discount SLUZone/Location1-64
    2Service Charges SLUZone/Location1-64
    3Tender Media SLUZone/Location1-64
    6Menu Items SLUEnterprise/Zone/Location/RVC1-999999999
    7Menu Item Master Groups SLUZone/Location1-32
    \n", "type":"integer", "example":1 }, "images":{ "type":"array", "description":"An array of images associated with the SLU", "items":{ "$ref":"#/definitions/SLU_image" } } } }, "SLUUpdateRequestBody":{ "description":"Model for an SLU CUD Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name", "type" ], "properties":{ "hierUnitId":{ "description":"Hierarchy Unit Id of the root node of the hierarchy", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the SLU", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "type":{ "description":"

    Slu Type Number assigned to the SLU

    \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    Slu TypeSLU NameAllowed Hierarchy LevelAllowed objectNum
    1Discount SLUZone/Location1-64
    2Service Charges SLUZone/Location1-64
    3Tender Media SLUZone/Location1-64
    6Menu Items SLUEnterprise/Zone/Location/RVC1-999999999
    7Menu Item Master Groups SLUZone/Location1-32
    \n", "type":"integer", "example":1 }, "images":{ "type":"array", "description":"An array of images associated with the SLU", "items":{ "$ref":"#/definitions/SLU_image" } } } }, "SLU_image":{ "type":"object", "properties":{ "imageIndex":{ "type":"integer", "example":1, "description":"Image Number for reference. Values range from 1-4." }, "url":{ "type":"string", "example":"https://oracleObjectStore.com/images/coffee822815.jpg", "description":"The URL of the image of the SLU" }, "altText":{ "type":"string", "example":"SLU 1", "description":"The image alternative text of the SLU" }, "description":{ "type":"string", "example":"SLU description", "description":"The description text of the SLU" }, "isCloudImage":{ "type":"boolean", "example":true, "description":"Flag indicating if the image is stored on the Cloud" }, "size":{ "type":"string", "example":"1", "description":"The size of the image" } } }, "ReportGroupResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Report Group", "type":"integer", "example":1 } } }, "ReportGroups":{ "description":"Model for Report Groups Object", "type":"object", "properties":{ "objectNum":{ "description":"Object Number of the Report Groups.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Report Groups is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the Report Groups is configured", "type":"integer", "example":26 }, "hierUnitName":{ "description":"A string that contains translations of hierarchy unit name into multiple languages", "type":"object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "name":{ "description":"A group of string objects representing the name of the Report Group in configured languages", "type":"object", "example":{ "en-US":"Routing Group", "de-DE":"Routing-Gruppe" } }, "options":{ "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the Report Groups", "type":"string", "example":"1000000000000000" }, "optionsExt":{ "description":"An object containing the descriptive option list", "type":"object", "properties":{ "includeInBankDueSection":{ "description":"A Boolean flag indicating to show tenders in the group in the Bank Due section of reports.Applicable only if type = 1", "type":"integer", "example":1 }, "subtractInBankDueSection":{ "description":"A Boolean flag indicating to subtract tenders in the group in the Bank Due section of reports. You must also select Include in Bank Due section. Applicable only if type = 1", "type":"integer", "example":1 }, "dontIncludeInTenderBreakdownSection":{ "description":"A Boolean flag indicating to omit the tender group from the Tender Breakdown section of reports. Applicable only if type = 1", "type":"integer", "example":1 }, "dontDisplayForBlindDropReports":{ "description":"A Boolean flag indicating to prevent tenders in this group from appearing on reports. Applicable only if type = 1", "type":"integer", "example":1 }, "depositTypeOfTenderMedia":{ "description":"A Boolean flag indicating to prevent the deposit type of tenders in this group from appearing on reports.Applicable only if type = 1", "type":"integer", "example":1 }, "dontIncludeInDiscountBreakdownSection":{ "description":"A Boolean flag indicating to omit the discount group from the Discount Breakdown section of reports.Applicable only if type = 2", "type":"integer", "example":1 }, "dontIncludeInSvcChgBreakdownSection":{ "description":"A Boolean flag indicating to omit the service charge group from the Service Charge Breakdown section of reports.Applicable only if type = 3", "type":"integer", "example":1 } } }, "type":{ "description":"Type of the report group; 0 - None; 1 - Tender / Media; 2 - Discount; 3 - Service Charge", "type":"integer", "example":1 } } }, "ReportGroupsGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Report Groups objects of the organization.", "items":{ "$ref":"#/definitions/ReportGroupsResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "ReportGroupsResponsev1":{ "description":"Model for Report Groups Object", "type":"object", "properties":{ "objectNum":{ "description":"Object Number of the Report Groups.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Report Groups is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the Report Groups is configured", "type":"integer", "example":26 }, "hierUnitName":{ "description":"A string that contains translations of hierarchy unit name into multiple languages", "type":"object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "name":{ "description":"A group of string objects representing the name of the Report Group in configured languages", "type":"object", "example":{ "en-US":"Routing Group", "de-DE":"Routing-Gruppe" } }, "options":{ "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the Report Groups", "type":"string", "example":"1000000000000000" }, "optionsExt":{ "description":"An object containing the descriptive option list", "type":"object", "properties":{ "includeInBankDueSection":{ "description":"A Boolean flag indicating to show tenders in the group in the Bank Due section of reports.Applicable only if type = 1", "type":"integer", "example":1 }, "subtractInBankDueSection":{ "description":"A Boolean flag indicating to subtract tenders in the group in the Bank Due section of reports. You must also select Include in Bank Due section. Applicable only if type = 1", "type":"integer", "example":1 }, "dontIncludeInTenderBreakdownSection":{ "description":"A Boolean flag indicating to omit the tender group from the Tender Breakdown section of reports. Applicable only if type = 1", "type":"integer", "example":1 }, "dontDisplayForBlindDropReports":{ "description":"A Boolean flag indicating to prevent tenders in this group from appearing on reports. Applicable only if type = 1", "type":"integer", "example":1 }, "depositTypeOfTenderMedia":{ "description":"A Boolean flag indicating to prevent the deposit type of tenders in this group from appearing on reports.Applicable only if type = 1", "type":"integer", "example":1 }, "dontIncludeInDiscountBreakdownSection":{ "description":"A Boolean flag indicating to omit the discount group from the Discount Breakdown section of reports.Applicable only if type = 2", "type":"integer", "example":1 }, "dontIncludeInSvcChgBreakdownSection":{ "description":"A Boolean flag indicating to omit the service charge group from the Service Charge Breakdown section of reports.Applicable only if type = 3", "type":"integer", "example":1 } } }, "type":{ "description":"Type of the report group; 0 - None; 1 - Tender / Media; 2 - Discount; 3 - Service Charge", "type":"integer", "example":1 } } }, "ReportGroupv2":{ "description":"Model for Report Groups Object", "type":"object", "properties":{ "objectNum":{ "description":"Object Number of the Report Groups.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Report Groups is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the Report Groups is configured", "type":"integer", "example":26 }, "name":{ "description":"A group of string objects representing the name of the Report Group in configured languages", "type":"object", "example":{ "1":"Routing Group", "2":"Routing-Gruppe" } }, "options":{ "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the Report Groups", "type":"string", "example":"1000000000000000" }, "optionsExt":{ "description":"An object containing the descriptive option list", "type":"object", "properties":{ "includeInBankDueSection":{ "description":"A Boolean flag indicating to show tenders in the group in the Bank Due section of reports.Applicable only if type = 1", "type":"integer", "example":1 }, "subtractInBankDueSection":{ "description":"A Boolean flag indicating to subtract tenders in the group in the Bank Due section of reports. You must also select Include in Bank Due section. Applicable only if type = 1", "type":"integer", "example":1 }, "dontIncludeInTenderBreakdownSection":{ "description":"A Boolean flag indicating to omit the tender group from the Tender Breakdown section of reports. Applicable only if type = 1", "type":"integer", "example":1 }, "dontDisplayForBlindDropReports":{ "description":"A Boolean flag indicating to prevent tenders in this group from appearing on reports. Applicable only if type = 1", "type":"integer", "example":1 }, "depositTypeOfTenderMedia":{ "description":"A Boolean flag indicating to prevent the deposit type of tenders in this group from appearing on reports.Applicable only if type = 1", "type":"integer", "example":1 }, "dontIncludeInDiscountBreakdownSection":{ "description":"A Boolean flag indicating to omit the discount group from the Discount Breakdown section of reports.Applicable only if type = 2", "type":"integer", "example":1 }, "dontIncludeInSvcChgBreakdownSection":{ "description":"A Boolean flag indicating to omit the service charge group from the Service Charge Breakdown section of reports.Applicable only if type = 3", "type":"integer", "example":1 } } }, "type":{ "description":"Type of the report group; 0 - None; 1 - Tender / Media; 2 - Discount; 3 - Service Charge", "type":"integer", "example":1 } } }, "ReportGroupCUDRequestBody":{ "description":"Model for Report Groups CUD Request Body", "type":"object", "required":[ "objectNum", "hierUnitId", "name" ], "properties":{ "objectNum":{ "description":"Object Number of the Report Groups.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Report Groups is configured", "type":"integer", "example":3599 }, "name":{ "description":"A group of string objects representing the name of the Report Group in configured languages", "type":"object", "example":{ "en-US":"Routing Group", "de-DE":"Routing-Gruppe" } }, "options":{ "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the Report Groups", "type":"string", "example":"1000000000000000" }, "type":{ "description":"Type of the report group; 0 - None; 1 - Tender / Media; 2 - Discount; 3 - Service Charge", "type":"integer", "example":1 } } }, "DiscountAwardGrpsResponse":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique Hierarchy Unit Value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the Discount", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"ObjectNumber of Effectivity Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence Number of the discount award group", "type":"integer", "example":1 } } }, "DiscountAwardGrpsGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Discount Award Group objects of the organization.", "items":{ "$ref":"#/definitions/DiscountAwardGrpsResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "DiscountAwardGrpsResponsev1":{ "description":"Model for Discount Award Groups Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object number of the Discount", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Discounts in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "effGrpObjNum":{ "description":"Object Number of the effectivity group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence Number of the Discount Award Group", "type":"integer", "example":1 }, "awardMIGroupObjNum":{ "description":"Object number of the Menu Item Group to trigger the discount award.", "type":"integer", "example":1 }, "awardMIGroupName":{ "description":"A group of string objects representing the name of the trigger condiment menu item group in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "awardType":{ "description":"Type of the award; 0 - None, 1 - Percent Off, 2 - Amount Off, 3 - Amount Substitution", "type":"integer", "example":1 }, "awardCount":{ "description":"The number of award items that are allowed once the Trigger MI Group's Minimum quantity is reached.", "type":"integer", "example":1 }, "percentOff":{ "description":"The percentage of the percent-based discount. Applicable only for awardType - 1", "type":"number", "example":1.55 }, "amountOff":{ "description":"The discount amount for flat amount-based discount. Applicable only for awardType - 2", "type":"number", "example":2.55 }, "amountSubstitution":{ "description":"The price to charge for each item in the Trigger Menu Item Group. Applicable only for awardType - 3", "type":"number", "example":1.22 }, "maxCount":{ "description":"When Simple Transaction Exclusivity is set for this discount, enter the maximum number of discounts that can be applied to one check. Applicable only for autoRuleType - 1-4", "type":"integer", "example":1 } } }, "DiscountAwardGrpsResponsev2":{ "description":"Model for Discount Award Groups Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Discount", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"Object Number of the effectivity group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence Number of the Discount Award Group", "type":"integer", "example":1 }, "awardMIGroupObjNum":{ "description":"Object number of the Menu Item Group to trigger the discount award.", "type":"integer", "example":1 }, "awardType":{ "description":"Type of the award; 0 - None, 1 - Percent Off, 2 - Amount Off, 3 - Amount Substitution", "type":"integer", "example":1 }, "awardCount":{ "description":"The number of award items that are allowed once the Trigger MI Group's Minimum quantity is reached.", "type":"integer", "example":1 }, "percentOff":{ "description":"The percentage of the percent-based discount. Applicable only for awardType - 1", "type":"number", "example":1.55 }, "amountOff":{ "description":"The discount amount for flat amount-based discount. Applicable only for awardType - 2", "type":"number", "example":2.55 }, "amountSubstitution":{ "description":"The price to charge for each item in the Trigger Menu Item Group. Applicable only for awardType - 3", "type":"number", "example":1.22 }, "maxCount":{ "description":"When Simple Transaction Exclusivity is set for this discount, enter the maximum number of discounts that can be applied to one check. Applicable only for autoRuleType - 1-4", "type":"integer", "example":1 } } }, "DiscountAwardGrpsBody":{ "description":"The input Body model that needs to be given.", "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"en-US, de-DE" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":10 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"objectNum:asc" }, "hierUnitId":{ "description":"Unique reference of the hierarchy.", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the discount", "type":"integer", "example":2 }, "effGrpObjNum":{ "description":"Object Number of the effectivity group", "type":"integer", "example":2 } } }, "BarCodesGetRequestBody":{ "type":"object", "required":[ "hierUnitId" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy location of the barcodes being fetched" }, "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." } } }, "BarCode":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy location where the barcode is being added" }, "objectNum":{ "type":"integer", "example":101, "description":"Barcode record object number" }, "barcode":{ "type":"integer", "example":1, "description":"Barcode value" }, "masterObjNum":{ "type":"integer", "example":501, "description":"Master object number" }, "defSequenceNum":{ "type":"integer", "example":5, "description":"Definition sequence number this barcode applies to. If null, all definitions apply" }, "priceSequenceNum":{ "type":"integer", "example":3, "description":"Price sequence this barcode applies to. If null, applies to all price records for the selected master and definitions." }, "alternatePrice":{ "type":"number", "example":5.16, "description":"Price used when ordering with barcode" }, "alternatePrepCost":{ "type":"number", "example":0.18, "description":"Prep cost used when ordering with barcode" }, "leadNumZeros":{ "type":"number", "example":2, "description":"Leading Zeroes" } }, "description":"Model for Barcode object" }, "BarCodeGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Bracode objects of the organization.", "items":{ "$ref":"#/definitions/BarCodeResourceObject" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "BarCodeResourceObject":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy location where the barcode is being added" }, "objectNum":{ "type":"integer", "example":101, "description":"Barcode record object number" }, "barcode":{ "type":"integer", "example":1, "description":"Barcode value" }, "masterObjNum":{ "type":"integer", "example":501, "description":"Master object number" }, "defSequenceNum":{ "type":"integer", "example":5, "description":"Definition sequence number this barcode applies to. If null, all definitions apply" }, "priceSequenceNum":{ "type":"integer", "example":3, "description":"Price sequence this barcode applies to. If null, applies to all price records for the selected master and definitions." }, "alternatePrice":{ "type":"number", "example":5.16, "description":"Price used when ordering with barcode" }, "alternatePrepCost":{ "type":"number", "example":0.18, "description":"Prep cost used when ordering with barcode" }, "leadNumZeros":{ "type":"number", "example":2, "description":"Leading Zeroes" } }, "description":"Model for Barcode object" }, "BarCodeResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy location where the barcode is being added" }, "objectNum":{ "type":"integer", "example":101, "description":"Barcode record object number" } }, "description":"Model for Barcode Response object" }, "BarCodeDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "TaxResponse":{ "description":"Model for the response", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the tax rate", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"Object number of the effectivity group associated with the tax rate", "type":"integer", "example":1 } } }, "TaxCURequestBody":{ "description":"Model for TaxObject", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the tax rate", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "type":{ "description":"\n

    Tax Rate Type

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    TypeType Description
    0 Disabled for Tax Rates that are not in use.
    1 Add On Breakpoint
    2 Add On Percentage
    3 Included
    4 Surcharge
    6 Add on, Excludes Start Amount
    \n", "type":"integer", "example":1 }, "start":{ "description":"Taxable sales amount that must be reached in a transaction before the tax rate is applied", "type":"number", "example":0.5 }, "percent":{ "description":"The tax percentage for the tax rate", "type":"number", "example":1 }, "breakpoints":{ "description":"An array of breakpoints configured for the tax rate Applicable only if type = 1", "type":"array", "items":{ "type":"object", "properties":{ "index":{ "description":"Tax breakpoint index", "type":"integer", "example":1 }, "breakpoint":{ "description":"Tax Breakpoint", "type":"integer", "example":1 } } } }, "repeatStart":{ "description":"The field (1-32) when the incrementing pattern begins. Applicable only if type =1", "type":"integer", "example":1 }, "repeatEnd":{ "description":"The field (1-32) when the incrementing pattern ends. Applicable only if type =1", "type":"integer", "example":32 }, "reportGroup":{ "description":"The report group number (0-99) for the Tax Rate. If set to 0, the tax rate does not appear on the reports.", "type":"integer", "example":0 }, "taxLabel":{ "description":"Tax Code for the tax rate", "type":"string", "example":"aaa" }, "effGrpObjNum":{ "description":"Object number of the effectivity group associated with the tax rate", "type":"integer", "example":1 } } }, "Tax":{ "description":"Model for TaxObject", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object Number of the tax rate", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "type":{ "description":"\n

    Tax Rate Type

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    TypeType Description
    0 Disabled for Tax Rates that are not in use.
    1 Add On Breakpoint
    2 Add On Percentage
    3 Included
    4 Surcharge
    6 Add on, Excludes Start Amount
    \n", "type":"integer", "example":1 }, "start":{ "description":"Taxable sales amount that must be reached in a transaction before the tax rate is applied", "type":"number", "example":0.5 }, "percent":{ "description":"The tax percentage for the tax rate", "type":"number", "example":1 }, "breakpoints":{ "description":"An array of breakpoints configured for the tax rate Applicable only if type = 1", "type":"array", "items":{ "type":"object", "properties":{ "index":{ "description":"Tax breakpoint index", "type":"integer", "example":1 }, "breakpoint":{ "description":"Tax Breakpoint", "type":"integer", "example":1 } } } }, "repeatStart":{ "description":"The field (1-32) when the incrementing pattern begins. Applicable only if type =1", "type":"integer", "example":1 }, "repeatEnd":{ "description":"The field (1-32) when the incrementing pattern ends. Applicable only if type =1", "type":"integer", "example":32 }, "reportGroup":{ "description":"The report group number (0-99) for the Tax Rate. If set to 0, the tax rate does not appear on the reports.", "type":"integer", "example":0 }, "taxLabel":{ "description":"Tax Code for the tax rate", "type":"string", "example":"aaa" }, "effGrpObjNum":{ "description":"Object number of the effectivity group associated with the tax rate", "type":"integer", "example":1 }, "effGrpName":{ "type":"object", "description":"Effective Group Name", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } } } }, "TaxGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Tax objects of the organization.", "items":{ "$ref":"#/definitions/TaxResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "TaxResponsev1":{ "description":"Model for TaxObject", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object Number of the tax rate", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "type":{ "description":"\n

    Tax Rate Type

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    TypeType Description
    0 Disabled for Tax Rates that are not in use.
    1 Add On Breakpoint
    2 Add On Percentage
    3 Included
    4 Surcharge
    6 Add on, Excludes Start Amount
    \n", "type":"integer", "example":1 }, "start":{ "description":"Taxable sales amount that must be reached in a transaction before the tax rate is applied", "type":"number", "example":0.5 }, "percent":{ "description":"The tax percentage for the tax rate", "type":"number", "example":1 }, "breakpoints":{ "description":"An array of breakpoints configured for the tax rate Applicable only if type = 1", "type":"array", "items":{ "type":"object", "properties":{ "index":{ "description":"Tax breakpoint index", "type":"integer", "example":1 }, "breakpoint":{ "description":"Tax Breakpoint", "type":"integer", "example":1 } } } }, "repeatStart":{ "description":"The field (1-32) when the incrementing pattern begins. Applicable only if type =1", "type":"integer", "example":1 }, "repeatEnd":{ "description":"The field (1-32) when the incrementing pattern ends. Applicable only if type =1", "type":"integer", "example":32 }, "reportGroup":{ "description":"The report group number (0-99) for the Tax Rate. If set to 0, the tax rate does not appear on the reports.", "type":"integer", "example":0 }, "taxLabel":{ "description":"Tax Code for the tax rate", "type":"string", "example":"aaa" }, "effGrpObjNum":{ "description":"Object number of the effectivity group associated with the tax rate", "type":"integer", "example":1 }, "effGrpName":{ "type":"object", "description":"Effective Group Name", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } } } }, "TaxResponsev2":{ "description":"Model for TaxObject", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the tax rate", "type":"integer", "example":1 }, "name":{ "description":"Tax Rate Name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "type":{ "description":"\n

    Tax Rate Type

    \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    TypeType Description
    0 Disabled for Tax Rates that are not in use.
    1 Add On Breakpoint
    2 Add On Percentage
    3 Included
    4 Surcharge
    6 Add on, Excludes Start Amount
    \n", "type":"integer", "example":1 }, "start":{ "description":"Taxable sales amount that must be reached in a transaction before the tax rate is applied", "type":"number", "example":0.5 }, "percent":{ "description":"The tax percentage for the tax rate", "type":"number", "example":1 }, "breakpoints":{ "description":"An array of breakpoints configured for the tax rate Applicable only if type = 1", "type":"array", "items":{ "type":"object", "properties":{ "index":{ "description":"Tax breakpoint index", "type":"integer", "example":1 }, "breakpoint":{ "description":"Tax Breakpoint", "type":"integer", "example":1 } } } }, "repeatStart":{ "description":"The field (1-32) when the incrementing pattern begins. Applicable only if type =1", "type":"integer", "example":1 }, "repeatEnd":{ "description":"The field (1-32) when the incrementing pattern ends. Applicable only if type =1", "type":"integer", "example":32 }, "reportGroup":{ "description":"The report group number (0-99) for the Tax Rate. If set to 0, the tax rate does not appear on the reports.", "type":"integer", "example":0 }, "taxLabel":{ "description":"Tax Code for the tax rate", "type":"string", "example":"aaa" }, "effGrpObjNum":{ "description":"Object number of the effectivity group associated with the tax rate", "type":"integer", "example":1 } } }, "TaxParameterResponse":{ "description":"Model for the tax Parameter response", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 } } }, "TaxParametersGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Tax Parameter objects of the organization.", "items":{ "$ref":"#/definitions/TaxParametersResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "TaxParametersResponsev1":{ "description":"Model for Tax Parameter object.", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "internationalOptions":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the tax parameter", "type":"string", "example":"00000000000000000000000000000000" }, "internationalOptionsExt":{ "description":"An object containing the descriptive international options list associated with the tax parameter", "type":"object", "properties":{ "printTaxItmzrs":{ "description":"A Boolean flag indicating to print tax itemizers on guest checks and receipts. This option must be selected for the Philippine tax.", "type":"boolean", "example":false }, "enableCandianGST":{ "description":"A Boolean flag indicating to enable Canadian GST.", "type":"boolean", "example":false }, "enableThailandTaxPrinting":{ "description":"A Boolean flag indicating to enable Thailand tax printing", "type":"boolean", "example":false }, "roundJapaneseTaxAfterDecimal":{ "description":"A Boolean flag indicating to truncate digits after decimal; Set to false to round digits after decimal", "type":"boolean", "example":false }, "printJapaneseTaxAmtDue":{ "description":"A Boolean flag indicating to print the amount of Japanese Tax Due, even if summary totals are suppressed for the tender media.", "type":"boolean", "example":false }, "truncateInclusiveTaxes":{ "description":"A Boolean flag indicating to truncate inclusive tax amounts. Deselect to round inclusive tax amounts.", "type":"boolean", "example":false }, "printItemInclTaxTotal":{ "description":"A Boolean flag indicating whether to print the total inclusive tax on the guest check when the check contains items with inclusive taxes. The printed amount represents the sum of inclusive taxes for each item.", "type":"boolean", "example":false }, "printCheckInclTaxTotal":{ "description":"A Boolean flag indicating to print the total inclusive tax calculated on the total sales for each tax rate on guest checks when a check has items with inclusive taxes.", "type":"boolean", "example":false }, "printTaxRatePerItem":{ "description":"A Boolean flag indicating to print the applied tax rates for each menu item on guest checks, customer receipts, and in the journal.", "type":"boolean", "example":false }, "enableTaxLabels":{ "description":"A Boolean flag indicating to consolidate tax reporting information based on defined Tax Labels configured under Tax Rates.", "type":"boolean", "example":false }, "postInclTaxToNetSalesTotal":{ "description":"A Boolean flag indicating Post Inclusive Tax to Net Sales Total.", "type":"boolean", "example":false }, "svcChgNetOfInclTaxValue":{ "description":"A Boolean flag indicating Service Charge Itemizer is Net of Inclusive Tax. This option bit is supported from Simphony 19.8 and above.", "type":"boolean", "example":false }, "enableJapaneseTax":{ "description":"A Boolean flag indicating to enable Japanese tax options. This option bit is supported starting from Simphony version 19.9.", "type":"boolean", "example":false } } }, "options":{ "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the tax parameter", "type":"string", "example":"0000000000000000" }, "optionsExt":{ "description":"An object containing the descriptive options list associated with the tax parameter", "type":"object", "properties":{ "dontIncludeTaxInTipReportTtl":{ "description":"A Boolean flag indicating to prevent a transaction's calculated tax amount from posting to the Gross Receipts and Charged Receipts totals on Tip Reports.", "type":"boolean", "example":false }, "requireRefEntryWithTaxExemptions":{ "description":"A Boolean flag indicating to enforce workstation operators to enter an alphanumeric Reference Entry when using Exempt Tax keys.", "type":"boolean", "example":false }, "printInclTaxBeforeSummaryTtls":{ "description":"A Boolean flag indicating to print inclusive tax totals before the summary totals on guest checks and customer receipts.", "type":"boolean", "example":false }, "printInclTaxTtlsWhen0":{ "description":"A Boolean flag indicating to print inclusive totals on guest checks and customer receipts, even when the tax is zero.", "type":"boolean", "example":false }, "printConslVATOnReceipts":{ "description":"A Boolean flag indicating to print a consolidated VAT line..", "type":"boolean", "example":false }, "printVATNetTtlOnReceipts":{ "description":"A Boolean flag indicating to print a VAT Net Totals line on guest checks and customer receipts.", "type":"boolean", "example":false }, "printTaxExmptVoucher":{ "description":"A Boolean flag indicating to print a voucher when a tax is exempted using a Tax Exempt key or by a Tender key that is programmed to exempt tax. Deselect to suppress printing the tax exempt voucher..", "type":"boolean", "example":false }, "postTxblSlsWhenTaxRateIs0":{ "description":"A Boolean flag indicating to post taxable sales when the tax rate is set to 0.00%.", "type":"boolean", "example":false }, "prorateTaxForEachComboItemAsPercent":{ "description":"A Boolean flag indicating to prorate the menu item price of each combo meal item as a percentage of the total combo meal price in order to apply the correct amount of tax to each item.", "type":"boolean", "example":false }, "excludeStartAmountOnTaxableSales":{ "description":"A Boolean flag indicating to exclude the start amount on Taxable Sales.", "type":"boolean", "example":false } } }, "printVATLineForTaxRates":{ "description":"A string value of 0s & 1s of length 64 representing the enablement / disablement of printing the VAT lines for the tax rates.", "type":"string", "example":"0000000001011110000000000000000000000000000000000000000000000000" }, "printVATLineForTaxRatesExt":{ "description":"An object containing the descriptive list of the tax rates for which VAT lines are to be printed.", "type":"object", "properties":{ "printVATLineForRate1":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 1" }, "printVATLineForRate2":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 2" }, "printVATLineForRate3":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 3" }, "printVATLineForRate4":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 4" }, "printVATLineForRate5":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 5" }, "printVATLineForRate6":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 6" }, "printVATLineForRate7":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 7" }, "printVATLineForRate8":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 8" }, "printVATLineForRate9":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 9" }, "printVATLineForRate10":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 10" }, "printVATLineForRate11":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 11" }, "printVATLineForRate12":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 12" }, "printVATLineForRate13":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 13" }, "printVATLineForRate14":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 14" }, "printVATLineForRate15":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 15" }, "printVATLineForRate16":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 16" }, "printVATLineForRate17":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 17" }, "printVATLineForRate18":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 18" }, "printVATLineForRate19":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 19" }, "printVATLineForRate20":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 20" }, "printVATLineForRate21":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 21" }, "printVATLineForRate22":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 22" }, "printVATLineForRate23":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 23" }, "printVATLineForRate24":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 24" }, "printVATLineForRate25":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 25" }, "printVATLineForRate26":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 26" }, "printVATLineForRate27":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 27" }, "printVATLineForRate28":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 28" }, "printVATLineForRate29":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 29" }, "printVATLineForRate30":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 30" }, "printVATLineForRate31":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 31" }, "printVATLineForRate32":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 32" }, "printVATLineForRate33":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 33" }, "printVATLineForRate34":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 34" }, "printVATLineForRate35":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 35" }, "printVATLineForRate36":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 36" }, "printVATLineForRate37":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 37" }, "printVATLineForRate38":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 38" }, "printVATLineForRate39":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 39" }, "printVATLineForRate40":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 40" }, "printVATLineForRate41":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 41" }, "printVATLineForRate42":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 42" }, "printVATLineForRate43":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 43" }, "printVATLineForRate44":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 44" }, "printVATLineForRate45":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 45" }, "printVATLineForRate46":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 46" }, "printVATLineForRate47":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 47" }, "printVATLineForRate48":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 48" }, "printVATLineForRate49":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 49" }, "printVATLineForRate50":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 50" }, "printVATLineForRate51":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 51" }, "printVATLineForRate52":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 52" }, "printVATLineForRate53":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 53" }, "printVATLineForRate54":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 54" }, "printVATLineForRate55":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 55" }, "printVATLineForRate56":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 56" }, "printVATLineForRate57":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 57" }, "printVATLineForRate58":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 58" }, "printVATLineForRate59":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 59" }, "printVATLineForRate60":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 60" }, "printVATLineForRate61":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 61" }, "printVATLineForRate62":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 62" }, "printVATLineForRate63":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 63" }, "printVATLineForRate64":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 64" } } } } }, "TaxParametersv2":{ "description":"Model for Tax Parameter object.", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "internationalOptions":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the tax parameter", "type":"string", "example":"00000000000000000000000000000000" }, "internationalOptionsExt":{ "description":"An object containing the descriptive international options list associated with the tax parameter", "type":"object", "properties":{ "printTaxItmzrs":{ "description":"A Boolean flag indicating to print tax itemizers on guest checks and receipts. This option must be selected for the Philippine tax.", "type":"boolean", "example":false }, "enableCandianGST":{ "description":"A Boolean flag indicating to enable Canadian GST.", "type":"boolean", "example":false }, "enableThailandTaxPrinting":{ "description":"A Boolean flag indicating to enable Thailand tax printing", "type":"boolean", "example":false }, "roundJapaneseTaxAfterDecimal":{ "description":"A Boolean flag indicating to truncate digits after decimal; Set to false to round digits after decimal", "type":"boolean", "example":false }, "printJapaneseTaxAmtDue":{ "description":"A Boolean flag indicating to print the amount of Japanese Tax Due, even if summary totals are suppressed for the tender media.", "type":"boolean", "example":false }, "truncateInclusiveTaxes":{ "description":"A Boolean flag indicating to truncate inclusive tax amounts. Deselect to round inclusive tax amounts.", "type":"boolean", "example":false }, "printItemInclTaxTotal":{ "description":"A Boolean flag indicating whether to print the total inclusive tax on the guest check when the check contains items with inclusive taxes. The printed amount represents the sum of inclusive taxes for each item.", "type":"boolean", "example":false }, "printCheckInclTaxTotal":{ "description":"A Boolean flag indicating to print the total inclusive tax calculated on the total sales for each tax rate on guest checks when a check has items with inclusive taxes.", "type":"boolean", "example":false }, "printTaxRatePerItem":{ "description":"A Boolean flag indicating to print the applied tax rates for each menu item on guest checks, customer receipts, and in the journal.", "type":"boolean", "example":false }, "enableTaxLabels":{ "description":"A Boolean flag indicating to consolidate tax reporting information based on defined Tax Labels configured under Tax Rates.", "type":"boolean", "example":false }, "postInclTaxToNetSalesTotal":{ "description":"A Boolean flag indicating Post Inclusive Tax to Net Sales Total.", "type":"boolean", "example":false }, "svcChgNetOfInclTaxValue":{ "description":"A Boolean flag indicating Service Charge Itemizer is Net of Inclusive Tax. This option bit is supported from Simphony 19.8 and above.", "type":"boolean", "example":false }, "enableJapaneseTax":{ "description":"A Boolean flag indicating to enable Japanese tax options. This option bit is supported starting from Simphony version 19.9.", "type":"boolean", "example":false } } }, "options":{ "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the tax parameter", "type":"string", "example":"0000000000000000" }, "optionsExt":{ "description":"An object containing the descriptive options list associated with the tax parameter", "type":"object", "properties":{ "dontIncludeTaxInTipReportTtl":{ "description":"A Boolean flag indicating to prevent a transaction's calculated tax amount from posting to the Gross Receipts and Charged Receipts totals on Tip Reports.", "type":"boolean", "example":false }, "requireRefEntryWithTaxExemptions":{ "description":"A Boolean flag indicating to enforce workstation operators to enter an alphanumeric Reference Entry when using Exempt Tax keys.", "type":"boolean", "example":false }, "printInclTaxBeforeSummaryTtls":{ "description":"A Boolean flag indicating to print inclusive tax totals before the summary totals on guest checks and customer receipts.", "type":"boolean", "example":false }, "printInclTaxTtlsWhen0":{ "description":"A Boolean flag indicating to print inclusive totals on guest checks and customer receipts, even when the tax is zero.", "type":"boolean", "example":false }, "printConslVATOnReceipts":{ "description":"A Boolean flag indicating to print a consolidated VAT line..", "type":"boolean", "example":false }, "printVATNetTtlOnReceipts":{ "description":"A Boolean flag indicating to print a VAT Net Totals line on guest checks and customer receipts.", "type":"boolean", "example":false }, "printTaxExmptVoucher":{ "description":"A Boolean flag indicating to print a voucher when a tax is exempted using a Tax Exempt key or by a Tender key that is programmed to exempt tax. Deselect to suppress printing the tax exempt voucher..", "type":"boolean", "example":false }, "postTxblSlsWhenTaxRateIs0":{ "description":"A Boolean flag indicating to post taxable sales when the tax rate is set to 0.00%.", "type":"boolean", "example":false }, "prorateTaxForEachComboItemAsPercent":{ "description":"A Boolean flag indicating to prorate the menu item price of each combo meal item as a percentage of the total combo meal price in order to apply the correct amount of tax to each item.", "type":"boolean", "example":false }, "excludeStartAmountOnTaxableSales":{ "description":"A Boolean flag indicating to exclude the start amount on Taxable Sales.", "type":"boolean", "example":false } } }, "printVATLineForTaxRates":{ "description":"A string value of 0s & 1s of length 64 representing the enablement / disablement of printing the VAT lines for the tax rates.", "type":"string", "example":"0000000001011110000000000000000000000000000000000000000000000000" }, "printVATLineForTaxRatesExt":{ "description":"An object containing the descriptive list of the tax rates for which VAT lines are to be printed.", "type":"object", "properties":{ "printVATLineForRate1":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 1" }, "printVATLineForRate2":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 2" }, "printVATLineForRate3":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 3" }, "printVATLineForRate4":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 4" }, "printVATLineForRate5":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 5" }, "printVATLineForRate6":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 6" }, "printVATLineForRate7":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 7" }, "printVATLineForRate8":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 8" }, "printVATLineForRate9":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 9" }, "printVATLineForRate10":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 10" }, "printVATLineForRate11":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 11" }, "printVATLineForRate12":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 12" }, "printVATLineForRate13":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 13" }, "printVATLineForRate14":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 14" }, "printVATLineForRate15":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 15" }, "printVATLineForRate16":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 16" }, "printVATLineForRate17":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 17" }, "printVATLineForRate18":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 18" }, "printVATLineForRate19":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 19" }, "printVATLineForRate20":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 20" }, "printVATLineForRate21":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 21" }, "printVATLineForRate22":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 22" }, "printVATLineForRate23":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 23" }, "printVATLineForRate24":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 24" }, "printVATLineForRate25":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 25" }, "printVATLineForRate26":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 26" }, "printVATLineForRate27":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 27" }, "printVATLineForRate28":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 28" }, "printVATLineForRate29":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 29" }, "printVATLineForRate30":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 30" }, "printVATLineForRate31":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 31" }, "printVATLineForRate32":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 32" }, "printVATLineForRate33":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 33" }, "printVATLineForRate34":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 34" }, "printVATLineForRate35":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 35" }, "printVATLineForRate36":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 36" }, "printVATLineForRate37":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 37" }, "printVATLineForRate38":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 38" }, "printVATLineForRate39":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 39" }, "printVATLineForRate40":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 40" }, "printVATLineForRate41":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 41" }, "printVATLineForRate42":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 42" }, "printVATLineForRate43":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 43" }, "printVATLineForRate44":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 44" }, "printVATLineForRate45":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 45" }, "printVATLineForRate46":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 46" }, "printVATLineForRate47":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 47" }, "printVATLineForRate48":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 48" }, "printVATLineForRate49":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 49" }, "printVATLineForRate50":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 50" }, "printVATLineForRate51":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 51" }, "printVATLineForRate52":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 52" }, "printVATLineForRate53":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 53" }, "printVATLineForRate54":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 54" }, "printVATLineForRate55":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 55" }, "printVATLineForRate56":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 56" }, "printVATLineForRate57":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 57" }, "printVATLineForRate58":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 58" }, "printVATLineForRate59":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 59" }, "printVATLineForRate60":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 60" }, "printVATLineForRate61":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 61" }, "printVATLineForRate62":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 62" }, "printVATLineForRate63":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 63" }, "printVATLineForRate64":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the VAT Line is to be printed for tax rate with object number 64" } } } } }, "TaxClassResponse":{ "description":"Model for the response", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the tax class", "type":"integer", "example":1 } } }, "TaxClassCURequestBody":{ "description":"Model for Tax Class Object", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the Tax Class", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "taxes":{ "description":"An array of taxes configured for the tax class", "type":"array", "items":{ "type":"object", "properties":{ "taxObjNum":{ "description":"Object Number of the tax", "type":"integer", "example":1 } } } }, "dataExtensions":{ "description":"An array of data extensions for the tax class", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } }, "TaxClassGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Tax Class objects of the organization.", "items":{ "$ref":"#/definitions/TaxClassv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "TaxClassv2":{ "description":"Model for Tax Class Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the Tax Class", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Tax class Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "taxes":{ "description":"An array of taxes configured for the tax class", "type":"array", "items":{ "type":"object", "properties":{ "taxObjNum":{ "description":"Object Number of the tax", "type":"integer", "example":1 } } } }, "dataExtensions":{ "description":"An array of data extensions for the Tax Class", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } }, "TaxClassv1":{ "description":"Model for Tax Class Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object Number of the Tax Class", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "taxes":{ "description":"An array of taxes configured for the tax class", "type":"array", "items":{ "type":"object", "properties":{ "taxObjNum":{ "description":"Object Number of the tax", "type":"integer", "example":1 } } } }, "dataExtensions":{ "description":"An array of data extensions for the Tax Class", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } }, "ComboSideGroupsLite":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value." }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the combo side group." }, "comboMealGroupId":{ "type":"integer", "example":2, "description":"Unique ID of combo side group." }, "name":{ "type":"object", "description":"Name of the combo side group.", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing enabled or disabled options" }, "optionsExt":{ "type":"object", "properties":{ "allowDiscounts":{ "type":"boolean", "example":false, "description":"Flag indicating to apply discounts to items in this group." }, "substitutionGroupItemsUseThisSidesPrice":{ "type":"boolean", "example":false, "description":"When substituting a Combo Meal side with a menu item from another group, Set this attribute to True to set the item's price to the side's combo meal price specified in the sides Combo Group Price." } }, "description":"An object containing the descriptive options list associated with the combo side group." }, "alternateGroups":{ "type":"array", "description":"An array of alternate groups associated with combo side group.", "items":{ "type":"object", "properties":{ "sequenceNum":{ "type":"integer", "example":1, "description":"Sequence number of the alternate combo side group." }, "alternateGroupObjNum":{ "type":"integer", "example":2, "description":"Object number of the alternate combo side group." } } } } } }, "ComboMealsLite":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "objectNum":{ "type":"integer", "example":1, "description":"Combo Meal object number" }, "name":{ "type":"object", "description":"Combo Meal Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "menuItemMasterObjNum":{ "type":"integer", "example":101, "description":"Menu item master object number" }, "priority":{ "type":"integer", "example":1, "description":"The combo meal priority when pressing the Auto Combo function key" }, "autoComboMealAlgorithm":{ "type":"integer", "example":0, "description":"The Auto-Combo Algorithm. Allowed values are 0,1,2
    Description Value
    First Deal Found 0
    Best Deal for Customer 1
    Best Deal for Merchant 2
    " }, "pricingAlgorithm":{ "type":"integer", "example":1, "description":"Pricing Algorithm Values
    Description Value
    Default NULL
    Most Expensive Side Group 1
    Least Expensive Side Group 2
    " }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing enabled or disabled options" }, "optionsExt":{ "type":"object", "description":"A descriptive options list associated with the Combo Meal.", "properties":{ "disableAutoComboRecognition":{ "type":"boolean", "example":false, "description":"Flag indicating to prevent this combo meal from being considered when pressing the Auto Combo function key." }, "allowAutocomboInPreviousRound":{ "type":"boolean", "example":false, "description":"Flag indicating to allow this combo meal to consider previous-round items when pressing the Auto Combo function key." }, "isSizedcomboMeal":{ "type":"boolean", "example":false, "description":"Flag indicating to allow this combo meal to use Combo Size - Size 1-4 function keys, changing the size of the items ordered." }, "addSidePricesToMealPrice":{ "type":"boolean", "example":false, "description":"Flag indicating to add the prices of the combo meal side items to the price of the meal on the workstation client and the printed guest check." }, "onlyPrintPricedSidesToGuestCheck":{ "type":"boolean", "example":false, "description":"Flag indicating to prevent the combo meal side items from printing on the guest check if they have no price, or if their price is added to the price of the meal." }, "noChargeForCondiments":{ "type":"boolean", "example":false, "description":"Flag indicating when added condiments (to the meal) are non-priced." }, "noBulkOrderWithQuantityOrder":{ "type":"boolean", "example":false, "description":"Flag indicating to prompt for each non-default side item per meal" }, "allowResizingOfIndividualSides":{ "type":"boolean", "example":false, "description":"Flag indicating to allow re-sizing of one selected combo meal side item." }, "doNotShowWithComboMealChoices":{ "type":"boolean", "example":false, "description":"Flag indicating to exclude this meal from the list of choices if multiple combo meals can be created from existing menu items on the check." }, "keepLastItemSelectedAfterOrdering":{ "type":"boolean", "example":false, "description":"Flag indicating if you expect modifications to the combo meal after adding the last side, keeping the combo meal selected." }, "isDefinedComboMeal":{ "type":"boolean", "example":false, "description":"Flag indicating if the item is a pre-defined combo meal." } } } } }, "Hierarchyv1":{ "description":"Model for a Hierarchy Object", "type":"object", "properties":{ "name":{ "description":"Hierarchy Name", "type":"object", "example":"{\"en-US\":\"Enterprise\", \"de-DE\": \"Enterprise\", \"ar-AR\": \"??????????????\"}" }, "hierType":{ "description":"Type of Hierarchy Node", "type":"string", "example":"Default" }, "hierUnitId":{ "description":"Hierarchy Unit Id of the root node of the hierarchy", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit.", "type":"integer", "example":1 }, "hierStrucId":{ "description":"Hierarchy Structure Id of the node of the hierarchy. Excluded by default.", "type":"integer", "example":1 }, "locRef":{ "description":"Location Reference of the node (Only valid for hierType = Location). Excluded by default.", "type":"string", "example":"Location-1" }, "parentHierUnitId":{ "description":"Hierarchy unit id of the parent node", "type":"integer", "example":0 }, "parentHierStrucId":{ "description":"Hierarchy Structure Id of the parent node. Excluded by default.", "type":"integer", "example":0 }, "parentLocRef":{ "description":"Location Reference of the parent node (Only valid for hierType = RVC). Excluded by default.", "type":"string", "example":"Location-1" }, "simphonyType":{ "description":"Determines the simphony type (essentials or standard) of organization. This field is present in the first object of the response and searching using this field is not allowed.", "type":"string", "example":"Essentials" }, "nodes":{ "description":"An array of Hierarchy.", "type":"array", "items":{ "$ref":"#/definitions/Hierarchyv1" } } } }, "Hierarchyv2":{ "description":"Model for a Hierarchy Object", "type":"object", "properties":{ "name":{ "type":"object", "description":"Hierachy Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "hierType":{ "description":"Type of Hierarchy Node", "type":"string", "example":"Default" }, "hierUnitId":{ "description":"Hierarchy Unit Id of the root node of the hierarchy", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit.", "type":"integer", "example":1 }, "hierStrucId":{ "description":"Hierarchy Structure Id of the node of the hierarchy. Excluded by default.", "type":"integer", "example":1 }, "locRef":{ "description":"Location Reference of the node (Only valid for hierType = Location). Excluded by default.", "type":"string", "example":"Location-1" }, "parentHierUnitId":{ "description":"Hierarchy unit id of the parent node", "type":"integer", "example":0 }, "parentHierStrucId":{ "description":"Hierarchy Structure Id of the parent node. Excluded by default.", "type":"integer", "example":0 }, "parentLocRef":{ "description":"Location Reference of the parent node (Only valid for hierType = RVC). Excluded by default.", "type":"string", "example":"Location-1" }, "simphonyType":{ "description":"Determines the simphony type (essentials or standard) of organization. This field is present in the first object of the response and searching using this field is not allowed.", "type":"string", "example":"Essentials" }, "nodes":{ "description":"An array of Hierarchy.", "type":"array", "items":{ "$ref":"#/definitions/Hierarchyv2" } } } }, "HierarchyNode":{ "description":"Hierarchy Node record", "type":"object", "properties":{ "name":{ "description":"Hierarchy Unit Name", "type":"object", "example":{ "1":"Subway", "2":"U-Bahn", "3":"Metro" } }, "hierType":{ "description":"Type to determine if the node is associated to a zone or not.", "type":"string", "example":"Default" }, "nodeType":{ "description":"Type to determine if the node is a Location, RVC, Zone or the Enterprise.", "type":"string", "example":"Location" }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit. Multiple nodes with same hierUnitId but different hierStrucId indicate they are the same Location/RVC defined under zone(s) or sub-zone(s).", "type":"integer", "example":3599 }, "hierStrucId":{ "description":"Unique reference of the hierarchy node.", "type":"integer", "example":3597 }, "objectNum":{ "description":"Object number of the Location/RVC/Zone.", "type":"integer", "example":1 }, "parentHierUnitId":{ "description":"Unique reference of the parent hierarchy unit.", "type":"integer", "example":4234 }, "parentHierStrucId":{ "description":"Unique reference of the parent hierarchy node.", "type":"integer", "example":4223 }, "hierOptions":{ "type":"string", "example":"0000000000000000", "description":"

    A string of values 0s and 1s of length 16 representing the options for the hierarchy node

    \n \n \n \n \n \n \n \n \n
    Position(starts from 1) Description
    1 EnforceUniquePropertiesWithinZone
    2 EnforceUniqueRVCsWithinZone
    3 restrictModulesInChildZones
    4 allRVCsfromSameLocation
    5 sortAlphabetically
    \n" } } }, "HierarchyGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":1, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Hierarchy objects of the organization.", "items":{ "$ref":"#/definitions/Hierarchyv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "CustomContent_targetExt":{ "type":"object", "description":"An object containing the descriptive platforms list where the content can be targeted", "properties":{ "win32":{ "type":"boolean", "example":false, "description":"target the content on Win32 platform" }, "androidMC40":{ "type":"boolean", "example":false, "description":"target the content on AndroidMC platform" }, "android":{ "type":"boolean", "example":false, "description":"target the content on Android platform" }, "androidMTablet":{ "type":"boolean", "example":false, "description":"target the content on AndroidMTablet platform" }, "linux":{ "type":"boolean", "example":false, "description":"deploy package to KDS Controller related service host target the content on Linux platform" } } }, "CustomContent":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "id":{ "type":"integer", "example":1, "description":"Unique reference of the content" }, "name":{ "type":"string", "example":"Image Spoons", "description":"The name of the content object" }, "description":{ "type":"object", "description":"Description", "example":{ "en-US":"Image Spoons", "de-DE":"Bild L??ffel", "es-MX":"Cucharas de Imagen" } }, "size":{ "type":"integer", "example":"Size: 12 kb, png: 100 x 100 px", "description":"the size of the custom content in bytes." }, "type":{ "type":"integer", "example":9, "description":"The file type for the custom content" }, "filenameOrigin":{ "type":"string", "example":"C:\\Program Files\\Oracle Hospitality\\EMCClient\\OPIPayment.dll", "description":"the content file origin." }, "target":{ "type":"string", "example":"11111111111111111111111111111111", "description":"A string value of 0's & 1's representing the platforms where the content is targeted" }, "targetExt":{ "$ref":"#/definitions/CustomContent_targetExt" }, "filename":{ "type":"string", "example":"ImageSpoons.jpg", "description":"The name of the custom content file with extension" }, "url":{ "$ref":"#/definitions/customContentURL" } } }, "CustomContentv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number" }, "id":{ "type":"integer", "example":1, "description":"Unique reference of the content" }, "name":{ "type":"string", "example":"Image Spoons", "description":"The name of the content object" }, "description":{ "description":"A group of string objects representing the description of custom content in configured languages", "type":"object", "example":{ "1":"Image Spoons", "2":"Bild L??ffel", "3":"Cucharas de Imagen" } }, "size":{ "type":"integer", "example":"Size: 12 kb, png: 100 x 100 px", "description":"the size of the custom content in bytes." }, "type":{ "type":"integer", "example":9, "description":"The file type for the custom content" }, "filenameOrigin":{ "type":"string", "example":"C:\\Program Files\\Oracle Hospitality\\EMCClient\\OPIPayment.dll", "description":"the content file origin." }, "target":{ "type":"string", "example":"11111111111111111111111111111111", "description":"A string value of 0's & 1's representing the platforms where the content is targeted" }, "targetExt":{ "$ref":"#/definitions/CustomContent_targetExt" }, "filename":{ "type":"string", "example":"ImageSpoons.jpg", "description":"The name of the custom content file with extension" }, "url":{ "$ref":"#/definitions/customContentURL" } } }, "CustomContentInsertRequestBody":{ "type":"object", "required":[ "hierUnitId", "name", "description", "type" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "name":{ "type":"string", "example":"Image Spoons", "description":"The name of the content object" }, "description":{ "type":"object", "description":"Description", "example":{ "en-US":"Image Spoons", "de-DE":"Bild L??ffel", "es-MX":"Cucharas de Imagen" } }, "size":{ "type":"integer", "example":"Size: 12 kb, png: 100 x 100 px", "description":"the size of the custom content in bytes." }, "type":{ "type":"integer", "example":9, "description":"The file type for the custom content" }, "filenameOrigin":{ "type":"string", "example":"C:\\Program Files\\Oracle Hospitality\\EMCClient\\OPIPayment.dll", "description":"the content file origin." }, "target":{ "type":"string", "example":"11111111111111111111111111111111", "description":"A string value of 0's & 1's representing the platforms where the content is targeted" }, "filename":{ "type":"string", "example":"ImageSpoons.jpg", "description":"The name of the custom content file with extension" } } }, "UpdateCustomContent":{ "type":"object", "required":[ "hierUnitId", "name", "description", "type" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "id":{ "type":"integer", "example":1, "description":"Unique reference of the content" }, "name":{ "type":"string", "example":"Image Spoons", "description":"The name of the content object" }, "description":{ "type":"object", "description":"Description", "example":{ "en-US":"Image Spoons", "de-DE":"Bild L??ffel", "es-MX":"Cucharas de Imagen" } }, "size":{ "type":"integer", "example":"Size: 12 kb, png: 100 x 100 px", "description":"the size of the custom content in bytes." }, "type":{ "type":"integer", "example":9, "description":"The file type for the custom content" }, "filenameOrigin":{ "type":"string", "example":"C:\\Program Files\\Oracle Hospitality\\EMCClient\\OPIPayment.dll", "description":"the content file origin." }, "target":{ "type":"string", "example":"11111111111111111111111111111111", "description":"A string value of 0's & 1's representing the platforms where the content is targeted" }, "filename":{ "type":"string", "example":"ImageSpoons.jpg", "description":"The name of the custom content file with extension" } } }, "customContentURL":{ "type":"object", "description":"The URL of the download API which needs to be used to download the actual content file. This is auto-generated and does not need to be provided during add/update calls.", "properties":{ "params":{ "$ref":"#/definitions/customContentParams" }, "endpoint":{ "type":"string", "example":"https://abc.com/content/sim/v1/menuItems/downloadConsumerContent" } } }, "customContentParams":{ "type":"object", "properties":{ "id":{ "type":"integer", "example":1, "description":"Unique reference of the content" } } }, "CustomContentResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." }, "id":{ "type":"integer", "example":1, "description":"Unique reference of the content" } } }, "CustomContentGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Custom Content objects of the organization.", "items":{ "$ref":"#/definitions/CustomContent" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "DiscountTriggerGrpsResponse":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique Hierarchy Unit Value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the Discount.", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"ObjectNumber of Effectivity Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence Number of the discount trigger group", "type":"integer", "example":1 } } }, "DiscountTriggerGrpsGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Discount Trigger Group objects of the organization.", "items":{ "$ref":"#/definitions/DiscountTriggerGrpsResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "DiscountTriggerGrpsResponsev1":{ "description":"Model for Discount Trigger Groups Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object number of the Discount", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Discounts in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "effGrpObjNum":{ "description":"ObjectNumber of Effectivity Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence Number of the discount trigger group", "type":"integer", "example":1 }, "triggerMIGroupObjNum":{ "description":"Object number of the Menu Item Group to trigger the discount award.", "type":"integer", "example":1 }, "triggerMIGroupName":{ "description":"A group of string objects representing the name of the trigger condiment menu item group in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "triggerCondimentGroupObjNum":{ "description":"Object number of the Condiment Menu Item Group to use as the trigger for the discount", "type":"integer", "example":1 }, "triggerCondimentGroupName":{ "description":"A group of string objects representing the name of the trigger condiment menu item group in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "minimumQuantity":{ "description":"The minimum number of items that must be ordered from the Trigger Menu Item Group before the discount is applied to the check. Applicable only for autoRuleType 1 and 2", "type":"integer", "example":1 }, "total":{ "description":"The total amount of Trigger Menu Item Group Items that must ordered to activate the Award Menu Item Group. Applicable only for autoRuleType 3", "type":"number", "example":1.23 } } }, "DiscountTriggerGroupv2":{ "description":"Model for Discount Trigger Groups Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Discount", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"ObjectNumber of Effectivity Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence Number of the discount trigger group", "type":"integer", "example":1 }, "triggerMIGroupObjNum":{ "description":"Object number of the Menu Item Group to trigger the discount award.", "type":"integer", "example":1 }, "triggerCondimentGroupObjNum":{ "description":"Object number of the Condiment Menu Item Group to use as the trigger for the discount", "type":"integer", "example":1 }, "minimumQuantity":{ "description":"The minimum number of items that must be ordered from the Trigger Menu Item Group before the discount is applied to the check. Applicable only for autoRuleType 1 and 2", "type":"integer", "example":1 }, "total":{ "description":"The total amount of Trigger Menu Item Group Items that must ordered to activate the Award Menu Item Group. Applicable only for autoRuleType 3", "type":"number", "example":1.23 } } }, "DiscountTriggerGrpsGetRequestBody":{ "description":"The input Body model that needs to be given.", "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "description":"Search criteria to filter results based on field value", "example":"where equals(objectNum,1)" }, "include":{ "type":"string", "description":"Objects included in response", "example":"hierUnitId" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"en-US, de-DE, es-MX" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":10 }, "orderBy":{ "type":"string", "description":"Sorts the response by the specified field name and sort order.", "example":"objectNum:asc" }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Discount", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"ObjectNumber of Effectivity Group", "type":"integer", "example":1 } } }, "MenuItemv1GetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item objects of the organization.", "items":{ "$ref":"#/definitions/MenuItemv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "MenuItemv1":{ "type":"object", "properties":{ "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the menu item master." }, "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "description":"Object Number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "familyGroupObjectNum":{ "type":"integer", "example":1, "description":"Object number of the family group" }, "familyGroupName":{ "type":"object", "description":"Family Group Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "majorGroupObjectNum":{ "type":"integer", "example":1, "description":"Object Number of the major group." }, "majorGroupName":{ "description":"A group of string objects representing the name of the major group in the configured languages.", "type":"object", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "masterGroupObjectNum":{ "type":"integer", "example":1, "description":"Object number of the master group." }, "masterGroupName":{ "description":"A group of string objects representing the name of master group in the configured languages.", "type":"object", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "reportGroupObjectNum":{ "type":"integer", "example":1, "description":"Object number of the report group" }, "reportGroupName":{ "description":"A group of string objects representing the name of the report group in the configured languages.", "type":"object", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "miMasterOptions":{ "type":"string", "example":"00000000", "description":"A string of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the menu item master. If not specified, this will represent the default options associated with the menu item master" }, "miMasterOptionsExt":{ "$ref":"#/definitions/MenuItem_miMasterOptionsExt" }, "dietaryLabels":{ "type":"array", "description":"An array of dietary labels for menu item", "items":{ "$ref":"#/definitions/MenuItem_dietaryLabels" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for menu item", "items":{ "$ref":"#/definitions/MenuItem_dataExtensions" } }, "definitions":{ "type":"array", "description":"Array of definitions of the menu item master", "items":{ "$ref":"#/definitions/MenuItem_definitions" } } }, "description":"Model for an Integrated Menu Item Object" }, "MenuItemsGetRequestBody":{ "type":"object", "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations", "description":"If specified, limits the data returned to these fields." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." } } }, "MenuItem_miMasterOptionsExt":{ "type":"object", "properties":{ "disableEditByWSEditMenuItem":{ "type":"boolean", "example":false, "description":"A flag indicating to prevent the menu item from appearing or being edited by OPS Function, Edit Menu Item. This prevents configuration changes to all definitions of the item. This option does not affect configuration of Menu Item Availability. miMasterOptions Option Bit = 2" }, "nonRevenue":{ "type":"boolean", "example":false, "description":"Select to enforce non-revenue menu items. Non-revenue menu items do not add value to the sales reports, but add value to the guest check. miMasterOptions Option Bit = 3" }, "core":{ "type":"boolean", "example":false, "description":"Selecting the core option designates the menu item as a core item, ensuring it is always available for sale and cannot be disabled using effectivity groups. When this option is chosen, the effectivity group selection grid is disabled, and any previously selected effectivity groups are disregarded during the sales process. miMasterOptions Option Bit = 4" }, "disabled":{ "type":"boolean", "example":false, "description":"Selecting the 'disabled' option deactivates the menu item for transactions and renders it unavailable for sale. Choosing this option takes precedence over other selections, such as the core menu item option and effectivity groups assigned to the master. miMasterOptions Option Bit = 5" } }, "description":"An object containing the descriptive options list associated with the menu item master" }, "MenuItem_definitions":{ "type":"object", "properties":{ "defSequenceNum":{ "type":"integer", "example":1, "description":"Indicates the definition sequence number, which is the number of the definition in the revenue center for this master record.Sequence Number should be with 1-64" }, "firstName":{ "type":"object", "description":"First Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "secondName":{ "type":"object", "description":"Second Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "thirdName":{ "type":"object", "description":"Third Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "longDescriptor":{ "type":"object", "description":"Long Descriptor", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "menuItemClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item Class" }, "menuItemClassName":{ "type":"object", "description":"Menu Item Class Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "menuItemType":{ "type":"string", "example":"Menu Item | Condiment", "description":"A flag indicating if the given item is Menu Item or Condiment" }, "overridePrintClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Print Class" }, "printClassName":{ "type":"object", "description":"Print Class Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "mainLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of lenth 8 representing Main Levels on which the definition is active." }, "mainLevelExt":{ "$ref":"#/definitions/MenuItem_mainLevelExt" }, "subLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of lenth 8 representing Sub Levels on which the definition is active" }, "subLevelExt":{ "$ref":"#/definitions/MenuItem_subLevelExt" }, "slu":{ "type":"array", "description":"Array of SLU keys and names to which the Menu Item Definition belongs", "items":{ "$ref":"#/definitions/MenuItem_slu" } }, "sluSortPriority":{ "type":"integer", "example":0, "description":"Use this field when Page Design Layout option" }, "nluGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the NLU Group associated with this menu item" }, "nluNum":{ "example":"1", "description":"Unique NLU number for this menu item (up to 12 digits)." }, "tareWeight":{ "type":"integer", "example":"1.23", "description":"Weight of the empty package for an item sold by weight" }, "surcharge":{ "type":"integer", "example":1, "description":"Surcharge for the menu item" }, "quantity":{ "type":"integer", "example":1, "description":"Quantity of a Menu Item" }, "overrideAllergenClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Allergen Class for the menu item definition to override its menu item class setting" }, "allergenClassName":{ "type":"object", "description":"Allergen Class Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "kdsPrepTime":{ "type":"integer", "example":"10.3", "description":"The number of minutes necessary to prepare this item" }, "prefixLevelOverride":{ "type":"integer", "example":1, "description":"Select to allow the condiment prefix to override the price level of the item it modifies." }, "guestCount":{ "type":"integer", "example":1, "description":"Guest count for the menu item to increment the check guest count when added." }, "consumerAdvisoryDesc":{ "type":"string", "example":"Menu Item 1", "description":"The consumer advisory description of the menu item" }, "consumerItemName":{ "type":"object", "description":"Consumer Item Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "consumerItemDescription":{ "type":"object", "description":"Consumer Item Description", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "images":{ "type":"array", "description":"An array of images associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_images" } }, "customMenuLevels":{ "type":"array", "description":"An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured", "items":{ "$ref":"#/definitions/MenuItem_customMenuLevels" } }, "defaultCondiments":{ "type":"array", "description":"An array of Default Condiment of a Menu Item", "items":{ "$ref":"#/definitions/MenuItem_defaultCondiments" } }, "productionItems":{ "type":"array", "description":"An array of production items associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_productionItems" } }, "components":{ "type":"array", "description":"An array of components associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_components" } }, "tags":{ "type":"array", "description":"An array of tags associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_tags" } }, "nutrients":{ "type":"array", "description":"An array of nutrients of the menu item", "items":{ "$ref":"#/definitions/MenuItem_nutrients" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item", "items":{ "$ref":"#/definitions/MenuItem_dataExtensions" } }, "prices":{ "type":"array", "description":"Array of prices associated with the menu item definition", "items":{ "$ref":"#/definitions/MenuItem_prices" } } } }, "MenuItem_mainLevelExt":{ "type":"object", "properties":{ "mainLevel1":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on Main Level 1" }, "mainLevel2":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on Main Level 2" }, "mainLevel3":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on Main Level 3" }, "mainLevel4":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on Main Level 4" }, "mainLevel5":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on Main Level 5" }, "mainLevel6":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on Main Level 6" }, "mainLevel7":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on Main Level 7" }, "mainLevel8":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on Main Level 8" } }, "description":"An object containing the descriptive options list associated with the Main level" }, "MenuItem_subLevelExt":{ "type":"object", "properties":{ "subLevel1":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on Sub Level 1" }, "subLevel2":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on Sub Level 2" }, "subLevel3":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on Sub Level 3" }, "subLevel4":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on Sub Level 4" }, "subLevel5":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on Sub Level 5" }, "subLevel6":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on Sub Level 6" }, "subLevel7":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on Sub Level 7" }, "subLevel8":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on Sub Level 8" } }, "description":"An object containing the descriptive options list associated with the Sub Level" }, "MenuItem_slu":{ "type":"object", "properties":{ "sluSeqNum":{ "type":"integer", "example":1, "description":"SLU sequence to which the Menu Item Definition belongs. This value ranges between 1-8" }, "sluObjNum":{ "type":"integer", "example":1, "description":"Object number of the SLU key to which the Menu Item Definition belongs" }, "sluName":{ "type":"object", "description":"SLU Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } } } }, "MenuItem_images":{ "type":"object", "properties":{ "imageIndex":{ "type":"integer", "example":1, "description":"Image Number for reference" }, "url":{ "type":"string", "example":"https://oracleObjectStore.com/images/coffee822815.jpg", "description":"The URL of the image of the menu item" }, "altText":{ "type":"string", "example":"pizza", "description":"The image alternative text of the menu item" }, "description":{ "type":"string", "example":"pizza description", "description":"The description text of the menu item" }, "isCloudImage":{ "type":"boolean", "example":true, "description":"Flag indicating if the image is stored on the Cloud" }, "size":{ "type":"string", "example":"1", "description":"The size of the image" } } }, "MenuItem_customMenuLevels":{ "type":"object", "properties":{ "menuLevelObjNum":{ "type":"integer", "example":3, "description":"Object number of the menu level" }, "activeOnAllLevels":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on all levels" }, "customLevel":{ "type":"string", "example":"11001111", "description":"Flag indicating if the menu item is active on Custom Level" }, "customLevelExt":{ "$ref":"#/definitions/MenuItem_customLevelExt" } } }, "MenuItem_defaultCondiments":{ "type":"object", "properties":{ "menuItemDefaultCondimentId":{ "type":"integer", "example":1000, "description":"Unique reference of the Menu Item Default Condiment" }, "condimentSetObjNum":{ "type":"integer", "example":1, "description":"Object number of the condiment set" }, "condimentSetName":{ "description":"A group of string objects representing the name of Condiment Set in configured languages. This value is excluded by default in GET response.", "type":"object", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "sortGroup":{ "type":"integer", "example":1, "description":"Sort group of the condiment set" }, "options":{ "type":"string", "example":"1000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the default condiments of the menu item. This value is excluded by default in GET response." }, "optionExt":{ "$ref":"#/definitions/MenuItem_optionExt" } } }, "MenuItem_productionItems":{ "type":"object", "properties":{ "productionItemObjNum":{ "type":"integer", "example":"false", "description":"Object number of the production item" }, "productionItemName":{ "type":"object", "description":"Production Item Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "productionItemCount":{ "type":"integer", "example":"1.4", "description":"The number of portions required to complete the menu item." } } }, "MenuItem_components":{ "type":"object", "properties":{ "componentObjNum":{ "type":"integer", "example":1, "description":"Object number of the component" }, "componentName":{ "type":"integer", "example":1, "description":"A group of string objects representing the name of component object in configured languages" } } }, "MenuItem_tags":{ "type":"object", "properties":{ "tagObjNum":{ "type":"integer", "example":1, "description":"Object number of the tag" }, "tagName":{ "type":"string", "example":"Tag", "description":"The name of Tag associated with the menu item" } } }, "MenuItem_nutrients":{ "type":"object", "properties":{ "nutrientSetObjNum":{ "type":"integer", "example":1, "description":"Object number of the nutrient set" }, "nutrientSetName":{ "type":"object", "description":"Nutrient Set Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } } } }, "MenuItem_dietaryLabels":{ "type":"object", "properties":{ "dietaryLabelsObjNum":{ "type":"integer", "example":1, "description":"Object number of the dietary label" }, "dietaryLabelName":{ "type":"string", "example":"Dietary Label 1", "description":"Name of the dietary label" } } }, "MenuItem_dataExtensions":{ "type":"object", "properties":{ "columnName":{ "type":"string", "example":"extension column 1", "description":"Name of the extention field" }, "value":{ "type":"string", "example":"value 1", "description":"Value of the extention field" } } }, "MenuItem_prices":{ "type":"object", "properties":{ "priceSequenceNum":{ "type":"integer", "example":1, "description":"Unique number of the detail" }, "activeOnMenuLevel":{ "type":"integer", "example":1, "description":"Level in which each price becomes active." }, "prepCost":{ "type":"integer", "example":"1.23", "description":"Prep cost amount for menu items in the price group" }, "price":{ "type":"integer", "example":"2.34", "description":"Price of the menu item" }, "taxClassOverrideObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Tax Class, if any, to use for each price record" }, "taxClassOverrideName":{ "type":"object", "description":"Tax Class Override Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "parentTaxClassOverrideObjNum":{ "type":"integer", "example":1, "description":"Object number of the parent tax class to use for the price record" }, "parentTaxClassOverrideName":{ "type":"object", "description":"Parent Tax Class Override Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "serviceChargeGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the service charge group associated with the price record" }, "serviceChargeGroupName":{ "type":"object", "description":"Service Charge Group Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "options":{ "type":"string", "example":"10000100", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the Menu Item Price" }, "optionsExt":{ "$ref":"#/definitions/MenuItem_optionsExt" }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"The effectivity group, if any, that determines when a price is active" }, "effectivityGroupName":{ "type":"object", "description":"Effectivity Group Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } } } }, "MenuItem_customLevelExt":{ "type":"object", "properties":{ "subLevel1":{ "type":"boolean", "example":false, "description":"Flag indicating if the menu item is active on Custom Level" } }, "description":"Flag indicating if the menu item is active on Custom Level" }, "MenuItem_optionExt":{ "type":"object", "properties":{ "displayWhenInDefaultState":{ "type":"boolean", "example":false, "description":"Flag to show the default condiment. Set to false to prevent condiments from appearing in the check detail, sending to KDS and Order Device printers, and printing on the customer receipt/guest check, even if the print class is set to print to KDS and Order Device printers." }, "chargeForEntireSalesCount":{ "type":"boolean", "example":false, "description":"Flag to charge customers for the condiment count. Deselect to charge only when the item count exceeds the default count. This is set by default for an Enhanced Prefix Mode Menu Item." } }, "description":"An object containing the descriptive options list associated with the default condiments of the menu item. This value is excluded by default in GET response." }, "MenuItem_optionsExt":{ "type":"object", "properties":{ "priceForFixedPriceMealCourse":{ "type":"boolean", "example":false, "description":"Flag indicating to use the menu item (bulk purchase) tax class override over the condiment parent tax class" }, "priceForFixedPriceMealCourseAndRegularMenuItem":{ "type":"boolean", "example":false, "description":"Flag indicating to exclude the condiment parent item from the menu item (bulk purchase) tax class override count" } }, "description":"An object containing the descriptive options list associated with the Menu Items Price" }, "ContentResponse":{ "description":"Response object for Content related Objects", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the SLU", "type":"integer", "example":1 }, "imageIndex":{ "description":"Image number of the SLU", "type":"integer", "example":1 }, "url":{ "description":"Object storage url of the uploaded image, can be used for downloading the uploaded image.", "type":"string", "example":"https://objectstorage.oracle.com/xyz.jpg" } } }, "SLUConsumerFacingContentGetRequest":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order" }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations", "description":"Objects included in response" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned" }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the SLU", "type":"integer", "example":1 } } }, "SLUConsumerFacingContentGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of SLU Consumer Facing Content objects of the organization.", "items":{ "$ref":"#/definitions/SLUConsumerFacingContentResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "SLUConsumerFacingContentResponsev1":{ "description":"Model for Screen Lookup Consumer Facing Content Object Get Response", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object Number of the SLU", "type":"integer", "example":1 }, "images":{ "type":"array", "description":"An array containing images of the Screen Lookup.", "items":{ "type":"object", "properties":{ "imageIndex":{ "description":"Number of the image. Values range from 1-4.", "type":"integer", "example":1 }, "title":{ "description":"Title of the image", "type":"string", "example":"Image of appetizers" }, "description":{ "description":"Description of the images.", "type":"string", "example":"Image of Appetizers" }, "size":{ "description":"The size of an image", "type":"string", "example":"Size: 12 kb, png: 100 x 100 px" }, "fileName":{ "description":"The name of the image file", "type":"string", "example":"ImageAppetizers.jpg" }, "url":{ "$ref":"#/definitions/SLUConsumerFacingContentURL" }, "imageUrl":{ "description":"The object storage url of the uploaded image, this url can be used to download the uploaded image.", "type":"string", "example":"https://objectstorage.oracle.com/xyz.jpg" } } } } } }, "SLUConsumerFacingContentv2":{ "description":"Model for Screen Lookup Consumer Facing Content Object Get Response", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the SLU", "type":"integer", "example":1 }, "images":{ "type":"array", "description":"An array containing images of the Screen Lookup.", "items":{ "type":"object", "properties":{ "imageIndex":{ "description":"Number of the image. Values range from 1-4.", "type":"integer", "example":1 }, "title":{ "description":"Title of the image", "type":"string", "example":"Image of appetizers" }, "description":{ "description":"Description of the images.", "type":"string", "example":"Image of Appetizers" }, "size":{ "description":"The size of an image", "type":"string", "example":"Size: 12 kb, png: 100 x 100 px" }, "fileName":{ "description":"The name of the image file", "type":"string", "example":"ImageAppetizers.jpg" }, "url":{ "$ref":"#/definitions/SLUConsumerFacingContentURL" }, "imageUrl":{ "description":"The object storage url of the uploaded image, this url can be used to download the uploaded image.", "type":"string", "example":"https://objectstorage.oracle.com/xyz.jpg" } } } } } }, "SLUConsumerFacingContentURL":{ "type":"object", "description":"The URL of the download API which needs to be used to download the actual content file. This is auto-generated and does not need to be provided during add/update calls.", "properties":{ "params":{ "$ref":"#/definitions/SLUParams" }, "endpoint":{ "type":"string", "example":"https://abc.com/content/sim/v1/menuItems/downloadConsumerContent" } } }, "SLUParams":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the SLU", "type":"integer", "example":1 }, "imageIndex":{ "description":"Number of the image. Values range from 1-4.", "type":"integer", "example":1 } } }, "MenuItemConsumerFacingContentResponse":{ "description":"Response object for Content related Objects", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the menu item", "type":"integer", "example":1 }, "imageIndex":{ "description":"Image number of the menu item", "type":"integer", "example":1 }, "url":{ "description":"Object storage url of the uploaded image, can be used for downloading the uploaded image.", "type":"string", "example":"https://objectstorage.oracle.com/xyz.jpg" } } }, "MenuItemConsumerFacingContentGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Definition Consumer Facing Content objects of the organization.", "items":{ "$ref":"#/definitions/MenuItemConsumerFacingContentResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "MenuItemConsumerFacingContentResponsev1":{ "description":"Model for Menu Item Consumer Facing Content Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Menu Item definition is configured.", "type":"integer", "example":2 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object Number of the menu item master.", "type":"integer", "example":1 }, "defSeqNum":{ "description":"Sequence Number of the menu item definition", "type":"integer", "example":1 }, "images":{ "type":"array", "description":"An array containing images of the Menu Item Definition.", "items":{ "type":"object", "properties":{ "imageIndex":{ "description":"Number of the image. Values range from 1-10.", "type":"integer", "example":1 }, "altText":{ "description":"altText of the image", "type":"string", "example":"Image of appetizers" }, "description":{ "description":"Description of the images.", "type":"string", "example":"Image of Appetizers" }, "size":{ "description":"The size of an image", "type":"string", "example":"Size: 12 kb, png: 100 x 100 px" }, "fileName":{ "description":"The name of the image file", "type":"string", "example":"ImageAppetizers.jpg" }, "url":{ "$ref":"#/definitions/MIDConsumerFacingContentURL" }, "imageUrl":{ "description":"The object storage URL of the uploaded image. This URL can be used to download the uploaded image.", "type":"string", "example":"https://objectstorage.oracle.com/xyz.jpg" } } } } } }, "MenuItemConsumerFacingContentv2":{ "description":"Model for Menu Item Consumer Facing Content Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Menu Item definition is configured.", "type":"integer", "example":2 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the menu item master.", "type":"integer", "example":1 }, "defSeqNum":{ "description":"Sequence Number of the menu item definition", "type":"integer", "example":1 }, "images":{ "type":"array", "description":"An array containing images of the Menu Item Definition.", "items":{ "type":"object", "properties":{ "imageIndex":{ "description":"Number of the image. Values range from 1-10.", "type":"integer", "example":1 }, "altText":{ "description":"altText of the image", "type":"string", "example":"Image of appetizers" }, "description":{ "description":"Description of the images.", "type":"string", "example":"Image of Appetizers" }, "size":{ "description":"The size of an image", "type":"string", "example":"Size: 12 kb, png: 100 x 100 px" }, "fileName":{ "description":"The name of the image file", "type":"string", "example":"ImageAppetizers.jpg" }, "url":{ "$ref":"#/definitions/MIDConsumerFacingContentURL" }, "imageUrl":{ "description":"The object storage URL of the uploaded image. This URL can be used to download the uploaded image.", "type":"string", "example":"https://objectstorage.oracle.com/xyz.jpg" } } } } } }, "MIDConsumerFacingContentURL":{ "type":"object", "description":"The URL of the download API which needs to be used to download the actual content file. This is auto-generated and does not need to be provided during add/update calls.", "properties":{ "params":{ "$ref":"#/definitions/MIDConsumerFacingContentParams" }, "endpoint":{ "type":"string", "example":"https://abc.com/content/sim/v1/menuItems/downloadConsumerContent" } } }, "MIDConsumerFacingContentParams":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Menu Item definition is configured.", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the menu item master.", "type":"integer", "example":1 }, "defSeqNum":{ "description":"Sequence Number of the menu item definition", "type":"integer", "example":1 }, "imageIndex":{ "description":"Number of the image. Values range from 1-10.", "type":"integer", "example":1 } } }, "MenuItemConsumerFacingContentGetRequest":{ "type":"object", "required":[ "hierUnitId", "objectNum", "defSeqNum" ], "properties":{ "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order" }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations", "description":"Objects included in response" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned" }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Menu Item definition is configured.", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the menu item master.", "type":"integer", "example":1 }, "defSeqNum":{ "description":"Sequence Number of the menu item definition", "type":"integer", "example":1 } } }, "Employee2Response":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" } } }, "Employee2GetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of basic employee objects of the organization.", "items":{ "$ref":"#/definitions/Employee2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "Employee_dataExtensions":{ "type":"object", "properties":{ "columnName":{ "type":"string", "example":"extension column 1", "description":"Name of the extention field" }, "value":{ "type":"string", "example":"value 1", "description":"Value of the extention field" } } }, "Employee2":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee in the system." }, "firstName":{ "type":"string", "example":"Employee", "description":"Employee's first name, which prints on reports." }, "lastName":{ "type":"string", "example":"Employee", "description":"Employee's last name, which prints on reports." }, "checkName":{ "type":"string", "example":"Employee Check Name", "description":"Name to print on guest checks." }, "email":{ "type":"string", "example":"employee@restaurant.com", "description":"Email address of the employee." }, "languageObjNum":{ "type":"integer", "example":1, "description":"The object number of the default language for the employee on the EMC and the workstation." }, "language":{ "description":"A string that contains translations of default language name for the employee on the EMC and the workstation into multiple languages", "type":"object", "example":{ "en-US":"Spanish", "de-DE":"Spanisch", "es-MX":"Espanol" } }, "payrollId":{ "type":"string", "example":"EMP-01", "description":"External payroll ID for the employee." }, "id":{ "type":"integer", "example":2021, "description":"ID number to identify the employee on workstations." }, "alternateId":{ "type":"integer", "example":2121, "description":"ID to use instead of the Employee ID when signing into the workstation." }, "pin":{ "type":"integer", "example":2222, "description":"PIN for the employee." }, "level":{ "type":"integer", "example":1, "description":"The level of the employee. This value should be between 1-9." }, "group":{ "type":"integer", "example":1, "description":"The group of the employee." }, "isDeleted":{ "type":"boolean", "example":false, "description":"Flag indicating if the employee record is deleted. If true, the record cannot be edited." }, "terminationDate":{ "type":"string", "example":"2021-11-21T00:00:00.000Z", "description":"The date the employee was terminated.Format:YYYY-MM-DD. This value is set from Labor Management and cannot be added" }, "isDataPrivacyConsentGranted":{ "type":"boolean", "example":false, "description":"The consent status of the employee." }, "infoLine1":{ "type":"string", "example":"Information line 1", "description":"Information line 1" }, "infoLine2":{ "type":"string", "example":"Information line 2", "description":"Information line 2" }, "infoLine3":{ "type":"string", "example":"Information line 3", "description":"Information line 3" }, "infoLine4":{ "type":"string", "example":"Information line 4", "description":"Information line 4" }, "userName":{ "type":"string", "example":"empName", "description":"The login name for the EMC." }, "localeObjNum":{ "type":"integer", "example":1, "description":"The object number of the locale of the employee" }, "locale":{ "description":"A string that contains translations of locale name for the employee to use in the EMC into multiple languages", "type":"object", "example":{ "en-US":"es-Spain", "de-DE":"es-Spanien", "es-MX":"es-Espana" } }, "hasFingerprintEnrolled":{ "type":"boolean", "example":false, "description":"Flag indicating if the employee has its fingerprint enrolled. This flag cannot be modified by API." }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for employees", "items":{ "$ref":"#/definitions/Employee_dataExtensions" } } } }, "Employee2v2":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee in the system." }, "firstName":{ "type":"string", "example":"Employee", "description":"Employee's first name, which prints on reports." }, "lastName":{ "type":"string", "example":"Employee", "description":"Employee's last name, which prints on reports." }, "checkName":{ "type":"string", "example":"Employee Check Name", "description":"Name to print on guest checks." }, "email":{ "type":"string", "example":"employee@restaurant.com", "description":"Email address of the employee." }, "languageObjNum":{ "type":"integer", "example":1, "description":"The object number of the default language for the employee on the EMC and the workstation." }, "langId":{ "description":"Lang Id of the language.", "type":"integer", "example":1 }, "payrollId":{ "type":"string", "example":"EMP-01", "description":"External payroll ID for the employee." }, "id":{ "type":"integer", "example":2021, "description":"ID number to identify the employee on workstations." }, "alternateId":{ "type":"integer", "example":2121, "description":"ID to use instead of the Employee ID when signing into the workstation." }, "pin":{ "type":"integer", "example":2222, "description":"PIN for the employee." }, "level":{ "type":"integer", "example":1, "description":"The level of the employee. This value should be between 1-9." }, "group":{ "type":"integer", "example":1, "description":"The group of the employee." }, "isDeleted":{ "type":"boolean", "example":false, "description":"Flag indicating if the employee record is deleted. If true, the record cannot be edited." }, "terminationDate":{ "type":"string", "example":"2021-11-21T00:00:00.000Z", "description":"The date the employee was terminated.Format:YYYY-MM-DD. This value is set from Labor Management and cannot be added" }, "isDataPrivacyConsentGranted":{ "type":"boolean", "example":false, "description":"The consent status of the employee." }, "infoLine1":{ "type":"string", "example":"Information line 1", "description":"Information line 1" }, "infoLine2":{ "type":"string", "example":"Information line 2", "description":"Information line 2" }, "infoLine3":{ "type":"string", "example":"Information line 3", "description":"Information line 3" }, "infoLine4":{ "type":"string", "example":"Information line 4", "description":"Information line 4" }, "userName":{ "type":"string", "example":"empName", "description":"The login name for the EMC." }, "localeObjNum":{ "type":"integer", "example":1, "description":"The object number of the locale of the employee" }, "hasFingerprintEnrolled":{ "type":"boolean", "example":false, "description":"Flag indicating if the employee has its fingerprint enrolled. This flag cannot be modified by API." }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for employees", "items":{ "$ref":"#/definitions/Employee_dataExtensions" } } } }, "MajorGroupGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Major Group objects of the organization.", "items":{ "$ref":"#/definitions/MajorGroupv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "MajorGroupv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "reportGroup":{ "description":"Object number of the Report Group.", "type":"integer", "example":1 }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the major group" }, "name":{ "type":"object", "description":"Major Group Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } } } }, "MajorGroupv1":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "reportGroup":{ "description":"Object number of the Report Group.", "type":"integer", "example":1 }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the major group" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } } } }, "MajorGroupCUDRequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit of an Enterprise" }, "reportGroup":{ "description":"Object number of the Report Group.", "type":"integer", "example":1 }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the major group" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } } } }, "MajorGroupResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the major group" } } }, "MajorGroupDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "AutoMenuLevelGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Auto Menu Level objects of the organization.", "items":{ "$ref":"#/definitions/AutoMenuLevelResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "AutoMenuLevelResponsev1":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "index":{ "type":"integer", "example":1, "description":"Object number of the auto menu level" }, "start":{ "type":"string", "example":"10:10", "description":"Indicates the Start Time for every Menu Level in 24-hour format" }, "end":{ "type":"string", "example":"20:20", "description":"Indicates the End Time for every Menu Level in 24-hour format" }, "mainLevelIndex":{ "type":"integer", "example":1, "description":"Select the Main Level, if any, that becomes active at the specified time" }, "subLevelIndex":{ "type":"integer", "example":1, "description":"Select the Sub Level, if any, that becomes active at the specified time" }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated" }, "optionsExt":{ "$ref":"#/definitions/OptionsExt_AutoMenuLevel" } }, "description":"Model for an Auto Menu Level" }, "AutoMenuLevelv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "index":{ "type":"integer", "example":1, "description":"Object number of the auto menu level" }, "start":{ "type":"string", "example":"10:10", "description":"Indicates the Start Time for every Menu Level in 24-hour format" }, "end":{ "type":"string", "example":"20:20", "description":"Indicates the End Time for every Menu Level in 24-hour format" }, "mainLevelIndex":{ "type":"integer", "example":1, "description":"Select the Main Level, if any, that becomes active at the specified time" }, "subLevelIndex":{ "type":"integer", "example":1, "description":"Select the Sub Level, if any, that becomes active at the specified time" }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated" }, "optionsExt":{ "$ref":"#/definitions/OptionsExt_AutoMenuLevel" } }, "description":"Model for an Auto Menu Level" }, "OptionsExt_AutoMenuLevel":{ "type":"object", "properties":{ "activeEntry":{ "type":"boolean", "example":false, "description":"Select to make the selected menu level configuration (1-8) active in the revenue center. Serving Periods, if configured with active levels, override this table." }, "activeOnSundays":{ "type":"boolean", "example":false, "description":"Select to activate the menu level configuration on Sundays." }, "activeOnMondays":{ "type":"boolean", "example":false, "description":"Select to activate the menu level configuration on Mondays." }, "activeOnTuesdays":{ "type":"boolean", "example":false, "description":"Select to activate the menu level configuration on Tuesdays." }, "activeOnWednesdays":{ "type":"boolean", "example":false, "description":"Select to activate the menu level configuration on Wednesdays." }, "activeOnThursdays":{ "type":"boolean", "example":false, "description":"Select to activate the menu level configuration on Thursdays." }, "activeOnFridays":{ "type":"boolean", "example":false, "description":"Select to activate the menu level configuration on Fridays." }, "activeOnSaturdays":{ "type":"boolean", "example":false, "description":"Select to activate the menu level configuration on Saturdays." } }, "description":"An object containing the descriptive options list associated with the AutoMenu Level" }, "AutoMenuLevelResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "index":{ "type":"integer", "example":1, "description":"Object number of the auto menu level" } } }, "ComboGroupItemPriceGetRequestBody":{ "type":"object", "required":[ "hierUnitId", "comboMealGroupItemObjNum", "comboMealGroupObjNum" ], "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealGroupItemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "comboMealGroupObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal group" } } }, "ComboGroupItemPrice":{ "type":"object", "required":[ "hierUnitId", "comboMealGroupItemObjNum", "comboMealGroupObjNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "comboMealGroupObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal group" }, "comboMealGroupItemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" }, "price":{ "type":"number", "example":1.23, "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items" }, "prepcost":{ "type":"number", "example":0.89, "description":"The preparation cost of the combo group side items." }, "activeOnLevel":{ "type":"integer", "example":0, "description":"The main menu level on which the price is active. Setting it to 0 indicates the prices is active on all levels" }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group associated with the price" } }, "description":"Model for Combo Group Item Price Object" }, "ComboGroupItemPriceGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Combo Group Item Price objects of the organization.", "items":{ "$ref":"#/definitions/ComboGroupItemPriceResourceObjectv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "ComboGroupItemPriceResourceObjectv1":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "comboMealGroupObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal group" }, "comboMealGroupItemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" }, "price":{ "type":"number", "example":1.23, "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items" }, "prepcost":{ "type":"number", "example":0.89, "description":"The preparation cost of the combo group side items." }, "activeOnLevel":{ "type":"integer", "example":0, "description":"The main menu level on which the price is active. Setting it to 0 indicates the prices is active on all levels" }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group associated with the price" } }, "description":"Model for Combo Group Item Price Object" }, "ComboSideGroupItemPricev2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value where the price is located." }, "comboMealGroupObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal group" }, "comboMealGroupItemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" }, "price":{ "type":"number", "example":1.23, "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items" }, "prepcost":{ "type":"number", "example":0.89, "description":"The preparation cost of the combo group side items." }, "activeOnLevel":{ "type":"integer", "example":0, "description":"The main menu level on which the price is active. Setting it to 0 indicates the prices is active on all levels" }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group associated with the price" } }, "description":"Model for Combo Group Item Price Object" }, "ComboGroupItemPriceResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealGrpObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal group" }, "comboMealGroupItemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" } } }, "ComboGroupItemPriceDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "ComboMealPriceGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Combo Meal Side Group Price objects of the organization.", "items":{ "$ref":"#/definitions/ComboMealPricev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "ComboMealPricev1":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "comboMealObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal" }, "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side" }, "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" }, "price":{ "type":"number", "example":1.23, "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items." }, "prepCost":{ "type":"number", "example":0.67, "description":"The preparation cost of the combo meal side." }, "activeOnMenuLevel":{ "type":"integer", "example":0, "description":"The menu level (main or sub) on which the price is active. This should be a value between 0-8.Setting it to 0 indicates the prices is active on all levels" } }, "description":"Model for Price of side of Combo Meal Object" }, "ComboMealPricev2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "comboMealObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal" }, "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side" }, "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" }, "price":{ "type":"number", "example":1.23, "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items." }, "prepCost":{ "type":"number", "example":0.67, "description":"The preparation cost of the combo meal side." }, "activeOnMenuLevel":{ "type":"integer", "example":0, "description":"The menu level (main or sub) on which the price is active. This should be a value between 0-8.Setting it to 0 indicates the prices is active on all levels" } }, "description":"Model for Price of side of Combo Meal Object" }, "ComboMealPriceGetRequestBody":{ "type":"object", "required":[ "hierUnitId", "comboMealObjNum", "sideNum" ], "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal" }, "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side" } } }, "ComboMealPriceResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal" }, "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side" }, "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" } } }, "ComboMealPriceDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "ComboMealsDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "ComboMealsGetParametersv1":{ "type":"object", "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." } } }, "ComboMeals_OptionsExt":{ "type":"object", "properties":{ "disableAutoComboRecognition":{ "type":"boolean", "example":false, "description":"Flag indicating to prevent this combo meal from being considered when pressing the Auto Combo function key." }, "allowAutocomboInPreviousRound":{ "type":"boolean", "example":false, "description":"Flag indicating to allow this combo meal to consider previous-round items when pressing the Auto Combo function key." }, "isSizedcomboMeal":{ "type":"boolean", "example":false, "description":"Flag indicating to allow this combo meal to use Combo Size - Size 1-4 function keys, changing the size of the items ordered." }, "addSidePricesToMealPrice":{ "type":"boolean", "example":false, "description":"Flag indicating to add the prices of the combo meal side items to the price of the meal on the workstation client and the printed guest check." }, "onlyPrintPricedSidesToGuestCheck":{ "type":"boolean", "example":false, "description":"Flag indicating to prevent the combo meal side items from printing on the guest check if they have no price, or if their price is added to the price of the meal." }, "noChargeForCondiments":{ "type":"boolean", "example":false, "description":"Flag indicating when added condiments (to the meal) are non-priced." }, "noBulkOrderWithQuantityOrder":{ "type":"boolean", "example":false, "description":"Flag indicating to prompt for each non-default side item per meal" }, "allowResizingOfIndividualSides":{ "type":"boolean", "example":false, "description":"Flag indicating to allow re-sizing of one selected combo meal side item." }, "doNotShowWithComboMealChoices":{ "type":"boolean", "example":false, "description":"Flag indicating to exclude this meal from the list of choices if multiple combo meals can be created from existing menu items on the check." }, "keepLastItemSelectedAfterOrdering":{ "type":"boolean", "example":false, "description":"Flag indicating if you expect modifications to the combo meal after adding the last side, keeping the combo meal selected." }, "isDefinedComboMeal":{ "type":"boolean", "example":false, "description":"Flag indicating if the item is a pre-defined combo meal." } }, "description":"An object containing the descriptive options list associated with the Combo Meal." }, "ComboMeals_MenuLevelExt":{ "type":"object", "description":"An object containing the descriptive list of menu levels associated with the Combo Meal", "properties":{ "menuLevel1":{ "type":"boolean", "example":true, "description":"A flag indicating if the combo meal is associated with Menu Level 1" }, "menuLevel2":{ "type":"boolean", "example":false, "description":"A flag indicating if the combo meal is associated with Menu Level 2" }, "menuLevel3":{ "type":"boolean", "example":true, "description":"A flag indicating if the combo meal is associated with Menu Level 3" }, "menuLevel4":{ "type":"boolean", "example":false, "description":"A flag indicating if the combo meal is associated with Menu Level 4" }, "menuLevel5":{ "type":"boolean", "example":true, "description":"A flag indicating if the combo meal is associated with Menu Level 5" }, "menuLevel6":{ "type":"boolean", "example":false, "description":"A flag indicating if the combo meal is associated with Menu Level 6" }, "menuLevel7":{ "type":"boolean", "example":true, "description":"A flag indicating if the combo meal is associated with Menu Level 7" }, "menuLevel8":{ "type":"boolean", "example":true, "description":"A flag indicating if the combo meal is associated with Menu Level 8" } } }, "ComboMeals_Prices":{ "type":"object", "description":"An array of prices associated with the combo meal", "properties":{ "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" }, "price":{ "type":"number", "example":1.23, "description":"The default side item price to use for the combo group items." }, "prepCost":{ "type":"number", "example":0.89, "description":"The a-la carte price of the combo group side items." }, "activeOnMenuLevel":{ "type":"integer", "example":0, "description":"The menu level (main or sub) on which the price is active." } } }, "ComboMeals_Sides":{ "type":"object", "required":[ "sideNum", "comboGrpObjNum", "comboGroupName", "sideCount", "defaultMenuLevelIndex", "menuLevel", "menuLevelExt", "prices" ], "properties":{ "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side." }, "comboGrpObjNum":{ "type":"integer", "example":1, "description":"Object number of the Side Item Group that contains the side items for the combo meal." }, "comboGroupName":{ "type":"string", "description":"name of the combo meal group" }, "sideCount":{ "type":"integer", "example":1, "description":"Number of Combo Meal Group items required for the combo meal side." }, "defaultMenuLevelIndex":{ "type":"integer", "example":1, "description":"Index of the default menu level for this combo group." }, "menuLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing the configured menu levels that are available for ordering with this combo group" }, "menuLevelExt":{ "$ref":"#/definitions/ComboMeals_MenuLevelExt" }, "prices":{ "type":"array", "items":{ "$ref":"#/definitions/ComboMeals_Prices" } } } }, "ComboMeals_Sidesv2":{ "type":"object", "properties":{ "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side." }, "comboGrpObjNum":{ "type":"integer", "example":1, "description":"Object number of the Side Item Group that contains the side items for the combo meal." }, "sideCount":{ "type":"integer", "example":1, "description":"Number of Combo Meal Group items required for the combo meal side." }, "defaultMenuLevelIndex":{ "type":"integer", "example":1, "description":"Index of the default menu level for this combo group." }, "menuLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing the configured menu levels that are available for ordering with this combo group" }, "menuLevelExt":{ "$ref":"#/definitions/ComboMeals_MenuLevelExt" }, "prices":{ "type":"array", "items":{ "$ref":"#/definitions/ComboMeals_Prices" } } } }, "ComboMeals_Sides_CUD":{ "type":"object", "properties":{ "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side." }, "comboGrpObjNum":{ "type":"integer", "example":1, "description":"Object number of the Side Item Group that contains the side items for the combo meal." }, "sideCount":{ "type":"integer", "example":1, "description":"Number of Combo Meal Group items required for the combo meal side." }, "defaultMenuLevelIndex":{ "type":"integer", "example":1, "description":"Index of the default menu level for this combo group." }, "menuLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing the configured menu levels that are available for ordering with this combo group" }, "prices":{ "type":"array", "items":{ "$ref":"#/definitions/ComboMeals_Prices" } } } }, "ComboMealsResourceObject":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "type":"integer", "example":1, "description":"Combo Meal object number" }, "name":{ "type":"object", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "menuItemMasterObjNum":{ "type":"integer", "example":101, "description":"Menu item master object number" }, "menuItemMasterName":{ "type":"object", "example":{ "en-US":"Condiment Set Items", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "priority":{ "type":"integer", "example":1, "description":"The combo meal priority when pressing the Auto Combo function key" }, "autoComboMealAlgorithm":{ "type":"integer", "example":0, "description":"The Auto-Combo Algorithm" }, "pricingAlgorithm":{ "type":"integer", "example":1, "description":"Pricing Algorithm Values
    Description Value
    Default NULL
    Most Expensive Side Group 1
    Least Expensive Side Group 2
    " }, "autoComboMealAlgorithmName":{ "type":"object", "example":{ "en-US":"FirstDealFound", "de-DE":"Unternehmen", "es-MX":"Primera oferta encontrada" } }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing enabled or disabled options" }, "optionsExt":{ "$ref":"#/definitions/ComboMeals_OptionsExt" }, "sides":{ "type":"array", "description":"An array of Sides that are associated with the combo meal", "items":{ "$ref":"#/definitions/ComboMeals_Sides" } } } }, "ComboMealsv1GetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Combo Meals objects of the organization.", "items":{ "$ref":"#/definitions/ComboMealsResourceObject" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "ComboMealsResourceObjectv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Combo Meal object number" }, "name":{ "type":"object", "description":"Combo Meal Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "menuItemMasterObjNum":{ "type":"integer", "example":101, "description":"Menu item master object number" }, "priority":{ "type":"integer", "example":1, "description":"The combo meal priority when pressing the Auto Combo function key" }, "autoComboMealAlgorithm":{ "type":"integer", "example":0, "description":"The Auto-Combo Algorithm" }, "pricingAlgorithm":{ "type":"integer", "example":1, "description":"Pricing Algorithm Values
    Description Value
    Default NULL
    Most Expensive Side Group 1
    Least Expensive Side Group 2
    " }, "autoComboMealAlgorithmName":{ "type":"string", "example":"FirstDealFound", "description":"The Auto-Combo Algorithm Name" }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing enabled or disabled options" }, "optionsExt":{ "$ref":"#/definitions/ComboMeals_OptionsExt" }, "sides":{ "type":"array", "description":"An array of Sides that are associated with the combo meal", "items":{ "$ref":"#/definitions/ComboMeals_Sidesv2" } } } }, "ComboMealsResourceObjectCUDRequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "objectNum":{ "type":"integer", "example":1, "description":"Combo Meal object number" }, "name":{ "type":"object", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "menuItemMasterObjNum":{ "type":"integer", "example":101, "description":"Menu item master object number" }, "priority":{ "type":"integer", "example":1, "description":"The combo meal priority when pressing the Auto Combo function key" }, "autoComboMealAlgorithm":{ "type":"integer", "example":0, "description":"The Auto-Combo Algorithm" }, "pricingAlgorithm":{ "type":"integer", "example":1, "description":"Pricing Algorithm Values
    Description Value
    Default NULL
    Most Expensive Side Group 1
    Least Expensive Side Group 2
    " }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing enabled or disabled options" }, "sides":{ "type":"array", "description":"An array of Sides that are associated with the combo meal", "items":{ "$ref":"#/definitions/ComboMeals_Sides_CUD" } } } }, "ComboMealsResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Combo Meal" } } }, "ComboMealPre-DeleteCheckResponse":{ "type":"object", "required":[ "msg" ], "properties":{ "msg":{ "type":"string", "example":"Dependency exists/Dependency does not exist", "description":"Indicates existence of references to the object in the database." } } }, "KDS":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value.", "example":1 }, "objectNum":{ "description":"Object number of the Kitchen Display Client.", "type":"integer", "example":1 } } }, "KDSDisplaysGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Kitchen Display Client objects of the organization.", "items":{ "$ref":"#/definitions/KDSDisplaysv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "KDSDisplaysv1":{ "description":"Model for KDS Displays Object.", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit.", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit.", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages.", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object number of the KDS Display.", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the KDS Display in configured languages.", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "kdsControllerObjNum":{ "description":"Object number of the KDS controller for the display.", "type":"integer", "example":1 }, "kdsControllerName":{ "description":"A group of string objects representing the name of the KDS controller for the display in configured languages.", "type":"integer", "example":1 }, "ipAddress":{ "description":"The IP address for the display.", "type":"string", "example":"0.0.0.0" }, "toolbarObjNum":{ "description":"Object number of the toolbar to use for the display.", "type":"integer", "example":1 }, "toolbarName":{ "description":"A group of string objects representing the name of the toolbar to use for the display in configured languages.", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "bumpBarObjNum":{ "description":"Object number of the bump bar to use for the display.", "type":"integer", "example":1 }, "bumpBarName":{ "description":"A group of string objects representing the name of the Bump Bar to use for the display in configured languages.", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "platformType":{ "description":"The platform type of the display.", "type":"integer", "example":1 }, "cardId":{ "description":"The slot number or position of the SEI card in the OASYS box. Applicable only if platformType = 1", "type":"integer", "example":1 }, "videoId":{ "description":"An ID to identify the display in the system. Applicable only if platformType = 1", "type":"integer", "example":1 }, "displayOrientation":{ "description":"The orientation type for the display.", "type":"integer", "example":1 }, "orderSelectionTimeInSecs":{ "description":"The amount of time in seconds an order remains selected on the display.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the KDS Display", "type":"string", "example":"00000011000000000000000000000000" }, "optionsExt":{ "description":"An object containing the descriptive options list associated with the KDS Display.", "type":"object", "properties":{ "enableItemSelect":{ "description":"A Boolean flag indicating to allow kitchen staff to select items on the chit.", "type":"integer", "example":1 }, "onlyActiveTables":{ "description":"A Boolean flag indicating to show only tables that are currently active on the SOS Display.", "type":"integer", "example":1 }, "dynamicDisplays":{ "description":"A Boolean flag indicating to Select to enable Dynamic Display on an SOS Display.", "type":"integer", "example":1 }, "displayZone":{ "description":"A Boolean flag indicating to show zones when SOS and Dynamic Displays are enabled.", "type":"integer", "example":1 }, "displayRVCSeparator":{ "description":"A Boolean flag indicating to separate orders by revenue center when SOS and Dynamic Displays are enabled.", "type":"integer", "example":1 }, "displayItemDoubleTouchBump":{ "description":"A Boolean flag indicating to prevent kitchen staff from bumping items from KDS Displays using double touch.", "type":"integer", "example":1 }, "allowRemoteView":{ "description":"A Boolean flag indicating to allow other KDS Displays to remotely view orders on this display.", "type":"integer", "example":1 }, "allowRemoteActions":{ "description":"A Boolean flag indicating to allow other KDS Displays to perform Done, Recall, and Review actions on this KDS Display while in Remote View.", "type":"integer", "example":1 }, "resetKDSChitTimer":{ "description":"A Boolean flag indicating to have the KDS chit timer reset on the first service total.", "type":"integer", "example":1 }, "showMouseCursor":{ "description":"A Boolean flag indicating to make the cursor visible on the KDS display.", "type":"integer", "example":1 }, "allowHideFrame":{ "description":"A Boolean flag indicating to hide the KDS Display window frame when the KDS Display UI is not in full-screen mode.", "type":"integer", "example":1 } } }, "displayType":{ "description":"An integer value representing the type of the display.", "type":"integer", "example":1 }, "toolBarPosition":{ "description":"An integer value representing the location for the toolbar on the display.", "type":"integer", "example":1 }, "panelLayout":{ "description":"If the display has two panels, select whether the panels appear side-by-side or one on top of the other. Applicable only if displayType = 2 or 3", "type":"integer", "example":1 }, "tableDetailToolbarObjNum":{ "description":"Object number of the toolbar to use when viewing Table Details on a SOS Display.", "type":"integer", "example":1 }, "tableDetailToolbarName":{ "description":"A group of string objects representing the name of the toolbar to use when viewing Table Details on a SOS Display in configured languages.", "type":"integer", "example":1 }, "panelConfiguration":{ "description":"An array of configurations for the different panel definitions of the Display. Applicable only if displayType = 2 or 3", "type":"array", "items":{ "type":"object", "properties":{ "panelNum":{ "description":"The number of panels to show on the KDS Display.", "type":"integer", "example":1 }, "proportion":{ "description":"The ratio for the panel to occupy on the KDS Display.", "type":"integer", "example":1 }, "chitColumns":{ "description":"The number of chit columns to display in the panel.", "type":"integer", "example":1 }, "chitRows":{ "description":"The number of chit rows to display in the panel.", "type":"integer", "example":1 }, "capacity":{ "description":"The relative capacity of the order devices linked to this panel. This field should only be used with KDS Controllers | General | Options | 13 - Enable Capacity Scheduling.", "type":"integer", "example":1 } } } }, "kdsChitLayoutStyleObjNum":{ "description":"Object number of the chit layout type for the display.", "type":"integer", "example":1 }, "kdsChitLayoutStyleName":{ "description":"A group of string objects representing the name of the chit layout type for the display in configured languages.", "type":"integer", "example":1 }, "serpentineMode":{ "description":"A value representing the arrangement of chits on the display.", "type":"integer", "example":1 }, "menuItemFont":{ "description":"The font size for menu items to appear on the display.", "type":"integer", "example":1 }, "comboItemFont":{ "description":"The font size for the Combo Items as they should appear on the KDS Display.", "type":"integer", "example":1 }, "orderTypeFont":{ "description":"The font size for the Order Type text to appear on the display.", "type":"integer", "example":1 }, "sosDisplayTableColumns":{ "description":"The number of columns to use to present table numbers for the SOS Table Display. Applicable only if displayType = 1", "type":"integer", "example":1 }, "sosDisplayTimeout":{ "description":"The duration that a table appears on the regular Expo Display screen before returning to the SOS Table Display. Applicable only if displayType = 1", "type":"integer", "example":1 }, "sosZoneFont":{ "description":"The font size for SOS zones to appear on the display. Applicable only if displayType = 1", "type":"integer", "example":1 }, "sosSortMethod":{ "description":"The SOS sort method for the display. Use the Width fields to determine how each column appears.", "type":"integer", "example":1 }, "recallReviewList":{ "description":"

    An array of column configurations to display on the KDS Recall/ Review List.

    \n

    Configuration is allowed for up to 6 columns. Use the Column Type to select the detail types from the following preset 9 choices.

    \n\n \n \n \n \n \n \n \n \n \n \n \n
    0 None
    1 Check
    2 Table
    3 Revenue Center
    4 Done Time
    5 Done Time Elapsed
    6 Order Time Elapsed
    7 Server
    8 Order Type
    9 Items
    \n

    Use the Width fields to determine how each column appears.

    \n", "type":"array", "items":{ "type":"object", "properties":{ "colNum":{ "description":"The column number of the recall/review list.", "type":"integer", "example":1 }, "colType":{ "description":"The column type from the preset 9 choices.", "type":"integer", "example":1 }, "width":{ "description":"The column width relative to the total screen width.", "type":"integer", "example":1 } } } }, "kdsProdLocation":{ "description":"The placement of production item counters on the display. 1 - Top, 2 - Bottom", "type":"integer", "example":1 }, "kdsProdColumns":{ "description":"The maximum number of production item counters to show per line or production bar.", "type":"integer", "example":1 }, "prodItems":{ "description":"An array of production items.", "type":"array", "items":{ "type":"object", "properties":{ "prodItemNum":{ "description":"Sequence number of the production item.", "type":"integer", "example":1 }, "prodItemObjNum":{ "description":"Object number of the production item.", "type":"integer", "example":1 }, "prodItemName":{ "description":"A group of strings representing the name of the production items in configured languages.", "type":"integer", "example":1 }, "persistence":{ "description":"An integer value representing the persistence type of the item on the display. 1 - Static. Shows counts on KDS displays even when the quantity is zero. 2 - Dynamic. Shows counts on KDS displays only for a non-zero quantity.", "type":"integer", "example":1 } } } }, "resolutionWidth":{ "description":"The width (in pixels) used to display KDS in a side-by-side (split window) display.", "type":"integer", "example":1 }, "resolutionHeight":{ "description":"The height (in pixels) used to display KDS in a side-by-side (split window) display.", "type":"integer", "example":1 }, "locationFromTop":{ "description":"A value representing how far from the top (in pixels) the KDS window should be placed on the workstation display screen.", "type":"integer", "example":1 }, "locationFromLeft":{ "description":"A value representing how far from the left (in pixels) the KDS window should be placed on the workstation display screen.", "type":"integer", "example":1 }, "minTableState":{ "description":"Minimum Table State", "type":"integer", "example":0 }, "maxTableState":{ "description":"Maximum Table State", "type":"integer", "example":1 } } }, "KitchenDisplayClientsv2":{ "description":"Model for KDS Displays Object.", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit.", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit.", "type":"integer", "example":1 }, "kdsClientId":{ "type":"integer", "description":"Unique reference of a Kitchen Display Client", "example":2000 }, "objectNum":{ "description":"Object number of the KDS Display.", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the KDS Display in configured languages.", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "kdsControllerObjNum":{ "description":"Object number of the KDS controller for the display.", "type":"integer", "example":1 }, "ipAddress":{ "description":"The IP address for the display.", "type":"string", "example":"0.0.0.0" }, "toolbarObjNum":{ "description":"Object number of the toolbar to use for the display.", "type":"integer", "example":1 }, "bumpBarObjNum":{ "description":"Object number of the bump bar to use for the display.", "type":"integer", "example":1 }, "platformType":{ "description":"The platform type of the display.", "type":"integer", "example":1 }, "cardId":{ "description":"The slot number or position of the SEI card in the OASYS box. Applicable only if platformType = 1", "type":"integer", "example":1 }, "videoId":{ "description":"An ID to identify the display in the system. Applicable only if platformType = 1", "type":"integer", "example":1 }, "displayOrientation":{ "description":"The orientation type for the display.", "type":"integer", "example":1 }, "orderSelectionTimeInSecs":{ "description":"The amount of time in seconds an order remains selected on the display.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the KDS Display", "type":"string", "example":"00000011000000000000000000000000" }, "optionsExt":{ "description":"An object containing the descriptive options list associated with the KDS Display.", "type":"object", "properties":{ "enableItemSelect":{ "description":"A Boolean flag indicating to allow kitchen staff to select items on the chit.", "type":"integer", "example":1 }, "onlyActiveTables":{ "description":"A Boolean flag indicating to show only tables that are currently active on the SOS Display.", "type":"integer", "example":1 }, "dynamicDisplays":{ "description":"A Boolean flag indicating to Select to enable Dynamic Display on an SOS Display.", "type":"integer", "example":1 }, "displayZone":{ "description":"A Boolean flag indicating to show zones when SOS and Dynamic Displays are enabled.", "type":"integer", "example":1 }, "displayRVCSeparator":{ "description":"A Boolean flag indicating to separate orders by revenue center when SOS and Dynamic Displays are enabled.", "type":"integer", "example":1 }, "displayItemDoubleTouchBump":{ "description":"A Boolean flag indicating to prevent kitchen staff from bumping items from KDS Displays using double touch.", "type":"integer", "example":1 }, "allowRemoteView":{ "description":"A Boolean flag indicating to allow other KDS Displays to remotely view orders on this display.", "type":"integer", "example":1 }, "allowRemoteActions":{ "description":"A Boolean flag indicating to allow other KDS Displays to perform Done, Recall, and Review actions on this KDS Display while in Remote View.", "type":"integer", "example":1 }, "resetKDSChitTimer":{ "description":"A Boolean flag indicating to have the KDS chit timer reset on the first service total.", "type":"integer", "example":1 }, "showMouseCursor":{ "description":"A Boolean flag indicating to make the cursor visible on the KDS display.", "type":"integer", "example":1 }, "allowHideFrame":{ "description":"A Boolean flag indicating to hide the KDS Display window frame when the KDS Display UI is not in full-screen mode.", "type":"integer", "example":1 } } }, "displayType":{ "description":"An integer value representing the type of the display.", "type":"integer", "example":1 }, "toolBarPosition":{ "description":"An integer value representing the location for the toolbar on the display.", "type":"integer", "example":1 }, "panelLayout":{ "description":"If the display has two panels, select whether the panels appear side-by-side or one on top of the other. Applicable only if displayType = 2 or 3", "type":"integer", "example":1 }, "tableDetailToolbarObjNum":{ "description":"Object number of the toolbar to use when viewing Table Details on a SOS Display.", "type":"integer", "example":1 }, "panelConfiguration":{ "description":"An array of configurations for the different panel definitions of the Display. Applicable only if displayType = 2 or 3", "type":"array", "items":{ "type":"object", "properties":{ "panelNum":{ "description":"The number of panels to show on the KDS Display.", "type":"integer", "example":1 }, "proportion":{ "description":"The ratio for the panel to occupy on the KDS Display.", "type":"integer", "example":1 }, "chitColumns":{ "description":"The number of chit columns to display in the panel.", "type":"integer", "example":1 }, "chitRows":{ "description":"The number of chit rows to display in the panel.", "type":"integer", "example":1 }, "capacity":{ "description":"The relative capacity of the order devices linked to this panel. This field should only be used with KDS Controllers | General | Options | 13 - Enable Capacity Scheduling.", "type":"integer", "example":1 } } } }, "kdsChitLayoutStyleObjNum":{ "description":"Object number of the chit layout type for the display.", "type":"integer", "example":1 }, "serpentineMode":{ "description":"A value representing the arrangement of chits on the display.", "type":"integer", "example":1 }, "menuItemFont":{ "description":"The font size for menu items to appear on the display.", "type":"integer", "example":1 }, "comboItemFont":{ "description":"The font size for the Combo Items as they should appear on the KDS Display.", "type":"integer", "example":1 }, "orderTypeFont":{ "description":"The font size for the Order Type text to appear on the display.", "type":"integer", "example":1 }, "sosDisplayTableColumns":{ "description":"The number of columns to use to present table numbers for the SOS Table Display. Applicable only if displayType = 1", "type":"integer", "example":1 }, "sosDisplayTimeout":{ "description":"The duration that a table appears on the regular Expo Display screen before returning to the SOS Table Display. Applicable only if displayType = 1", "type":"integer", "example":1 }, "sosZoneFont":{ "description":"The font size for SOS zones to appear on the display. Applicable only if displayType = 1", "type":"integer", "example":1 }, "sosSortMethod":{ "description":"The SOS sort method for the display. Use the Width fields to determine how each column appears.", "type":"integer", "example":1 }, "recallReviewList":{ "description":"

    An array of column configurations to display on the KDS Recall/ Review List.

    \n

    Configuration is allowed for up to 6 columns. Use the Column Type to select the detail types from the following preset 9 choices.

    \n\n \n \n \n \n \n \n \n \n \n \n \n
    0 None
    1 Check
    2 Table
    3 Revenue Center
    4 Done Time
    5 Done Time Elapsed
    6 Order Time Elapsed
    7 Server
    8 Order Type
    9 Items
    \n

    Use the Width fields to determine how each column appears.

    \n", "type":"array", "items":{ "type":"object", "properties":{ "colNum":{ "description":"The column number of the recall/review list.", "type":"integer", "example":1 }, "colType":{ "description":"The column type from the preset 9 choices.", "type":"integer", "example":1 }, "width":{ "description":"The column width relative to the total screen width.", "type":"integer", "example":1 } } } }, "kdsProdLocation":{ "description":"The placement of production item counters on the display. 1 - Top, 2 - Bottom", "type":"integer", "example":1 }, "kdsProdColumns":{ "description":"The maximum number of production item counters to show per line or production bar.", "type":"integer", "example":1 }, "prodItems":{ "description":"An array of production items.", "type":"array", "items":{ "type":"object", "properties":{ "prodItemNum":{ "description":"Sequence number of the production item.", "type":"integer", "example":1 }, "prodItemObjNum":{ "description":"Object number of the production item.", "type":"integer", "example":1 }, "persistence":{ "description":"An integer value representing the persistence type of the item on the display. 1 - Static. Shows counts on KDS displays even when the quantity is zero. 2 - Dynamic. Shows counts on KDS displays only for a non-zero quantity.", "type":"integer", "example":1 } } } }, "resolutionWidth":{ "description":"The width (in pixels) used to display KDS in a side-by-side (split window) display.", "type":"integer", "example":1 }, "resolutionHeight":{ "description":"The height (in pixels) used to display KDS in a side-by-side (split window) display.", "type":"integer", "example":1 }, "locationFromTop":{ "description":"A value representing how far from the top (in pixels) the KDS window should be placed on the workstation display screen.", "type":"integer", "example":1 }, "locationFromLeft":{ "description":"A value representing how far from the left (in pixels) the KDS window should be placed on the workstation display screen.", "type":"integer", "example":1 }, "minTableState":{ "description":"Minimum Table State", "type":"integer", "example":0 }, "maxTableState":{ "description":"Maximum Table State", "type":"integer", "example":1 } } }, "KDSDisplaysCUDRequestBody":{ "description":"Model for KDS Displays CUD Request.", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit.", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the KDS Display.", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the KDS Display in configured languages.", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "kdsControllerObjNum":{ "description":"Object number of the KDS controller for the display.", "type":"integer", "example":1 }, "ipAddress":{ "description":"The IP address for the display.", "type":"string", "example":"0.0.0.0" }, "toolbarObjNum":{ "description":"Object number of the toolbar to use for the display.", "type":"integer", "example":1 }, "bumpBarObjNum":{ "description":"Object number of the bump bar to use for the display.", "type":"integer", "example":1 }, "platformType":{ "description":"The platform type of the display.", "type":"integer", "example":1 }, "cardId":{ "description":"The slot number or position of the SEI card in the OASYS box. Applicable only if platformType = 1", "type":"integer", "example":1 }, "videoId":{ "description":"An ID to identify the display in the system. Applicable only if platformType = 1", "type":"integer", "example":1 }, "displayOrientation":{ "description":"The orientation type for the display.", "type":"integer", "example":1 }, "orderSelectionTimeInSecs":{ "description":"The amount of time in seconds an order remains selected on the display.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the KDS Display", "type":"string", "example":"00000011000000000000000000000000" }, "displayType":{ "description":"An integer value representing the type of the display.", "type":"integer", "example":1 }, "toolBarPosition":{ "description":"An integer value representing the location for the toolbar on the display.", "type":"integer", "example":1 }, "panelLayout":{ "description":"If the display has two panels, select whether the panels appear side-by-side or one on top of the other. Applicable only if displayType = 2 or 3", "type":"integer", "example":1 }, "tableDetailToolbarObjNum":{ "description":"Object number of the toolbar to use when viewing Table Details on a SOS Display.", "type":"integer", "example":1 }, "panelConfiguration":{ "description":"An array of configurations for the different panel definitions of the Display. Applicable only if displayType = 2 or 3", "type":"array", "items":{ "type":"object", "properties":{ "panelNum":{ "description":"The number of panels to show on the KDS Display.", "type":"integer", "example":1 }, "proportion":{ "description":"The ratio for the panel to occupy on the KDS Display.", "type":"integer", "example":1 }, "chitColumns":{ "description":"The number of chit columns to display in the panel.", "type":"integer", "example":1 }, "chitRows":{ "description":"The number of chit rows to display in the panel.", "type":"integer", "example":1 }, "capacity":{ "description":"The relative capacity of the order devices linked to this panel. This field should only be used with KDS Controllers | General | Options | 13 - Enable Capacity Scheduling.", "type":"integer", "example":1 } } } }, "kdsChitLayoutStyleObjNum":{ "description":"Object number of the chit layout type for the display.", "type":"integer", "example":1 }, "serpentineMode":{ "description":"A value representing the arrangement of chits on the display.", "type":"integer", "example":1 }, "menuItemFont":{ "description":"The font size for menu items to appear on the display.", "type":"integer", "example":1 }, "comboItemFont":{ "description":"The font size for the Combo Items as they should appear on the KDS Display.", "type":"integer", "example":1 }, "orderTypeFont":{ "description":"The font size for the Order Type text to appear on the display.", "type":"integer", "example":1 }, "sosDisplayTableColumns":{ "description":"The number of columns to use to present table numbers for the SOS Table Display. Applicable only if displayType = 1", "type":"integer", "example":1 }, "sosDisplayTimeout":{ "description":"The duration that a table appears on the regular Expo Display screen before returning to the SOS Table Display. Applicable only if displayType = 1", "type":"integer", "example":1 }, "sosZoneFont":{ "description":"The font size for SOS zones to appear on the display. Applicable only if displayType = 1", "type":"integer", "example":1 }, "sosSortMethod":{ "description":"The SOS sort method for the display. Use the Width fields to determine how each column appears.", "type":"integer", "example":1 }, "recallReviewList":{ "description":"

    An array of column configurations to display on the KDS Recall/ Review List.

    \n

    Configuration is allowed for up to 6 columns. Use the Column Type to select the detail types from the following preset 9 choices.

    \n\n \n \n \n \n \n \n \n \n \n \n \n
    0 None
    1 Check
    2 Table
    3 Revenue Center
    4 Done Time
    5 Done Time Elapsed
    6 Order Time Elapsed
    7 Server
    8 Order Type
    9 Items
    \n

    Use the Width fields to determine how each column appears.

    \n", "type":"array", "items":{ "type":"object", "properties":{ "colNum":{ "description":"The column number of the recall/review list.", "type":"integer", "example":1 }, "colType":{ "description":"The column type from the preset 9 choices.", "type":"integer", "example":1 }, "width":{ "description":"The column width relative to the total screen width.", "type":"integer", "example":1 } } } }, "kdsProdLocation":{ "description":"The placement of production item counters on the display. 1 - Top, 2 - Bottom", "type":"integer", "example":1 }, "kdsProdColumns":{ "description":"The maximum number of production item counters to show per line or production bar.", "type":"integer", "example":1 }, "prodItems":{ "description":"An array of production items.", "type":"array", "items":{ "type":"object", "properties":{ "prodItemNum":{ "description":"Sequence number of the production item.", "type":"integer", "example":1 }, "prodItemObjNum":{ "description":"Object number of the production item.", "type":"integer", "example":1 }, "persistence":{ "description":"An integer value representing the persistence type of the item on the display. 1 - Static. Shows counts on KDS displays even when the quantity is zero. 2 - Dynamic. Shows counts on KDS displays only for a non-zero quantity.", "type":"integer", "example":1 } } } }, "resolutionWidth":{ "description":"The width (in pixels) used to display KDS in a side-by-side (split window) display.", "type":"integer", "example":1 }, "resolutionHeight":{ "description":"The height (in pixels) used to display KDS in a side-by-side (split window) display.", "type":"integer", "example":1 }, "locationFromTop":{ "description":"A value representing how far from the top (in pixels) the KDS window should be placed on the workstation display screen.", "type":"integer", "example":1 }, "locationFromLeft":{ "description":"A value representing how far from the left (in pixels) the KDS window should be placed on the workstation display screen.", "type":"integer", "example":1 }, "minTableState":{ "description":"Minimum Table State", "type":"integer", "example":0 }, "maxTableState":{ "description":"Maximum Table State", "type":"integer", "example":1 } } }, "OrderDevice":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the printer", "type":"integer", "example":1 } } }, "OrderDevicesGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Order Devices objects of the organization.", "items":{ "$ref":"#/definitions/OrderDevicesv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "OrderDevicesv1":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Hierarchy unit object number", "type":"integer", "example":1 }, "hierUnitName":{ "description":"Hierarchy Unit Name", "type":"object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "objectNum":{ "description":"Object number of the Order Device", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Order Device 1", "es-MX":"Dispositivo de pedido" } }, "deviceType":{ "description":"The remote device to which orders print. For a local device, orders print at the Local Order Receipt printer set for the workstation from which the order is placed. 1 - Remote, 2 - Local", "type":"integer", "example":1 }, "primaryDeviceType":{ "description":"Select the Primary Device Type . 0 - Printer, 1 - KDS", "type":"integer", "example":0 }, "deviceObjNum":{ "description":"Object number of the relevant order device record.", "type":"integer", "example":0 }, "deviceName":{ "type":"object", "description":"name of the relevant order device record", "example":{ "en-US":"Order Device 1", "es-MX":"Dispositivo de pedido" } }, "backupDeviceObjNum":{ "description":"Object number of the backup order device in the event of a communication failure or other problem.", "type":"integer", "example":0 }, "backupDeviceName":{ "type":"object", "description":"Backup Device Name", "example":{ "en-US":"Order Device 1", "es-MX":"Dispositivo de pedido" } }, "orderDeviceRedirectObjNum":{ "description":"Object number of the order device to which orders sent to this device should be redirected. Typically, this field is set to itself.", "type":"integer", "example":0 }, "orderDeviceRedirectName":{ "type":"object", "description":"Order Device Redirect Name", "example":{ "en-US":"Order Device 1", "es-MX":"Dispositivo de pedido" } }, "customInstructions":{ "description":"instructions (up to 250 characters) for the workstation's script to handle order output based on custom instructions in the script in case of using Custom Print Handling", "type":"string", "example":"Custom Instructions" }, "primaryDistGroupObjNum":{ "description":"Object number of the Primary Distribution Group for the KDS. Applicable only if primaryDeviceType = 1", "type":"integer", "example":1 }, "primaryDistGroupName":{ "type":"object", "description":"Primary Dist Group Name", "example":{ "en-US":"Order Device 1", "es-MX":"Dispositivo de pedido" } }, "condimentSortType":{ "description":"Specify how condiments will be sorted on the selected order device. The options are: 1 - No condiment sorting - (Condiments are listed in the order entered by the user), 2 - Sort allowed condiments - (Required condiments are not sorted), 3 - Sort all condiments (All condiments are sorted)", "type":"integer", "example":1 }, "menuItemPrinting":{ "description":"the type of menu items to output to the order device. 1 - All Items, 2 - Only Items with Condiments, 3 - Only items without condiments", "type":"integer", "example":1 }, "maxNumLinePerChit":{ "description":"the maximum number of lines (0-99) to print on each page of an order chit. Applicable only if primaryDeviceType = 0", "type":"integer", "example":0 }, "sortConsoldiationMethod":{ "description":"

    The sort and consolidation method for the order device.

    \n \n \n \n \n \n \n \n \n \n \n
    0 Do Not Sort
    1 Seat Consolidated
    2 Seat No Consolidation
    3 Print Group Consolidated
    4 Print Group No Consolidation
    5 Seat & Print Group Consolidated
    6 Seat & Print Group No Consolidation
    7 Print Group and Seat Consolidated
    8 Print Group and Seat No Consolidation
    \n

    Applicable only if primaryDeviceType = 0

    \n", "type":"integer", "example":0 }, "languageObjNum":{ "description":"Object number of the primary language for the order device. Applicable only if primaryDeviceType = 0", "type":"integer", "example":1 }, "languageName":{ "description":"Name of the primary language for the order device. Applicable only if primaryDeviceType = 0", "type":"string", "example":"English" }, "language2ObjNum":{ "description":"Object number of the secondary language for the print output. Applicable only if primaryDeviceType = 0", "type":"integer", "example":2 }, "language2Name":{ "description":"Name of the secondary language for the print output. Applicable only if primaryDeviceType = 0", "type":"string", "example":"English" }, "language3ObjNum":{ "description":"Object number of the third language for the print output. Applicable only if primaryDeviceType = 0", "type":"integer", "example":3 }, "language3Name":{ "description":"Name of the third language for the print output. Applicable only if primaryDeviceType = 0", "type":"string", "example":"English" }, "lineFeedBeforeOrder":{ "description":"The number of lines to advance before printing the order on order chits. Applicable only if primaryDeviceType = 0", "type":"integer", "example":0 }, "lineFeedsAfterOrder":{ "description":"The number of lines to advance after printing the order on order chits. Applicable only if primaryDeviceType = 0", "type":"integer", "example":0 }, "kdsSettings":{ "type":"object", "properties":{ "course1FirstAlertTimeInSecs":{ "description":"The amount of time, in seconds, for course 1 items to show the first alert.", "type":"integer", "example":0 }, "course1SecondAlertTimeInSecs":{ "description":"The amount of time, in seconds, for course 2 items to show the second alert.", "type":"integer", "example":0 }, "othCourseFirstAlertTimeInSecs":{ "description":"The amount of time, in seconds, for any course except course 1 to show the first alert.", "type":"integer", "example":0 }, "othCourseSecondAlertTimeInSecs":{ "description":"The amount of time, in seconds, for any course except course 1 to show the second alert.", "type":"integer", "example":0 }, "primaryRunnerChitPrinterObjNum":{ "description":"Object number of the printer where runner chits print when orders are bumped from the KDS.", "type":"integer", "example":0 }, "primaryRunnerChitPrinterName":{ "type":"object", "description":"Primary Runner Chit Printer Name", "example":{ "en-US":"Order Device 1", "es-MX":"Dispositivo de pedido" } }, "backupRunnerChitPrinterObjNum":{ "description":"Object number of the printer where runner chits print when orders are bumped from the KDS if Simphony cannot establish communication with the primary runner chit printer", "type":"integer", "example":0 }, "backupRunnerChitPrinterName":{ "type":"object", "description":"Backup Runner Chit Printer Name", "example":{ "en-US":"Order Device 1", "es-MX":"Dispositivo de pedido" } }, "sendToPanelNum":{ "description":"The number of a panel (1 through 9) where orders appear on this device.", "type":"integer", "example":0 }, "domType":{ "description":"the Dynamic Order Mode type for the KDS Display.", "type":"integer", "example":0 }, "addSortRule":{ "description":"The sort type to use when the quantity of an item changes.", "type":"integer", "example":0 }, "modifySortRule":{ "description":"The sort type to use when existing items on an order are modified.\\ 0 - Sort to Top", "type":"integer", "example":0 }, "voidSortRule":{ "description":"The sort type to use when an item is voided.", "type":"integer", "example":0 }, "addHighlightScheme":{ "description":"The color configuration to use to highlight items with the quantity changed.", "type":"integer", "example":0 }, "modifyHighlightScheme":{ "description":"The color configuration to use to highlight modified items on orders.", "type":"integer", "example":0 }, "voidHighlightScheme":{ "description":"The color configuration to use to highlight voided items.", "type":"integer", "example":0 }, "beepOnNewOrder":{ "description":"The sound type to emit when an order is received on the order device", "type":"integer", "example":0 }, "newOrderNotificationTimeInSecs":{ "description":"The length of time, in seconds, newly added items flash on screen.", "type":"integer", "example":0 }, "displayNewOrderNotification":{ "description":"A Boolean flag indicating to make new orders flash when appearing on the KDS Display if not using DOM", "type":"boolean", "example":false }, "beepOnPrioritize":{ "description":"The sound type to emit when an order is prioritized or the order priority is increased on the order device. 0 - None, 1 - PC Speaker, 2 - WAV File, 3 - Bump Bar Speaker", "type":"integer", "example":0 }, "beepOnVIP":{ "description":"The sound type to emit when a VIP order is received.", "type":"integer", "example":0 }, "beepOnRush":{ "description":"0 - None, 1 - PC Speaker, 2 - WAV File, 3 - Bump Bar Speaker", "type":"integer", "example":0 } } }, "printerOptions":{ "description":"A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the Printer Order Device. Applicable if primaryDeviceType = 0", "type":"string", "example":"000000000000000000000000000000000000000000000000" }, "printerOptionsExt":{ "type":"object", "properties":{ "printTransEmpNumAndName":{ "description":"A Boolean flag indicating to print the employee name and number of the transaction operator. Deselect to print the employee name and number of the check operator.", "type":"boolean", "example":false }, "printDopplebon":{ "description":"A Boolean flag indicating to print a separate order chit for each menu item in the current service round (dopplebon style). Deselect to print one order chit for all menu items in the current service round.", "type":"boolean", "example":false }, "printDopplebonSummary":{ "description":"A Boolean flag indicating to print an order summary chit before printing an order's dopplebon order chits. Deselect to suppress dopplebon summary chit printing.", "type":"boolean", "example":false }, "printSeatNumWithIndvItems":{ "description":"A Boolean flag indicating to print seat numbers with each individual menu item.", "type":"boolean", "example":false }, "printRVCNameOnOrder":{ "description":"A Boolean flag indicating to show the revenue center name with each order sent to the order device. Deselect to hide the name.", "type":"boolean", "example":false }, "printVoidMarkerBeforeVoid":{ "description":"A Boolean flag indicating to print a VV VOID VV line, in red or inverse, in front of voided menu items. Deselect to print voided items in red", "type":"boolean", "example":false }, "printCondimentsInRed":{ "description":"A Boolean flag indicating to print condiments in red ink or in inverse. Deselect to print condiments in red/inverse or black, depending on the Print Class Red/Black option setting.", "type":"boolean", "example":false }, "printBothMenuItemNames":{ "description":"A Boolean flag indicating to print both names configured for a menu item. Deselect to print one name.", "type":"boolean", "example":false }, "printChkInfoLinesBeforeHeader":{ "description":"A Boolean flag indicating to print guest check information lines before the order device header. Deselect to suppress the printing.", "type":"boolean", "example":false }, "printChkInfoLinesAfterHeader":{ "description":"A Boolean flag indicating to print guest check information lines after the order device header. Deselect to suppress the printing.", "type":"boolean", "example":false }, "printChkInfoLinesAfterTrailer":{ "description":"A Boolean flag indicating to print guest check information lines after the order device trailer. Deselect to suppress the printing.", "type":"boolean", "example":false }, "printSecondaryItems":{ "description":"A Boolean flag indicating to print secondary items being broadcast from other order devices.", "type":"boolean", "example":false }, "printSecondaryPrinterHeader":{ "description":"A Boolean flag indicating to send menu items sent to this order printer as secondary items to other order printers.", "type":"boolean", "example":false }, "printSecondaryItemsInRed":{ "description":"A Boolean flag indicating to print secondary items in red. Deselect to print secondary items in black.", "type":"boolean", "example":false }, "supressBlankLinesBetweenSecondaryItems":{ "description":"A Boolean flag indicating to suppress printing extra line spacing between secondary items on order chits.", "type":"boolean", "example":false }, "excludeVoids":{ "description":"A Boolean flag indicating to not send voids of previous round items to the kitchen.", "type":"boolean", "example":false }, "intersperseDiffLanguages":{ "description":"A Boolean flag indicating to print menu items in each different language before printing condiments when printing in multiple languages.", "type":"boolean", "example":false }, "identiftyComboMeals":{ "description":"A Boolean flag indicating to print a flag to denote menu items that are part of a combo meal.", "type":"boolean", "example":false }, "printDiningCourseHeader":{ "description":"A Boolean flag indicating to print a dining course header and to group menu items by dining course.", "type":"boolean", "example":false }, "formatPrefixOnSeparateLine":{ "description":"A Boolean flag indicating to print the prefix on a separate line above the condiment. Deselect to print the prefix on the same line as the condiment.", "type":"boolean", "example":false }, "printSingleWide":{ "description":"A Boolean flag indicating to print the order using single-width characters.", "type":"boolean", "example":false } } }, "kdsOptions":{ "description":"A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the KDS Order Device. Applicable if primaryDeviceType = 1", "type":"string", "example":"000000000000000000000000000000000000000000000000" }, "kdsOptionsExt":{ "type":"object", "properties":{ "enableKDSConsolidation":{ "description":"A Boolean flag indicating to consolidate identical items with different modifiers onto one line, preceded by the quantity on the KDS Display. This feature is not supported with DOM or a DOM KDS chit layout style.", "type":"boolean", "example":false }, "sortVoidsToTop":{ "description":"A Boolean flag indicating to sort voided items to the top of the screen if not using DOM.", "type":"boolean", "example":false }, "singleItemPerSubOrder":{ "description":"A Boolean flag indicating to show every item on an order on its own chit. This option is required to enable Option 32 - removeOriginalChitWhenItemVoided.", "type":"boolean", "example":false }, "printOnPrepDone":{ "description":"A Boolean flag indicating to print a runner chit when the order is marked Done at a Prep Station.", "type":"boolean", "example":false }, "printOnExpoDone":{ "description":"A Boolean flag indicating to print a runner chit when the order is marked Done at the Expo Station.", "type":"boolean", "example":false }, "printOnAllPrepDone":{ "description":"A Boolean flag indicating to print a runner chit when an order is complete at all Prep Stations and before the order is bumped from the KDS Expo Display.", "type":"boolean", "example":false }, "sortBySeat":{ "description":"A Boolean flag indicating to sort items by seat number. Deselect to show items in the order in which they were ordered.", "type":"boolean", "example":false }, "resortWhenAllPrepDone":{ "description":"A Boolean flag indicationg to re-sort when all prep done.", "type":"boolean", "example":false }, "displaySubTotal":{ "description":"A Boolean flag indicating to cause the KDS to display the order subtotal if using DOM. Note that Subtotal is only displayed in certain layouts - 301, 305, 306, 309, 312, 315 , 317, 320, 401 and 402.Subtotal = Menu Item Sales Total + Discount + Tax + Auto Service Charge + Service Charge + Rounding Total", "type":"boolean", "example":false }, "dontDisplayVoids":{ "description":"A Boolean flag indicating select to remove voided items from the KDS Display. Deselect to show the letter V next to voided items if using DOM.", "type":"boolean", "example":false }, "displayMenuItemCount":{ "description":"A Boolean flag indicating to show the menu item count on the KDS Display if using DOM", "type":"boolean", "example":false }, "noExpoDoneBeforePaid":{ "description":"A Boolean flag indicating to not allow the order to be expedited before the order is paid if using DOM", "type":"boolean", "example":false }, "unconsolidateItemsAfterCondimentEntry":{ "description":"A Boolean flag indicating to unconsolidate multiple quantities of similar menu items if condiments are selected for each item.", "type":"boolean", "example":false }, "multipleCondimentsPerLine":{ "description":"A Boolean flag indicating to print condiments in a continuous line on each order chit. Deselect to print each condiment on a separate line beneath the referenced menu item.", "type":"boolean", "example":false }, "displayNewOrderNotification":{ "description":"A Boolean flag indicating to make new orders flash when appearing on the KDS Display if not using DOM.", "type":"boolean", "example":false }, "expoDoneExempt":{ "description":"A Boolean flag indicating to prevent an Expo Station from marking a sub-order as Done when it is marked as Done on another Expo Station.", "type":"boolean", "example":false }, "printCourseHeader":{ "description":"A Boolean flag indicating print course header.", "type":"boolean", "example":false }, "dontConsolidate":{ "description":"A Boolean flag indicating to print identical items separately if they are posted separately. Deselect to consolidate identical items onto one line, preceded by the quantity.", "type":"boolean", "example":false }, "noPrepDoneBeforePaid":{ "description":"A Boolean flag indicating to prevent an order from being bumped from the order device, until after the order has been paid for if using DOM", "type":"boolean", "example":false }, "showPrevCourseIndicator":{ "description":"A Boolean flag indicating to show an icon on order chits from any course other than the first course to indicate that a previous course exists for this check. This feature only works on systems using KDS Coursing functionality with KDS Controller option Display Next Course after Previous Course Complete.", "type":"boolean", "example":false }, "disableDoubleTouchBump":{ "description":"A Boolean flag indicating to prevent KDS users from bumping an order by double-clicking it on the display.", "type":"boolean", "example":false }, "matchVoidsWithOrderChits":{ "description":"A Boolean flag indicating to show voided chits in front of the original order.", "type":"boolean", "example":false }, "sortByPrintGroup":{ "description":"A Boolean flag indicating to sort menu items by their print group. If a print group is not assigned, items print in order of their record number.", "type":"boolean", "example":false }, "printCheckOnExpoDone":{ "description":"A Boolean flag indicating to print a check or receipt at the Runner Chit printer when the order is bumped from the Expo.", "type":"boolean", "example":false }, "alertsExcludePrepTime":{ "description":"A Boolean flag indicating to have the alert time calculation ignore the menu item prep time.", "type":"boolean", "example":false }, "bumpMarkedItems":{ "description":"A Boolean flag indicating to allow bumping of marked items and orders.", "type":"boolean", "example":false }, "supressCheckTotal":{ "description":"A Boolean flag indicating to hide the subtotal and paid amounts on chits when the Display Subtotal option is set.", "type":"boolean", "example":false }, "useDeliChitFormatOnRunnerChits":{ "description":"A Boolean flag indicating to print the order number using a larger and bold font on the top and bottom of runner chits.", "type":"boolean", "example":false }, "itemPrintOnItemAllPrepDone":{ "description":"A Boolean flag indicating item print on item when all prep done.", "type":"boolean", "example":false }, "suppressGuestCheckIdOnRunnerChits":{ "description":"A Boolean flag indicating to suppress guest check Id on runner chits.", "type":"boolean", "example":false }, "alwaysShowQuantity":{ "description":"A Boolean flag indicating to display the quantity of every condiment ordered on a non-DOM KDS. This feature is not supported with DOM enabled.", "type":"boolean", "example":false }, "removeOriginalChitWhenItemVoided":{ "description":"A Boolean flag indicating to if enabled, any item voids on the POS will immediately bump the associated item chit on the KDS. This option cannot be used with DOM, and requires Single Item Per Sub Order to be enabled. This option is required to enable Option 33 - Hide Void Chit When Item Voided and Option 34 - Show Void Chit Even if Item No Longer in Production.", "type":"boolean", "example":false }, "hideVoidChitWhenItemVoided":{ "description":"A Boolean flag indicating to hide void chit when item is voided.", "type":"boolean", "example":false }, "showVoidChitEvenIfNotInProduction":{ "description":"A Boolean flag indicating if enabled, a void chit will show for an item that has been bumped from the KDS prior to being voided on the POS. This option cannot be used with DOM, and requires Single Item Per Sub Order to be enabled. This option requires Option 32 - Remove Original Chit When Item Voided.", "type":"boolean", "example":false }, "useDeliveryChitFormatForRunnerChits":{ "description":"A Boolean flag indicating to print the order number using a larger and bold font on the top and bottom of runner chits.", "type":"boolean", "example":false }, "disableChitNotifications":{ "description":"A Boolean flag to enable/disable chit notifications. This option is supported from Simphony 19.9 and above.", "type":"boolean", "example":false }, "automaticallyRemoveOrdersOnAllPrepDone":{ "description":"A Boolean flag to automatically remove orders on all prep done. This option is supported from Simphony 19.9 and above.", "type":"boolean", "example":false } } } } }, "OrderDevicesv2":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Hierarchy unit object number", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Order Device", "type":"integer", "example":1 }, "name":{ "description":"A string that contains translations of name", "type":"object", "example":{ "1":"Property", "2":"Eigentum", "3":"Propiedad" } }, "deviceType":{ "description":"The remote device to which orders print. For a local device, orders print at the Local Order Receipt printer set for the workstation from which the order is placed. 1 - Remote, 2 - Local", "type":"integer", "example":1 }, "primaryDeviceType":{ "description":"Select the Primary Device Type . 0 - Printer, 1 - KDS", "type":"integer", "example":0 }, "deviceObjNum":{ "description":"Object number of the relevant order device record.", "type":"integer", "example":0 }, "backupDeviceObjNum":{ "description":"Object number of the backup order device in the event of a communication failure or other problem.", "type":"integer", "example":0 }, "orderDeviceRedirectObjNum":{ "description":"Object number of the order device to which orders sent to this device should be redirected. Typically, this field is set to itself.", "type":"integer", "example":0 }, "customInstructions":{ "description":"instructions (up to 250 characters) for the workstation's script to handle order output based on custom instructions in the script in case of using Custom Print Handling", "type":"string", "example":"Custom Instructions" }, "primaryDistGroupObjNum":{ "description":"Object number of the Primary Distribution Group for the KDS. Applicable only if primaryDeviceType = 1", "type":"integer", "example":1 }, "condimentSortType":{ "description":"Specify how condiments will be sorted on the selected order device. The options are: 1 - No condiment sorting - (Condiments are listed in the order entered by the user), 2 - Sort allowed condiments - (Required condiments are not sorted), 3 - Sort all condiments (All condiments are sorted)", "type":"integer", "example":1 }, "menuItemPrinting":{ "description":"the type of menu items to output to the order device. 1 - All Items, 2 - Only Items with Condiments, 3 - Only items without condiments", "type":"integer", "example":1 }, "maxNumLinePerChit":{ "description":"the maximum number of lines (0-99) to print on each page of an order chit. Applicable only if primaryDeviceType = 0", "type":"integer", "example":0 }, "sortConsoldiationMethod":{ "description":"

    The sort and consolidation method for the order device.

    \n \n \n \n \n \n \n \n \n \n \n
    0 Do Not Sort
    1 Seat Consolidated
    2 Seat No Consolidation
    3 Print Group Consolidated
    4 Print Group No Consolidation
    5 Seat & Print Group Consolidated
    6 Seat & Print Group No Consolidation
    7 Print Group and Seat Consolidated
    8 Print Group and Seat No Consolidation
    \n

    Applicable only if primaryDeviceType = 0

    \n", "type":"integer", "example":0 }, "languageObjNum":{ "description":"Object number of the primary language for the order device. Applicable only if primaryDeviceType = 0", "type":"integer", "example":1 }, "language2ObjNum":{ "description":"Object number of the secondary language for the print output. Applicable only if primaryDeviceType = 0", "type":"integer", "example":2 }, "language3ObjNum":{ "description":"Object number of the third language for the print output. Applicable only if primaryDeviceType = 0", "type":"integer", "example":3 }, "lineFeedBeforeOrder":{ "description":"The number of lines to advance before printing the order on order chits. Applicable only if primaryDeviceType = 0", "type":"integer", "example":0 }, "lineFeedsAfterOrder":{ "description":"The number of lines to advance after printing the order on order chits. Applicable only if primaryDeviceType = 0", "type":"integer", "example":0 }, "kdsSettings":{ "type":"object", "properties":{ "course1FirstAlertTimeInSecs":{ "description":"The amount of time, in seconds, for course 1 items to show the first alert.", "type":"integer", "example":0 }, "course1SecondAlertTimeInSecs":{ "description":"The amount of time, in seconds, for course 2 items to show the second alert.", "type":"integer", "example":0 }, "othCourseFirstAlertTimeInSecs":{ "description":"The amount of time, in seconds, for any course except course 1 to show the first alert.", "type":"integer", "example":0 }, "othCourseSecondAlertTimeInSecs":{ "description":"The amount of time, in seconds, for any course except course 1 to show the second alert.", "type":"integer", "example":0 }, "primaryRunnerChitPrinterObjNum":{ "description":"Object number of the printer where runner chits print when orders are bumped from the KDS.", "type":"integer", "example":0 }, "backupRunnerChitPrinterObjNum":{ "description":"Object number of the printer where runner chits print when orders are bumped from the KDS if Simphony cannot establish communication with the primary runner chit printer", "type":"integer", "example":0 }, "sendToPanelNum":{ "description":"The number of a panel (1 through 9) where orders appear on this device.", "type":"integer", "example":0 }, "domType":{ "description":"the Dynamic Order Mode type for the KDS Display.", "type":"integer", "example":0 }, "addSortRule":{ "description":"The sort type to use when the quantity of an item changes.", "type":"integer", "example":0 }, "modifySortRule":{ "description":"The sort type to use when existing items on an order are modified.\\ 0 - Sort to Top", "type":"integer", "example":0 }, "voidSortRule":{ "description":"The sort type to use when an item is voided.", "type":"integer", "example":0 }, "addHighlightScheme":{ "description":"The color configuration to use to highlight items with the quantity changed.", "type":"integer", "example":0 }, "modifyHighlightScheme":{ "description":"The color configuration to use to highlight modified items on orders.", "type":"integer", "example":0 }, "voidHighlightScheme":{ "description":"The color configuration to use to highlight voided items.", "type":"integer", "example":0 }, "beepOnNewOrder":{ "description":"The sound type to emit when an order is received on the order device", "type":"integer", "example":0 }, "newOrderNotificationTimeInSecs":{ "description":"The length of time, in seconds, newly added items flash on screen.", "type":"integer", "example":0 }, "displayNewOrderNotification":{ "description":"A Boolean flag indicating to make new orders flash when appearing on the KDS Display if not using DOM", "type":"boolean", "example":false }, "beepOnPrioritize":{ "description":"The sound type to emit when an order is prioritized or the order priority is increased on the order device. 0 - None, 1 - PC Speaker, 2 - WAV File, 3 - Bump Bar Speaker", "type":"integer", "example":0 }, "beepOnVIP":{ "description":"The sound type to emit when a VIP order is received.", "type":"integer", "example":0 }, "beepOnRush":{ "description":"0 - None, 1 - PC Speaker, 2 - WAV File, 3 - Bump Bar Speaker", "type":"integer", "example":0 } } }, "printerOptions":{ "description":"A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the Printer Order Device. Applicable if primaryDeviceType = 0", "type":"string", "example":"000000000000000000000000000000000000000000000000" }, "printerOptionsExt":{ "type":"object", "properties":{ "printTransEmpNumAndName":{ "description":"A Boolean flag indicating to print the employee name and number of the transaction operator. Deselect to print the employee name and number of the check operator.", "type":"boolean", "example":false }, "printDopplebon":{ "description":"A Boolean flag indicating to print a separate order chit for each menu item in the current service round (dopplebon style). Deselect to print one order chit for all menu items in the current service round.", "type":"boolean", "example":false }, "printDopplebonSummary":{ "description":"A Boolean flag indicating to print an order summary chit before printing an order's dopplebon order chits. Deselect to suppress dopplebon summary chit printing.", "type":"boolean", "example":false }, "printSeatNumWithIndvItems":{ "description":"A Boolean flag indicating to print seat numbers with each individual menu item.", "type":"boolean", "example":false }, "printRVCNameOnOrder":{ "description":"A Boolean flag indicating to show the revenue center name with each order sent to the order device. Deselect to hide the name.", "type":"boolean", "example":false }, "printVoidMarkerBeforeVoid":{ "description":"A Boolean flag indicating to print a VV VOID VV line, in red or inverse, in front of voided menu items. Deselect to print voided items in red", "type":"boolean", "example":false }, "printCondimentsInRed":{ "description":"A Boolean flag indicating to print condiments in red ink or in inverse. Deselect to print condiments in red/inverse or black, depending on the Print Class Red/Black option setting.", "type":"boolean", "example":false }, "printBothMenuItemNames":{ "description":"A Boolean flag indicating to print both names configured for a menu item. Deselect to print one name.", "type":"boolean", "example":false }, "printChkInfoLinesBeforeHeader":{ "description":"A Boolean flag indicating to print guest check information lines before the order device header. Deselect to suppress the printing.", "type":"boolean", "example":false }, "printChkInfoLinesAfterHeader":{ "description":"A Boolean flag indicating to print guest check information lines after the order device header. Deselect to suppress the printing.", "type":"boolean", "example":false }, "printChkInfoLinesAfterTrailer":{ "description":"A Boolean flag indicating to print guest check information lines after the order device trailer. Deselect to suppress the printing.", "type":"boolean", "example":false }, "printSecondaryItems":{ "description":"A Boolean flag indicating to print secondary items being broadcast from other order devices.", "type":"boolean", "example":false }, "printSecondaryPrinterHeader":{ "description":"A Boolean flag indicating to send menu items sent to this order printer as secondary items to other order printers.", "type":"boolean", "example":false }, "printSecondaryItemsInRed":{ "description":"A Boolean flag indicating to print secondary items in red. Deselect to print secondary items in black.", "type":"boolean", "example":false }, "supressBlankLinesBetweenSecondaryItems":{ "description":"A Boolean flag indicating to suppress printing extra line spacing between secondary items on order chits.", "type":"boolean", "example":false }, "excludeVoids":{ "description":"A Boolean flag indicating to not send voids of previous round items to the kitchen.", "type":"boolean", "example":false }, "intersperseDiffLanguages":{ "description":"A Boolean flag indicating to print menu items in each different language before printing condiments when printing in multiple languages.", "type":"boolean", "example":false }, "identiftyComboMeals":{ "description":"A Boolean flag indicating to print a flag to denote menu items that are part of a combo meal.", "type":"boolean", "example":false }, "printDiningCourseHeader":{ "description":"A Boolean flag indicating to print a dining course header and to group menu items by dining course.", "type":"boolean", "example":false }, "formatPrefixOnSeparateLine":{ "description":"A Boolean flag indicating to print the prefix on a separate line above the condiment. Deselect to print the prefix on the same line as the condiment.", "type":"boolean", "example":false }, "printSingleWide":{ "description":"A Boolean flag indicating to print the order using single-width characters.", "type":"boolean", "example":false } } }, "kdsOptions":{ "description":"A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the KDS Order Device. Applicable if primaryDeviceType = 1", "type":"string", "example":"000000000000000000000000000000000000000000000000" }, "kdsOptionsExt":{ "type":"object", "properties":{ "enableKDSConsolidation":{ "description":"A Boolean flag indicating to consolidate identical items with different modifiers onto one line, preceded by the quantity on the KDS Display. This feature is not supported with DOM or a DOM KDS chit layout style.", "type":"boolean", "example":false }, "sortVoidsToTop":{ "description":"A Boolean flag indicating to sort voided items to the top of the screen if not using DOM.", "type":"boolean", "example":false }, "singleItemPerSubOrder":{ "description":"A Boolean flag indicating to show every item on an order on its own chit. This option is required to enable Option 32 - removeOriginalChitWhenItemVoided.", "type":"boolean", "example":false }, "printOnPrepDone":{ "description":"A Boolean flag indicating to print a runner chit when the order is marked Done at a Prep Station.", "type":"boolean", "example":false }, "printOnExpoDone":{ "description":"A Boolean flag indicating to print a runner chit when the order is marked Done at the Expo Station.", "type":"boolean", "example":false }, "printOnAllPrepDone":{ "description":"A Boolean flag indicating to print a runner chit when an order is complete at all Prep Stations and before the order is bumped from the KDS Expo Display.", "type":"boolean", "example":false }, "sortBySeat":{ "description":"A Boolean flag indicating to sort items by seat number. Deselect to show items in the order in which they were ordered.", "type":"boolean", "example":false }, "resortWhenAllPrepDone":{ "description":"A Boolean flag indicationg to re-sort when all prep done.", "type":"boolean", "example":false }, "displaySubTotal":{ "description":"A Boolean flag indicating to cause the KDS to display the order subtotal if using DOM. Note that Subtotal is only displayed in certain layouts - 301, 305, 306, 309, 312, 315 , 317, 320, 401 and 402.Subtotal = Menu Item Sales Total + Discount + Tax + Auto Service Charge + Service Charge + Rounding Total", "type":"boolean", "example":false }, "dontDisplayVoids":{ "description":"A Boolean flag indicating select to remove voided items from the KDS Display. Deselect to show the letter V next to voided items if using DOM.", "type":"boolean", "example":false }, "displayMenuItemCount":{ "description":"A Boolean flag indicating to show the menu item count on the KDS Display if using DOM", "type":"boolean", "example":false }, "noExpoDoneBeforePaid":{ "description":"A Boolean flag indicating to not allow the order to be expedited before the order is paid if using DOM", "type":"boolean", "example":false }, "unconsolidateItemsAfterCondimentEntry":{ "description":"A Boolean flag indicating to unconsolidate multiple quantities of similar menu items if condiments are selected for each item.", "type":"boolean", "example":false }, "multipleCondimentsPerLine":{ "description":"A Boolean flag indicating to print condiments in a continuous line on each order chit. Deselect to print each condiment on a separate line beneath the referenced menu item.", "type":"boolean", "example":false }, "displayNewOrderNotification":{ "description":"A Boolean flag indicating to make new orders flash when appearing on the KDS Display if not using DOM.", "type":"boolean", "example":false }, "expoDoneExempt":{ "description":"A Boolean flag indicating to prevent an Expo Station from marking a sub-order as Done when it is marked as Done on another Expo Station.", "type":"boolean", "example":false }, "printCourseHeader":{ "description":"A Boolean flag indicating print course header.", "type":"boolean", "example":false }, "dontConsolidate":{ "description":"A Boolean flag indicating to print identical items separately if they are posted separately. Deselect to consolidate identical items onto one line, preceded by the quantity.", "type":"boolean", "example":false }, "noPrepDoneBeforePaid":{ "description":"A Boolean flag indicating to prevent an order from being bumped from the order device, until after the order has been paid for if using DOM", "type":"boolean", "example":false }, "showPrevCourseIndicator":{ "description":"A Boolean flag indicating to show an icon on order chits from any course other than the first course to indicate that a previous course exists for this check. This feature only works on systems using KDS Coursing functionality with KDS Controller option Display Next Course after Previous Course Complete.", "type":"boolean", "example":false }, "disableDoubleTouchBump":{ "description":"A Boolean flag indicating to prevent KDS users from bumping an order by double-clicking it on the display.", "type":"boolean", "example":false }, "matchVoidsWithOrderChits":{ "description":"A Boolean flag indicating to show voided chits in front of the original order.", "type":"boolean", "example":false }, "sortByPrintGroup":{ "description":"A Boolean flag indicating to sort menu items by their print group. If a print group is not assigned, items print in order of their record number.", "type":"boolean", "example":false }, "printCheckOnExpoDone":{ "description":"A Boolean flag indicating to print a check or receipt at the Runner Chit printer when the order is bumped from the Expo.", "type":"boolean", "example":false }, "alertsExcludePrepTime":{ "description":"A Boolean flag indicating to have the alert time calculation ignore the menu item prep time.", "type":"boolean", "example":false }, "bumpMarkedItems":{ "description":"A Boolean flag indicating to allow bumping of marked items and orders.", "type":"boolean", "example":false }, "supressCheckTotal":{ "description":"A Boolean flag indicating to hide the subtotal and paid amounts on chits when the Display Subtotal option is set.", "type":"boolean", "example":false }, "useDeliChitFormatOnRunnerChits":{ "description":"A Boolean flag indicating to print the order number using a larger and bold font on the top and bottom of runner chits.", "type":"boolean", "example":false }, "itemPrintOnItemAllPrepDone":{ "description":"A Boolean flag indicating item print on item when all prep done.", "type":"boolean", "example":false }, "suppressGuestCheckIdOnRunnerChits":{ "description":"A Boolean flag indicating to suppress guest check Id on runner chits.", "type":"boolean", "example":false }, "alwaysShowQuantity":{ "description":"A Boolean flag indicating to display the quantity of every condiment ordered on a non-DOM KDS. This feature is not supported with DOM enabled.", "type":"boolean", "example":false }, "removeOriginalChitWhenItemVoided":{ "description":"A Boolean flag indicating to if enabled, any item voids on the POS will immediately bump the associated item chit on the KDS. This option cannot be used with DOM, and requires Single Item Per Sub Order to be enabled. This option is required to enable Option 33 - Hide Void Chit When Item Voided and Option 34 - Show Void Chit Even if Item No Longer in Production.", "type":"boolean", "example":false }, "hideVoidChitWhenItemVoided":{ "description":"A Boolean flag indicating to hide void chit when item is voided.", "type":"boolean", "example":false }, "showVoidChitEvenIfNotInProduction":{ "description":"A Boolean flag indicating if enabled, a void chit will show for an item that has been bumped from the KDS prior to being voided on the POS. This option cannot be used with DOM, and requires Single Item Per Sub Order to be enabled. This option requires Option 32 - Remove Original Chit When Item Voided.", "type":"boolean", "example":false }, "useDeliveryChitFormatForRunnerChits":{ "description":"A Boolean flag indicating to print the order number using a larger and bold font on the top and bottom of runner chits.", "type":"boolean", "example":false }, "disableChitNotifications":{ "description":"A Boolean flag to enable/disable chit notifications. This option is supported from Simphony 19.9 and above.", "type":"boolean", "example":false }, "automaticallyRemoveOrdersOnAllPrepDone":{ "description":"A Boolean flag to automatically remove orders on all prep done. This option is supported from Simphony 19.9 and above.", "type":"boolean", "example":false } } } } }, "OrderDeviceCUDRequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum", "deviceType", "condimentSortType", "menuItemPrinting" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Order Device", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Order Device 1", "es-MX":"Dispositivo de pedido" } }, "deviceType":{ "description":"The remote device to which orders print. For a local device, orders print at the Local Order Receipt printer set for the workstation from which the order is placed. 1 - Remote, 2 - Local", "type":"integer", "example":1 }, "primaryDeviceType":{ "description":"Select the Primary Device Type . 0 - Printer, 1 - KDS", "type":"integer", "example":0 }, "deviceObjNum":{ "description":"Object number of the relevant order device record.", "type":"integer", "example":0 }, "backupDeviceObjNum":{ "description":"Object number of the backup order device in the event of a communication failure or other problem.", "type":"integer", "example":0 }, "orderDeviceRedirectObjNum":{ "description":"Object number of the order device to which orders sent to this device should be redirected. Typically, this field is set to itself.", "type":"integer", "example":0 }, "customInstructions":{ "description":"instructions (up to 250 characters) for the workstation's script to handle order output based on custom instructions in the script in case of using Custom Print Handling", "type":"string", "example":"Custom Instructions" }, "primaryDistGroupObjNum":{ "description":"Object number of the Primary Distribution Group for the KDS. Applicable only if primaryDeviceType = 1", "type":"integer", "example":1 }, "condimentSortType":{ "description":"Specify how condiments will be sorted on the selected order device. The options are: 1 - No condiment sorting - (Condiments are listed in the order entered by the user), 2 - Sort allowed condiments - (Required condiments are not sorted), 3 - Sort all condiments (All condiments are sorted)", "type":"integer", "example":1 }, "menuItemPrinting":{ "description":"the type of menu items to output to the order device. 1 - All Items, 2 - Only Items with Condiments, 3 - Only items without condiments", "type":"integer", "example":1 }, "maxNumLinePerChit":{ "description":"the maximum number of lines (0-99) to print on each page of an order chit. Applicable only if primaryDeviceType = 0", "type":"integer", "example":0 }, "sortConsoldiationMethod":{ "description":"

    The sort and consolidation method for the order device.

    \n \n \n \n \n \n \n \n \n \n \n
    0 Do Not Sort
    1 Seat Consolidated
    2 Seat No Consolidation
    3 Print Group Consolidated
    4 Print Group No Consolidation
    5 Seat & Print Group Consolidated
    6 Seat & Print Group No Consolidation
    7 Print Group and Seat Consolidated
    8 Print Group and Seat No Consolidation
    \n

    Applicable only if primaryDeviceType = 0

    \n", "type":"integer", "example":0 }, "languageObjNum":{ "description":"Object number of the primary language for the order device. Applicable only if primaryDeviceType = 0", "type":"integer", "example":1 }, "language2ObjNum":{ "description":"Object number of the secondary language for the print output. Applicable only if primaryDeviceType = 0", "type":"integer", "example":2 }, "language3ObjNum":{ "description":"Object number of the third language for the print output. Applicable only if primaryDeviceType = 0", "type":"integer", "example":3 }, "lineFeedBeforeOrder":{ "description":"The number of lines to advance before printing the order on order chits. Applicable only if primaryDeviceType = 0", "type":"integer", "example":0 }, "lineFeedsAfterOrder":{ "description":"The number of lines to advance after printing the order on order chits. Applicable only if primaryDeviceType = 0", "type":"integer", "example":0 }, "kdsSettings":{ "type":"object", "properties":{ "course1FirstAlertTimeInSecs":{ "description":"The amount of time, in seconds, for course 1 items to show the first alert.", "type":"integer", "example":0 }, "course1SecondAlertTimeInSecs":{ "description":"The amount of time, in seconds, for course 2 items to show the second alert.", "type":"integer", "example":0 }, "othCourseFirstAlertTimeInSecs":{ "description":"The amount of time, in seconds, for any course except course 1 to show the first alert.", "type":"integer", "example":0 }, "othCourseSecondAlertTimeInSecs":{ "description":"The amount of time, in seconds, for any course except course 1 to show the second alert.", "type":"integer", "example":0 }, "primaryRunnerChitPrinterObjNum":{ "description":"Object number of the printer where runner chits print when orders are bumped from the KDS.", "type":"integer", "example":0 }, "backupRunnerChitPrinterObjNum":{ "description":"Object number of the printer where runner chits print when orders are bumped from the KDS if Simphony cannot establish communication with the primary runner chit printer", "type":"integer", "example":0 }, "sendToPanelNum":{ "description":"The number of a panel (1 through 9) where orders appear on this device.", "type":"integer", "example":0 }, "domType":{ "description":"the Dynamic Order Mode type for the KDS Display.", "type":"integer", "example":0 }, "addSortRule":{ "description":"The sort type to use when the quantity of an item changes.", "type":"integer", "example":0 }, "modifySortRule":{ "description":"The sort type to use when existing items on an order are modified.\\ 0 - Sort to Top", "type":"integer", "example":0 }, "voidSortRule":{ "description":"The sort type to use when an item is voided.", "type":"integer", "example":0 }, "addHighlightScheme":{ "description":"The color configuration to use to highlight items with the quantity changed.", "type":"integer", "example":0 }, "modifyHighlightScheme":{ "description":"The color configuration to use to highlight modified items on orders.", "type":"integer", "example":0 }, "voidHighlightScheme":{ "description":"The color configuration to use to highlight voided items.", "type":"integer", "example":0 }, "beepOnNewOrder":{ "description":"The sound type to emit when an order is received on the order device", "type":"integer", "example":0 }, "newOrderNotificationTimeInSecs":{ "description":"The length of time, in seconds, newly added items flash on screen.", "type":"integer", "example":0 }, "displayNewOrderNotification":{ "description":"A Boolean flag indicating to make new orders flash when appearing on the KDS Display if not using DOM", "type":"boolean", "example":false }, "beepOnPrioritize":{ "description":"The sound type to emit when an order is prioritized or the order priority is increased on the order device. 0 - None, 1 - PC Speaker, 2 - WAV File, 3 - Bump Bar Speaker", "type":"integer", "example":0 }, "beepOnVIP":{ "description":"The sound type to emit when a VIP order is received.", "type":"integer", "example":0 }, "beepOnRush":{ "description":"0 - None, 1 - PC Speaker, 2 - WAV File, 3 - Bump Bar Speaker", "type":"integer", "example":0 } } }, "printerOptions":{ "description":"A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the Printer Order Device. Applicable if primaryDeviceType = 0", "type":"string", "example":"000000000000000000000000000000000000000000000000" }, "kdsOptions":{ "description":"A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the KDS Order Device. Applicable if primaryDeviceType = 1", "type":"string", "example":"000000000000000000000000000000000000000000000000" } } }, "CashiersGetResponseV1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Cashier objects.", "items":{ "$ref":"#/definitions/CashierResponseV1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "CashierResponseV1":{ "description":"Model for Cashiers Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit id of the revenue center.", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object number of the cashiers.", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the cashiers in configured languages.", "type":"object", "example":{ "en-US":"Cashier", "de-DE":"La caissiere", "es-MX":"Cajero" } } } }, "Cashiersv2":{ "description":"Model for Cashiers Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit id of the revenue center.", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object number of the cashiers.", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the cashiers in configured languages.", "type":"object", "example":{ "1":"Cashier", "2":"La caissiere", "3":"Cajero" } } } }, "CUCashiersRequestBody":{ "description":"Model for Cashiers CU Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit id of the revenue center.", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object number of the cashiers.", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the cashiers in configured languages.", "type":"object", "example":{ "en-US":"Cashier", "de-DE":"La caissiere", "es-MX":"Cajero" } } } }, "PaymentDriverConfigGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Payment Driver Config objects of the organization.", "items":{ "$ref":"#/definitions/PaymentDriverConfigv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "PaymentDriverConfigv1":{ "description":"Model for a Payment Driver Configuration Object.", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit.", "type":"integer", "example":1034 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit.", "type":"integer", "example":3 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit in configured languages.", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object number of the Payment Driver.", "type":"integer", "example":20 }, "name":{ "description":"A group of string objects representing the name of the Payment Driver in configured languages.", "type":"object", "example":{ "en-US":"OPI", "de-DE":"OPI", "es-MX":"OPI" } }, "configuration":{ "description":"An object containing the configuration parameters for the payment driver.", "type":"object", "properties":{ "assemblyName":{ "description":"Name of the assembly containing the module", "type":"string" }, "categoryAndType":{ "description":"Category and type of the driver to be initiated", "type":"string" }, "className":{ "description":"Class name of the module to be initiated", "type":"string" }, "description":{ "description":"A description for this module", "type":"string" }, "displayName":{ "description":"Display Name of module", "type":"string" }, "currencyCode":{ "description":"Enter the 3 digit ISO Numeric Currency Code. (SPI Only)", "type":"string" }, "enableQuickChip":{ "description":"Select True to enable the Quick Chip feature with fast transactions. The payment Service provider should support this feature.(SPI only)", "type":"boolean" }, "merchantNumber":{ "description":"Enter the merchant identification number.", "type":"string" }, "supportsCardAcquisition":{ "description":"Select True to enable the Payment Service Provider to supply Card Acquisition payment and loyalty data.(SPI only)", "type":"boolean" }, "hostTimeout":{ "description":"Timeout in seconds before the request is abandoned.", "type":"integer" }, "includeNamespaceWithXMLMessage":{ "description":"Include NameSpace elements in XML message.(SPI only)", "type":"boolean" }, "passphrase":{ "description":"Enter the authentication pass phrase.(OPI only)", "type":"string" }, "primaryHost":{ "description":"Enter the URL for the endpoint.(format- http(s)://host:port number)", "type":"string" }, "spiInterface":{ "description":"True- Use SPI Interface, False- Use OPI JSON Interface", "type":"boolean" }, "validateXMLAgainstSchema":{ "description":"Validate XML message against schema and log errors in SPIXML.log.(SPI only)", "type":"boolean" }, "securitySettings":{ "description":"Http Only; Https without certificate validation; Https with certificate validation(Server certificate required, Client certificate optional)(SPI only)", "type":"integer" }, "serverCertificate":{ "description":"Server certificate public key", "type":"string" }, "serverCertCommonName":{ "description":"Displays server certificate common name, if loaded", "type":"string" }, "serverCertEffectiveDt":{ "description":"Displays server certificate effective date, if loaded", "type":"string" }, "serverCertExpDt":{ "description":"Displays server certificate expiration date, if loaded", "type":"string" }, "clientCertificate":{ "description":"Client certificate public key", "type":"string" }, "clientCertCommonName":{ "description":"Displays client certificate common name, if loaded", "type":"string" }, "clientCertEffectiveDt":{ "description":"Displays client certificate effective date, if loaded", "type":"string" }, "clientCertExpDt":{ "description":"Displays client certificate expiration date, if loaded", "type":"string" }, "clientCertPassword":{ "description":"Client certificate password", "type":"string" } } } } }, "PaymentDriverConfigurationv2":{ "description":"Model for a Payment Driver Configuration Object.", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit.", "type":"integer", "example":1034 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit.", "type":"integer", "example":3 }, "objectNum":{ "description":"Object number of the Payment Driver.", "type":"integer", "example":20 }, "configuration":{ "description":"An object containing the configuration parameters for the payment driver.", "type":"object", "properties":{ "assemblyName":{ "description":"Name of the assembly containing the module", "type":"string" }, "categoryAndType":{ "description":"Category and type of the driver to be initiated", "type":"string" }, "className":{ "description":"Class name of the module to be initiated", "type":"string" }, "description":{ "description":"A description for this module", "type":"string" }, "displayName":{ "description":"Display Name of module", "type":"string" }, "currencyCode":{ "description":"Enter the 3 digit ISO Numeric Currency Code. (SPI Only)", "type":"string" }, "enableQuickChip":{ "description":"Select True to enable the Quick Chip feature with fast transactions. The payment Service provider should support this feature.(SPI only)", "type":"boolean" }, "merchantNumber":{ "description":"Enter the merchant identification number.", "type":"string" }, "supportsCardAcquisition":{ "description":"Select True to enable the Payment Service Provider to supply Card Acquisition payment and loyalty data.(SPI only)", "type":"boolean" }, "hostTimeout":{ "description":"Timeout in seconds before the request is abandoned.", "type":"integer" }, "includeNamespaceWithXMLMessage":{ "description":"Include NameSpace elements in XML message.(SPI only)", "type":"boolean" }, "passphrase":{ "description":"Enter the authentication pass phrase.(OPI only)", "type":"string" }, "primaryHost":{ "description":"Enter the URL for the endpoint.(format- http(s)://host:port number)", "type":"string" }, "spiInterface":{ "description":"True- Use SPI Interface, False- Use OPI JSON Interface", "type":"boolean" }, "validateXMLAgainstSchema":{ "description":"Validate XML message against schema and log errors in SPIXML.log.(SPI only)", "type":"boolean" }, "securitySettings":{ "description":"Http Only; Https without certificate validation; Https with certificate validation(Server certificate required, Client certificate optional)(SPI only)", "type":"integer" }, "serverCertificate":{ "description":"Server certificate public key", "type":"string" }, "serverCertCommonName":{ "description":"Displays server certificate common name, if loaded", "type":"string" }, "serverCertEffectiveDt":{ "description":"Displays server certificate effective date, if loaded", "type":"string" }, "serverCertExpDt":{ "description":"Displays server certificate expiration date, if loaded", "type":"string" }, "clientCertificate":{ "description":"Client certificate public key", "type":"string" }, "clientCertCommonName":{ "description":"Displays client certificate common name, if loaded", "type":"string" }, "clientCertEffectiveDt":{ "description":"Displays client certificate effective date, if loaded", "type":"string" }, "clientCertExpDt":{ "description":"Displays client certificate expiration date, if loaded", "type":"string" }, "clientCertPassword":{ "description":"Client certificate password", "type":"string" } } } } }, "PaymentDriverConfigResponse":{ "description":"Model for a Payment Driver Configuration Response Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1034 }, "objectNum":{ "description":"Object number of the Payment Driver", "type":"integer", "example":20 } } }, "EffGroupCUResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the effectivity group", "type":"integer", "example":1 }, "changeSetId":{ "description":"The unique reference of the effectivity group.", "type":"integer", "example":1 } } }, "EffectivityGroupsCUDRequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the effectivity group", "type":"integer", "example":1 }, "name":{ "description":"name of the Effectivity Group", "type":"object", "example":{ "en-US":"Effectivity Group 1", "es-MX":"Efectividad Grupo 1" } }, "activeTimes":{ "type":"array", "items":{ "properties":{ "effId":{ "description":"The unique reference of the effectivity record", "type":"integer", "example":1 }, "startTime":{ "description":"The time that the record becomes active for each Active Time interval. Leave the field blank if the start time is not relevant.", "type":"string", "example":"2020-01-01T00:00:00" }, "endTime":{ "description":"The time that the record becomes inactive for each Active Time interval. Leave the field blank if the record never becomes inactive", "type":"string", "example":"2020-12-31T23:59:59" }, "timeIsLocal":{ "description":"A Boolean flag indicating if the Start/End times represent the local time of the property.", "type":"boolean", "example":false }, "mustActivateBy":{ "description":"The time that the record must activate for each Active Time. This should be between startTime and endTime.\n", "type":"string", "example":"2023-11-17T02:27:39" } } } }, "allowLocalControl":{ "description":"A Boolean flag indicating if the effectivity group is allowed to be controlled at local level.\n", "type":"boolean", "example":true }, "dataExtensions":{ "description":"An array of data extensions for the effectivity group", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extention field", "type":"string", "example":"extension_Column" }, "value":{ "description":"value of the extension field", "type":"string", "example":"value1" } } } } } }, "EffectivityGroupsGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Effectivity Group objects of the organization.", "items":{ "$ref":"#/definitions/EffectivityGroupsResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "EffectivityGroupv2":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Hierarchy unit object number", "type":"integer", "example":1 }, "changeSetId":{ "description":"The unique reference of the effectivity group.", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the effectivity group", "type":"integer", "example":1 }, "name":{ "description":"name of the Effectivity Group", "type":"object", "example":{ "1":"Effectivity Group 1", "2":"Efectividad Grupo 1" } }, "activeTimes":{ "type":"array", "items":{ "properties":{ "effId":{ "description":"The unique reference of the effectivity record", "type":"integer", "example":1 }, "startTime":{ "description":"The time that the record becomes active for each Active Time interval. Leave the field blank if the start time is not relevant.", "type":"string", "example":"2020-01-01T00:00:00" }, "endTime":{ "description":"The time that the record becomes inactive for each Active Time interval. Leave the field blank if the record never becomes inactive", "type":"string", "example":"2020-12-31T23:59:59" }, "timeIsLocal":{ "description":"A Boolean flag indicating if the Start/End times represent the local time of the property.", "type":"boolean", "example":false }, "mustActivateBy":{ "description":"The time that the record must activate for each Active Time. This should be between startTime and endTime.\n", "type":"string", "example":"2023-11-17T02:27:39" } } } }, "allowLocalControl":{ "description":"A Boolean flag indicating if the effectivity group is allowed to be controlled at local level.\n", "type":"boolean", "example":true }, "localEffectivtyGroupStatus":{ "description":"A list indicating the status of enableEffectivityGroup flags at inherited locations.\n", "type":"array", "items":{ "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "enableEffectivityGroup":{ "description":"Flag indicating if the effectivity group is enabled or not at the specified hierarchy.", "type":"boolean", "example":true } } } }, "dataExtensions":{ "description":"An array of data extensions for the effectivity group", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extention field", "type":"string", "example":"extension_Column" }, "value":{ "description":"value of the extension field", "type":"string", "example":"value1" } } } } } }, "EffectivityGroupsResponsev1":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Hierarchy unit object number", "type":"integer", "example":1 }, "hierUnitName":{ "description":"Hierarchy unit name", "type":"object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "changeSetId":{ "description":"The unique reference of the effectivity group.", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the effectivity group", "type":"integer", "example":1 }, "name":{ "description":"name of the Effectivity Group", "type":"object", "example":{ "en-US":"Effectivity Group 1", "es-MX":"Efectividad Grupo 1" } }, "activeTimes":{ "type":"array", "items":{ "properties":{ "effId":{ "description":"The unique reference of the effectivity record", "type":"integer", "example":1 }, "startTime":{ "description":"The time that the record becomes active for each Active Time interval. Leave the field blank if the start time is not relevant.", "type":"string", "example":"2020-01-01T00:00:00" }, "endTime":{ "description":"The time that the record becomes inactive for each Active Time interval. Leave the field blank if the record never becomes inactive", "type":"string", "example":"2020-12-31T23:59:59" }, "timeIsLocal":{ "description":"A Boolean flag indicating if the Start/End times represent the local time of the property.", "type":"boolean", "example":false }, "mustActivateBy":{ "description":"The time that the record must activate for each Active Time. This should be between startTime and endTime.\n", "type":"string", "example":"2023-11-17T02:27:39" } } } }, "allowLocalControl":{ "description":"A Boolean flag indicating if the effectivity group is allowed to be controlled at local level.\n", "type":"boolean", "example":true }, "localEffectivtyGroupStatus":{ "description":"A list indicating the status of enableEffectivityGroup flags at inherited locations.\n", "type":"array", "items":{ "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "hierUnitName":{ "description":"Hierarchy unit name", "type":"object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "enableEffectivityGroup":{ "description":"Flag indicating if the effectivity group is enabled or not at the specified hierarchy.", "type":"boolean", "example":true } } } }, "dataExtensions":{ "description":"An array of data extensions for the effectivity group", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extention field", "type":"string", "example":"extension_Column" }, "value":{ "description":"value of the extension field", "type":"string", "example":"value1" } } } } } }, "CUResponseBody":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Currency", "type":"integer", "example":1 } } }, "CurrencyParamterCUResponseBody":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "baseCurrObjNum":{ "description":"Object number of the Currency", "type":"integer", "example":1 } } }, "CUDCurrencyRequestBody":{ "description":"Model for Currency CUD Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "objectNum":{ "description":"Object number of the currency.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Currency is configured", "type":"integer", "example":3599 }, "name":{ "type":"object", "description":"Currency Name", "example":{ "en-US":"USD Dollar", "de-DE":"USD-Dollar" } }, "abbreviation":{ "description":"The abbreviation for the currency record. For a long abbreviation, you may add a space in the end for good print format.", "type":"object", "example":{ "en-US":"USD" } }, "symbol":{ "description":"The record symbol of the currency.", "type":"string", "example":"$" }, "numberOfDigits":{ "description":"The number of digits after the decimal point that each currency allows. Default value is 2.Values between 1-3.", "type":"integer", "example":2 }, "options":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currency", "type":"string", "example":"11010101" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } }, "Currencyv1":{ "description":"Model for Currency Object", "type":"object", "properties":{ "objectNum":{ "description":"Object number of the currency.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Currency is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the Currency is configured", "type":"integer", "example":26 }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"USD Dollar", "de-DE":"USD-Dollar" } }, "abbreviation":{ "description":"The abbreviation for the currency record. For a long abbreviation, you may add a space in the end for good print format.", "type":"object", "example":{ "en-US":"USD" } }, "symbol":{ "description":"The record symbol of the currency.", "type":"string", "example":"$" }, "numberOfDigits":{ "description":"The number of digits after the decimal point that each currency allows. Default value is 2.Values between 1-3.", "type":"integer", "example":2 }, "options":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currency", "type":"string", "example":"11010101" }, "optionsExt":{ "$ref":"#/definitions/OptionsExt" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } }, "Currencyv1GetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Currency objects of the organization.", "items":{ "$ref":"#/definitions/Currencyv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "Currencyv2":{ "description":"Model for Currency Object", "type":"object", "properties":{ "objectNum":{ "description":"Object number of the currency.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Currency is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the Currency is configured", "type":"integer", "example":26 }, "name":{ "type":"object", "description":"Currency Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "abbreviation":{ "description":"The abbreviation for the currency record. For a long abbreviation, you may add a space in the end for good print format.", "type":"object", "example":{ "1":"USD", "2":"INR", "3":"DNR" } }, "symbol":{ "description":"The record symbol of the currency.", "type":"string", "example":"$" }, "numberOfDigits":{ "description":"The number of digits after the decimal point that each currency allows. Default value is 2.Values between 1-3.", "type":"integer", "example":2 }, "options":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currency", "type":"string", "example":"11010101" }, "optionsExt":{ "$ref":"#/definitions/OptionsExt" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } }, "CurrencyParameterv1GetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Currency Parameter objects of the organization.", "items":{ "$ref":"#/definitions/CurrencyParameterv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "CurrencyParameterv1":{ "description":"Model for Currency Parameter Object", "type":"object", "required":[ "hierUnitId", "baseCurrObjNum" ], "properties":{ "baseCurrObjNum":{ "description":"Object number of the currency.", "type":"integer", "example":1 }, "baseCurrObjName":{ "type":"object", "description":"Base Current Object Name", "example":{ "en-US":"USD Dollar", "de-DE":"USD-Dollar" } }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the Currency Parameter is configured", "type":"integer", "example":26 }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "options":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currency parameter", "type":"string", "example":"11010101" }, "optionsExt":{ "$ref":"#/definitions/CurrencyParameterOptionsExt" } } }, "CurrencyParameterv2":{ "description":"Model for Currency Parameter Object", "type":"object", "properties":{ "baseCurrObjNum":{ "description":"Object number of the currency.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Currency Parameter is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the Currency Parameter is configured", "type":"integer", "example":26 }, "options":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currency parameter", "type":"string", "example":"11010101" }, "optionsExt":{ "$ref":"#/definitions/CurrencyParameterOptionsExt" } } }, "CurrencyParameterOptionsExt":{ "description":"An object containing the descriptive options list associated with the currency parameter.", "type":"object", "properties":{ "roundCurrency":{ "example":false, "type":"boolean", "description":"Selecting this option activates the subsequent options for rounding currency" }, "roundToNearestZero":{ "example":false, "type":"boolean", "description":"Round currency amounts to the nearest 0 (for eg. 163.336 rounds to 163.340)" }, "roundToSecondLeastSignDigit":{ "example":false, "type":"boolean", "description":"Round currency amounts based on the second least significant digit" } } }, "EnableEffGroupsCUResponseBody":{ "type":"object", "properties":{ "hierUnitId":{ "description":"hierUnitId of property where the record is inherited", "type":"integer", "example":1 }, "changeSetId":{ "description":"Unique reference of the inherited effectivity group.", "type":"integer", "example":1 } } }, "EnableEffGroups":{ "type":"object", "properties":{ "hierUnitId":{ "description":"hierUnitId of property where the record is inherited", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Hierarchy unit object number", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A string that contains translations of hierarchy unit name into multiple languages", "type":"object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "changeSetId":{ "description":"Unique reference of the inherited effectivity group.", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the inherited effectivity group", "type":"integer", "example":1 }, "enableEffectivityGroup":{ "description":"Flag indicating if the effectivity group is enabled or not.", "type":"boolean", "example":false }, "name":{ "description":"name of the effectivity group", "type":"object", "example":{ "en-US":"Effectivity Group 1", "es-MX":"Dispositivo de pedido 1" } } } }, "EnableEffectivityGroupv2":{ "type":"object", "properties":{ "hierUnitId":{ "description":"hierUnitId of property where the record is inherited", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Hierarchy unit object number", "type":"integer", "example":1 }, "changeSetId":{ "description":"Unique reference of the inherited effectivity group.", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the inherited effectivity group", "type":"integer", "example":1 }, "enableEffectivityGroup":{ "description":"Flag indicating if the effectivity group is enabled or not.", "type":"boolean", "example":false } } }, "EnableEffGroupsGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of enable effectivity groups record of the organization.", "items":{ "$ref":"#/definitions/EnableEffGroups" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "MenuItemClassGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Classes objects.", "items":{ "$ref":"#/definitions/MenuItemClass" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "MenuItemClass_optionsExt":{ "type":"object", "description":"An object containing the descriptive options", "properties":{ "enableOpenPricedMenuItems":{ "type":"boolean", "example":false, "description":"Flag indicating if users asked for amount each time a menu item in this class is ordered." }, "enableCondimentMenuItems":{ "type":"boolean", "example":false, "description":"Flag indicating to designate menu items as condiments." }, "enableNegativePricedMenuItems":{ "type":"boolean", "example":false, "description":"Flag indicating to have menu items in this class post a negative price/sales amount." }, "incrementSeatNumberWithSaleOfMenuItems":{ "type":"boolean", "example":false, "description":"Flag indicating to increment the seat number each time a menu item in this class is ordered." }, "ReferenceEntryRequired":{ "type":"boolean", "example":false, "description":"Flag indicating to require a reference entry for menu items assigned to this class." }, "validationRequired":{ "type":"boolean", "example":false, "description":"Flag indicating to allow menu items in this class to be discounted with an item discount." }, "applyItemDiscountsToMenuItems":{ "type":"boolean", "example":false, "description":"Flag indicating to allow menu items in this class to be discounted with an item discount." }, "allowNonPricedMenuItems":{ "type":"boolean", "example":false, "description":"Flag indicating to allow menu items in this class to be non-priced." }, "allowCondimentChangesPrintGroupOfParentClass":{ "type":"boolean", "example":false, "description":"Flag indicating to force a parent menu item that is modified by a condiment." }, "useSubLevelPricing":{ "type":"boolean", "example":false, "description":"Flag indicating to use Sub Level pricing for this menu item class." }, "addToGuestCount":{ "type":"boolean", "example":false, "description":"Flag indicating to increase the guest count when menu items in this class are ordered." }, "addToAutoSVCItmzr":{ "type":"boolean", "example":false, "description":"Flag indicating to add menu items in this class to the Automatic Service Charge itemizer." }, "printPricetoOrderchit":{ "type":"boolean", "example":false, "description":"Flag indicating to print the price of open-priced items on order chits." }, "doNotPutInTransactionDetail":{ "type":"boolean", "example":false, "description":"Flag indicating to prevent menu items in this class that have a 0.00 price, or no price record assigned, from printing, appearing, or posting." }, "weighedItems":{ "type":"boolean", "example":false, "description":"Flag indicating if all menu items in this class are sold by weight." }, "printName1And2OnChecks":{ "type":"boolean", "example":false, "description":"Flag indicating to print the First Name and the Second Name." }, "printName2OnOrderOutput":{ "type":"boolean", "example":false, "description":"Flag indicating to print the Second Name on Order Device output." }, "useName2OnTouchScreens":{ "type":"boolean", "example":false, "description":"Flag indicating to show the Second Name, if defined, of menu items assigned to this class on workstation touchscreen keys." }, "requireNumberOfCondimentsToMatchParent":{ "type":"boolean", "example":false, "description":"Flag indicating to require the number of required condiments to match the number of parent menu items ordered." }, "useOwnOuputLink":{ "type":"boolean", "example":false, "description":"Flag indicating to have condiments in this class print to their own order devices." }, "addCondimentPriceToParentItem":{ "type":"boolean", "example":false, "description":"Flag indicating to add Condiment Price to Parent Item." }, "ldsItems":{ "type":"boolean", "example":false, "description":"Flag indicating if all menu items in this class can be ordered using an International Liquor Dispensing System (ILDS)." }, "useWithRepeatRoundKey":{ "type":"boolean", "example":false, "description":"Flag indicating if all menu items in this class can be reposted on guest checks using the Repeat Round key." }, "keepMainLevelWithRepeatRounds":{ "type":"boolean", "example":false, "description":"Flag indicating to enforce items in this class to use the same Main Menu Level that was in effect during the most recent service round when ordered using the Repeat Round key." }, "keepSubLevelWithRepeatRounds":{ "type":"boolean", "example":false, "description":"Flag indicating to enforce items in this class to use the same Sub Menu Level that was in effect during the most recent service round when ordered using the Repeat Round key." }, "printMainLevelPrefixAndSuffix":{ "type":"boolean", "example":false, "description":"Flag indicating to have the Main level prefix or suffix show on the check detail area and to print on order output devices, guest checks, and customer receipts." }, "printSubLevelPrefixAndSuffix":{ "type":"boolean", "example":false, "description":"Flag indicating to have the Sub level prefix or suffix show on the check detail area and to print on order output devices, guest checks, and customer receipts." }, "sortCondimentsByPrintGroup":{ "type":"boolean", "example":false, "description":"Flag indicating to sort condiment display and printing tasks according to their Print Group assignment." }, "promptForSeatNumWithEachItem":{ "type":"boolean", "example":false, "description":"Flag indicating to prompt Enter Seat Number after adding each parent item with this Menu Item Class." }, "isBeverageItem":{ "type":"boolean", "example":false, "description":"Flag indicating if all items in this Menu Item Class are beverages." }, "isShareableItem":{ "type":"boolean", "example":false, "description":"Flag indicating to allow sharing of menu items in this class between two or more seats, or two or more checks." }, "isRetailItem":{ "type":"boolean", "example":false, "description":"Flag indicating whether item is retailable or not." }, "consolidateMenuItemWithCondimentsOnOrderOutput":{ "type":"boolean", "example":false, "description":"Flag indicating to consolidate parent menu items on Order Device Output, and then to print each condiment with the seat number." }, "consolidateParentsWithMatchingCondimentsOnOrderOutput":{ "type":"boolean", "example":false, "description":"Flag indicating to consolidate parent menu items with identical (matching) condiments." }, "includeInCRMOrTMSCheckDetilUpdate":{ "type":"boolean", "example":false, "description":"Flag indicating to indicate whether a menu item is sent to the TMS Interface with the check detail status message." }, "useKDSDiningCourseNumber":{ "type":"boolean", "example":false, "description":"Flag indicating to use KDS/Dining Coursing with this Menu Item Class." }, "overrideKDSCourseNumOfParentClass":{ "type":"boolean", "example":false, "description":"Flag indicating to allow a parent menu item modified by a condiment in this Menu Item Class to use the KDS Course of the condiment." }, "participatesInMenuItemSwitching":{ "type":"boolean", "example":false, "description":"Flag indicating to switch a parent menu item based a menu level change." }, "isAnonymousMenuItem":{ "type":"boolean", "example":false, "description":"Flag indicating to allow placeholder or anonymous menu items, which can be replaced with the actual parent menu items during the ordering process." }, "itemMustCompleteBeforeNextItem":{ "type":"boolean", "example":false, "description":"Flag indicating to prevent operators from adding a second menu item before completing the first item." }, "promptToBeginNextItemIfItemIsIncomplete":{ "type":"boolean", "example":false, "description":"Flag indicating to prompt to move to the next item before completing a menu item order." }, "removeItemOnSubsequentPressIfExclusiveOrderingType":{ "type":"boolean", "example":false, "description":"Flag indicating to remove a condiment item and revert the parent menu item to the default state." }, "condimentEntryRelationaltoParentItemsQuantity":{ "type":"boolean", "example":false, "description":"Flag indicating to show the number of condiments for each parent menu item." }, "discountsApplyToPricedCondiments":{ "type":"boolean", "example":false, "description":"Flag indicating to apply discounts to parent items in this class and all priced condiments associated with the items." }, "parentItemsAppearOnCondimentOrderDevices":{ "type":"boolean", "example":false, "description":"Flag indicating to send the parent item to the order devices programmed for this class." }, "condimentOrderDeviceProgrammingOverridesThatOfParent":{ "type":"boolean", "example":false, "description":"Flag indicating to allow the order devices programmed for this condiments class to override the order devices defined for the parent items." }, "allowItemIncompleteBasedOnRole":{ "type":"boolean", "example":false, "description":"Flag indicating to allow the employee to add the parent menu item without the required condiments." }, "placeHolder":{ "type":"boolean", "example":false, "description":"Flag indicating for menu items that serve as a placeholder during Combo Meal ordering." }, "noPlaceHolderDisplay":{ "type":"boolean", "example":false, "description":"Flag indicating to hide placeholder items from the check detail area." }, "countMenuItem":{ "type":"boolean", "example":false, "description":"Flag indicating to allow the menu item count to appear on the KDS or at the bottom of the requisition chit from a local or remote printer." }, "autoFill":{ "type":"boolean", "example":false, "description":"Flag indicating to adjust the quantity to satisfy the required condiments when adding the condiment with a required condiment group that has Min/Max set, and more than one condiment is still needed." }, "rentalDeposit":{ "type":"boolean", "example":false, "description":"Flag indicating to make all items in this class Rental Deposits." }, "supportEnhancedPrefixMode":{ "type":"boolean", "example":false, "description":"Flag indicating to turn on Enhanced Prefix Support for non-condiment menu items in this class." }, "printName3OnOrderOutputInsteadOfName1":{ "type":"boolean", "example":false, "description":"Flag indicating to print the menu item definition's Third Name (if defined) on order devices for menu items in this class." }, "useName3OnTouchscreensInsteadOfName1":{ "type":"boolean", "example":false, "description":"Flag indicating to show the third name (if defined) on system generated touchscreen keys." }, "printName3OnChecks":{ "type":"boolean", "example":false, "description":"Flag indicating to print the menu item definition's Third Name (if defined) on guest checks for menu items in this class." }, "promptToLookupMenuItemDefinitionbasedOncurrentMenuLevels":{ "type":"boolean", "example":false, "description":"Flag indicating to prompt the operator to look up a menu item definition based on the current menu levels when a repeatable menu item is unavailable." }, "useName2OnOCBInsteadOfName1":{ "type":"boolean", "example":false, "description":"Flag indicating to show the menu item definition's Second Name (if defined) on an Order Confirmation Board." }, "useName3OnOCBInsteadOfName1":{ "type":"boolean", "example":false, "description":"Flag indicating to show the third name (if defined) on an Order Confirmation Board. If no third name is defined, the first name is used." }, "enableRefill":{ "type":"boolean", "example":false, "description":"Flag indicating for customers to pay once for selected menu items, while receiving multiple servings or refills." }, "PreventMenuItemsFromBeingHeld":{ "type":"boolean", "example":false, "description":"Flag indicating to prevent menu items belonging to this Menu Item Class from being held." }, "kdsSortPriorityAboveNormal":{ "type":"boolean", "example":false, "description":"Flag indicating to allow menu items assigned to this class to use a higher sort priority than normal." }, "postSalesCountToKDSReports":{ "type":"boolean", "example":false, "description":"Flag indicating to allow the menu item count to add to the Menu Item Count totals on the KDS reports." }, "onlyAllowCondimentsWithAnActivePriceRecord":{ "type":"boolean", "example":false, "description":"Flag indicating to prevent condiments that do not have an effective price record from being displayed in SLU's or added to a parent item from a direct access button." }, "forgiveInclusiveTax":{ "type":"boolean", "example":false, "description":"Flag indicating to forgive Inclusive Tax for this class." }, "doNotPrintUnPricedCondimentsOnGuestChecks":{ "type":"boolean", "example":false, "description":"Flag indicating to stop unpriced condiments from printing on guest checks and customer receipts." }, "containsAlcohol":{ "type":"boolean", "example":false, "description":"Flag indicating for menu items in this class to be marked as containing alcohol." }, "ignoreKDSPrepTime":{ "type":"boolean", "example":false, "description":"Flag indicating for menu items in this class to be displayed at a KDS display as soon capacity is available, ignoring having all menu items prep complete at the same time." }, "overrideParentsIgnoreKDSPrepTimeOption":{ "type":"boolean", "example":false, "description":"Flag indicating to override Option 83 of Parent Class." } } }, "MenuItemClass_dataExtensions":{ "type":"object", "properties":{ "columnName":{ "type":"string", "example":"extension column 1", "description":"Name of the extention field" }, "value":{ "type":"string", "example":"value 1", "description":"Value of the extention field" } } }, "MenuItemClass_requiredCondimentGroups_forceOptions":{ "type":"object", "properties":{ "minimum":{ "type":"integer", "example":1, "description":"Minimum number of items in the condiment group" }, "maximum":{ "type":"integer", "example":1, "description":"Maximum number of items allowed in the condiment group" }, "threshold1":{ "type":"integer", "example":1, "description":"Threshold 1 count of the condiment group" }, "thresholdLevel1":{ "type":"integer", "example":1, "description":"Threshold Level 1 of the condiment group" }, "threshold2":{ "type":"integer", "example":1, "description":"Threshold 2 count of the condiment group" }, "thresholdLevel2":{ "type":"integer", "example":1, "description":"Threshold Level 2 of the condiment group" } } }, "MenuItemClass_requiredCondimentGroups":{ "type":"object", "properties":{ "condimentGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the condiment group" }, "forceOptions":{ "type":"array", "description":"Force Options of the condiment group", "items":{ "$ref":"#/definitions/MenuItemClass_requiredCondimentGroups_forceOptions" } } } }, "MenuItemClass_allowedCondimentGroups":{ "type":"object", "properties":{ "condimentGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the condiment group" } } }, "MenuItemClass_memberCondimentGroups":{ "type":"object", "properties":{ "condimentGroupObjNum":{ "type":"integer", "example":2, "description":"Object number of the condiment group" } } }, "MenuItemClass_condimentGroups":{ "type":"object", "description":"List of condiment groups that are associated with the Menu Item Class", "properties":{ "requiredCondimentGroups":{ "type":"array", "description":"Array of the Condiment Groups that are required when ordering items assigned to this Menu Item Class.", "items":{ "$ref":"#/definitions/MenuItemClass_requiredCondimentGroups" } }, "allowedCondimentGroups":{ "type":"array", "description":"Array of the Condiment Groups that are allowed when adding items in this Menu Item Class.", "items":{ "$ref":"#/definitions/MenuItemClass_allowedCondimentGroups" } }, "memberCondimentGroups":{ "type":"array", "description":"Array of the Condiment Groups to which items in this Menu Item Class belong.", "items":{ "$ref":"#/definitions/MenuItemClass_memberCondimentGroups" } } } }, "MenuItemClass":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "hierUnitObjNum":{ "type":"integer", "example":2, "description":"Hierarchy unit object number" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the menu item Class." }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Menu Item", "de-DE":"Men??punkt", "es-MX":"Opci??n del men??" } }, "taxClassObjNum":{ "type":"integer", "example":1, "description":"Tax Class object for the Menu Item class" }, "taxClassName":{ "type":"object", "description":"Tax Class Name", "example":{ "en-US":"Tax Class", "de-DE":"Steuerklasse", "es-MX":"Clasificaci??n Fiscal" } }, "mainLevelPopupIndex":{ "type":"integer", "example":1, "description":"Main Level of the transaction to become active after adding an item from this Menu Item Class." }, "mainLevelDefault":{ "type":"boolean", "example":false, "description":"Select Main Level Dflt to return the Main Level of the transaction to the default Main Level after adding an item from this Menu Item Class." }, "subLevelPopupIndex":{ "type":"integer", "example":1, "description":"Sub Level of the transaction to become active after adding an item from this Menu Item Class." }, "subLevelDefault":{ "type":"boolean", "example":false, "description":"Select Sub Level Dflt to return the Sub Level of the transaction to the default Sub Level after adding an item from this Menu Item Class." }, "privilegeGroup":{ "type":"integer", "example":1, "description":"Privilege Group number to restrict the use of items in this Menu Item Class to employees who are linked to the same Privilege Group" }, "slsItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Sales Itemizer used to sort Menu Item Classes." }, "slsItmzrName":{ "type":"object", "description":"SLS Itemizer Name", "example":{ "en-US":"Menu Item", "de-DE":"Men??punkt", "es-MX":"Opci??n del men??" } }, "dscItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Discount Itemizer associated with this Menu Item Class." }, "dscItmZrName":{ "type":"object", "description":"Discount Itemizer Name", "example":{ "en-US":"Discount Itemizer", "de-DE":"Rabatt-Itemizer", "es-MX":"Itemizador de descuento" } }, "svcItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Service Charge Itemizer associated with menus items assigned to this Menu item Class." }, "svcItmzrName":{ "type":"object", "description":"Service Charge Itemizer", "example":{ "en-US":"Service Charge", "de-DE":"Servicegeb??hr", "es-MX":"Cargo por servicio" } }, "halo":{ "type":"integer", "example":1, "description":"High Amount Lock Out (HALO) value for items in this Menu Item Class." }, "kdsCourseObjNum":{ "type":"integer", "example":1, "description":"Object number of the course to which items in this Menu Item Class belong." }, "kdsCourseName":{ "type":"object", "description":"KDS Course Name", "example":{ "en-US":"Course", "de-DE":"Kurs", "es-MX":"Curso" } }, "defaultMasterGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the default parent item for a condiment during conversational ordering." }, "defaultMasterGroupName":{ "type":"object", "description":"Default Master Group Name", "example":{ "en-US":"Master Group", "de-DE":"Meistergruppe", "es-MX":"Grupo Maestro" } }, "condimentOrderType":{ "type":"integer", "example":1, "description":"Method for adding a condiment to a check. Value should be between 0-4." }, "condimentOrderPopup":{ "type":"integer", "example":1, "description":"Popup Condiment Orderer page to automatically pop up when adding a menu item with required condiments." }, "condimentEditPopup":{ "type":"integer", "example":0, "description":"Condiment Orderer page to automatically pop up when selecting a menu item with required condiments in the check detail." }, "priceCalculation":{ "type":"integer", "example":0, "description":"Calculation method to use for pricing menu items in the class when entering a decimal count." }, "countDisplay":{ "type":"integer", "example":1, "description":"Count that appear on the workstation and printers." }, "countEntry":{ "type":"integer", "example":1, "description":"Select the operator entry method for item sales count." }, "printGroup":{ "type":"integer", "example":1, "description":"The sorting mechanism uses this value for receipt printing, check detail, and order output devices." }, "printClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Print Class for the menu item class." }, "printClassName":{ "type":"object", "description":"Print Class Name", "example":{ "en-US":"Print Class", "de-DE":"Klasse drucken", "es-MX":"Clase de impresi??n" } }, "kdsHighlightScheme":{ "type":"integer", "example":1, "description":"Object number of the KDS Highlight Scheme color to display menu items on the KDS." }, "kdsHighlightSchemeName":{ "type":"object", "description":"KDS Highlights Scheme Name", "example":{ "en-US":"Scheme", "de-DE":"Planen", "es-MX":"Esquema" } }, "condimentPrefixType":{ "type":"integer", "example":1, "description":"Prefix Type associated with a Condiment type." }, "condimentHandlingWithParentItemSwitching":{ "type":"integer", "example":0, "description":"Condiment behavior to use for Default and other Condiments when the parent item is switched in Conversational Ordering." }, "nextPage":{ "type":"integer", "example":0, "description":"Next screen or page to which the workstation user is directed." }, "nextPanel":{ "type":"integer", "example":0, "description":"Panel specifies which Tab to navigate." }, "maxRefillCount":{ "type":"integer", "example":1, "description":"Maximum number of Refills allowed for a Menu item." }, "refillDescriptor":{ "type":"object", "description":"Refill Descriptor", "example":{ "en-US":"Refill Descriptor", "de-DE":"Nachf??lldeskriptor", "es-MX":"Descriptor de recarga" } }, "svcGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the Service Charge Group to apply to this Menu Item Class." }, "svcGroupName":{ "type":"object", "description":"SVC Group Name", "example":{ "en-US":"Print Class", "de-DE":"Servicegruppe", "es-MX":"Clase de impresi??n" } }, "preProdChitPrintClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Pre Production Chit Print Class for the Menu Item Class." }, "preProdChitPrintClassName":{ "type":"object", "description":"Pre Prod Chit Print Class Name", "example":{ "en-US":"Print Class", "de-DE":"Klasse drucken", "es-MX":"Clase de impresi??n" } }, "allergenClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Allergen Class for the Menu Item Class." }, "allergenClassName":{ "type":"object", "description":"Allergen Class Name", "example":{ "en-US":"Allergen Class", "de-DE":"Allergenklasse", "es-MX":"Clase de al??rgeno" } }, "options":{ "type":"string", "example":"010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 96 representing the enablement or disablement of the options associated with the Menu Item Class." }, "optionsExt":{ "$ref":"#/definitions/MenuItemClass_optionsExt" }, "condimentGroups":{ "$ref":"#/definitions/MenuItemClass_condimentGroups" }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item class", "items":{ "$ref":"#/definitions/MenuItemClass_dataExtensions" } } } }, "MenuItemClassV2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "hierUnitObjNum":{ "type":"integer", "example":2, "description":"Hierarchy unit object number" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the menu item Class." }, "name":{ "type":"object", "description":"Menu Item Class Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "taxClassObjNum":{ "type":"integer", "example":1, "description":"Tax Class object for the Menu Item class" }, "mainLevelPopupIndex":{ "type":"integer", "example":1, "description":"Main Level of the transaction to become active after adding an item from this Menu Item Class." }, "mainLevelDefault":{ "type":"boolean", "example":false, "description":"Select Main Level Dflt to return the Main Level of the transaction to the default Main Level after adding an item from this Menu Item Class." }, "subLevelPopupIndex":{ "type":"integer", "example":1, "description":"Sub Level of the transaction to become active after adding an item from this Menu Item Class." }, "subLevelDefault":{ "type":"boolean", "example":false, "description":"Select Sub Level Dflt to return the Sub Level of the transaction to the default Sub Level after adding an item from this Menu Item Class." }, "privilegeGroup":{ "type":"integer", "example":1, "description":"Privilege Group number to restrict the use of items in this Menu Item Class to employees who are linked to the same Privilege Group" }, "slsItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Sales Itemizer used to sort Menu Item Classes." }, "dscItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Discount Itemizer associated with this Menu Item Class." }, "svcItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Service Charge Itemizer associated with menus items assigned to this Menu item Class." }, "halo":{ "type":"integer", "example":1, "description":"High Amount Lock Out (HALO) value for items in this Menu Item Class." }, "kdsCourseObjNum":{ "type":"integer", "example":1, "description":"Object number of the course to which items in this Menu Item Class belong." }, "defaultMasterGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the default parent item for a condiment during conversational ordering." }, "condimentOrderType":{ "type":"integer", "example":1, "description":"Method for adding a condiment to a check. Value should be between 0-4." }, "condimentOrderPopup":{ "type":"integer", "example":1, "description":"Popup Condiment Orderer page to automatically pop up when adding a menu item with required condiments." }, "condimentEditPopup":{ "type":"integer", "example":0, "description":"Condiment Orderer page to automatically pop up when selecting a menu item with required condiments in the check detail." }, "priceCalculation":{ "type":"integer", "example":0, "description":"Calculation method to use for pricing menu items in the class when entering a decimal count." }, "countDisplay":{ "type":"integer", "example":1, "description":"Count that appear on the workstation and printers." }, "countEntry":{ "type":"integer", "example":1, "description":"Select the operator entry method for item sales count." }, "printGroup":{ "type":"integer", "example":1, "description":"The sorting mechanism uses this value for receipt printing, check detail, and order output devices." }, "printClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Print Class for the menu item class." }, "kdsHighlightScheme":{ "type":"integer", "example":1, "description":"Object number of the KDS Highlight Scheme color to display menu items on the KDS." }, "condimentPrefixType":{ "type":"integer", "example":1, "description":"Prefix Type associated with a Condiment type." }, "condimentHandlingWithParentItemSwitching":{ "type":"integer", "example":0, "description":"Condiment behavior to use for Default and other Condiments when the parent item is switched in Conversational Ordering." }, "nextPage":{ "type":"integer", "example":0, "description":"Next screen or page to which the workstation user is directed." }, "nextPanel":{ "type":"integer", "example":0, "description":"Panel specifies which Tab to navigate." }, "maxRefillCount":{ "type":"integer", "example":1, "description":"Maximum number of Refills allowed for a Menu item." }, "refillDescriptor":{ "type":"object", "description":"Refill Descriptor", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "svcGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the Service Charge Group to apply to this Menu Item Class." }, "preProdChitPrintClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Pre Production Chit Print Class for the Menu Item Class." }, "allergenClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Allergen Class for the Menu Item Class." }, "options":{ "type":"string", "example":"010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 96 representing the enablement or disablement of the options associated with the Menu Item Class." }, "optionsExt":{ "$ref":"#/definitions/MenuItemClass_optionsExt" }, "condimentGroups":{ "$ref":"#/definitions/MenuItemClass_condimentGroups" }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item class", "items":{ "$ref":"#/definitions/MenuItemClass_dataExtensions" } } } }, "MenuItemClassCUDRequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the menu item Class." }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Menu Item", "de-DE":"Men??punkt", "es-MX":"Opci??n del men??" } }, "taxClassObjNum":{ "type":"integer", "example":1, "description":"Tax Class object for the Menu Item class" }, "mainLevelPopupIndex":{ "type":"integer", "example":1, "description":"Main Level of the transaction to become active after adding an item from this Menu Item Class." }, "mainLevelDefault":{ "type":"boolean", "example":false, "description":"Select Main Level Dflt to return the Main Level of the transaction to the default Main Level after adding an item from this Menu Item Class." }, "subLevelPopupIndex":{ "type":"integer", "example":1, "description":"Sub Level of the transaction to become active after adding an item from this Menu Item Class." }, "subLevelDefault":{ "type":"boolean", "example":false, "description":"Select Sub Level Dflt to return the Sub Level of the transaction to the default Sub Level after adding an item from this Menu Item Class." }, "privilegeGroup":{ "type":"integer", "example":1, "description":"Privilege Group number to restrict the use of items in this Menu Item Class to employees who are linked to the same Privilege Group" }, "slsItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Sales Itemizer used to sort Menu Item Classes." }, "dscItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Discount Itemizer associated with this Menu Item Class." }, "svcItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Service Charge Itemizer associated with menus items assigned to this Menu item Class." }, "halo":{ "type":"integer", "example":1, "description":"High Amount Lock Out (HALO) value for items in this Menu Item Class." }, "kdsCourseObjNum":{ "type":"integer", "example":1, "description":"Object number of the course to which items in this Menu Item Class belong." }, "defaultMasterGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the default parent item for a condiment during conversational ordering." }, "condimentOrderType":{ "type":"integer", "example":1, "description":"Method for adding a condiment to a check. Value should be between 0-4." }, "condimentOrderPopup":{ "type":"integer", "example":1, "description":"Popup Condiment Orderer page to automatically pop up when adding a menu item with required condiments." }, "condimentEditPopup":{ "type":"integer", "example":0, "description":"Condiment Orderer page to automatically pop up when selecting a menu item with required condiments in the check detail." }, "priceCalculation":{ "type":"integer", "example":0, "description":"Calculation method to use for pricing menu items in the class when entering a decimal count." }, "countDisplay":{ "type":"integer", "example":1, "description":"Count that appear on the workstation and printers." }, "countEntry":{ "type":"integer", "example":1, "description":"Select the operator entry method for item sales count." }, "printGroup":{ "type":"integer", "example":1, "description":"The sorting mechanism uses this value for receipt printing, check detail, and order output devices." }, "printClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Print Class for the menu item class." }, "kdsHighlightScheme":{ "type":"integer", "example":1, "description":"Object number of the KDS Highlight Scheme color to display menu items on the KDS." }, "condimentPrefixType":{ "type":"integer", "example":1, "description":"Prefix Type associated with a Condiment type." }, "condimentHandlingWithParentItemSwitching":{ "type":"integer", "example":0, "description":"Condiment behavior to use for Default and other Condiments when the parent item is switched in Conversational Ordering." }, "nextPage":{ "type":"integer", "example":0, "description":"Next screen or page to which the workstation user is directed." }, "nextPanel":{ "type":"integer", "example":0, "description":"Panel specifies which Tab to navigate." }, "maxRefillCount":{ "type":"integer", "example":1, "description":"Maximum number of Refills allowed for a Menu item." }, "refillDescriptor":{ "type":"object", "description":"Refill Descriptor", "example":{ "en-US":"Refill Descriptor", "de-DE":"Nachf??lldeskriptor", "es-MX":"Descriptor de recarga" } }, "svcGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the Service Charge Group to apply to this Menu Item Class." }, "preProdChitPrintClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Pre Production Chit Print Class for the Menu Item Class." }, "allergenClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Allergen Class for the Menu Item Class." }, "options":{ "type":"string", "example":"010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 96 representing the enablement or disablement of the options associated with the Menu Item Class." }, "condimentGroups":{ "$ref":"#/definitions/MenuItemClass_condimentGroups" }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item class", "items":{ "$ref":"#/definitions/MenuItemClass_dataExtensions" } } } }, "MenuItemClassResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Menu Item Class" } } }, "ComboMealGroupDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "ComboMealsGroupResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":2, "description":"Unique reference of the Combo Meal" } } }, "ComboMealGroupv1GetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Combo Meal Group objects of the organization.", "items":{ "$ref":"#/definitions/ComboMealGroupResourceObjectv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "ComboMealGroup_OptionsExt":{ "type":"object", "properties":{ "allowDiscounts":{ "type":"boolean", "example":false, "description":"Flag indicating to apply discounts to items in this group." }, "substitutionGroupItemsUseThisSidesPrice":{ "type":"boolean", "example":false, "description":"When substituting a Combo Meal side with a menu item from another group, Set this attribute to True to set the item's price to the side's combo meal price specified in the sides Combo Group Price." } }, "description":"An object containing the descriptive options list associated with the Combo Meal Group." }, "ComboMealGroup_AlternateGroup":{ "type":"object", "properties":{ "sequenceNum":{ "type":"integer", "example":1, "description":"Sequence number of the alternate combo meal group." }, "alternateGroupObjNum":{ "type":"integer", "example":2, "description":"Object number of the alternate combo meal group." } } }, "OptionsExt_ComboGroupItem":{ "type":"object", "properties":{ "defaultWhenNoOrderTypeIsSelected":{ "type":"boolean", "example":false, "description":"Flag indicating to make this item the default for the Combo Group without a declared Order Type." }, "defaultForOrderType1":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 1 is active." }, "defaultForOrderType2":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 2 is active." }, "defaultForOrderType3":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 3 is active." }, "defaultForOrderType4":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 4 is active." }, "defaultForOrderType5":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 5 is active." }, "defaultForOrderType6":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 6 is active." }, "defaultForOrderType7":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 7 is active." }, "defaultForOrderType8":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 8 is active." }, "autofill":{ "type":"boolean", "example":false, "description":"A flag indicating to change the side item quantity to the number of remaining items needed to complete the side requirements when ordering one of the combo meals where more than one remaining item is required." }, "sendToComboParentsOrderDevices":{ "type":"boolean", "example":false, "description":"A flag indicating to also send the combo side menu item to the combo meal parent menu item's Order Devices" }, "defaultForOrderType9":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 9 is active." }, "defaultForOrderType10":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 10 is active." }, "defaultForOrderType11":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 11 is active." }, "defaultForOrderType12":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 12 is active." }, "defaultForOrderType13":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 13 is active." }, "defaultForOrderType14":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 14 is active." }, "defaultForOrderType15":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 15 is active." }, "defaultForOrderType16":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 16 is active." }, "defaultForOrderType17":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 17 is active." }, "defaultForOrderType18":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 18 is active." }, "defaultForOrderType19":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 19 is active." }, "defaultForOrderType20":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 20 is active." }, "defaultForOrderType21":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 21 is active." }, "defaultForOrderType22":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 22 is active." }, "defaultForOrderType23":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 23 is active." }, "defaultForOrderType24":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 24 is active." }, "defaultForOrderType25":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 25 is active." }, "defaultForOrderType26":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 26 is active." }, "defaultForOrderType27":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 27 is active." }, "defaultForOrderType28":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 28 is active." }, "defaultForOrderType29":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 29 is active." }, "defaultForOrderType30":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 30 is active." }, "defaultForOrderType31":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 31 is active." }, "defaultForOrderType32":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 32 is active." } }, "description":"An object containing the descriptive options list associated with the Combo Meal Group Item" }, "ComboMealGroup_Items":{ "type":"object", "properties":{ "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the Menu Item Master that contains the side items for the combo meal" }, "quantity":{ "type":"integer", "example":1, "description":"Number of Combo Meal Group items required for the combo meal side" }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the Combo Meal Group Item. If not specified, this will represent the default options associated with the Combo MealGroup Item" }, "optionsExt":{ "description":"An object containing the descriptive options list associated with the Combo Meal Group Item", "$ref":"#/definitions/OptionsExt_ComboGroupItem" }, "size1ComboGroupObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 1 function key (663)." }, "size2ComboGroupObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 2 function key (664)." }, "size3ComboGroupObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 3 function key (665)." }, "size4ComboGroupObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 4 function key (666)." }, "size1MenuLevelIndex":{ "type":"integer", "example":0, "description":"Menu Level index for using the Combo Size 1." }, "size2MenuLevelIndex":{ "type":"integer", "example":0, "description":"Menu Level index for using the Combo Size 2." }, "size3MenuLevelIndex":{ "type":"integer", "example":0, "description":"Menu Level index for using the Combo Size 3." }, "size4MenuLevelIndex":{ "type":"integer", "example":0, "description":"Menu Level index for using the Combo Size 4." }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group" }, "effectivityGroupName":{ "type":"object", "description":"Effectivity Group Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "prices":{ "description":"An array of prices associated with the combo meal group items.", "$ref":"#/definitions/Price_ComboGroupItem" } }, "description":"Model for Combo Meal Group_Item Object" }, "ComboMealGroup_Itemsv2":{ "type":"object", "properties":{ "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the Menu Item Master that contains the side items for the combo meal" }, "quantity":{ "type":"integer", "example":1, "description":"Number of Combo Meal Group items required for the combo meal side" }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the Combo Meal Group Item. If not specified, this will represent the default options associated with the Combo MealGroup Item" }, "optionsExt":{ "description":"An object containing the descriptive options list associated with the Combo Meal Group Item", "$ref":"#/definitions/OptionsExt_ComboGroupItem" }, "size1ComboGroupObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 1 function key (663)." }, "size2ComboGroupObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 2 function key (664)." }, "size3ComboGroupObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 3 function key (665)." }, "size4ComboGroupObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 4 function key (666)." }, "size1MenuLevelIndex":{ "type":"integer", "example":0, "description":"Menu Level index for using the Combo Size 1." }, "size2MenuLevelIndex":{ "type":"integer", "example":0, "description":"Menu Level index for using the Combo Size 2." }, "size3MenuLevelIndex":{ "type":"integer", "example":0, "description":"Menu Level index for using the Combo Size 3." }, "size4MenuLevelIndex":{ "type":"integer", "example":0, "description":"Menu Level index for using the Combo Size 4." }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group" }, "prices":{ "description":"An array of prices associated with the combo meal group items.", "$ref":"#/definitions/Price_ComboGroupItemV2" } }, "description":"Model for Combo Meal Group_Item Object" }, "ComboMealGroup_Items_CUD":{ "type":"object", "properties":{ "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the Menu Item Master that contains the side items for the combo meal" }, "quantity":{ "type":"integer", "example":1, "description":"Number of Combo Meal Group items required for the combo meal side" }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the Combo Meal Group Item. If not specified, this will represent the default options associated with the Combo MealGroup Item" }, "size1ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 1 function key (663)." }, "size2ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 2 function key (664)." }, "size3ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 3 function key (665)." }, "size4ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 4 function key (666)." }, "size1MenuLevelIndex":{ "type":"integer", "example":0, "description":"Menu Level index for using the Combo Size 1." }, "size2MenuLevelIndex":{ "type":"integer", "example":0, "description":"Menu Level index for using the Combo Size 2." }, "size3MenuLevelIndex":{ "type":"integer", "example":0, "description":"Menu Level index for using the Combo Size 3." }, "size4MenuLevelIndex":{ "type":"integer", "example":0, "description":"Menu Level index for using the Combo Size 4." }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group" }, "prices":{ "description":"An array of prices associated with the combo meal group items.", "$ref":"#/definitions/Price_ComboGroupItem" } }, "description":"Model for Combo Meal Group_Item Object" }, "ComboMealGroup_Items_UpdateV2":{ "type":"object", "properties":{ "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the Menu Item Master that contains the side items for the combo meal" }, "quantity":{ "type":"integer", "example":1, "description":"Number of Combo Meal Group items required for the combo meal side" }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the Combo Meal Group Item. If not specified, this will represent the default options associated with the Combo MealGroup Item" }, "size1ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 1 function key (663)." }, "size2ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 2 function key (664)." }, "size3ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 3 function key (665)." }, "size4ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 4 function key (666)." }, "size1MenuLevelIndex":{ "type":"integer", "example":0, "description":"Menu Level index for using the Combo Size 1." }, "size2MenuLevelIndex":{ "type":"integer", "example":0, "description":"Menu Level index for using the Combo Size 2." }, "size3MenuLevelIndex":{ "type":"integer", "example":0, "description":"Menu Level index for using the Combo Size 3." }, "size4MenuLevelIndex":{ "type":"integer", "example":0, "description":"Menu Level index for using the Combo Size 4." }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group" }, "prices":{ "description":"An array of prices associated with the combo meal group items.", "$ref":"#/definitions/Price_ComboGroupItemV2" } }, "description":"Model for Combo Meal Group_Item Object" }, "ComboMealGroupResourceObjectv1":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name.", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "type":"integer", "example":1, "description":"Combo Meal object number" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Combo Group 1", "es-MX":"Combo Grupo 1" } }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing enabled or disabled options" }, "optionsExt":{ "$ref":"#/definitions/ComboMealGroup_OptionsExt" }, "alternateGroups":{ "type":"array", "description":"An array of Alternate Groups, if any, for this Combo Meal Group.", "items":{ "$ref":"#/definitions/ComboMealGroup_AlternateGroup" } }, "items":{ "type":"array", "description":"An array of items that are associated with the combo meal group", "items":{ "$ref":"#/definitions/ComboMealGroup_Items" } } } }, "ComboSideGroupv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Combo Meal object number" }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" }, "name":{ "type":"object", "description":"Combo Group Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing enabled or disabled options" }, "optionsExt":{ "$ref":"#/definitions/ComboMealGroup_OptionsExt" }, "alternateGroups":{ "type":"array", "description":"An array of Alternate Groups, if any, for this Combo Meal Group.", "items":{ "$ref":"#/definitions/ComboMealGroup_AlternateGroup" } }, "items":{ "type":"array", "description":"An array of items that are associated with the combo meal group", "items":{ "$ref":"#/definitions/ComboMealGroup_Itemsv2" } } } }, "ComboMealGroupCUDRequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "objectNum":{ "type":"integer", "example":1, "description":"Combo Meal object number" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Combo Group 1", "es-MX":"Combo Grupo 1" } }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing enabled or disabled options" }, "alternateGroups":{ "type":"array", "description":"An array of Alternate Groups, if any, for this Combo Meal Group.", "items":{ "$ref":"#/definitions/ComboMealGroup_AlternateGroup" } }, "items":{ "type":"array", "description":"An array of items that are associated with the combo meal group", "items":{ "$ref":"#/definitions/ComboMealGroup_Items_CUD" } } } }, "Price_ComboGroupItem":{ "type":"object", "properties":{ "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" }, "price":{ "type":"number", "example":1.23, "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items" }, "prepcost":{ "type":"number", "example":0.89, "description":"The a-la carte price of the combo group side items. You can override the a-la carte price for individual combo group items by setting an a-la carte price for those items." }, "activeOnLevel":{ "type":"integer", "example":0, "description":"The main menu level on which the price is active. Setting it to 0 indicates the prices is active on all levels" }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group associated with the price" } }, "description":"Model for Combo Group Item Price Object" }, "Price_ComboGroupItemV2":{ "type":"array", "items":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value where the price is located." }, "sequenceNum":{ "type":"integer", "example":1, "description":"The sequence number of the price" }, "price":{ "type":"number", "example":1.23, "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items" }, "prepcost":{ "type":"number", "example":0.89, "description":"The a-la carte price of the combo group side items. You can override the a-la carte price for individual combo group items by setting an a-la carte price for those items." }, "activeOnLevel":{ "type":"integer", "example":0, "description":"The main menu level on which the price is active. Setting it to 0 indicates the prices is active on all levels" }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group associated with the price" } } }, "description":"Model for Combo Group Item Price Object" }, "ComboMealSideDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "ComboMealsSideGroupsGetParametersv1":{ "type":"object", "required":[ "hierUnitId", "comboMealObjNum" ], "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "comboMealObjNum":{ "type":"integer", "example":2, "description":"Unique reference of the Combo Meal" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." } } }, "ComboMealSideGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Combo Meal Side objects of the organization.", "items":{ "$ref":"#/definitions/ComboMealSideResourceObject" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "ComboMealSideResourceObject":{ "type":"object", "required":[ "hierUnitId", "comboMealObjNum", "sideNum", "comboGrpObjNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "comboMealObjNum":{ "type":"integer", "example":1, "description":"Combo Meal object number" }, "comboGroupName":{ "type":"object", "description":"Combo Group Name", "example":{ "en-US":"Combo Group 1", "es-MX":"Combo Grupo 1" } }, "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side." }, "comboGrpObjNum":{ "type":"integer", "example":1, "description":"Object number of the Side Item Group that contains the side items for the combo meal." }, "sideCount":{ "type":"integer", "example":1, "description":"Number of Combo Meal Group items required for the combo meal side." }, "defaultMenuLevelIndex":{ "type":"integer", "example":1, "description":"Index of the default menu level for this combo group." }, "menuLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing the configured menu levels that are available for ordering with this combo group" }, "menuLevelExt":{ "$ref":"#/definitions/ComboMeals_MenuLevelExt" } } }, "ComboMealSideResourceObjectv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "comboMealObjNum":{ "type":"integer", "example":1, "description":"Combo Meal object number" }, "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side." }, "comboGrpObjNum":{ "type":"integer", "example":1, "description":"Object number of the Side Item Group that contains the side items for the combo meal." }, "sideCount":{ "type":"integer", "example":1, "description":"Number of Combo Meal Group items required for the combo meal side." }, "defaultMenuLevelIndex":{ "type":"integer", "example":1, "description":"Index of the default menu level for this combo group." }, "menuLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing the configured menu levels that are available for ordering with this combo group" }, "menuLevelExt":{ "$ref":"#/definitions/ComboMeals_MenuLevelExt" } } }, "ComboMealSideResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "comboMealObjNum":{ "type":"integer", "example":2, "description":"Unique reference of the Combo Meal." }, "sideNum":{ "type":"integer", "example":1, "description":"Sequence number of the side." } } }, "ComboGroupItemGetRequestBody":{ "type":"object", "required":[ "hierUnitId", "comboMealGroupObjNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealGroupObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal group" } } }, "ComboGroupItemGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Combo Group Item objects of the organization.", "items":{ "$ref":"#/definitions/ComboGroupItemResourceObjectv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "ComboGroupItemResourceObjectv1":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "comboMealGroupObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal group" }, "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "quantity":{ "type":"integer", "example":1, "description":"The quantity of the item" }, "options":{ "type":"string", "example":"000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the Combo Meal Group Item. If not specified, this will represent the default options associated with the Combo MealGroup Item" }, "optionsExt":{ "description":"An object containing the descriptive options list associated with the Combo Meal Group Item", "$ref":"#/definitions/OptionsExt_ComboGroupItem" }, "size1ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 1 function key (663)." }, "size2ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 2 function key (664)." }, "size3ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 3 function key (665)." }, "size4ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 4 function key (666)." }, "size1MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 1. Valid range is between 1 and 8." }, "size2MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 2. Valid range is between 1 and 8." }, "size3MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 3. Valid range is between 1 and 8." }, "size4MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 4. Valid range is between 1 and 8." }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group" }, "effectivityGroupName":{ "type":"object", "description":"Effectivity Group Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "prices":{ "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items.", "$ref":"#/definitions/Price_ComboGroupItem" } }, "description":"Model for Combo Group Item Object" }, "ComboSideGroupItemv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" }, "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "quantity":{ "type":"integer", "example":1, "description":"The quantity of the item" }, "options":{ "type":"string", "example":"000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the Combo Meal Group Item. If not specified, this will represent the default options associated with the Combo MealGroup Item" }, "optionsExt":{ "description":"An object containing the descriptive options list associated with the Combo Meal Group Item", "$ref":"#/definitions/OptionsExt_ComboGroupItem" }, "size1ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 1 function key (663)." }, "size2ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 2 function key (664)." }, "size3ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 3 function key (665)." }, "size4ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 4 function key (666)." }, "size1MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 1. Valid range is between 1 and 8." }, "size2MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 2. Valid range is between 1 and 8." }, "size3MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 3. Valid range is between 1 and 8." }, "size4MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 4. Valid range is between 1 and 8." }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group" }, "prices":{ "description":"The default side item price to use for the combo group items. You can override the price for individual combo group items by setting a price for those items.", "$ref":"#/definitions/Price_ComboGroupItemV2" } }, "description":"Model for Combo Group Item Object" }, "ComboGroupItemResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "comboMealGroupObjNum":{ "type":"integer", "example":1, "description":"Object Number of the Combo Meal group" }, "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" } } }, "ComboGroupItemDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "CondimentGroupResponseV1":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the condiment Group" }, "name":{ "type":"object", "description":"Name", "example":{ "1":"Family Group 1", "2":"Familiengruppe 1", "3":"Grupo familiar 1" } }, "consumerDescription":{ "type":"object", "description":"Consumer Description", "example":{ "1":"Family Group 1", "2":"Familiengruppe 1", "3":"Grupo familiar 1" } } }, "description":"Model for Condiment Group Object" }, "CondimentGroupGetResponseV1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Condiment Group objects.", "items":{ "$ref":"#/definitions/CondimentGroupResponseV1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "CondimentGroupV2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the condiment Group" }, "name":{ "type":"object", "description":"Name", "example":{ "1":"Family Group 1", "2":"Familiengruppe 1", "3":"Grupo familiar 1" } }, "consumerDescription":{ "type":"object", "description":"Consumer Description", "example":{ "1":"Family Group 1", "2":"Familiengruppe 1", "3":"Grupo familiar 1" } } }, "description":"Model for Condiment Group Object" }, "CondimentGroupCUDRequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the condiment Group" }, "name":{ "type":"object", "description":"Name", "example":{ "1":"Family Group 1", "2":"Familiengruppe 1", "3":"Grupo familiar 1" } }, "consumerDescription":{ "type":"object", "description":"Consumer Description", "example":{ "1":"Family Group 1", "2":"Familiengruppe 1", "3":"Grupo familiar 1" } } }, "description":"CUD Request Body for Condiment Group Object" }, "CondimentGroupResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment group" } } }, "CondimentGroupDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "CondimentSet":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment set" }, "name":{ "type":"object", "description":"name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "condimentItems":{ "type":"array", "description":"An array of menu items that are part of the condiment set", "items":{ "$ref":"#/definitions/CondimentSet_condimentItems" } } }, "description":"Model for Condiment Set Object" }, "CondimentSetsv1":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment set" }, "name":{ "type":"object", "description":"name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "condimentItems":{ "type":"array", "description":"An array of menu items that are part of the condiment set", "items":{ "$ref":"#/definitions/CondimentSet_condimentItems" } } }, "description":"Model for Condiment Set Object" }, "CondimentSetGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Condiment Set objects of the organization.", "items":{ "$ref":"#/definitions/CondimentSetsv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "CondimentSetsv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment set" }, "name":{ "type":"object", "description":"Condiment Set Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "condimentItems":{ "type":"array", "description":"An array of menu items that are part of the condiment set", "items":{ "$ref":"#/definitions/CondimentSet_condimentItemsv2" } } }, "description":"Model for Condiment Set Object" }, "CondimentSetCUDRequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment set" }, "name":{ "type":"object", "description":"name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "condimentItems":{ "type":"array", "description":"An array of menu items that are part of the condiment set", "items":{ "$ref":"#/definitions/CondimentSet_condimentItemsCUD" } } }, "description":"CUD Request Body for Condiment Set Object" }, "CondimentSetResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment set" } } }, "CondimentSetDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "CondimentSetItem_optionsExt":{ "type":"object", "properties":{ "persistOnPlain":{ "type":"boolean", "example":true, "description":"A Boolean flag indicating to keep the selected condiment when the menu item is changed to Plain. Deselect to remove it." } }, "description":"An object containing the descriptive options list associated with the condiment item" }, "CondimentSet_condimentItems":{ "type":"object", "properties":{ "condimentItemNum":{ "type":"integer", "example":1, "description":"Sequence number of the condiment item" }, "miMstrObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master assigned to the condiment item" }, "miMstrName":{ "type":"object", "description":"Menu item master name", "example":{ "en-US":"Condiment Set Items", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "defaultCount":{ "type":"integer", "example":1, "description":"The number of each condiment that comes with the set." }, "sortOrder":{ "type":"integer", "example":1, "description":"The order in which the condiments are displayed on checks, receipts, SLUs, and KDS displays. 0 - Ascending 1 - Descending" }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment item" }, "optionsExt":{ "$ref":"#/definitions/CondimentSetItem_optionsExt" }, "miDefSequence":{ "type":"integer", "example":0, "description":"The Menu Item definition sequence number of each record. This coincides with the Menu Item Definition that appears in the POS client when the condiment is triggered." } } }, "CondimentSet_condimentItemsv2":{ "type":"object", "properties":{ "condimentItemNum":{ "type":"integer", "example":1, "description":"Sequence number of the condiment item" }, "miMstrObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master assigned to the condiment item" }, "defaultCount":{ "type":"integer", "example":1, "description":"The number of each condiment that comes with the set." }, "sortOrder":{ "type":"integer", "example":1, "description":"The order in which the condiments are displayed on checks, receipts, SLUs, and KDS displays. 0 - Ascending 1 - Descending" }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment item" }, "optionsExt":{ "$ref":"#/definitions/CondimentSetItem_optionsExt" }, "miDefSequence":{ "type":"integer", "example":0, "description":"The Menu Item definition sequence number of each record. This coincides with the Menu Item Definition that appears in the POS client when the condiment is triggered." } } }, "CondimentSet_condimentItemsCUD":{ "type":"object", "properties":{ "condimentItemNum":{ "type":"integer", "example":1, "description":"Sequence number of the condiment item" }, "miMstrObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master assigned to the condiment item" }, "defaultCount":{ "type":"integer", "example":1, "description":"The number of each condiment that comes with the set. Value must lie between 0 and 99999999." }, "sortOrder":{ "type":"integer", "example":1, "description":"The order in which the condiments are displayed on checks, receipts, SLUs, and KDS displays. Value must lie between 0 and 32767." }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment item" }, "miDefSequence":{ "type":"integer", "example":0, "description":"The Menu Item definition sequence number of each record. This coincides with the Menu Item Definition that appears in the POS client when the condiment is triggered." } } }, "CondimentSetItemGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Condiment set item objects of the organization.", "items":{ "$ref":"#/definitions/CondimentSetItemResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "CondimentSetItemGetResponsev2":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Condiment set item objects of the organization.", "items":{ "$ref":"#/definitions/CondimentSetItemResponsev2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "CondimentSetItemResponsev1":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment set" }, "condimentItemNum":{ "type":"integer", "example":1, "description":"Sequence number of the condiment item" }, "miMstrObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master assigned to the condiment item" }, "miMstrName":{ "type":"object", "description":"Menu Item Master Name", "example":{ "en-US":"Condiment Set Items", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "defaultCount":{ "type":"integer", "example":1, "description":"The number of each condiment that comes with the set." }, "sortOrder":{ "type":"integer", "example":1, "description":"The order in which the condiments are displayed on checks, receipts, SLUs, and KDS displays. 0 indicates Ascending and 1 indicates Descending." }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment item" }, "optionsExt":{ "$ref":"#/definitions/CondimentSetItem_optionsExt" }, "miDefSequence":{ "type":"integer", "example":0, "description":"The Menu Item definition sequence number of each record. This coincides with the Menu Item Definition that appears in the POS client when the condiment is triggered." } }, "description":"Model for Condiment Set Item Object" }, "CondimentSetItemResponsev2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment set" }, "condimentItemNum":{ "type":"integer", "example":1, "description":"Sequence number of the condiment item" }, "miMstrObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master assigned to the condiment item" }, "defaultCount":{ "type":"integer", "example":1, "description":"The number of each condiment that comes with the set." }, "sortOrder":{ "type":"integer", "example":1, "description":"The order in which the condiments are displayed on checks, receipts, SLUs, and KDS displays. 0 indicates Ascending and 1 indicates Descending." }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment item" }, "optionsExt":{ "$ref":"#/definitions/CondimentSetItem_optionsExt" }, "miDefSequence":{ "type":"integer", "example":0, "description":"The Menu Item definition sequence number of each record. This coincides with the Menu Item Definition that appears in the POS client when the condiment is triggered." } }, "description":"Model for Condiment Set Item Object" }, "CondimentSetItemsGetRequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the condiment set" } } }, "CondimentSetItemResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the condiment set" }, "condimentItemNum":{ "type":"integer", "example":1, "description":"Sequence number of the condiment item" } } }, "CondimentSetItemDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "ServiceChargeItemizersCURequestBody":{ "description":"Model for Service Charge Itemizers Object for Create/Update Request", "type":"object", "required":[ "hierUnitId", "svcItmzrIndex", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "svcItmzrIndex":{ "description":"Object number of the Service Charge Itemizer", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Service Charge Itemizer in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } } } }, "ServiceChargeItemizers":{ "description":"Model for Service Charge Itemizers Object", "type":"object", "required":[ "hierUnitId", "svcItmzrIndex", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "svcItmzrIndex":{ "description":"Object number of the Service Charge Itemizer", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Service Charge Itemizer in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } } } }, "ServiceChargeItemizersGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Service Charge Itemizer objects of the organization.", "items":{ "$ref":"#/definitions/ServiceChargeItemizersResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "ServiceChargeItemizerv2":{ "description":"Model for Service Charge Itemizers Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "svcItmzrIndex":{ "description":"Object number of the Service Charge Itemizer", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Service Charge Itemizer in configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } } } }, "ServiceChargeItemizersResponsev1":{ "description":"Model for Service Charge Itemizers Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "svcItmzrIndex":{ "description":"Object number of the Service Charge Itemizer", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Service Charge Itemizer in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } } } }, "ServiceChargeItemizersResponse":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "svcItmzrIndex":{ "description":"Object number of the Service Charge Itemizer", "type":"integer", "example":1 } } }, "AllergenClass":{ "description":"Allergen Class record", "type":"object", "properties":{ "hierUnitId":{ "description":"Hier Unit Id of the Enterprise.", "type":"integer", "example":7 }, "objectNum":{ "description":"Object Number of the Allergen Class.", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name of the Allergen Class.", "example":{ "1":"Entp", "2":"AllergenClass", "3":"Emp" } }, "allergenCodes":{ "type":"string", "description":"Allergen codes listed as comma-separated values for an Allergen Class.", "example":"Milk,Eggs,Fish" } } }, "LocationParams_taiwanGUIParameters":{ "type":"object", "required":[ "endOfRangeThreshold" ], "description":"An object containing the Taiwan tax number prefix and the end of range tax threshold", "properties":{ "taxNumPrefix":{ "type":"string", "description":"The Taiwan tax number prefix. Maximum string length allowed is 2.", "example":"TU" }, "endOfRangeThreshold":{ "type":"string", "description":"The end of range tax threshold.", "example":"A23" } } }, "LocationParams_serialNumberInfo":{ "type":"object", "required":[ "minSerialNum1", "maxSerialNum1", "minSerialNum2", "maxSerialNum2" ], "description":"An object containing the details of the system serial numbers", "properties":{ "minSerialNum1":{ "type":"integer", "example":1, "description":"The minimum value for system serial #1 (1 to 99998)." }, "maxSerialNum1":{ "type":"integer", "example":"maxSerialNum1", "description":"The maximum value for system serial #1 (2 to 99999)." }, "minSerialNum2":{ "type":"integer", "example":1, "description":"The minimum value for system serial #2 (1 to 99998)." }, "maxSerialNum2":{ "type":"integer", "example":99999, "description":"The maximum value for system serial #2 (2 to 99999)." } } }, "LocationParams_language":{ "type":"object", "description":"An array of languages that are available at the property.", "properties":{ "languageNum":{ "type":"integer", "example":1, "description":"The index of the language configured." }, "languageObjNum":{ "type":"integer", "example":1, "description":"Object number of the language." }, "languageName":{ "type":"string", "example":"English", "description":"The name of the language." } } }, "LocationParams_languageV2":{ "type":"object", "description":"An array of languages that are available at the property.", "properties":{ "languageNum":{ "type":"integer", "example":1, "description":"The index of the language configured." }, "languageObjNum":{ "type":"integer", "example":1, "description":"Object number of the language." }, "langId":{ "type":"integer", "example":45, "description":"Unique ID of the Language." } } }, "LocationParams_languageV2CUD":{ "type":"object", "description":"An array of languages that are available at the property.", "properties":{ "languageNum":{ "type":"integer", "example":1, "description":"The index of the language configured." }, "languageObjNum":{ "type":"integer", "example":1, "description":"Object number of the language." } } }, "LocationParams_primarySMTPServer":{ "type":"object", "description":"An object containing the primary SMTP server settings of the location.", "properties":{ "server":{ "type":"string", "example":"smtp.mail.com", "description":"URL of the email server or service." }, "port":{ "type":"integer", "example":587, "description":"The port number for the SMTP email server. A default port of 587 works for most SMTP servers." }, "isSSL":{ "type":"boolean", "example":false, "description":"A require secure Internet communication." }, "username":{ "type":"string", "example":"test", "description":"The user name of the email address that sends receipts." }, "password":{ "type":"string", "example":"aaddsfgf@34", "description":"The password associated with the email user name." }, "sourceEmail":{ "type":"string", "example":"admin@oracle.com", "description":"The full email address to appear as the sender in the emailed receipt." }, "name":{ "type":"string", "example":"Admin", "description":"The business name or name to appear along with the email in the sender field." }, "bccList":{ "type":"string", "example":"admin2@oracle.com; admin3@oracle.com", "description":"The email addresses to receive a blind carbon copy of the email receipt that is sent to the guest." } } }, "LocationParams_backupSMTPServer":{ "type":"object", "description":"An object containing the backup SMTP server details for email configuration of the property.", "properties":{ "server":{ "type":"string", "example":"smtp.mail.com", "description":"URL of the email server or service." }, "port":{ "type":"integer", "example":587, "description":"The port number for the SMTP email server. A default port of 587 works for most SMTP servers." }, "isSSL":{ "type":"boolean", "example":false, "description":"A require secure Internet communication." }, "username":{ "type":"string", "example":"test", "description":"The user name of the email address that sends receipts." }, "password":{ "type":"string", "example":"aaddsfgf@34", "description":"The password associated with the email user name." }, "sourceEmail":{ "type":"string", "example":"admin@oracle.com", "description":"The full email address to appear as the sender in the emailed receipt." }, "name":{ "type":"string", "example":"Admin", "description":"The business name or name to appear along with the email in the sender field." } } }, "LocationParams_textFormatting":{ "type":"object", "description":"An object containing the text formatting settings of the email configuration of the location.", "properties":{ "emailSubject":{ "type":"string", "example":"Subject", "description":"Text in rich text format to appear as the subject line of email receipts." }, "emailBody":{ "type":"string", "example":"Email Body", "description":"Text in rich text format to appear as the body of email receipts." } } }, "LocationParams_htmlFormatting":{ "type":"object", "description":"An object containing the text formatting settings of the email configuration of the location.", "properties":{ "emailSubject":{ "type":"string", "example":"Subject", "description":"Text in rich text format to appear as the subject line of email receipts." }, "emailBody":{ "type":"string", "example":"HTML Email Body", "description":"Text in rich text format to appear as the body of email receipts." } } }, "LocationParams_emailConfiguration":{ "type":"object", "description":"An object containing the email configuration for the location", "properties":{ "sendHTMLEmail":{ "type":"boolean", "example":false, "description":"A flag indicating if the mail format is in HTML." }, "primarySMTPServer":{ "$ref":"#/definitions/LocationParams_primarySMTPServer" }, "backupSMTPServer":{ "$ref":"#/definitions/LocationParams_backupSMTPServer" }, "textFormatting":{ "$ref":"#/definitions/LocationParams_textFormatting" }, "htmlFormatting":{ "$ref":"#/definitions/LocationParams_htmlFormatting" } } }, "LocationParams_optionsExt":{ "type":"object", "description":"An object containing the descriptive options list associated with the location parameter.", "properties":{ "useDDMMYYYYFormat":{ "type":"boolean", "example":false, "description":"A print and show dates with the day first." }, "use24HourClock":{ "type":"boolean", "example":false, "description":"A print and show time in 24-hour format" }, "showItemWeightInKilos":{ "type":"boolean", "example":false, "description":"A print and show the weight of weighed menu items in kilograms." }, "dontCheckMacroLoopLimit":{ "type":"boolean", "example":false, "description":"A disable the limit of 20 consecutive macro iterations." }, "acceptGenericEmployeeIDCard":{ "type":"boolean", "example":false, "description":"A flag indicating if the site uses its own employee ID cards." }, "itemDiscountsNetSubTotalDiscountItemizers":{ "type":"boolean", "example":false, "description":"A post the subtotal discount against the total amount of the itemizer, regardless of item discounts." }, "sendCashierNumberInsteadOfOperatorNumber":{ "type":"boolean", "example":false, "description":"A store the cashier number in the Credit Card Batch, rather than the operator number." }, "hrgasPMSCompatability":{ "type":"boolean", "example":false, "description":"A void tenders on a check that have been posted to the PMS when the check is reopened and the first tender is voided." }, "postNonTaxableSlaesTotalsNetOfDiscounts":{ "type":"boolean", "example":false, "description":"A include discounts in calculating the non-taxable sales total that appears on System Tax Reports." }, "eybs":{ "type":"boolean", "example":false, "description":"A create a separate log to track database changes made for Weights and Measures." }, "enableSeatNumberInJournal":{ "type":"boolean", "example":false, "description":"A include the seat number on the journal output." }, "enableEUROCurrencySystem":{ "type":"boolean", "example":false, "description":"A make the Euro functionality and all requirements available in the system." }, "euroIsBaseCurrency":{ "type":"boolean", "example":false, "description":"make the Euro dollar the base currency for the system" }, "issueChangeInNationalCurrency":{ "type":"boolean", "example":false, "description":"issue change in the national currency." }, "printAltSummaryTotalsBeforeBase":{ "type":"boolean", "example":false, "description":"A reverse the print order of the Base and Alternate Summary Totals sections on Euro checks and receipts." }, "printSimplifiedAltSummaryTotals":{ "type":"boolean", "example":false, "description":"A reduce the Alternate Summary Totals section to the section header and a single Amount Due/Payment." }, "euroCurrencyConversionReportingFeature":{ "type":"boolean", "example":false, "description":"A print change due on the customer receipt in both the local and Euro currency." }, "postVoidsToLDS":{ "type":"boolean", "example":false, "description":"send negative postings to the Oracle suspense file and to the LDS" }, "extendedEventDate":{ "type":"boolean", "example":false, "description":"send extra summary details to the VSS interface." }, "disableDSTOnKDSDisplayControllers":{ "type":"boolean", "example":false, "description":"disable Daylight Saving Time on KDS Controllers. Deselect to synchronize Daylight Saving Time settings between the CAL Server and KDS Controllers in the property." }, "enableSalesRecordingModule":{ "type":"boolean", "example":false, "description":"A flag indicating for Quebec sites required to use a Sales Recording Module (SRM) device." }, "showItemWeightInOunces":{ "type":"boolean", "example":false, "description":"print and show the weight of weighed menu items in ounces" }, "doNotShowtareWeight":{ "type":"boolean", "example":false, "description":"prevent tare weight from appearing on the POS client, checks, and receipts." }, "enableClockInRequirementForAuthorization":{ "type":"boolean", "example":false, "description":"require that employees clock-in to authorize workstation actions." }, "disableP2PCheckSharingWhenCAPSUnavailable":{ "type":"boolean", "example":false, "description":"A prevent checks from passing between workstations when the Check and Posting service is unavailable." }, "runSODFromOPS":{ "type":"boolean", "example":false, "description":"allow a user to run Start of Day from the POS client" }, "printSODValidationChit":{ "type":"boolean", "example":false, "description":"print a validation chit when the user runs Start of Day from the POS client." }, "doNotShowNegativeTareWeight":{ "type":"boolean", "example":false, "description":"A remove negative tare weights from the POS client, checks, and receipts." }, "enableEventsReporting":{ "type":"boolean", "example":false, "description":"A associate transactions with events and to use event reporting." }, "enableNoDefaultAreaSelectedOption":{ "type":"boolean", "example":false, "description":"A allow a privileged workstation operator to select No default area selected, rather than a default area." }, "enableWorkstationAlerting":{ "type":"boolean", "example":false, "description":"A enable generation of alerts that will be displayed on workstations within the property." } } }, "LocationParams_postingOptionsExt":{ "type":"object", "description":"An object containing the descriptive options list associated with the location parameter.", "properties":{ "postSalesNetOfVAT":{ "type":"boolean", "example":false, "description":"A post menu items, discounts, and service charges net of VAT." }, "postFoodCostTotalsNetOfItemDiscounts":{ "type":"boolean", "example":false, "description":"A post food cost totals net of item discounts." }, "isSynchronousConnectionForClockInOutPunch":{ "type":"boolean", "example":false, "description":"A allow Clock In/ Out to communicate with Labor Management instantly, instead of scheduled requests." }, "hostFinancialReportFormat":{ "type":"boolean", "example":false, "description":"A flag indicating for systems installed at Host sites" }, "postOfflineTransactionsWithActualTransactionTime":{ "type":"boolean", "example":false, "description":"A post Offline checks to the database with the actual time stamp of the transaction." } } }, "LocationParams_workstationOptions":{ "type":"object", "description":"An object containing the workstation options associated with the location", "properties":{ "dbUpdateFrequencyInSecs":{ "description":"The number of seconds the workstation and KDS Controllers wait to retrieve updates from the database.", "type":"integer", "example":1800 }, "linesPerWSReportPage":{ "description":"The number of lines to print per page on workstation reports.", "type":"integer", "example":0 }, "defaultTransactionHelpScreenObjNum":{ "description":"Object number of the Help Screen to show when the Help key is pressed on workstations.", "type":"integer", "example":0 }, "defaultTransactionHelpScreenName":{ "type":"object", "description":"Default Transaction Help Screen Name.", "example":{ "en-US":"Help Screen", "de-DE":"Hilfebildschirm", "es-MX":"Pantalla de ayuda" } }, "onDemandReplayFrequencyCheck":{ "description":"The number of seconds for workstations to wait before checking for initiation of an on demand replay.", "type":"integer", "example":0 } } }, "LocationParams_workstationOptionsv2":{ "type":"object", "description":"An object containing the workstation options associated with the location", "properties":{ "dbUpdateFrequencyInSecs":{ "description":"The number of seconds the workstation and KDS Controllers wait to retrieve updates from the database.", "type":"integer", "example":1800 }, "linesPerWSReportPage":{ "description":"The number of lines to print per page on workstation reports.", "type":"integer", "example":0 }, "defaultTransactionHelpScreenObjNum":{ "description":"Object number of the Help Screen to show when the Help key is pressed on workstations.", "type":"integer", "example":0 }, "onDemandReplayFrequencyCheck":{ "description":"The number of seconds for workstations to wait before checking for initiation of an on demand replay.", "type":"integer", "example":0 } } }, "LocationParams_serviceHosts":{ "type":"object", "properties":{ "serviceID":{ "description":"Unique ID of the service host.", "type":"integer", "example":4715 }, "type":{ "description":"Type of the service host", "type":"string", "example":"Check and Posting" }, "serviceHostObjNum":{ "description":"Object number of the service host associated with the location", "type":"integer", "example":4715 }, "serviceHostName":{ "description":"Service Host Name.", "type":"object", "example":{ "en-US":"Service Host", "de-DE":"Service-Host", "es-MX":"Anfitri??n del servicio" } }, "port":{ "description":"Port of the service host associated with the location.", "type":"integer", "example":8080 }, "url":{ "description":"URL of the service host associated with the location", "type":"string", "example":"egateway/egateway.asmx" } } }, "LocationParams_serviceHostsv2":{ "type":"object", "properties":{ "serviceID":{ "description":"Unique ID of the service host.", "type":"integer", "example":4715 }, "type":{ "description":"Type of the service host", "type":"string", "example":"Check and Posting" }, "serviceHostObjNum":{ "description":"Object number of the service host associated with the location", "type":"integer", "example":4715 }, "port":{ "description":"Port of the service host associated with the location.", "type":"integer", "example":8080 }, "url":{ "description":"URL of the service host associated with the location", "type":"string", "example":"egateway/egateway.asmx" } } }, "LocationParams_timekeeping":{ "type":"object", "description":"An object containing the timekeeping configuration for the location", "required":[ "enableLaborManagement" ], "properties":{ "enableLaborManagement":{ "type":"boolean", "example":false, "description":"A use Labor Management for employee configuration." }, "propertyLaborManagementURL":{ "type":"string", "example":"myLabor.orcle.com", "description":"The URL if workstations use an external address when connecting to the Simphony Labor web service." }, "printWTDTotalsInClockInOutChits":{ "type":"boolean", "example":false, "description":"A print week-to-date total hours worked by employees on clock-in/out chits." }, "printAccumulatedLaborShiftTotalsInClockInOutChits":{ "type":"boolean", "example":false, "description":"A print a single labor shift total hours worked by employees on clock-in/out chits." } } }, "LocationParams_startOfDaySettings":{ "type":"object", "properties":{ "dayOfWeek":{ "type":"integer", "example":1, "description":"A number representing the day of the week" }, "time":{ "type":"string", "example":"03:00", "description":"The start time of the start of day for given day of the week." }, "pcAutoSequenceObjNum":{ "type":"integer", "example":0, "description":"Object number of the PC Autosequence to run immediately after the given business day begins." }, "pcAutoSequenceName":{ "description":"Name of the PC Autosequence to run immediately after the given business day begins", "type":"object", "example":{ "en-US":"Sequence", "de-DE":"Reihenfolge", "es-MX":"Secuencia" } }, "runManually":{ "type":"boolean", "example":false, "description":"A manually run the start of day for this business date." } } }, "LocationParams_startOfDaySettingsv2":{ "type":"object", "properties":{ "dayOfWeek":{ "type":"integer", "example":1, "description":"A number representing the day of the week" }, "time":{ "type":"string", "example":"03:00", "description":"The start time of the start of day for given day of the week." }, "pcAutoSequenceObjNum":{ "type":"integer", "example":0, "description":"Object number of the PC Autosequence to run immediately after the given business day begins." }, "runManually":{ "type":"boolean", "example":false, "description":"A manually run the start of day for this business date." } } }, "LocationParameters_AlternateDates":{ "type":"object", "properties":{ "number":{ "type":"integer", "example":1, "description":"Sequence number of the date of the start of month" }, "date":{ "type":"string", "example":"12/01/2021", "description":"Date of the start of month" } } }, "LocationParams_startOfPeriodSettings":{ "type":"object", "description":"An object containing the start of period settings for the location", "properties":{ "startOfWeek":{ "type":"integer", "example":1, "description":"The day of the week that represents the start of the business week." }, "sOWPCAutoSeqObjNum":{ "type":"integer", "example":1, "description":"Object number of the PC autosequence of start of week." }, "sOWPCAutoSeqName":{ "description":"Name of the PC autosequence of start of week", "type":"object", "example":{ "en-US":"Sequence", "de-DE":"Reihenfolge", "es-MX":"Secuencia" } }, "startOfMonth":{ "type":"integer", "example":1, "description":"The day of the month that represents the start of the business month." }, "sOMPCAutoSeqObjNum":{ "type":"integer", "example":1, "description":"Object number of the PC autosequence of start of month." }, "sOMPCAutoSeqName":{ "description":"Name of the PC autosequence of start of month.", "type":"object", "example":{ "en-US":"Sequence", "de-DE":"Reihenfolge", "es-MX":"Secuencia" } }, "useSOMAlternateDates":{ "type":"boolean", "example":false, "description":"A use user-defined dates for this period, instead of standard calendar periods" }, "sOMAlternateDates":{ "type":"array", "description":"An array of alternate dates for the start of month.", "items":{ "$ref":"#/definitions/LocationParameters_AlternateDates" } }, "startOfQuarter":{ "type":"string", "example":"1/4 , 4/1, 7/1, 10/1", "description":"A string representing the start dates for the quarter in MM/DD format" }, "sOQPCAutoSeqObjNum":{ "type":"integer", "example":1, "description":"Object number of the PC autosequence of start of quarter." }, "sOQPCAutoSeqName":{ "description":"Name of the PC autosequence of start of quarter.", "type":"object", "example":{ "en-US":"Sequence", "de-DE":"Reihenfolge", "es-MX":"Secuencia" } }, "useSOQAlternateDates":{ "type":"boolean", "example":false, "description":"A use user-defined dates for this period, instead of standard calendar periods." }, "sOQAlternateDates":{ "type":"array", "description":"An array of alternate dates for the start of quarter. Applicable only if useSOQAlternateDates = true", "items":{ "$ref":"#/definitions/LocationParameters_AlternateDates" } }, "startOfYear":{ "type":"integer", "example":1, "description":"Month for the start of the year" }, "sOYPCAutoSeqObjNum":{ "type":"integer", "example":1, "description":"Object number of the PC autosequence of start of year." }, "sOYPCAutoSeqName":{ "description":"Name of the PC autosequence of start of year.", "type":"object", "example":{ "en-US":"Sequence", "de-DE":"Reihenfolge", "es-MX":"Secuencia" } }, "sOYAlternateDates":{ "type":"array", "description":"An array of dates for the start of year", "items":{ "$ref":"#/definitions/LocationParameters_AlternateDates" } }, "startOfPayPeriod":{ "type":"string", "example":"BiWeekly", "description":"String representing the start of pay period" }, "sOPPCAutoSeqObjNum":{ "type":"integer", "example":1, "description":"Object number of the PC autosequence of start of period." }, "sOPPCAutoSeqName":{ "description":"Name of the PC autosequence of start of period.", "type":"object", "example":{ "en-US":"Sequence", "de-DE":"Reihenfolge", "es-MX":"Secuencia" } }, "otherPeriod1":{ "type":"array", "description":"An array of dates for the Other Period 1.", "items":{ "$ref":"#/definitions/LocationParameters_AlternateDates" } }, "otherPeriod1PCAutoSeqObjNum":{ "type":"integer", "example":1, "description":"Object number of the PC autosequence of Other Totals period 1." }, "otherPeriod1PCAutoSeqName":{ "description":"Name of the PC autosequence of the Other Totals period 1.", "type":"object", "example":{ "en-US":"Sequence", "de-DE":"Reihenfolge", "es-MX":"Secuencia" } }, "otherPeriod2":{ "type":"array", "description":"An array of dates for the Other Period 2.", "items":{ "$ref":"#/definitions/LocationParameters_AlternateDates" } }, "otherPeriod2PCAutoSeqObjNum":{ "type":"integer", "example":1, "description":"Object number of the PC autosequence of Other Totals period 2." }, "otherPeriod2PCAutoSeqName":{ "description":"Name of the PC autosequence of the Other Totals period 2.", "type":"object", "example":{ "en-US":"Sequence", "de-DE":"Reihenfolge", "es-MX":"Secuencia" } }, "otherPeriod3":{ "type":"array", "description":"An array of dates for the Other Period 3.", "items":{ "$ref":"#/definitions/LocationParameters_AlternateDates" } }, "otherPeriod3PCAutoSeqObjNum":{ "type":"integer", "example":1, "description":"Object number of the PC autosequence of Other Totals period 3." }, "otherPeriod3PCAutoSeqName":{ "description":"Name of the PC autosequence of the Other Totals period 3.", "type":"object", "example":{ "en-US":"Sequence", "de-DE":"Reihenfolge", "es-MX":"Secuencia" } } } }, "LocationParams_startOfPeriodSettingsv2":{ "type":"object", "description":"An object containing the start of period settings for the location", "properties":{ "startOfWeek":{ "type":"integer", "example":1, "description":"The day of the week that represents the start of the business week." }, "sOWPCAutoSeqObjNum":{ "type":"integer", "example":1, "description":"Object number of the PC autosequence of start of week." }, "startOfMonth":{ "type":"integer", "example":1, "description":"The day of the month that represents the start of the business month." }, "sOMPCAutoSeqObjNum":{ "type":"integer", "example":1, "description":"Object number of the PC autosequence of start of month." }, "useSOMAlternateDates":{ "type":"boolean", "example":false, "description":"A use user-defined dates for this period, instead of standard calendar periods" }, "sOMAlternateDates":{ "type":"array", "description":"An array of alternate dates for the start of month.", "items":{ "$ref":"#/definitions/LocationParameters_AlternateDates" } }, "startOfQuarter":{ "type":"string", "example":"1/4 , 4/1, 7/1, 10/1", "description":"A string representing the start dates for the quarter in MM/DD format" }, "sOQPCAutoSeqObjNum":{ "type":"integer", "example":1, "description":"Object number of the PC autosequence of start of quarter." }, "useSOQAlternateDates":{ "type":"boolean", "example":false, "description":"A use user-defined dates for this period, instead of standard calendar periods." }, "sOQAlternateDates":{ "type":"array", "description":"An array of alternate dates for the start of quarter. Applicable only if useSOQAlternateDates = true", "items":{ "$ref":"#/definitions/LocationParameters_AlternateDates" } }, "startOfYear":{ "type":"integer", "example":1, "description":"Month for the start of the year" }, "sOYPCAutoSeqObjNum":{ "type":"integer", "example":1, "description":"Object number of the PC autosequence of start of year." }, "sOYAlternateDates":{ "type":"array", "description":"An array of dates for the start of year", "items":{ "$ref":"#/definitions/LocationParameters_AlternateDates" } }, "startOfPayPeriod":{ "type":"string", "example":"BiWeekly", "description":"String representing the start of pay period" }, "sOPPCAutoSeqObjNum":{ "type":"integer", "example":1, "description":"Object number of the PC autosequence of start of period." }, "otherPeriod1":{ "type":"array", "description":"An array of dates for the Other Period 1.", "items":{ "$ref":"#/definitions/LocationParameters_AlternateDates" } }, "otherPeriod1PCAutoSeqObjNum":{ "type":"integer", "example":1, "description":"Object number of the PC autosequence of Other Totals period 1." }, "otherPeriod2":{ "type":"array", "description":"An array of dates for the Other Period 2.", "items":{ "$ref":"#/definitions/LocationParameters_AlternateDates" } }, "otherPeriod2PCAutoSeqObjNum":{ "type":"integer", "example":1, "description":"Object number of the PC autosequence of Other Totals period 2." }, "otherPeriod3":{ "type":"array", "description":"An array of dates for the Other Period 3.", "items":{ "$ref":"#/definitions/LocationParameters_AlternateDates" } }, "otherPeriod3PCAutoSeqObjNum":{ "type":"integer", "example":1, "description":"Object number of the PC autosequence of Other Totals period 3." } } }, "LocationParams_calendar":{ "type":"object", "description":"An object containing the calendar settings for the location", "required":[ "startOfDaySettings", "startOfPeriodSettings" ], "properties":{ "currentBusinessDate":{ "type":"string", "example":"12/20/21", "description":"Current business date of the location" }, "startedAt":{ "type":"string", "example":"12/20/21 03:00:00 AM", "description":"Time at which the current business date started at the location." }, "startOfDaySettings":{ "type":"array", "description":"An array of the start of day settings for the business week.", "items":{ "$ref":"#/definitions/LocationParams_startOfDaySettings" } }, "manualSODSafetyCatchTime":{ "description":"the time the application automatically increments the business date if manually SOD is not run.", "type":"string", "example":"00:00" }, "startOfPeriodSettings":{ "$ref":"#/definitions/LocationParams_startOfPeriodSettings" } } }, "LocationParams_calendarv2":{ "type":"object", "description":"An object containing the calendar settings for the location", "required":[ "startOfDaySettings", "startOfPeriodSettings" ], "properties":{ "currentBusinessDate":{ "type":"string", "example":"12/20/21", "description":"Current business date of the location" }, "startedAt":{ "type":"string", "example":"12/20/21 03:00:00 AM", "description":"Time at which the current business date started at the location." }, "startOfDaySettings":{ "type":"array", "description":"An array of the start of day settings for the business week.", "items":{ "$ref":"#/definitions/LocationParams_startOfDaySettingsv2" } }, "manualSODSafetyCatchTime":{ "description":"the time the application automatically increments the business date if manually SOD is not run.", "type":"string", "example":"00:00" }, "startOfPeriodSettings":{ "$ref":"#/definitions/LocationParams_startOfPeriodSettingsv2" } } }, "LocationParams_security":{ "type":"object", "description":"An object containing the attributes of the credentials of the system", "properties":{ "installSecurityUser":{ "type":"string", "example":"user", "description":"Install Security Username for the property's workstations." }, "installSecurityUserPasswordCompliance":{ "type":"string", "example":"Compliance Not Met", "description":"the current Install Security Password compliance status." }, "installSecurityUserPassword":{ "type":"string", "example":"cfsdf@343%", "description":"Install Security password for the property's workstations." }, "adminUser":{ "type":"string", "example":"user", "description":"Admin Username for the property's workstations. Changes take effect when the workstations are restarted." }, "adminUserPasswordCompliance":{ "type":"string", "example":"Compliance Not Met", "description":"The current Admin User Password compliance status." }, "adminUserPassword":{ "type":"string", "example":"cfsdf@343%", "description":"The admin password for the property's workstations. Changes take effect when the workstations are restarted" }, "dbUser":{ "type":"string", "example":"user", "description":"The Database Username for the property's workstations." }, "dbUserPasswordCompliance":{ "type":"string", "example":"Compliance Not Met", "description":"The current Database User Password compliance status." }, "dbUserPassword":{ "type":"string", "example":"cfsdf@343%", "description":"The Database Password for the property's workstations." } } }, "LocationParams_simphonyEssentials":{ "type":"object", "description":"Object containing the configuration settings for Simphony Essentials enabled organization", "properties":{ "fiscalLocationNum":{ "type":"integer", "example":1, "description":"Select the Fiscal Location for this Property." }, "fiscalLocationName":{ "type":"string", "example":"Mexico", "description":"Name of the Country associated with the Fiscal location." } } }, "LocationParametersCUDRequestBody":{ "type":"object", "required":[ "hierUnitId", "taiwanGUIParameters", "timekeeping", "calendar", "serialNumberInfo" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the location", "type":"integer", "example":1 }, "numDaystoSaveCABatchFiles":{ "description":"The number of days to retain Credit Authorization batch files and log files. Value must lie between 1 and 999 (both inclusive).", "type":"integer", "example":1 }, "ldsNLUGroup":{ "description":"The number of the Menu Item NLU Group to be used by menu items posted by the LDS", "type":"integer", "example":0 }, "taiwanGUIParameters":{ "$ref":"#/definitions/LocationParams_taiwanGUIParameters" }, "serialNumberInfo":{ "$ref":"#/definitions/LocationParams_serialNumberInfo" }, "language":{ "$ref":"#/definitions/LocationParams_language" }, "secondaryPrintLanguageObjNum":{ "description":"Object number of the language to print under the Default Language on a guest check or customer receipt", "type":"integer", "example":0 }, "secondaryPrintLanguageName":{ "description":"Name of the language to print under the Default Language on a guest check or customer receipt.", "type":"string", "example":"English" }, "wlsStrengthOfflineThreshold":{ "description":"The percentage amount to be used to determine if communications should be suspended for wireless workstations, until network signal strength is improved.", "type":"number", "example":0 }, "wlsStrengthReconnectThreshold":{ "description":"the percentage amount of signal strength to be used to determine at which point the system attempts to reconnect wireless workstations to the network.", "type":"number", "example":0 }, "emailConfiguration":{ "$ref":"#/definitions/LocationParams_emailConfiguration" }, "options":{ "description":"A string value of 0s & 1s of length 96 reprsenting options for location parameters.", "type":"string", "example":"000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" }, "optionsExt":{ "$ref":"#/definitions/LocationParams_optionsExt" }, "postingOptions":{ "description":"A string value of 0s & 1s of length 8 reprsenting posting options for location parameters.", "type":"string", "example":"00000000" }, "postingOptionsExt":{ "$ref":"#/definitions/LocationParams_postingOptionsExt" }, "workstationOptions":{ "$ref":"#/definitions/LocationParams_workstationOptions" }, "serviceHosts":{ "type":"array", "description":"An array of service hosts associated with the location.", "items":{ "$ref":"#/definitions/LocationParams_serviceHosts" } }, "timekeeping":{ "$ref":"#/definitions/LocationParams_timekeeping" }, "calendar":{ "$ref":"#/definitions/LocationParams_calendar" }, "security":{ "$ref":"#/definitions/LocationParams_security" }, "simphonyEssentials":{ "$ref":"#/definitions/LocationParams_simphonyEssentials" }, "reportingOrgId":{ "description":"the ID of the organization to which this property belongs in the reporting databases", "type":"integer", "example":11866 }, "reportingLanguageObjNum":{ "description":"The object number of the language to use when posting data to Reporting and Analytics.", "type":"integer", "example":1 }, "reportingLanguage":{ "description":"The name of the language to use when posting data to Reporting and Analytics.", "type":"string", "example":"English" } } }, "LocationParameters":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the location", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the location", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the location configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "numDaystoSaveCABatchFiles":{ "description":"The number of days to retain Credit Authorization batch files and log files.", "type":"integer", "example":0 }, "ldsNLUGroup":{ "description":"The number of the Menu Item NLU Group to be used by menu items posted by the LDS", "type":"integer", "example":0 }, "taiwanGUIParameters":{ "$ref":"#/definitions/LocationParams_taiwanGUIParameters" }, "serialNumberInfo":{ "$ref":"#/definitions/LocationParams_serialNumberInfo" }, "language":{ "type":"array", "items":{ "$ref":"#/definitions/LocationParams_language" } }, "secondaryPrintLanguageObjNum":{ "description":"Object number of the language to print under the Default Language on a guest check or customer receipt", "type":"integer", "example":0 }, "secondaryPrintLanguageName":{ "description":"Name of the language to print under the Default Language on a guest check or customer receipt.", "type":"string", "example":"English" }, "wlsStrengthOfflineThreshold":{ "description":"The percentage amount to be used to determine if communications should be suspended for wireless workstations, until network signal strength is improved.", "type":"number", "example":0 }, "wlsStrengthReconnectThreshold":{ "description":"the percentage amount of signal strength to be used to determine at which point the system attempts to reconnect wireless workstations to the network.", "type":"number", "example":0 }, "emailConfiguration":{ "$ref":"#/definitions/LocationParams_emailConfiguration" }, "options":{ "description":"A string value of 0s & 1s of length 96 reprsenting options for location parameters.", "type":"string", "example":"000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" }, "optionsExt":{ "$ref":"#/definitions/LocationParams_optionsExt" }, "postingOptions":{ "description":"A string value of 0s & 1s of length 8 reprsenting posting options for location parameters.", "type":"string", "example":"00000000" }, "postingOptionsExt":{ "$ref":"#/definitions/LocationParams_postingOptionsExt" }, "workstationOptions":{ "$ref":"#/definitions/LocationParams_workstationOptions" }, "serviceHosts":{ "type":"array", "description":"An array of service hosts associated with the location.", "items":{ "$ref":"#/definitions/LocationParams_serviceHosts" } }, "timekeeping":{ "$ref":"#/definitions/LocationParams_timekeeping" }, "calendar":{ "$ref":"#/definitions/LocationParams_calendar" }, "security":{ "$ref":"#/definitions/LocationParams_security" }, "simphonyEssentials":{ "$ref":"#/definitions/LocationParams_simphonyEssentials" }, "reportingOrgId":{ "description":"the ID of the organization to which this property belongs in the reporting databases", "type":"integer", "example":11866 }, "reportingLanguageObjNum":{ "description":"The object number of the language to use when posting data to Reporting and Analytics.", "type":"integer", "example":1 }, "reportingLanguage":{ "description":"The name of the language to use when posting data to Reporting and Analytics.", "type":"string", "example":"English" } } }, "LocationParametersv2":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the location", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the location", "type":"integer", "example":1 }, "numDaystoSaveCABatchFiles":{ "description":"The number of days to retain Credit Authorization batch files and log files.", "type":"integer", "example":0 }, "ldsNLUGroup":{ "description":"The number of the Menu Item NLU Group to be used by menu items posted by the LDS", "type":"integer", "example":0 }, "taiwanGUIParameters":{ "$ref":"#/definitions/LocationParams_taiwanGUIParameters" }, "serialNumberInfo":{ "$ref":"#/definitions/LocationParams_serialNumberInfo" }, "language":{ "type":"array", "items":{ "$ref":"#/definitions/LocationParams_languageV2" } }, "secondaryPrintLanguageObjNum":{ "description":"Object number of the language to print under the Default Language on a guest check or customer receipt", "type":"integer", "example":0 }, "secondaryPrintLanguageName":{ "description":"Name of the language to print under the Default Language on a guest check or customer receipt.", "type":"string", "example":"English" }, "wlsStrengthOfflineThreshold":{ "description":"The percentage amount to be used to determine if communications should be suspended for wireless workstations, until network signal strength is improved.", "type":"number", "example":0 }, "wlsStrengthReconnectThreshold":{ "description":"the percentage amount of signal strength to be used to determine at which point the system attempts to reconnect wireless workstations to the network.", "type":"number", "example":0 }, "emailConfiguration":{ "$ref":"#/definitions/LocationParams_emailConfiguration" }, "options":{ "description":"A string value of 0s & 1s of length 96 reprsenting options for location parameters.", "type":"string", "example":"000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" }, "optionsExt":{ "$ref":"#/definitions/LocationParams_optionsExt" }, "postingOptions":{ "description":"A string value of 0s & 1s of length 8 reprsenting posting options for location parameters.", "type":"string", "example":"00000000" }, "postingOptionsExt":{ "$ref":"#/definitions/LocationParams_postingOptionsExt" }, "workstationOptions":{ "$ref":"#/definitions/LocationParams_workstationOptionsv2" }, "serviceHosts":{ "type":"array", "description":"An array of service hosts associated with the location.", "items":{ "$ref":"#/definitions/LocationParams_serviceHostsv2" } }, "timekeeping":{ "$ref":"#/definitions/LocationParams_timekeeping" }, "calendar":{ "$ref":"#/definitions/LocationParams_calendarv2" }, "security":{ "$ref":"#/definitions/LocationParams_security" }, "simphonyEssentials":{ "$ref":"#/definitions/LocationParams_simphonyEssentials" }, "reportingOrgId":{ "description":"the ID of the organization to which this property belongs in the reporting databases", "type":"integer", "example":11866 }, "reportingLanguageObjNum":{ "description":"The object number of the language to use when posting data to Reporting and Analytics.", "type":"integer", "example":1 }, "reportingLanguage":{ "description":"The name of the language to use when posting data to Reporting and Analytics.", "type":"string", "example":"English" } } }, "LocationParametersGetRequestBodyv1":{ "type":"object", "required":[ "hierUnitId" ], "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." }, "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." } } }, "LocationParametersGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Location Parameters objects of the organization.", "items":{ "$ref":"#/definitions/LocationParameters" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "LocationParametersResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." } } }, "DiscountResponse":{ "type":"object", "properties":{ "effGrpObjNum":{ "description":"ObjectNumber of Effectivity Group", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the Discount.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique Hierarchy Unit Value", "type":"integer", "example":1 } } }, "DiscountCURequestBody":{ "description":"Model for Discount Object", "type":"object", "required":[ "hierUnitId", "objectNum", "name", "options" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Discount", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Discounts in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "effGrpObjNum":{ "description":"Object number of the Effectivity Group for the current record", "type":"integer", "example":1 }, "consumerDisplayname":{ "description":"A group of string objects representing the name of the Discounts in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "activationType":{ "description":"Type of Discount ; 0 - Manual (Manually Entered and applied);1 - Automatic (Automatically applied and operator cannot enter);2 - Coupon (Automatically applied, operator must enter)", "type":"integer", "example":1 }, "percent":{ "description":"Percentage for the manual discount. Value must lie between 0 and 1.", "type":"integer", "example":1 }, "minAmount":{ "description":"Minimum menu item subtotal amount", "type":"integer", "example":1 }, "maxAmount":{ "description":"Maximum amount allowed for an open-priced or amount discount", "type":"integer", "example":1 }, "taxClassObjNum":{ "description":"Tax Class to be Discounted", "type":"integer", "example":1 }, "privilegeGroup":{ "description":"Privilege Group number to restrict the use of the discount", "type":"integer", "example":1 }, "condimentDiscountability":{ "description":"Determine how condiment menu items are discounted;0 - Use Menu Item ClassOption;1 - Parent Items only;2 - Condiment Items only;3 - Parent and Highlighted Condiment Items;4 - Parent and all Condiment Items;5 - Single Condiment", "type":"integer", "example":1 }, "reportGroupObjnum":{ "description":"Report Group to associate with the discount.", "type":"integer", "example":1 }, "printClassObjNum":{ "description":"Print Class for the Discount", "type":"integer", "example":1 }, "enabled":{ "description":"A Boolean flag indicating to enabling the Discount", "type":"boolean", "example":false }, "triggerMIGrpObjNum":{ "description":"Menu Item Group that triggers the discount.", "type":"integer", "example":1 }, "triggerCondimentGrpObjNum":{ "description":"Condiment Menu Item Group to use as the trigger for the discount.", "type":"integer", "example":1 }, "options":{ "description":"A String of Values of 0s and 1s of length 56 representing the enablement or disablement of the options associated with Discounts", "type":"string", "example":"00000000000000000000000000000000000000000000000000000000" }, "effectivity":{ "description":"An object representing the effective dates for the record", "type":"object", "properties":{ "startDateTime":{ "description":"The effective start date for the record.", "type":"string", "example":"2021-09-22T00:00:00" }, "endDateTime":{ "description":"Enter the effective end date for the record", "type":"string", "example":"2022-09-21T23:59:59" }, "activeStartTime":{ "description":"Enter the effective start time for the record", "type":"string", "example":"09:00" }, "activeEndTime":{ "description":"Enter the effective end time for the record", "type":"string", "example":"22:00" }, "recurrenceDayOfWeek":{ "description":"Select the recurrence effective day of the week(Monday - Sunday) for the record", "type":"string", "example":"1111111" } } }, "rvcType":{ "description":"A string value of 0s & 1s of length 32 to configure the availability of the Discount in an RVC", "type":"string", "example":"00000000000000000000000000000000" }, "dscItmzr":{ "description":"A string value of 0s & 1s of length 15 representing the enablement or disablement of the discount itemizers on which the discount is computable", "type":"string", "example":"000000000000000" }, "menuLevels":{ "description":"An object containing the menu levels on which the discount is active", "type":"object", "properties":{ "mainLevel":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the discount on main levels", "type":"string", "example":"00000000" }, "sublevel":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the discount on sub levels", "type":"string", "example":"00000000" } } }, "transDefaultMainLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Main Level after pressing the discount", "type":"boolean", "example":false }, "mainLevelPopup":{ "description":"The Main Level that activates after pressing the discount", "type":"integer", "example":1 }, "transDefaultSubLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Sub Level after pressing the discount.", "type":"boolean", "example":false }, "subLevelPopup":{ "description":"The Sub Level that activates after pressing the discount", "type":"integer", "example":1 }, "sluObjNum":{ "description":"Object number of the Screen Lookup key for the discount.", "type":"integer", "example":1 }, "nlu":{ "description":"A unique Number Lookup (0-9,999,999,999) for the discount", "type":"integer", "example":1 }, "autoRule":{ "description":"Determine how Simphony calculates a discount", "type":"object", "properties":{ "autoRuleType":{ "description":"The types of Automatic Discounts rule;0 - Not Active;1 - Item Price Substitution;2 - Quantity Threshold;3 - Total Price Threshold;4 - Combination Pricing;5 - Sales Price", "type":"integer", "example":1 }, "constraintType":{ "description":"The types of Discounts Constraints;1-No Constraint, 2-Menu Item,3-Major Group,4-Family Group, Applicable only for autoRuleType 2 and 3.", "type":"integer", "example":1 }, "awardAlgorithm":{ "description":"The award algorithm to be used in the discount.;1- Best Deal for Customer to apply the highest discount amount to the check;2 - Best Deal for Merchant to apply the lowest discount amount to the check", "type":"integer", "example":1 }, "priority":{ "description":"The order in which the POS client calculates discounts. Applicable only for autoRuleType 1-4", "type":"integer", "example":1 }, "maxCountPerCheck":{ "description":"The maximum number of times the coupon discount can be entered on a check. Enter 0 for unlimited entries", "type":"integer", "example":1 }, "usePriceInMIGroupDetail":{ "description":"A Boolean flag indicating to use the Menu Item Groups promotion price for the discounted menu item. Does not function with Combination Pricing Discounts. Applicable only for autoRuleType - 1,2,3 and 5", "type":"boolean", "example":false }, "allowAwardOfHigherPricedTriggerItem":{ "description":"A Boolean flag indicating to allow award of a higher priced trigger item if the trigger item is also an award item. Applicable only for autoRuleType - 2 and 3", "type":"boolean", "example":false }, "triggerGroups":{ "description":"Menu Item Group to trigger the discount award.", "type":"array", "items":{ "type":"object", "properties":{ "sequenceNum":{ "description":"Sequence Number of the Menu Item Group", "type":"integer", "example":1 }, "triggerMIGroupObjNum":{ "description":"Object number of the Menu Item Group to trigger the discount award.", "type":"integer", "example":1 }, "triggerCondimentGroupObjNum":{ "description":"Object number of the Condiment Menu Item Group to use as the trigger for the discount", "type":"integer", "example":1 }, "minimumQuantity":{ "description":"Number of items that customers must order from the corresponding trigger menu group before applying the discount award.", "type":"integer", "example":1 }, "total":{ "description":"Total amount of corresponding trigger menu item group items customers must order before applying the discount", "type":"number", "example":1 } } } }, "awardGroups":{ "description":"An array of award groups for the discount", "type":"array", "items":{ "type":"object", "properties":{ "sequenceNum":{ "description":"The sequence number of the award group", "type":"integer", "example":1 }, "awardMIGroupObjNum":{ "description":"Object number of the menu item group that is to be discounted. Applicable only for autoRuleType - 2 and 3", "type":"integer", "example":1 }, "awardType":{ "description":"Type of the award;0 - None;1 - Percent Off;2 - Amount Off;3 - Amount Substitution", "type":"integer", "example":1 }, "percentOff":{ "description":"The percentage of the percent-based discount. Applicable only for awardType - 1. Value must lie between 0 and 1. For Example 15% will be 0.15 in the 200 response body.", "type":"integer", "example":1 }, "amountOff":{ "description":"The discount amount for flat amount-based discount. Applicable only for awardType - 2", "type":"number", "example":1 }, "amountSubstitution":{ "description":"The price to charge for each item in the Trigger Menu Item Group. Applicable only for awardType - 3", "type":"number", "example":1 }, "awardCount":{ "description":"The maximum number of items discounted after reaching the Trigger MI Group's Minimum Quantity", "type":"number", "example":1 }, "maxCount":{ "description":"When Simple Transaction Exclusivity is set for this discount, enter the maximum number of discounts that can be applied to one check. Applicable only for autoRuleType - 1-4", "type":"number", "example":1 } } } } } }, "exclusivity":{ "description":"Exclusivity stops all discounts from applying to a check at once. Discount exclusivity controls how multiple discounts interact with each other.", "type":"object", "properties":{ "transaction":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the discount on transactions", "type":"string", "example":"00000000000000000000000000000000" }, "item":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the discount on specific menu items", "type":"string", "example":"00000000000000000000000000000000" } } }, "orderChannelRestrictions":{ "description":"The order channels that are considered for the discount. Each objectNum belongs to a particular order channel.", "type":"array", "items":{ "type":"object", "required":[ "objectNum" ], "properties":{ "objectNum":{ "type":"integer", "description":"object number of a particular order channel", "example":1 } } } }, "orderTypeRestrictions":{ "description":"A string of values of 0s and 1s of length 32 representing ordertypes from 1 to 32, with a value of 1 indicating respected order type is included and 0 indicating exclusion.", "type":"string", "example":"11100000000000000000000000000000" }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } }, "Discountv1":{ "description":"Model for Discount Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object number of the Discount", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Discounts in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "effGrpObjNum":{ "description":"Object number of the Effectivity Group for the current record", "type":"integer", "example":1 }, "effGrpName":{ "description":"A group of string objects representing the name of the effectivity group for the discount in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "consumerDisplayname":{ "description":"A group of string objects representing the name of the Discounts in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "activationType":{ "description":"Type of Discount ; 0 - Manual (Manually Entered and applied);1 - Automatic (Automatically applied and operator cannot enter);2 - Coupon (Automatically applied, operator must enter)", "type":"integer", "example":1 }, "percent":{ "description":"Percentage for the manual discount. Value must lie between 0 and 1.", "type":"integer", "example":1 }, "minAmount":{ "description":"Minimum menu item subtotal amount", "type":"integer", "example":1 }, "maxAmount":{ "description":"Maximum amount allowed for an open-priced or amount discount", "type":"integer", "example":1 }, "taxClassObjNum":{ "description":"Tax Class to be Discounted", "type":"integer", "example":1 }, "taxClassName":{ "description":"A group of string objects representing the name of the tax class to be discounted in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "privilegeGroup":{ "description":"Privilege Group number to restrict the use of the discount", "type":"integer", "example":1 }, "condimentDiscountability":{ "description":"Determine how condiment menu items are discounted;0 - Use Menu Item ClassOption;1 - Parent Items only;2 - Condiment Items only;3 - Parent and Highlighted Condiment Items;4 - Parent and all Condiment Items;5 - Single Condiment", "type":"integer", "example":1 }, "reportGroupObjnum":{ "description":"Report Group to associate with the discount.", "type":"integer", "example":1 }, "reportGroupName":{ "description":"A group of string objects representing the name of the report group associated with the discount in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "printClassObjNum":{ "description":"Print Class for the Discount", "type":"integer", "example":1 }, "printClassName":{ "description":"A group of string objects representing the name of the print class for the discount in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "enabled":{ "description":"A Boolean flag indicating to enabling the Discount", "type":"boolean", "example":false }, "triggerMIGrpObjNum":{ "description":"Menu Item Group that triggers the discount.", "type":"integer", "example":1 }, "triggerMIGrpName":{ "description":"A group of string objects representing the name of the Menu Item Group for the discount in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "triggerCondimentGrpObjNum":{ "description":"Condiment Menu Item Group to use as the trigger for the discount.", "type":"integer", "example":1 }, "triggerCondimentGrpName":{ "description":"A group of string objects representing the name of the Menu Item Group for the discount in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "options":{ "description":"A String of Values of 0s and 1s of length 56 representing the enablement or disablement of the options associated with Discounts", "type":"string", "example":"00000000000000000000000000000000000000000000000000000000" }, "optionsExt":{ "description":"An object containing the descriptive option list", "type":"object", "properties":{ "isOpen":{ "description":"A Boolean flag indicating to make the discount open, prompting for the amount or percentage", "type":"boolean", "example":false }, "isAmount":{ "description":"A Boolean flag indicating to make the discount an amount. Deselect to make the discount a percentage.", "type":"boolean", "example":true }, "isItemDiscount":{ "description":"A Boolean flag indicating to calculate the discount based on the price of the last menu item", "type":"boolean", "example":false }, "isEmployeeMeal":{ "description":"A Boolean flag indicating to define as an Employee Discount", "type":"boolean", "example":false }, "referenceEntryRequired":{ "description":"A Boolean flag indicating to require entry of a name or number when using the discount.", "type":"boolean", "example":true }, "validationRequired":{ "description":"A Boolean flag indicating to print a validation chit when using the discount", "type":"boolean", "example":true }, "limitDiscountToValueInAmountField":{ "description":"A Boolean flag indicating to limit the discount amount", "type":"boolean", "example":false }, "useFullDiscountableAmountIfValueIsAbsent":{ "description":"A Boolean flag indicating to control the Open Amount Discount calculation when the operator does not enter an amount before pressing the Discount button", "type":"boolean", "example":true }, "simpleItemExclusivity":{ "description":"A Boolean flag indicating to apply the discount to a menu item, preventing individual items from receiving multiple discounts total.", "type":"boolean", "example":false }, "tenderRequiredForSubTtlDiscounts":{ "description":"A Boolean flag indicating to require workstation operators to tender the transaction after applying a subtotal discount. You must also deselect This is an Item Discount", "type":"boolean", "example":false }, "affectsAutoSVCForSubTtlDiscounts":{ "description":"A Boolean flag indicating to apply the discount to Menu Item Itemizers that allow Auto Service Charges", "type":"boolean", "example":false }, "doNotallowSubTtlDiscountIfSeatFilterActive":{ "description":"A Boolean flag indicating to not allow subtotal discounts that do not post while seat filtering is active", "type":"boolean", "example":true }, "simpleTransactionExclusivity":{ "description":"A Boolean flag indicating to prevent other discounts from being added to the check", "type":"boolean", "example":true }, "discountComboMealGroupItems":{ "description":"A Boolean flag indicating to apply the discount to Combo Meal Group items when Combo Meal Group option Allow Discounts is set", "type":"boolean", "example":true }, "menuItemToUseCheckOpenTime":{ "description":"A Boolean flag indicating to allow menu items to use the check's open time to determine the discount effectivity", "type":"boolean", "example":true }, "selectedMenuItemToIncludeParentMenuItem":{ "description":"A Boolean flag indicating to include the parent menu item in the discount when discounting a child menu item", "type":"boolean", "example":false }, "netAutomaticSVCItemzr":{ "description":"A Boolean flag indicating to post the menu item net value to the Automatic Service Charge Itemizer, reducing the Automatic Service Charge when the discount is applied.", "type":"boolean", "example":false }, "limitDiscountValueToDiscountableItemValue":{ "description":"A Boolean flag indicating to limit the discountable amount to the item or award when the Amount Off exceeds the item or award", "type":"boolean", "example":false }, "isCashManagementTransactionItem":{ "description":"A Boolean flag indicating to include the discount in Cash Management tracking and reporting.", "type":"boolean", "example":false }, "affectCashPullThreshold":{ "description":"A Boolean flag indicating to have any transactions performed for this tender affect the Cash Pull Threshold Sets balance. Set this option only for tenders that present a loss if lost or stolen", "type":"boolean", "example":false } } }, "effectivity":{ "description":"An object representing the effective dates for the record", "type":"object", "properties":{ "startDateTime":{ "description":"The effective start date for the record.", "type":"string", "example":"2021-09-22T00:00:00" }, "endDateTime":{ "description":"Enter the effective end date for the record", "type":"string", "example":"2022-09-21T23:59:59" }, "activeStartTime":{ "description":"Enter the effective start time for the record", "type":"string", "example":"09:00" }, "activeEndTime":{ "description":"Enter the effective end time for the record", "type":"string", "example":"22:00" }, "recurrenceDayOfWeek":{ "description":"Select the recurrence effective day of the week(Monday - Sunday) for the record", "type":"string", "example":"1111111" }, "recurrenceDayOfWeekExt":{ "description":"An object containing the descriptive list of recurrence effective day of the week for the record.", "type":"object", "properties":{ "Monday":{ "description":"select the recurrence for Monday.", "type":"boolean", "example":false }, "Tuesday":{ "description":"select the recurrence for Tuesday.", "type":"boolean", "example":false }, "Wednesday":{ "description":"select the recurrence for Wednesday.", "type":"boolean", "example":true }, "Thursday":{ "description":"select the recurrence for Thursday.", "type":"boolean", "example":true }, "Friday":{ "description":"select the recurrence for Friday.", "type":"boolean", "example":true }, "Saturday":{ "description":"select the recurrence for Saturday.", "type":"boolean", "example":true }, "Sunday":{ "description":"select the recurrence for Sunday.", "type":"boolean", "example":true } } } } }, "rvcType":{ "description":"A string value of 0s & 1s of length 32 to configure the availability of the Discount in an RVC", "type":"string", "example":"00000000000000000000000000000000" }, "rvcTypeExt":{ "description":"An object containing the descriptive list of revenue centers where the discount is available.", "type":"object", "properties":{ "rvcType1":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 1", "type":"boolean", "example":false }, "rvcType2":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 2", "type":"boolean", "example":false }, "rvcType3":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 3", "type":"boolean", "example":true }, "rvcType4":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 4", "type":"boolean", "example":true }, "rvcType5":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 5", "type":"boolean", "example":true }, "rvcType6":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 6", "type":"boolean", "example":true }, "rvcType7":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 7", "type":"boolean", "example":true }, "rvcType8":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 8", "type":"boolean", "example":true }, "rvcType9":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 9", "type":"boolean", "example":true }, "rvcType10":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 10", "type":"boolean", "example":true }, "rvcType11":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 11", "type":"boolean", "example":true }, "rvcType12":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 12", "type":"boolean", "example":true }, "rvcType13":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 13", "type":"boolean", "example":false }, "rvcType14":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 14", "type":"boolean", "example":false }, "rvcType15":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 15", "type":"boolean", "example":false }, "rvcType16":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 16", "type":"boolean", "example":false }, "rvcType17":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 17", "type":"boolean", "example":false }, "rvcType18":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 18", "type":"boolean", "example":false }, "rvcType19":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 19", "type":"boolean", "example":false }, "rvcType20":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 20", "type":"boolean", "example":false }, "rvcType21":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 21", "type":"boolean", "example":false }, "rvcType22":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 22", "type":"boolean", "example":false }, "rvcType23":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 23", "type":"boolean", "example":false }, "rvcType24":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 24", "type":"boolean", "example":false }, "rvcType25":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 25", "type":"boolean", "example":false }, "rvcType26":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 26", "type":"boolean", "example":false }, "rvcType27":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 27", "type":"boolean", "example":false }, "rvcType28":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 28", "type":"boolean", "example":false }, "rvcType29":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 29", "type":"boolean", "example":false }, "rvcType30":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 30", "type":"boolean", "example":false }, "rvcType31":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 31", "type":"boolean", "example":false }, "rvcType32":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 32", "type":"boolean", "example":true } } }, "dscItmzr":{ "description":"A string value of 0s & 1s of length 15 representing the enablement or disablement of the discount itemizers on which the discount is computable", "type":"string", "example":"000000000000000" }, "dscItmzrExt":{ "description":"An object containing the descriptive list associated with the condiment set associated with the menu item", "type":"object", "properties":{ "dscItmzr1":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 1", "type":"boolean", "example":false }, "dscItmzr2":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 2", "type":"boolean", "example":false }, "dscItmzr3":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 3", "type":"boolean", "example":false }, "dscItmzr4":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 4", "type":"boolean", "example":false }, "dscItmzr5":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 5", "type":"boolean", "example":false }, "dscItmzr6":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 6", "type":"boolean", "example":false }, "dscItmzr7":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 7", "type":"boolean", "example":false }, "dscItmzr8":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 8", "type":"boolean", "example":false }, "dscItmzr9":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 9", "type":"boolean", "example":false }, "dscItmzr10":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 10", "type":"boolean", "example":false }, "dscItmzr11":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 11", "type":"boolean", "example":false }, "dscItmzr12":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 12", "type":"boolean", "example":false }, "dscItmzr13":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 13", "type":"boolean", "example":false }, "dscItmzr14":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 14", "type":"boolean", "example":false }, "dscItmzr15":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 15", "type":"boolean", "example":false } } }, "menuLevels":{ "description":"An object containing the menu levels on which the discount is active", "type":"object", "properties":{ "mainLevel":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the discount on main levels", "type":"string", "example":"00000000" }, "mainLevelExt":{ "description":"An object containing the descriptive list associated with the enablement or disablement of the discount on main level", "type":"object", "properties":{ "mainLevel1":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 1", "type":"boolean", "example":false }, "mainLevel2":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 2", "type":"boolean", "example":false }, "mainLevel3":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 3", "type":"boolean", "example":false }, "mainLevel4":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 4", "type":"boolean", "example":false }, "mainLevel5":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 5", "type":"boolean", "example":false }, "mainLevel6":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 6", "type":"boolean", "example":false }, "mainLevel7":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 7", "type":"boolean", "example":false }, "mainLevel8":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 8", "type":"boolean", "example":false } } }, "sublevel":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the discount on sub levels", "type":"string", "example":"00000000" }, "subLevelExt":{ "description":"An object containing the descriptive list associated with the enablement or disablement of the discount on sub level", "type":"object", "properties":{ "subLevel1":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 1", "type":"boolean", "example":false }, "subLevel2":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 2", "type":"boolean", "example":false }, "subLevel3":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 3", "type":"boolean", "example":false }, "subLevel4":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 4", "type":"boolean", "example":false }, "subLevel5":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 5", "type":"boolean", "example":false }, "subLevel6":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 6", "type":"boolean", "example":false }, "subLevel7":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 7", "type":"boolean", "example":false }, "subLevel8":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 8", "type":"boolean", "example":false } } } } }, "transDefaultMainLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Main Level after pressing the discount", "type":"boolean", "example":false }, "mainLevelPopup":{ "description":"The Main Level that activates after pressing the discount", "type":"integer", "example":1 }, "transDefaultSubLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Sub Level after pressing the discount.", "type":"boolean", "example":false }, "subLevelPopup":{ "description":"The Sub Level that activates after pressing the discount", "type":"integer", "example":1 }, "sluObjNum":{ "description":"Object number of the Screen Lookup key for the discount.", "type":"integer", "example":1 }, "sluName":{ "description":"A group of string objects representing the name of the SLU in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "nlu":{ "description":"A unique Number Lookup (0-9,999,999,999) for the discount", "type":"integer", "example":1 }, "autoRule":{ "description":"Determine how Simphony calculates a discount", "type":"object", "properties":{ "autoRuleType":{ "description":"The types of Automatic Discounts rule;0 - Not Active;1 - Item Price Substitution;2 - Quantity Threshold;3 - Total Price Threshold;4 - Combination Pricing;5 - Sales Price", "type":"integer", "example":1 }, "constraintType":{ "description":"The types of Discounts Constraints;1-No Constraint, 2-Menu Item,3-Major Group,4-Family Group, Applicable only for autoRuleType 2 and 3.", "type":"integer", "example":1 }, "awardAlgorithm":{ "description":"The award algorithm to be used in the discount.;1- Best Deal for Customer to apply the highest discount amount to the check;2 - Best Deal for Merchant to apply the lowest discount amount to the check", "type":"integer", "example":1 }, "priority":{ "description":"The order in which the POS client calculates discounts. Applicable only for autoRuleType 1-4", "type":"integer", "example":1 }, "maxCountPerCheck":{ "description":"The maximum number of times the coupon discount can be entered on a check. Enter 0 for unlimited entries", "type":"integer", "example":1 }, "usePriceInMIGroupDetail":{ "description":"A Boolean flag indicating to use the Menu Item Groups promotion price for the discounted menu item. Does not function with Combination Pricing Discounts. Applicable only for autoRuleType - 1,2,3 and 5", "type":"boolean", "example":false }, "allowAwardOfHigherPricedTriggerItem":{ "description":"A Boolean flag indicating to allow award of a higher priced trigger item if the trigger item is also an award item. Applicable only for autoRuleType - 2 and 3", "type":"boolean", "example":false }, "triggerGroups":{ "description":"Menu Item Group to trigger the discount award.", "type":"array", "items":{ "type":"object", "properties":{ "sequenceNum":{ "description":"Sequence Number of the Menu Item Group", "type":"integer", "example":1 }, "triggerMIGroupObjNum":{ "description":"Object number of the Menu Item Group to trigger the discount award.", "type":"integer", "example":1 }, "triggerMIGroupName":{ "description":"A group of string objects representing the name of the trigger menu item group in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "triggerCondimentGroupObjNum":{ "description":"Object number of the Condiment Menu Item Group to use as the trigger for the discount", "type":"integer", "example":1 }, "triggerCondimentGroupName":{ "description":"A group of string objects representing the name of the trigger condiment menu item group in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "minimumQuantity":{ "description":"Number of items that customers must order from the corresponding trigger menu group before applying the discount award.", "type":"integer", "example":1 }, "total":{ "description":"Total amount of corresponding trigger menu item group items customers must order before applying the discount", "type":"number", "example":1 } } } }, "awardGroups":{ "description":"An array of award groups for the discount", "type":"array", "items":{ "type":"object", "properties":{ "sequenceNum":{ "description":"The sequence number of the award group", "type":"integer", "example":1 }, "awardMIGroupObjNum":{ "description":"Object number of the menu item group that is to be discounted. Applicable only for autoRuleType - 2 and 3", "type":"integer", "example":1 }, "awardMIGroupName":{ "description":"A group of string objects representing the name of the menu item group that is to be discounted in configured languages; Applicable only for autoRuleType - 2 and 3", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "awardType":{ "description":"Type of the award;0 - None;1 - Percent Off;2 - Amount Off;3 - Amount Substitution", "type":"integer", "example":1 }, "percentOff":{ "description":"The percentage of the percent-based discount. Applicable only for awardType - 1. Value must lie between 0 and 1. For Example 15% will be 0.15 in the 200 response body.", "type":"integer", "example":1 }, "amountOff":{ "description":"The discount amount for flat amount-based discount. Applicable only for awardType - 2", "type":"number", "example":1 }, "amountSubstitution":{ "description":"The price to charge for each item in the Trigger Menu Item Group. Applicable only for awardType - 3", "type":"number", "example":1 }, "awardCount":{ "description":"The maximum number of items discounted after reaching the Trigger MI Group's Minimum Quantity", "type":"number", "example":1 }, "maxCount":{ "description":"When Simple Transaction Exclusivity is set for this discount, enter the maximum number of discounts that can be applied to one check. Applicable only for autoRuleType - 1-4", "type":"number", "example":1 } } } } } }, "exclusivity":{ "description":"Exclusivity stops all discounts from applying to a check at once. Discount exclusivity controls how multiple discounts interact with each other.", "type":"object", "properties":{ "transaction":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the discount on transactions", "type":"string", "example":"00000000000000000000000000000000" }, "transactionExt":{ "description":"An object containing the descriptive list associated with the enablement or disablement of the discount on transactions", "type":"object", "properties":{ "transaction1":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 1", "type":"boolean", "example":false }, "transaction2":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 2", "type":"boolean", "example":false }, "transaction3":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 3", "type":"boolean", "example":false }, "transaction4":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 4", "type":"boolean", "example":false }, "transaction5":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 5", "type":"boolean", "example":false }, "transaction6":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 6", "type":"boolean", "example":false }, "transaction7":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 7", "type":"boolean", "example":false }, "transaction8":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 8", "type":"boolean", "example":false }, "transaction9":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 9", "type":"boolean", "example":false }, "transaction10":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 10", "type":"boolean", "example":false }, "transaction11":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 11", "type":"boolean", "example":false }, "transaction12":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 12", "type":"boolean", "example":false }, "transaction13":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 13", "type":"boolean", "example":false }, "transaction14":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 14", "type":"boolean", "example":false }, "transaction15":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 15", "type":"boolean", "example":false }, "transaction16":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 16", "type":"boolean", "example":false }, "transaction17":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 17", "type":"boolean", "example":false }, "transaction18":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 18", "type":"boolean", "example":false }, "transaction19":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 19", "type":"boolean", "example":false }, "transaction20":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 20", "type":"boolean", "example":false }, "transaction21":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 21", "type":"boolean", "example":false }, "transaction22":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 22", "type":"boolean", "example":false }, "transaction23":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 23", "type":"boolean", "example":false }, "transaction24":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 24", "type":"boolean", "example":false }, "transaction25":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 25", "type":"boolean", "example":false }, "transaction26":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 26", "type":"boolean", "example":false }, "transaction27":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 27", "type":"boolean", "example":false }, "transaction28":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 28", "type":"boolean", "example":false }, "transaction29":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 29", "type":"boolean", "example":false }, "transaction30":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 30", "type":"boolean", "example":false }, "transaction31":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 31", "type":"boolean", "example":false }, "transaction32":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 32", "type":"boolean", "example":false } } }, "item":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the discount on specific menu items", "type":"string", "example":"00000000000000000000000000000000" }, "itemExt":{ "description":"An object containing the descriptive list associated with the enablement or disablement of the discount on specific menu items", "type":"object", "properties":{ "item1":{ "description":"A Boolean flag indicating to apply discount to a menu item 1.", "type":"boolean", "example":false }, "item2":{ "description":"A Boolean flag indicating to apply discount to a menu item 2.", "type":"boolean", "example":false }, "item3":{ "description":"A Boolean flag indicating to apply discount to a menu item 3.", "type":"boolean", "example":false }, "item4":{ "description":"A Boolean flag indicating to apply discount to a menu item 4.", "type":"boolean", "example":false }, "item5":{ "description":"A Boolean flag indicating to apply discount to a menu item 5.", "type":"boolean", "example":false }, "item6":{ "description":"A Boolean flag indicating to apply discount to a menu item 6.", "type":"boolean", "example":false }, "item7":{ "description":"A Boolean flag indicating to apply discount to a menu item 7.", "type":"boolean", "example":false }, "item8":{ "description":"A Boolean flag indicating to apply discount to a menu item 8.", "type":"boolean", "example":false }, "item9":{ "description":"A Boolean flag indicating to apply discount to a menu item 9.", "type":"boolean", "example":false }, "item10":{ "description":"A Boolean flag indicating to apply discount to a menu item 10.", "type":"boolean", "example":false }, "item11":{ "description":"A Boolean flag indicating to apply discount to a menu item 11.", "type":"boolean", "example":false }, "item12":{ "description":"A Boolean flag indicating to apply discount to a menu item 12.", "type":"boolean", "example":false }, "item13":{ "description":"A Boolean flag indicating to apply discount to a menu item 13.", "type":"boolean", "example":false }, "item14":{ "description":"A Boolean flag indicating to apply discount to a menu item 14.", "type":"boolean", "example":false }, "item15":{ "description":"A Boolean flag indicating to apply discount to a menu item 15.", "type":"boolean", "example":false }, "item16":{ "description":"A Boolean flag indicating to apply discount to a menu item 16.", "type":"boolean", "example":false }, "item17":{ "description":"A Boolean flag indicating to apply discount to a menu item 17.", "type":"boolean", "example":false }, "item18":{ "description":"A Boolean flag indicating to apply discount to a menu item 18.", "type":"boolean", "example":false }, "item19":{ "description":"A Boolean flag indicating to apply discount to a menu item 19.", "type":"boolean", "example":false }, "item20":{ "description":"A Boolean flag indicating to apply discount to a menu item 20.", "type":"boolean", "example":false }, "item21":{ "description":"A Boolean flag indicating to apply discount to a menu item 21.", "type":"boolean", "example":false }, "item22":{ "description":"A Boolean flag indicating to apply discount to a menu item 22.", "type":"boolean", "example":false }, "item23":{ "description":"A Boolean flag indicating to apply discount to a menu item 23.", "type":"boolean", "example":false }, "item24":{ "description":"A Boolean flag indicating to apply discount to a menu item 24.", "type":"boolean", "example":false }, "item25":{ "description":"A Boolean flag indicating to apply discount to a menu item 25.", "type":"boolean", "example":false }, "item26":{ "description":"A Boolean flag indicating to apply discount to a menu item 26.", "type":"boolean", "example":false }, "item27":{ "description":"A Boolean flag indicating to apply discount to a menu item 27.", "type":"boolean", "example":false }, "item28":{ "description":"A Boolean flag indicating to apply discount to a menu item 28.", "type":"boolean", "example":false }, "item29":{ "description":"A Boolean flag indicating to apply discount to a menu item 29.", "type":"boolean", "example":false }, "item30":{ "description":"A Boolean flag indicating to apply discount to a menu item 30.", "type":"boolean", "example":false }, "item31":{ "description":"A Boolean flag indicating to apply discount to a menu item 31.", "type":"boolean", "example":false }, "item32":{ "description":"A Boolean flag indicating to apply discount to a menu item 32.", "type":"boolean", "example":false } } } } }, "orderChannelRestrictions":{ "description":"The order channels that are considered for the discount. Each objectNum belongs to a particular order channel.", "type":"array", "items":{ "type":"object", "required":[ "objectNum", "name" ], "properties":{ "objectNum":{ "type":"integer", "description":"objectNum of a particular order channel", "example":1 }, "name":{ "description":"A group of string objects representing the name of the order channel that is to be discounted in configured languages", "type":"object", "example":{ "en-US":"Default", "de-DE":"Standard", "es-MX":"Por defecto" } } } }, "example":[ { "name":{ "en-US":"Delivery" }, "objectNum":4 } ] }, "orderTypeRestrictions":{ "description":"A String of Values of 0s and 1s of length 32 representing ordertypes from 1 to 32, with a value of 1 indicating respected order type is included and 0 indicating exclusion.", "type":"string", "example":"11100000000000000000000000000000" }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } }, "Discountv1GetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Discounts objects of the organization.", "items":{ "$ref":"#/definitions/Discountv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "Discountv2":{ "description":"Model for Discount Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Discount", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Discounts in configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "effGrpObjNum":{ "description":"Object number of the Effectivity Group for the current record", "type":"integer", "example":1 }, "consumerDisplayname":{ "description":"A group of string objects representing the name of the Discounts in configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "activationType":{ "description":"Type of Discount ; 0 - Manual (Manually Entered and applied);1 - Automatic (Automatically applied and operator cannot enter);2 - Coupon (Automatically applied, operator must enter)", "type":"integer", "example":1 }, "percent":{ "description":"Percentage for the manual discount. Value must lie between 0 and 1.", "type":"integer", "example":1 }, "minAmount":{ "description":"Minimum menu item subtotal amount", "type":"integer", "example":1 }, "maxAmount":{ "description":"Maximum amount allowed for an open-priced or amount discount", "type":"integer", "example":1 }, "taxClassObjNum":{ "description":"Tax Class to be Discounted", "type":"integer", "example":1 }, "privilegeGroup":{ "description":"Privilege Group number to restrict the use of the discount", "type":"integer", "example":1 }, "condimentDiscountability":{ "description":"Determine how condiment menu items are discounted;0 - Use Menu Item ClassOption;1 - Parent Items only;2 - Condiment Items only;3 - Parent and Highlighted Condiment Items;4 - Parent and all Condiment Items;5 - Single Condiment", "type":"integer", "example":1 }, "reportGroupObjnum":{ "description":"Report Group to associate with the discount.", "type":"integer", "example":1 }, "printClassObjNum":{ "description":"Print Class for the Discount", "type":"integer", "example":1 }, "enabled":{ "description":"A Boolean flag indicating to enabling the Discount", "type":"boolean", "example":false }, "triggerMIGrpObjNum":{ "description":"Menu Item Group that triggers the discount.", "type":"integer", "example":1 }, "triggerCondimentGrpObjNum":{ "description":"Condiment Menu Item Group to use as the trigger for the discount.", "type":"integer", "example":1 }, "options":{ "description":"A String of Values of 0s and 1s of length 56 representing the enablement or disablement of the options associated with Discounts", "type":"string", "example":"00000000000000000000000000000000000000000000000000000000" }, "optionsExt":{ "description":"An object containing the descriptive option list", "type":"object", "properties":{ "isOpen":{ "description":"A Boolean flag indicating to make the discount open, prompting for the amount or percentage", "type":"boolean", "example":false }, "isAmount":{ "description":"A Boolean flag indicating to make the discount an amount. Deselect to make the discount a percentage.", "type":"boolean", "example":true }, "isItemDiscount":{ "description":"A Boolean flag indicating to calculate the discount based on the price of the last menu item", "type":"boolean", "example":false }, "isEmployeeMeal":{ "description":"A Boolean flag indicating to define as an Employee Discount", "type":"boolean", "example":false }, "referenceEntryRequired":{ "description":"A Boolean flag indicating to require entry of a name or number when using the discount.", "type":"boolean", "example":true }, "validationRequired":{ "description":"A Boolean flag indicating to print a validation chit when using the discount", "type":"boolean", "example":true }, "limitDiscountToValueInAmountField":{ "description":"A Boolean flag indicating to limit the discount amount", "type":"boolean", "example":false }, "useFullDiscountableAmountIfValueIsAbsent":{ "description":"A Boolean flag indicating to control the Open Amount Discount calculation when the operator does not enter an amount before pressing the Discount button", "type":"boolean", "example":true }, "simpleItemExclusivity":{ "description":"A Boolean flag indicating to apply the discount to a menu item, preventing individual items from receiving multiple discounts total.", "type":"boolean", "example":false }, "tenderRequiredForSubTtlDiscounts":{ "description":"A Boolean flag indicating to require workstation operators to tender the transaction after applying a subtotal discount. You must also deselect This is an Item Discount", "type":"boolean", "example":false }, "affectsAutoSVCForSubTtlDiscounts":{ "description":"A Boolean flag indicating to apply the discount to Menu Item Itemizers that allow Auto Service Charges", "type":"boolean", "example":false }, "doNotallowSubTtlDiscountIfSeatFilterActive":{ "description":"A Boolean flag indicating to not allow subtotal discounts that do not post while seat filtering is active", "type":"boolean", "example":true }, "simpleTransactionExclusivity":{ "description":"A Boolean flag indicating to prevent other discounts from being added to the check", "type":"boolean", "example":true }, "discountComboMealGroupItems":{ "description":"A Boolean flag indicating to apply the discount to Combo Meal Group items when Combo Meal Group option Allow Discounts is set", "type":"boolean", "example":true }, "menuItemToUseCheckOpenTime":{ "description":"A Boolean flag indicating to allow menu items to use the check's open time to determine the discount effectivity", "type":"boolean", "example":true }, "selectedMenuItemToIncludeParentMenuItem":{ "description":"A Boolean flag indicating to include the parent menu item in the discount when discounting a child menu item", "type":"boolean", "example":false }, "netAutomaticSVCItemzr":{ "description":"A Boolean flag indicating to post the menu item net value to the Automatic Service Charge Itemizer, reducing the Automatic Service Charge when the discount is applied.", "type":"boolean", "example":false }, "limitDiscountValueToDiscountableItemValue":{ "description":"A Boolean flag indicating to limit the discountable amount to the item or award when the Amount Off exceeds the item or award", "type":"boolean", "example":false }, "isCashManagementTransactionItem":{ "description":"A Boolean flag indicating to include the discount in Cash Management tracking and reporting.", "type":"boolean", "example":false }, "affectCashPullThreshold":{ "description":"A Boolean flag indicating to have any transactions performed for this tender affect the Cash Pull Threshold Sets balance. Set this option only for tenders that present a loss if lost or stolen", "type":"boolean", "example":false } } }, "effectivity":{ "description":"An object representing the effective dates for the record", "type":"object", "properties":{ "startDateTime":{ "description":"The effective start date for the record.", "type":"string", "example":"2021-09-22T00:00:00" }, "endDateTime":{ "description":"Enter the effective end date for the record", "type":"string", "example":"2022-09-21T23:59:59" }, "activeStartTime":{ "description":"Enter the effective start time for the record", "type":"string", "example":"09:00" }, "activeEndTime":{ "description":"Enter the effective end time for the record", "type":"string", "example":"22:00" }, "recurrenceDayOfWeek":{ "description":"Select the recurrence effective day of the week(Monday - Sunday) for the record", "type":"string", "example":"1111111" }, "recurrenceDayOfWeekExt":{ "description":"An object containing the descriptive list of recurrence effective day of the week for the record.", "type":"object", "properties":{ "Monday":{ "description":"select the recurrence for Monday.", "type":"boolean", "example":false }, "Tuesday":{ "description":"select the recurrence for Tuesday.", "type":"boolean", "example":false }, "Wednesday":{ "description":"select the recurrence for Wednesday.", "type":"boolean", "example":true }, "Thursday":{ "description":"select the recurrence for Thursday.", "type":"boolean", "example":true }, "Friday":{ "description":"select the recurrence for Friday.", "type":"boolean", "example":true }, "Saturday":{ "description":"select the recurrence for Saturday.", "type":"boolean", "example":true }, "Sunday":{ "description":"select the recurrence for Sunday.", "type":"boolean", "example":true } } } } }, "rvcType":{ "description":"A string value of 0s & 1s of length 32 to configure the availability of the Discount in an RVC", "type":"string", "example":"00000000000000000000000000000000" }, "rvcTypeExt":{ "description":"An object containing the descriptive list of revenue centers where the discount is available.", "type":"object", "properties":{ "rvcType1":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 1", "type":"boolean", "example":false }, "rvcType2":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 2", "type":"boolean", "example":false }, "rvcType3":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 3", "type":"boolean", "example":true }, "rvcType4":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 4", "type":"boolean", "example":true }, "rvcType5":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 5", "type":"boolean", "example":true }, "rvcType6":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 6", "type":"boolean", "example":true }, "rvcType7":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 7", "type":"boolean", "example":true }, "rvcType8":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 8", "type":"boolean", "example":true }, "rvcType9":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 9", "type":"boolean", "example":true }, "rvcType10":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 10", "type":"boolean", "example":true }, "rvcType11":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 11", "type":"boolean", "example":true }, "rvcType12":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 12", "type":"boolean", "example":true }, "rvcType13":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 13", "type":"boolean", "example":false }, "rvcType14":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 14", "type":"boolean", "example":false }, "rvcType15":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 15", "type":"boolean", "example":false }, "rvcType16":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 16", "type":"boolean", "example":false }, "rvcType17":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 17", "type":"boolean", "example":false }, "rvcType18":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 18", "type":"boolean", "example":false }, "rvcType19":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 19", "type":"boolean", "example":false }, "rvcType20":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 20", "type":"boolean", "example":false }, "rvcType21":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 21", "type":"boolean", "example":false }, "rvcType22":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 22", "type":"boolean", "example":false }, "rvcType23":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 23", "type":"boolean", "example":false }, "rvcType24":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 24", "type":"boolean", "example":false }, "rvcType25":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 25", "type":"boolean", "example":false }, "rvcType26":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 26", "type":"boolean", "example":false }, "rvcType27":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 27", "type":"boolean", "example":false }, "rvcType28":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 28", "type":"boolean", "example":false }, "rvcType29":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 29", "type":"boolean", "example":false }, "rvcType30":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 30", "type":"boolean", "example":false }, "rvcType31":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 31", "type":"boolean", "example":false }, "rvcType32":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 32", "type":"boolean", "example":true } } }, "dscItmzr":{ "description":"A string value of 0s & 1s of length 15 representing the enablement or disablement of the discount itemizers on which the discount is computable", "type":"string", "example":"000000000000000" }, "dscItmzrExt":{ "description":"An object containing the descriptive list associated with the condiment set associated with the menu item", "type":"object", "properties":{ "dscItmzr1":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 1", "type":"boolean", "example":false }, "dscItmzr2":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 2", "type":"boolean", "example":false }, "dscItmzr3":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 3", "type":"boolean", "example":false }, "dscItmzr4":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 4", "type":"boolean", "example":false }, "dscItmzr5":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 5", "type":"boolean", "example":false }, "dscItmzr6":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 6", "type":"boolean", "example":false }, "dscItmzr7":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 7", "type":"boolean", "example":false }, "dscItmzr8":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 8", "type":"boolean", "example":false }, "dscItmzr9":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 9", "type":"boolean", "example":false }, "dscItmzr10":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 10", "type":"boolean", "example":false }, "dscItmzr11":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 11", "type":"boolean", "example":false }, "dscItmzr12":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 12", "type":"boolean", "example":false }, "dscItmzr13":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 13", "type":"boolean", "example":false }, "dscItmzr14":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 14", "type":"boolean", "example":false }, "dscItmzr15":{ "description":"A Boolean flag indicating if the discount is computable on discount itemizer 15", "type":"boolean", "example":false } } }, "menuLevels":{ "description":"An object containing the menu levels on which the discount is active", "type":"object", "properties":{ "mainLevel":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the discount on main levels", "type":"string", "example":"00000000" }, "mainLevelExt":{ "description":"An object containing the descriptive list associated with the enablement or disablement of the discount on main level", "type":"object", "properties":{ "mainLevel1":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 1", "type":"boolean", "example":false }, "mainLevel2":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 2", "type":"boolean", "example":false }, "mainLevel3":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 3", "type":"boolean", "example":false }, "mainLevel4":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 4", "type":"boolean", "example":false }, "mainLevel5":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 5", "type":"boolean", "example":false }, "mainLevel6":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 6", "type":"boolean", "example":false }, "mainLevel7":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 7", "type":"boolean", "example":false }, "mainLevel8":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 8", "type":"boolean", "example":false } } }, "sublevel":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the discount on sub levels", "type":"string", "example":"00000000" }, "subLevelExt":{ "description":"An object containing the descriptive list associated with the enablement or disablement of the discount on sub level", "type":"object", "properties":{ "subLevel1":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 1", "type":"boolean", "example":false }, "subLevel2":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 2", "type":"boolean", "example":false }, "subLevel3":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 3", "type":"boolean", "example":false }, "subLevel4":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 4", "type":"boolean", "example":false }, "subLevel5":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 5", "type":"boolean", "example":false }, "subLevel6":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 6", "type":"boolean", "example":false }, "subLevel7":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 7", "type":"boolean", "example":false }, "subLevel8":{ "description":"A Boolean flag indicating if the discount is available at Revenue Center Type 8", "type":"boolean", "example":false } } } } }, "transDefaultMainLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Main Level after pressing the discount", "type":"boolean", "example":false }, "mainLevelPopup":{ "description":"The Main Level that activates after pressing the discount", "type":"integer", "example":1 }, "transDefaultSubLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Sub Level after pressing the discount.", "type":"boolean", "example":false }, "subLevelPopup":{ "description":"The Sub Level that activates after pressing the discount", "type":"integer", "example":1 }, "sluObjNum":{ "description":"Object number of the Screen Lookup key for the discount.", "type":"integer", "example":1 }, "nlu":{ "description":"A unique Number Lookup (0-9,999,999,999) for the discount", "type":"integer", "example":1 }, "autoRule":{ "description":"Determine how Simphony calculates a discount", "type":"object", "properties":{ "autoRuleType":{ "description":"The types of Automatic Discounts rule;0 - Not Active;1 - Item Price Substitution;2 - Quantity Threshold;3 - Total Price Threshold;4 - Combination Pricing;5 - Sales Price", "type":"integer", "example":1 }, "constraintType":{ "description":"The types of Discounts Constraints;1-No Constraint, 2-Menu Item,3-Major Group,4-Family Group, Applicable only for autoRuleType 2 and 3.", "type":"integer", "example":1 }, "awardAlgorithm":{ "description":"The award algorithm to be used in the discount.;1- Best Deal for Customer to apply the highest discount amount to the check;2 - Best Deal for Merchant to apply the lowest discount amount to the check", "type":"integer", "example":1 }, "priority":{ "description":"The order in which the POS client calculates discounts. Applicable only for autoRuleType 1-4", "type":"integer", "example":1 }, "maxCountPerCheck":{ "description":"The maximum number of times the coupon discount can be entered on a check. Enter 0 for unlimited entries", "type":"integer", "example":1 }, "usePriceInMIGroupDetail":{ "description":"A Boolean flag indicating to use the Menu Item Groups promotion price for the discounted menu item. Does not function with Combination Pricing Discounts. Applicable only for autoRuleType - 1,2,3 and 5", "type":"boolean", "example":false }, "allowAwardOfHigherPricedTriggerItem":{ "description":"A Boolean flag indicating to allow award of a higher priced trigger item if the trigger item is also an award item. Applicable only for autoRuleType - 2 and 3", "type":"boolean", "example":false }, "triggerGroups":{ "description":"Menu Item Group to trigger the discount award.", "type":"array", "items":{ "type":"object", "properties":{ "sequenceNum":{ "description":"Sequence Number of the Menu Item Group", "type":"integer", "example":1 }, "triggerMIGroupObjNum":{ "description":"Object number of the Menu Item Group to trigger the discount award.", "type":"integer", "example":1 }, "triggerCondimentGroupObjNum":{ "description":"Object number of the Condiment Menu Item Group to use as the trigger for the discount", "type":"integer", "example":1 }, "minimumQuantity":{ "description":"Number of items that customers must order from the corresponding trigger menu group before applying the discount award.", "type":"integer", "example":1 }, "total":{ "description":"Total amount of corresponding trigger menu item group items customers must order before applying the discount", "type":"number", "example":1 } } } }, "awardGroups":{ "description":"An array of award groups for the discount", "type":"array", "items":{ "type":"object", "properties":{ "sequenceNum":{ "description":"The sequence number of the award group", "type":"integer", "example":1 }, "awardMIGroupObjNum":{ "description":"Object number of the menu item group that is to be discounted. Applicable only for autoRuleType - 2 and 3", "type":"integer", "example":1 }, "awardType":{ "description":"Type of the award;0 - None;1 - Percent Off;2 - Amount Off;3 - Amount Substitution", "type":"integer", "example":1 }, "percentOff":{ "description":"The percentage of the percent-based discount. Applicable only for awardType - 1. Value must lie between 0 and 1. For Example 15% will be 0.15 in the 200 response body.", "type":"integer", "example":1 }, "amountOff":{ "description":"The discount amount for flat amount-based discount. Applicable only for awardType - 2", "type":"number", "example":1 }, "amountSubstitution":{ "description":"The price to charge for each item in the Trigger Menu Item Group. Applicable only for awardType - 3", "type":"number", "example":1 }, "awardCount":{ "description":"The maximum number of items discounted after reaching the Trigger MI Group's Minimum Quantity", "type":"number", "example":1 }, "maxCount":{ "description":"When Simple Transaction Exclusivity is set for this discount, enter the maximum number of discounts that can be applied to one check. Applicable only for autoRuleType - 1-4", "type":"number", "example":1 } } } } } }, "exclusivity":{ "description":"Exclusivity stops all discounts from applying to a check at once. Discount exclusivity controls how multiple discounts interact with each other.", "type":"object", "properties":{ "transaction":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the discount on transactions", "type":"string", "example":"00000000000000000000000000000000" }, "transactionExt":{ "description":"An object containing the descriptive list associated with the enablement or disablement of the discount on transactions", "type":"object", "properties":{ "transaction1":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 1", "type":"boolean", "example":false }, "transaction2":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 2", "type":"boolean", "example":false }, "transaction3":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 3", "type":"boolean", "example":false }, "transaction4":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 4", "type":"boolean", "example":false }, "transaction5":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 5", "type":"boolean", "example":false }, "transaction6":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 6", "type":"boolean", "example":false }, "transaction7":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 7", "type":"boolean", "example":false }, "transaction8":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 8", "type":"boolean", "example":false }, "transaction9":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 9", "type":"boolean", "example":false }, "transaction10":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 10", "type":"boolean", "example":false }, "transaction11":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 11", "type":"boolean", "example":false }, "transaction12":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 12", "type":"boolean", "example":false }, "transaction13":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 13", "type":"boolean", "example":false }, "transaction14":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 14", "type":"boolean", "example":false }, "transaction15":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 15", "type":"boolean", "example":false }, "transaction16":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 16", "type":"boolean", "example":false }, "transaction17":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 17", "type":"boolean", "example":false }, "transaction18":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 18", "type":"boolean", "example":false }, "transaction19":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 19", "type":"boolean", "example":false }, "transaction20":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 20", "type":"boolean", "example":false }, "transaction21":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 21", "type":"boolean", "example":false }, "transaction22":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 22", "type":"boolean", "example":false }, "transaction23":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 23", "type":"boolean", "example":false }, "transaction24":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 24", "type":"boolean", "example":false }, "transaction25":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 25", "type":"boolean", "example":false }, "transaction26":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 26", "type":"boolean", "example":false }, "transaction27":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 27", "type":"boolean", "example":false }, "transaction28":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 28", "type":"boolean", "example":false }, "transaction29":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 29", "type":"boolean", "example":false }, "transaction30":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 30", "type":"boolean", "example":false }, "transaction31":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 31", "type":"boolean", "example":false }, "transaction32":{ "description":"A Boolean flag indicating the discount to be applicable to entire check transaction 32", "type":"boolean", "example":false } } }, "item":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the discount on specific menu items", "type":"string", "example":"00000000000000000000000000000000" }, "itemExt":{ "description":"An object containing the descriptive list associated with the enablement or disablement of the discount on specific menu items", "type":"object", "properties":{ "item1":{ "description":"A Boolean flag indicating to apply discount to a menu item 1.", "type":"boolean", "example":false }, "item2":{ "description":"A Boolean flag indicating to apply discount to a menu item 2.", "type":"boolean", "example":false }, "item3":{ "description":"A Boolean flag indicating to apply discount to a menu item 3.", "type":"boolean", "example":false }, "item4":{ "description":"A Boolean flag indicating to apply discount to a menu item 4.", "type":"boolean", "example":false }, "item5":{ "description":"A Boolean flag indicating to apply discount to a menu item 5.", "type":"boolean", "example":false }, "item6":{ "description":"A Boolean flag indicating to apply discount to a menu item 6.", "type":"boolean", "example":false }, "item7":{ "description":"A Boolean flag indicating to apply discount to a menu item 7.", "type":"boolean", "example":false }, "item8":{ "description":"A Boolean flag indicating to apply discount to a menu item 8.", "type":"boolean", "example":false }, "item9":{ "description":"A Boolean flag indicating to apply discount to a menu item 9.", "type":"boolean", "example":false }, "item10":{ "description":"A Boolean flag indicating to apply discount to a menu item 10.", "type":"boolean", "example":false }, "item11":{ "description":"A Boolean flag indicating to apply discount to a menu item 11.", "type":"boolean", "example":false }, "item12":{ "description":"A Boolean flag indicating to apply discount to a menu item 12.", "type":"boolean", "example":false }, "item13":{ "description":"A Boolean flag indicating to apply discount to a menu item 13.", "type":"boolean", "example":false }, "item14":{ "description":"A Boolean flag indicating to apply discount to a menu item 14.", "type":"boolean", "example":false }, "item15":{ "description":"A Boolean flag indicating to apply discount to a menu item 15.", "type":"boolean", "example":false }, "item16":{ "description":"A Boolean flag indicating to apply discount to a menu item 16.", "type":"boolean", "example":false }, "item17":{ "description":"A Boolean flag indicating to apply discount to a menu item 17.", "type":"boolean", "example":false }, "item18":{ "description":"A Boolean flag indicating to apply discount to a menu item 18.", "type":"boolean", "example":false }, "item19":{ "description":"A Boolean flag indicating to apply discount to a menu item 19.", "type":"boolean", "example":false }, "item20":{ "description":"A Boolean flag indicating to apply discount to a menu item 20.", "type":"boolean", "example":false }, "item21":{ "description":"A Boolean flag indicating to apply discount to a menu item 21.", "type":"boolean", "example":false }, "item22":{ "description":"A Boolean flag indicating to apply discount to a menu item 22.", "type":"boolean", "example":false }, "item23":{ "description":"A Boolean flag indicating to apply discount to a menu item 23.", "type":"boolean", "example":false }, "item24":{ "description":"A Boolean flag indicating to apply discount to a menu item 24.", "type":"boolean", "example":false }, "item25":{ "description":"A Boolean flag indicating to apply discount to a menu item 25.", "type":"boolean", "example":false }, "item26":{ "description":"A Boolean flag indicating to apply discount to a menu item 26.", "type":"boolean", "example":false }, "item27":{ "description":"A Boolean flag indicating to apply discount to a menu item 27.", "type":"boolean", "example":false }, "item28":{ "description":"A Boolean flag indicating to apply discount to a menu item 28.", "type":"boolean", "example":false }, "item29":{ "description":"A Boolean flag indicating to apply discount to a menu item 29.", "type":"boolean", "example":false }, "item30":{ "description":"A Boolean flag indicating to apply discount to a menu item 30.", "type":"boolean", "example":false }, "item31":{ "description":"A Boolean flag indicating to apply discount to a menu item 31.", "type":"boolean", "example":false }, "item32":{ "description":"A Boolean flag indicating to apply discount to a menu item 32.", "type":"boolean", "example":false } } } } }, "orderChannelRestrictions":{ "description":"The order channels that are considered for the discount. Each objectNum belongs to a particular order channel.", "type":"array", "items":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "description":"objectNum of a particular order channel", "example":1 } } }, "example":[ { "objectNum":4 } ] }, "orderTypeRestrictions":{ "description":"A String of Values of 0s and 1s of length 32 representing ordertypes from 1 to 32, with a value of 1 indicating respected order type is included and 0 indicating exclusion.", "type":"string", "example":"11100000000000000000000000000000" }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } }, "FamilyGroupv1":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the family group" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "consumerDesc":{ "type":"object", "description":"Consumer Description. Maximum length supported is 1024 characters.", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "consumerName":{ "type":"object", "description":"Consumer Name", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "majorGrpObjNum":{ "type":"integer", "example":2, "description":"Object number of the major group" }, "majorGrpName":{ "type":"object", "description":"Major Group Name", "example":{ "en-US":"Major Group 1", "de-DE":"Hauptgruppe 1", "es-MX":"Grupo principal 1" } }, "reportGroup":{ "description":"Object number of the Report Group.", "type":"integer", "example":1 }, "images":{ "type":"array", "description":"An array of images associated with the family group", "items":{ "$ref":"#/definitions/FamilyGroup_image" } } }, "description":"Model for Family Group Object" }, "FamilyGroupv1GetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Family Groups objects of the organization.", "items":{ "$ref":"#/definitions/FamilyGroupv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "FamilyGroupv2GetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Family Groups objects of the organization.", "items":{ "$ref":"#/definitions/FamilyGroupv2" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "FamilyGroupv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the family group" }, "name":{ "type":"object", "description":"Family Group Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "consumerDesc":{ "type":"object", "description":"Consumer Description. Maximum length supported is 1024 characters.", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "consumerName":{ "type":"object", "description":"Consumer Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "majorGrpObjNum":{ "type":"integer", "example":2, "description":"Object number of the major group" }, "reportGroup":{ "description":"Object number of the Report Group.", "type":"integer", "example":1 }, "images":{ "type":"array", "description":"An array of images associated with the family group", "items":{ "$ref":"#/definitions/FamilyGroup_image" } } }, "description":"Model for Family Group Object" }, "FamilyGroupCUDRequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit of an Enterprise" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the family group" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "consumerDesc":{ "type":"object", "description":"Consumer Description. Maximum length supported is 1024 characters.", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "consumerName":{ "type":"object", "description":"Consumer Name", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "majorGrpObjNum":{ "type":"integer", "example":2, "description":"Object number of the major group" }, "reportGroup":{ "description":"Object number of the Report Group.", "type":"integer", "example":1 }, "images":{ "type":"array", "description":"An array of images associated with the family group", "items":{ "$ref":"#/definitions/FamilyGroup_image" } } }, "description":"Model for Family Group Object" }, "FamilyGroupResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the family group" } } }, "FamilyGroup_image":{ "type":"object", "properties":{ "imageIndex":{ "type":"integer", "example":1, "description":"Image Number for reference. Values range from 1-10." }, "url":{ "type":"string", "example":"https://oracleObjectStore.com/images/coffee822815.jpg", "description":"The URL of the image of the family group" }, "altText":{ "type":"string", "example":"pizza", "description":"The image alternative text of the family group" }, "description":{ "type":"string", "example":"pizza description", "description":"The description text of the family group" }, "isCloudImage":{ "type":"boolean", "example":true, "description":"Flag indicating if the image is stored on the Cloud" }, "size":{ "type":"string", "example":"1", "description":"The size of the image" } } }, "DeviceStatusDetails":{ "description":"Device Status Details record", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit reference", "type":"integer", "example":100 }, "serviceHostId":{ "description":"Unique service host reference", "type":"integer", "example":244 }, "clientApplicationLoader":{ "type":"object", "properties":{ "calActiveHostUrl":{ "type":"string", "description":"URL the CAL client connects too", "example":"https://wfivm05017.us.oracle.com:443/EGateway/EGateway.asmx" }, "calEnabled":{ "type":"string", "description":"Indicates if CAL client is enabled", "example":"True" }, "calPreviousUrl":{ "type":"string", "description":"deprecated", "example":null }, "calTlsActive":{ "type":"string", "description":"Indicates if CAL client uses HTTPS", "example":"True" }, "calUrlMatching":{ "type":"string", "description":"deprecated", "example":"NA" }, "calVersion":{ "type":"string", "description":"CAL client version", "example":"3.1.4.159" }, "dcalInUse":{ "type":"string", "description":"Indicates if DCAL is in use", "example":"False" }, "enterpriseUrl":{ "type":"string", "description":"Enterprise EGateway URL", "example":"https://wfivm05017.us.oracle.com:443/EGateway/EGateway.asmx" }, "status":{ "type":"boolean", "description":"CAL client health status (true - healthy; false - not healthy)", "example":true } } }, "clientVersion":{ "type":"string", "description":"Simphony software version", "example":"19.7.0.0.247" }, "databaseInformation":{ "type":"object", "description":"Shows version information and make of the database", "properties":{ "database":{ "description":"Database name", "type":"string", "example":"MySQL" }, "edition":{ "type":"string", "description":"Database edition", "example":"MySQL Enterprise Server - Commercial" }, "versionDetails":{ "type":"string", "description":"Database version", "example":"8.0.36-commercial" } } }, "dateTime":{ "type":"string", "description":"Time and date of data reported", "example":"2024-07-04T23:30:05" }, "directorySecurity":{ "type":"object", "description":"Shows information on the accessibility of directory", "properties":{ "allUsersProfile":{ "type":"string", "example":"True" }, "appRoot":{ "type":"string", "example":"True" }, "kdsRoot":{ "type":"string", "example":"NA" }, "systemDrive":{ "type":"string", "example":"True" }, "status":{ "type":"boolean", "description":"Directory accessibility health status (true - healthy; false - not healthy)", "example":true } } }, "displayInformation":{ "type":"object", "description":"The device's display information", "properties":{ "dpi":{ "type":"object", "description":"The pixel density of the screen (pixels/inch)", "properties":{ "dpiX":{ "type":"integer", "description":"Horizontal resolution", "example":695 }, "dpiY":{ "type":"integer", "description":"Vertical resolution", "example":1304 } } }, "orientation":{ "type":"string", "description":"The device's display orientation", "example":"Landscape" }, "resolution":{ "type":"object", "description":"The device's display resolution", "properties":{ "height":{ "type":"integer", "example":695 }, "width":{ "type":"integer", "example":1304 } } }, "screenSize":{ "type":"string", "description":"The device's screen size", "example":"15.4 Inch" }, "status":{ "type":"boolean", "description":"Display health status (true - healthy; false - not healthy)", "example":true } } }, "networkDetails":{ "type":"object", "properties":{ "dns1":{ "type":"string", "example":"206.223.27.1" }, "dns2":{ "type":"string", "example":"206.223.27.2" }, "defaultGateway":{ "type":"string", "example":"10.22.64.1" }, "ipAddress":{ "type":"string", "example":"10.22.94.139" }, "status":{ "type":"boolean", "example":false } } }, "operatingSystemDetails":{ "type":"object", "description":"Operating System Information", "properties":{ "buildNumber":{ "type":"string", "example":null }, "buildVersion":{ "type":"integer", "example":19044 }, "cpu":{ "type":"string", "example":null }, "edition":{ "type":"string", "example":"Enterprise" }, "majorVersion":{ "type":"integer", "example":10 }, "minorVersion":{ "type":"integer", "example":0 }, "name":{ "type":"string", "description":"The device operating system name", "example":"Windows 10" }, "osAutoLogonEnabled":{ "type":"string", "example":"False" }, "osBits":{ "type":"string", "example":"Bit64" }, "osPendingReboot":{ "type":"string", "description":"Whether a reboot is pending because of a Windows update", "example":"True" }, "platform":{ "type":"string", "description":"The device operating system", "example":"Win32NT" }, "processor":{ "type":"string", "example":"Intel Xeon Processor (Skylake IBRS no TSX)" }, "processorBits":{ "type":"string", "example":"Bit64" }, "programBits":{ "type":"string", "example":"Bit32" }, "revisionVersion":{ "type":"integer", "example":0 }, "servicePack":{ "type":"string", "example":null }, "version":{ "type":"string", "example":"10.0.19044.0" }, "versionString":{ "type":"string", "example":"Microsoft Windows NT 6.2.9200.0" }, "status":{ "type":"boolean", "description":"Operating System health status (true - healthy; false - not healthy)", "example":false } } }, "overallStatus":{ "type":"boolean", "description":"Service Host health status (true - healthy; false - not healthy)", "example":true }, "port":{ "type":"integer", "example":443 }, "securityDetails":{ "type":"object", "properties":{ "dbAdminLoginPossible":{ "type":"string", "description":"Whether the database administrator can log in to the local client database", "example":"True" }, "dbMeetsMaxLoginFailure":{ "type":"string", "description":"Whether the maximum log-in failure meets the requirements, which is minimum 8 for normal clients", "example":"True" }, "dbPendingCredentialsChanges":{ "type":"string", "description":"Whether database credential changes are pending, which require a restart.", "example":"False" }, "passwordPolicy":{ "type":"string", "description":"Does the password policy prevent successful update of the database password.", "example":"False" }, "status":{ "type":"boolean", "description":"Security health status (true - healthy; false - not healthy)", "example":true } } }, "serviceHost":{ "type":"object", "description":"Service host information", "properties":{ "serviceHostId":{ "type":"integer", "description":"Unique service host reference", "example":744 }, "serviceHostName":{ "type":"string", "description":"Name of the service host", "example":"wfivm06386" }, "workstationId":{ "type":"integer", "description":"Unique workstation reference", "example":745 } } }, "simphonySoftwareInformation":{ "type":"array", "items":{ "type":"object", "properties":{ "creationTime":{ "type":"string", "example":"2024-06-26T06:34:16" }, "fileSize":{ "type":"string", "example":"33.6" }, "lastModifiedTime":{ "type":"string", "example":"2024-06-26T10:16:54" }, "name":{ "type":"string", "example":"AuthenticationServer.exe" }, "productVersion":{ "type":"string", "example":"19.7.0.0.247" }, "status":{ "type":"boolean", "example":true } } } }, "wsAuthKey":{ "type":"object", "properties":{ "canConnect":{ "type":"boolean", "example":true }, "preset":{ "type":"boolean", "example":false }, "status":{ "type":"boolean", "example":false } } }, "workstationHardware":{ "type":"object", "description":"Workstation information", "properties":{ "appRootDirectory":{ "type":"string", "description":"Root directory of the workstation", "example":"C:" }, "cpuUsage":{ "type":"string", "description":"CPU usage of the workstation", "example":"32.57715 %" }, "diskSpaceAvailable":{ "type":"boolean", "description":"Indicates if the available disk space exceeds the minimum requirement of 1.5 GB.", "example":true }, "driveInfo":{ "type":"array", "items":{ "type":"object", "properties":{ "availableFreeSpace":{ "type":"string", "example":"126.965 GB" }, "driveLetter":{ "type":"string", "example":"C:\\Micros\\Simphony\\" }, "totalSize":{ "type":"string", "example":"199.949 GB" } } } }, "mainboardSerialNumber":{ "type":"string", "example":"NA" }, "ram":{ "type":"string", "description":"Total RAM of the workstation", "example":"16GB" }, "systemSerialNumber":{ "type":"string", "example":"NA" }, "workstationModel":{ "type":"string", "description":"The model type of the workstation", "example":"Generic Device" }, "status":{ "type":"boolean", "description":"Workstation health status (true - healthy; false - not healthy)", "example":true } } } } }, "TagsGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Tag objects.", "items":{ "$ref":"#/definitions/TagsGetResponseBody" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "TagsGetResponseBody":{ "description":"Model for Tag Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the Tag or the Dietary Label is configured. Only Enterprise hierUnitId is allowed.", "type":"integer", "example":3599 }, "objectNum":{ "type":"integer", "description":"Object Number of a Tag or a Dietary Label.", "example":200 }, "name":{ "description":"A string representing the name of the Tag or a Dietary Label.", "type":"string", "maxLength":255, "minLength":1, "example":"Tag" }, "tagGroupObjNum":{ "type":"integer", "description":"Object number of the Tag Group associated with the tag. It must not be included in the Insert request body and is ignored in the Update request body when dietaryLabel is set to 1.", "example":5 }, "dietaryLabel":{ "type":"integer", "default":0, "description":"A flag indicating a dietary label when set to 1. Permissible values are 0 and 1. It cannot be updated once set. Introduced in C&C API v23.7.", "example":1 } } }, "TagsResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique reference of the hierarchy unit where the Tag or the Dietary Label is configured. Only Enterprise hierUnitId is allowed.", "example":3599 }, "objectNum":{ "description":"Object Number of a Tag or a Dietary Label.", "type":"integer", "example":200 } } }, "DataExtensionResourceObject":{ "description":"Model for Data Extension Object", "type":"object", "properties":{ "objectNum":{ "description":"Object Number of the Data Extension property.", "type":"integer", "example":1 }, "extraColumnName":{ "description":"name of the data extension property, cannot be empty. Maximum allowed length of string is 128.", "type":"string", "example":"isKiosk" }, "type":{ "type":"integer", "description":"Type of data that can be inserted for this data extension property.\n\n** Below is a list of acceptable values for type\n\n|Type |Description |\n|-----|--------------|\n|0 |Text |\n|1 |Multiline Text|\n|2 |Number |\n|3 |Decimal |\n|4 |Boolean |\n|5 |Date |\n|6 |Time |\n|7 |Date/Time |\n|8 |Text List |\n|9 |Lookup List |\n|10 |Big Text List |\n|11 |XML Document |\n|12 |JSON |\n", "example":1 }, "dataConstraints":{ "description":"Constraints on the values that can be inserted for this data extension property. Note that for 'Boolean' and \"XML Document\" types, data constraints are not required. For all other types, this is a required field", "type":"object", "properties":{ "maxChars":{ "description":"maximum characters allowed. For types- Text and JSON", "type":"integer", "example":128 }, "lines":{ "description":"number of lines allowed. For types- Multiline Text", "example":2, "type":"integer" }, "minValue":{ "description":"minimum value for the allowed range. For types- Number, Decimal", "type":"number", "example":0 }, "maxValue":{ "description":"maximum value for the allowed range. For types- Number, Decimal", "type":"number", "example":9999 }, "dateTimeFormat":{ "description":"Valid Date/Time format. For types- Date, Time, Date/Time. Following is the format in which each of the mentioned fields should be passed:\nyear: yyyy or yy\nmonth: MM or M\ndate: dd or d\nhour: HH or H or h or hh\nminute: mm or m or mm:ss\ndisplay_type: t or tt (optional and applicable only when hour is in 'h' or 'hh' format)\ndate_format: year/month/date or month/date/year or date/month/year or year-month-date or month-date-year or date-month-year\ntime_format: hour:minute display_type\ndateTime format: date_format time_format\n", "type":"string", "example":"yyyy/MM/dd hh:mm t" }, "lookupList":{ "description":"List to choose data values from. For types- Lookup List, Text List, Big Text List", "type":"object", "example":{ "1":"Entry-1", "2":"Entry-2", "3":"Entry-3" } } } }, "tableNum":{ "description":"Object Number of the table.\n\n** Below table descibes acceptable values for tableNum and the corresponding table Name\n\n| tableNum | tableName |\n|-----------|--------------------|\n| 17 |Hierarchy Unit |\n| 20 |Revenue Center |\n| 25 |Order Type |\n| 41 |Workstations |\n| 50 |Currency |\n| 54 |Tax Class |\n| 58 |Menu Item Class |\n| 67 |Discount |\n| 70 |Service Charge |\n| 71 |Tender/Media |\n| 85 |Job Code |\n| 104 |Employee Class |\n| 106 |Employee |\n| 128 |Serving Period |\n| 131 |Menu Item Master |\n| 134 |Menu Item Definition|\n| 138 |Effectivity Groups |\n| 1001 |Property |\n| 1010 |Role |\n", "type":"integer", "example":1 }, "sortPriority":{ "type":"integer", "example":1, "description":"sort priority of the property." }, "displayWidth":{ "description":"The display width of the column, acceptable values include null, 30-999 inclusive", "type":"integer", "example":150 }, "translatableName":{ "description":"A string that contains translations of column name for the property", "type":"object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "ar-AR":"?????" } }, "translatableHelp":{ "description":"A string that contains translations of help for the property", "type":"object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "ar-AR":"?????" } }, "isEditable":{ "description":"boolean value to specify if the property is editable. Default Value = true", "type":"boolean", "example":true }, "isViewable":{ "description":"boolean value to specify if the property is viewable. Default Value = true", "type":"boolean", "example":true }, "isDownloadable":{ "description":"boolean value to specify if the property is downloadable. Default Value = true", "type":"boolean", "example":true } } }, "DataExtensionResponseBody":{ "description":"Model for Data Extension Object", "type":"object", "properties":{ "objectNum":{ "description":"Object Number of the Data Extension property.", "type":"integer", "example":1 }, "tableNum":{ "description":"Object Number of the table.", "type":"integer", "example":1 }, "tableName":{ "description":"Name of the table.", "type":"string", "example":"workstation" }, "extraColumnName":{ "description":"name of the data extension property, cannot be empty.", "type":"string", "example":"isKiosk" }, "type":{ "type":"integer", "description":"Type of data that can be inserted for this data extension property.\n\n** Below is a list of acceptable values for type\n\n|Type |Description |\n|-----|--------------|\n|0 |Text |\n|1 |Multiline Text|\n|2 |Number |\n|3 |Decimal |\n|4 |Boolean |\n|5 |Date |\n|6 |Time |\n|7 |Date/Time |\n|8 |Text List |\n|9 |Lookup List |\n|10 |Big Text List |\n|11 |XML Document |\n|12 |JSON |\n", "example":1 }, "sortPriority":{ "type":"integer", "example":1, "description":"sort priority of the property." }, "displayWidth":{ "description":"This value sets the width of the column when it is displayed in EMC", "type":"integer", "example":150 }, "valueLimits":{ "description":"Extension data property value limit.", "type":"string", "example":"128" }, "translatableName":{ "description":"A string that contains translations of column name for the property", "type":"object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "translatableHelp":{ "description":"A string that contains translations of help for the property", "type":"object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "isEditable":{ "description":"boolean value to specify if the property is editable.", "type":"boolean", "example":true }, "isViewable":{ "description":"boolean value to specify if the property is viewable.", "type":"boolean", "example":true }, "isDownloadable":{ "description":"boolean value to specify if the property is downloadable.", "type":"boolean", "example":true }, "dataConstraints":{ "description":"Constraints on the values that can be inserted for this data extension property.", "type":"object", "properties":{ "maxChars":{ "description":"maximum characters allowed. For types- Text and JSON", "type":"integer", "example":128 }, "lines":{ "description":"number of lines allowed. For types- Multiline Text", "example":2, "type":"integer" }, "minValue":{ "description":"minimum value for the allowed range. For types- Number, Decimal", "type":"number", "example":0 }, "maxValue":{ "description":"maximum value for the allowed range. For types- Number, Decimal", "type":"number", "example":9999 }, "dateTimeFormat":{ "description":"Valid Date/Time format. For types- Date, Time, Date/Time.\n", "type":"string", "example":"yyyy/MM/dd hh:mm t" }, "lookupList":{ "description":"List to choose data values from. For types- Lookup List, Text List, Big Text List", "type":"object", "example":{ "1":"Entry-1", "2":"Entry-2", "3":"Entry-3" } } } } } }, "DataExtensionsv2":{ "description":"Model for Data Extension Object", "type":"object", "properties":{ "objectNum":{ "description":"Object Number of the Data Extension property.", "type":"integer", "example":1 }, "tableNum":{ "description":"Object Number of the table.", "type":"integer", "example":1 }, "tableName":{ "description":"Name of the table.", "type":"string", "example":"workstation" }, "extraColumnName":{ "description":"name of the data extension property, cannot be empty.", "type":"string", "example":"isKiosk" }, "type":{ "type":"integer", "description":"Type of data that can be inserted for this data extension property.\n\n** Below is a list of acceptable values for type\n\n|Type |Description |\n|-----|--------------|\n|0 |Text |\n|1 |Multiline Text|\n|2 |Number |\n|3 |Decimal |\n|4 |Boolean |\n|5 |Date |\n|6 |Time |\n|7 |Date/Time |\n|8 |Text List |\n|9 |Lookup List |\n|10 |Big Text List |\n|11 |XML Document |\n|12 |JSON |\n", "example":1 }, "sortPriority":{ "type":"integer", "example":1, "description":"sort priority of the property." }, "valueLimits":{ "description":"Extension data property value limit.", "type":"string", "example":"128" }, "displayWidth":{ "description":"This value sets the width of the column when it is displayed in EMC", "type":"integer", "example":150 }, "translatableName":{ "description":"A string that contains translations of column name for the property", "type":"object", "example":{ "1":"Property", "2":"Eigentum", "3":"Propiedad" } }, "translatableHelp":{ "description":"A string that contains translations of help for the property", "type":"object", "example":{ "1":"Property", "2":"Eigentum", "3":"Propiedad" } }, "isEditable":{ "description":"boolean value to specify if the property is editable.", "type":"boolean", "example":true }, "isViewable":{ "description":"boolean value to specify if the property is viewable.", "type":"boolean", "example":true }, "isDownloadable":{ "description":"boolean value to specify if the property is downloadable.", "type":"boolean", "example":true }, "dataConstraints":{ "description":"Constraints on the values that can be inserted for this data extension property.", "type":"object", "properties":{ "maxChars":{ "description":"maximum characters allowed. For types- Text and JSON", "type":"integer", "example":128 }, "lines":{ "description":"number of lines allowed. For types- Multiline Text", "example":2, "type":"integer" }, "minValue":{ "description":"minimum value for the allowed range. For types- Number, Decimal", "type":"number", "example":0 }, "maxValue":{ "description":"maximum value for the allowed range. For types- Number, Decimal", "type":"number", "example":9999 }, "dateTimeFormat":{ "description":"Valid Date/Time format. For types- Date, Time, Date/Time.\n", "type":"string", "example":"yyyy/MM/dd hh:mm t" }, "lookupList":{ "description":"List to choose data values from. For types- Lookup List, Text List, Big Text List", "type":"object", "example":{ "1":"Entry-1", "2":"Entry-2", "3":"Entry-3" } } } } } }, "DataExtensionsGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of data extension objects of the organization.", "items":{ "$ref":"#/definitions/DataExtensionResponseBody" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "DataExtensionsResponse":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object number of the data extension property" } } }, "DataExtensionsDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "PaymentDriver":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number" }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the payment driver." }, "name":{ "description":"A group of string objects representing the name of the payment driver in configured languages", "type":"object", "example":{ "en-US":"Payment Driver", "de-DE":"Zahlungstreiber", "es-MX":"Conductor de pago" } }, "type":{ "type":"integer", "example":26, "description":"the type of the file." }, "filenameOrigin":{ "type":"string", "example":"C:\\Program Files\\Oracle Hospitality\\EMCClient\\OPIPayment.dll", "description":"the content file origin." }, "filename":{ "type":"string", "example":"OPIPayment.dll", "description":"The name of the image file with extension." }, "url":{ "type":"object", "description":"The URL of the download API which needs to be used to download the actual content file. This is auto-generated and does not need to be provided during add/update calls.", "properties":{ "params":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the payment driver", "type":"integer", "example":1 } } }, "endpoint":{ "type":"string", "example":"https://abc.com/content/sim/v1/setup/downloadpaymentdrivers" } } } } }, "PaymentDriverv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the payment driver." }, "name":{ "description":"A group of string objects representing the name of the payment driver in configured languages", "type":"object", "example":{ "1":"Payment Driver", "2":"Zahlungstreiber", "3":"Conductor de pago" } }, "type":{ "type":"integer", "example":26, "description":"the type of the file." }, "filenameOrigin":{ "type":"string", "example":"C:\\Program Files\\Oracle Hospitality\\EMCClient\\OPIPayment.dll", "description":"the content file origin." }, "filename":{ "type":"string", "example":"OPIPayment.dll", "description":"The name of the image file with extension." }, "url":{ "type":"object", "description":"The URL of the download API which needs to be used to download the actual content file. This is auto-generated and does not need to be provided during add/update calls.", "properties":{ "params":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":2 }, "objectNum":{ "description":"Object Number of the payment driver", "type":"integer", "example":1 } } }, "endpoint":{ "type":"string", "example":"https://abc.com/content/sim/v1/setup/downloadpaymentdrivers" } } } } }, "PaymentDriverCURequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name", "displayName", "passphrase" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the payment driver." }, "name":{ "description":"A group of string objects representing the name of the payment driver in configured languages", "type":"object", "example":{ "en-US":"Payment Driver", "de-DE":"Zahlungstreiber", "es-MX":"Conductor de pago" } }, "displayName":{ "type":"string", "example":"Payment Driver", "description":"Class name of the driver to be instantiated." }, "passphrase":{ "type":"string", "example":"Pa$$woRd123", "description":"Enter the authentication passphrase (OPI Only)." }, "type":{ "type":"integer", "example":26, "description":"the type of the file." }, "filenameOrigin":{ "type":"string", "example":"C:\\Program Files\\Oracle Hospitality\\EMCClient\\OPIPayment.dll", "description":"the content file origin." }, "filename":{ "type":"string", "example":"OPIPayment.dll", "description":"The name of the image file with extension." } } }, "PaymentDriverResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value." }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the payment driver." } } }, "PaymentDriverGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Payment Drivers objects of the organization.", "items":{ "$ref":"#/definitions/PaymentDriver" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "MenuItem2v1":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "familyGroupObjectNum":{ "type":"integer", "example":1, "description":"Family group object number" }, "majorGroupObjectNum":{ "type":"integer", "example":2, "description":"Major group object number" }, "masterGroupObjectNum":{ "type":"integer", "example":2, "description":"Master group object number" }, "reportGroupObjectNum":{ "type":"integer", "example":2, "description":"Report group object number" }, "dietaryLabels":{ "type":"array", "description":"An array of dietary labels for menu item", "items":{ "$ref":"#/definitions/MenuItem_dietaryLabels" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item", "items":{ "$ref":"#/definitions/MenuItem_dataExtensions" } }, "miMasterOptions":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of lenth 8 representing the enablement or disablement of the options associated" }, "definitions":{ "type":"array", "description":"An Array of Menu Item Definitions", "items":{ "$ref":"#/definitions/MenuItem_definition2" } }, "effectivityGroups":{ "type":"array", "description":"An array of effectivity groups for the menu item", "items":{ "$ref":"#/definitions/MenuItem_effectivityGroups" } } } }, "MenuItem2v1GetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item objects of the organization.", "items":{ "$ref":"#/definitions/MenuItem2v1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "MenuItem2v2":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" }, "definitions":{ "type":"array", "description":"An Array of Menu Item Definitions", "items":{ "$ref":"#/definitions/MenuItem_definitionv2" } } } }, "MenuItem_effectivityGroups":{ "type":"object", "properties":{ "effectivityGroupObjectNum":{ "type":"integer", "example":1, "description":"effectivity group object number" }, "hierUnitId":{ "type":"integer", "example":14102, "description":"hierarchy where the effectivity group is configured" }, "effectivityGroupName":{ "type":"object", "description":"Effectivity Group Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } } } }, "MenuItem_definition2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique value of hierarchy unit" }, "menuItemDefinitionId":{ "type":"integer", "example":1, "description":"Unique reference for the menu item definition" }, "defSequenceNum":{ "type":"integer", "example":1, "description":"Indicates the definition sequence number, which is the number of the definition in the revenue center for this master record.Sequence Number should be with 1-64" }, "firstName":{ "type":"object", "description":"First Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "secondName":{ "type":"object", "description":"Second Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "thirdName":{ "type":"object", "description":"Third Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "longDescriptor":{ "type":"object", "description":"Long Descriptor", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "menuItemClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item Class" }, "overridePrintClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Print Class" }, "mainLevel":{ "type":"string", "example":"11001111", "description":"Main Levels on which the definition is active." }, "subLevel":{ "type":"string", "example":"11001111", "description":"Sub Levels on which the definition is active" }, "slu1ObjNum":{ "type":"integer", "example":200, "description":"Object number of SLU 1 to which the Menu Item Definition belongs" }, "slu2ObjNum":{ "type":"integer", "example":201, "description":"Object number of SLU 2 to which the Menu Item Definition belongs" }, "slu3ObjNum":{ "type":"integer", "example":202, "description":"Object number of SLU 3 to which the Menu Item Definition belongs" }, "slu4ObjNum":{ "type":"integer", "example":203, "description":"Object number of SLU 4 to which the Menu Item Definition belongs" }, "slu5ObjNum":{ "type":"integer", "example":204, "description":"Object number of SLU 5 to which the Menu Item Definition belongs" }, "slu6ObjNum":{ "type":"integer", "example":205, "description":"Object number of SLU 6 to which the Menu Item Definition belongs" }, "slu7ObjNum":{ "type":"integer", "example":206, "description":"Object number of SLU 7 to which the Menu Item Definition belongs" }, "slu8ObjNum":{ "type":"integer", "example":207, "description":"Object number of SLU 8 to which the Menu Item Definition belongs" }, "sluSortPriority":{ "type":"integer", "example":0, "description":"Use this field when Page Design Layout option" }, "nluGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the NLU Group associated with this menu item" }, "nluNum":{ "type":"integer", "example":1, "description":"Unique NLU number for this menu item (up to 12 digits)." }, "tareWeight":{ "type":"integer", "example":"1.23", "description":"Weight of the empty package for an item sold by weight" }, "surcharge":{ "type":"integer", "example":1, "description":"Surcharge for the menu item" }, "quantity":{ "type":"integer", "example":1, "description":"Quantity of a Menu Item" }, "overrideAllergenClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Allergen Class for the menu item definition to override its menu item class setting" }, "kdsPrepTime":{ "type":"integer", "example":"10.3", "description":"The number of minutes necessary to prepare this item" }, "prefixLevelOverride":{ "type":"integer", "example":1, "description":"Select to allow the condiment prefix to override the price level of the item it modifies." }, "guestCount":{ "type":"integer", "example":1, "description":"Guest count for the menu item to increment the check guest count when added." }, "consumerAdvisoryDesc":{ "type":"string", "example":"Menu Item 1", "description":"The consumer advisory description of the menu item" }, "consumerItemName":{ "type":"object", "description":"Consumer Item Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "consumerItemDescription":{ "type":"object", "description":"Consumer Item Description", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "images":{ "type":"array", "description":"An array of images associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_image" } }, "customMenuLevels":{ "type":"array", "description":"An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured", "items":{ "$ref":"#/definitions/MenuItem_customMenuLevel" } }, "defaultCondiments":{ "type":"array", "description":"An array of Default Condiment of a Menu Item", "items":{ "$ref":"#/definitions/MenuItem_defaultCondiment" } }, "productionItems":{ "type":"array", "description":"An array of production items associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_productionItem" } }, "components":{ "type":"array", "description":"An array of components associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_component" } }, "tags":{ "type":"array", "description":"An array of tags associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_tag" } }, "nutrients":{ "type":"array", "description":"An array of nutrients of the menu item", "items":{ "$ref":"#/definitions/MenuItem_nutrient" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item", "items":{ "$ref":"#/definitions/MenuItem_dataExtensions" } }, "prices":{ "type":"array", "description":"An array of Menu Item Prices", "items":{ "$ref":"#/definitions/MenuItem_menuItemPrice" } } } }, "MenuItem_definitionv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Menu Item definition Hierarchy Unit Id" }, "menuItemDefinitionId":{ "type":"integer", "example":1, "description":"Unique reference for the menu item definition" }, "defSequenceNum":{ "type":"integer", "example":1, "description":"Indicates the definition sequence number, which is the number of the definition in the revenue center for this master record.Sequence Number should be with 1-64" }, "prices":{ "type":"array", "description":"An array of Menu Item Prices", "items":{ "$ref":"#/definitions/MenuItem_menuItemPricev2" } } } }, "MenuItem_image":{ "type":"object", "properties":{ "imageIndex":{ "type":"integer", "example":1, "description":"Image Number for reference" }, "url":{ "type":"string", "example":"https://oracleObjectStore.com/images/coffee822815.jpg", "description":"The URL of the image of the menu item" }, "altText":{ "type":"string", "example":"pizza", "description":"The image alternative text of the menu item" }, "description":{ "type":"string", "example":"pizza description", "description":"The description text of the menu item" }, "isCloudImage":{ "type":"boolean", "example":true, "description":"Flag indicating if the image is stored on the Cloud" }, "size":{ "type":"string", "example":1, "description":"The size of the image" } } }, "MenuItem_defaultCondiment":{ "type":"object", "properties":{ "menuItemDefaultCondimentId":{ "type":"integer", "example":1000, "description":"Unique reference of the Menu Item Default Condiment" }, "condimentSetObjNum":{ "type":"integer", "example":1, "description":"Object number of the condiment set" }, "sortGroup":{ "type":"integer", "example":1, "description":"Sort group of the condiment set" }, "options":{ "type":"string", "example":"1000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the default condiments of the menu item. This value is excluded by default in GET response." } } }, "MenuItem_customMenuLevel":{ "type":"object", "properties":{ "menuLevelObjNum":{ "type":"integer", "example":3, "description":"Object number of the menu level" }, "customLevel":{ "type":"string", "example":"11001111", "description":"Flag indicating if the menu item is active on Custom Level" } } }, "MenuItem_productionItem":{ "type":"object", "properties":{ "productionItemObjNum":{ "type":"integer", "example":"false", "description":"Object number of the production item" }, "productionItemCount":{ "type":"integer", "example":"1.4", "description":"The number of portions required to complete the menu item." } } }, "MenuItem_nutrient":{ "type":"object", "properties":{ "nutrientSetObjNum":{ "type":"integer", "example":1, "description":"Object number of the nutrient set" }, "menuItemNutrientSetId":{ "type":"integer", "example":1, "description":"Unique reference of the menu item nutrient" } } }, "MenuItem_tag":{ "type":"object", "properties":{ "tagName":{ "type":"string", "example":"Tag", "description":"The name of Tag associated with the menu item" } } }, "MenuItem_component":{ "type":"object", "properties":{ "componentObjNum":{ "type":"integer", "example":1, "description":"Object number of the component" } } }, "MenuItem_menuItemPrice":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy unit unique reference" }, "priceSequenceNum":{ "type":"integer", "example":3, "description":"Price record number" }, "menuItemPriceId":{ "type":"number", "example":5.16, "description":"Unique menu item price reference" }, "activeOnMenuLevel":{ "type":"number", "example":0.18, "description":"Menu Level Value" }, "prepCost":{ "type":"number", "example":0.18, "description":"Preparation cost" }, "price":{ "type":"number", "example":0.18, "description":"Menu item price. Note that precision is determined by currency settings." }, "taxClassOverrideObjNum":{ "type":"number", "example":0.18, "description":"Overrides menu item tax class setting (main item only)" }, "condimentParentTaxClassOverrideObjNum":{ "type":"number", "example":0.18, "description":"Specifies the parent item's tax class override (condiment item only)" }, "serviceChargeGroupObjNum":{ "type":"number", "example":0.18, "description":"Service charge group object number" }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing enabled or disabled options" }, "effectivityGroupObjNum":{ "type":"number", "example":0.18, "description":"Effectivity group option numbers" } }, "description":"Model for Menu Item Price object" }, "MenuItem_menuItemPricev2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy unit unique reference" }, "priceSequenceNum":{ "type":"integer", "example":3, "description":"Price record number" }, "menuItemPriceId":{ "type":"number", "example":5.16, "description":"Unique menu item price reference" } }, "description":"Model for Menu Item Price object" }, "LocationResponse":{ "type":"object", "properties":{ "hierUnitId":{ "description":"unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Location", "type":"integer", "example":1 } } }, "LocationGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Location objects of the organization.", "items":{ "$ref":"#/definitions/Location" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "LocationInsertRequestBody":{ "description":"Model for Location Object", "type":"object", "required":[ "objectNum", "name", "tZIndex", "locRef", "reportingLocName", "reportingParentEnterpriseLevelName" ], "properties":{ "objectNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "consumerFacingName":{ "description":"A group of string objects representing the consumer facing name in the configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "phoneCountryCode":{ "description":"The phone number country code of the property. It cannot be null when assigning a phone number to the property.", "type":"string", "example":"US" }, "phone":{ "description":"The phone number of the property. If it is not null, the phoneCountryCode is required.", "type":"string", "example":1234567890 }, "address1":{ "description":"The address line 1 for the property.", "type":"string", "example":"Address Line 1" }, "address2":{ "description":"The address line 2 for the property.", "type":"string", "example":"Address Line 2" }, "address3":{ "description":"The address line 3 for the property.", "type":"string", "example":1 }, "city":{ "description":"The city for the property", "type":"string", "example":"City" }, "stateOrRegionCode":{ "description":"The state or region code for the property. It cannot be null when stateOrRegion is not null.", "type":"string", "example":"NY" }, "stateOrRegion":{ "description":"The state or region for the property. It cannot be null when stateOrRegionCode is not null.", "type":"string", "example":"New York" }, "zipOrPostalCode":{ "description":"The state or region for the property. The ZIP or postal code for the property.", "type":"string", "example":"YXA123" }, "countryCode":{ "description":"The country code for the property.", "type":"string", "example":"US" }, "latitude":{ "description":"The property latitude. Latitude must be within range -90 to +90", "type":"string", "example":12.23 }, "longitude":{ "description":"The property longitude. Longitude must be between -180 and 180", "type":"string", "example":12.34 }, "comment":{ "description":"Additional information about the property.", "type":"string", "example":"Comment" }, "tZIndex":{ "description":"The index time zone of the property.", "type":"integer", "example":20 }, "localeInfoId":{ "description":"Unique reference of the locale for the property to determine the use of decimal or thousand separators.", "type":"integer", "example":1 }, "reportingLocName":{ "description":"The location name created in Simphony Reporting.", "type":"string", "example":"Location1" }, "locRef":{ "description":"The unique reference for the location in Simphony Reporting", "type":"string", "example":"Loc1" }, "laborEnabled":{ "description":"Flag indicating if enterprise labor is enabled,", "type":"boolean", "example":false }, "inventoryEnabled":{ "description":"Flag indicating if inventory is enabled,", "type":"boolean", "example":false }, "laborLogin":{ "description":"The username to use to connect to the Simphony Labor Service. Either both laborLogin and laborPassword have to be null or non-null.", "type":"string", "example":"user123" }, "laborPassword":{ "description":"The password to use to log on to the Simphony Labor Service. Either both laborLogin and laborPassword have to be null or non-null.", "type":"string", "example":"slkdrtj132@!#$1" }, "reportingParentEnterpriseLevelName":{ "description":"The name of the parent organization level under which this location is to be reported.", "type":"string", "example":"District" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } }, "LocationUpdateRequestBody":{ "description":"Model for Location Object", "type":"object", "required":[ "hierUnitId", "name", "tZIndex", "locRef", "reportingLocName", "reportingParentEnterpriseLevelName" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":2 }, "name":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "consumerFacingName":{ "description":"A group of string objects representing the consumer facing name in the configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "phoneCountryCode":{ "description":"The phone number country code of the property. It cannot be null when assigning a phone number to the property.", "type":"string", "example":"US" }, "phone":{ "description":"The phone number of the property. If it is not null, the phoneCountryCode is required.", "type":"string", "example":1234567890 }, "address1":{ "description":"The address line 1 for the property.", "type":"string", "example":"Address Line 1" }, "address2":{ "description":"The address line 2 for the property.", "type":"string", "example":"Address Line 2" }, "address3":{ "description":"The address line 3 for the property.", "type":"string", "example":1 }, "city":{ "description":"The city for the property", "type":"string", "example":"City" }, "stateOrRegionCode":{ "description":"The state or region code for the property. It cannot be null when stateOrRegion is not null.", "type":"string", "example":"NY" }, "stateOrRegion":{ "description":"The state or region for the property. It cannot be null when stateOrRegionCode is not null.", "type":"string", "example":"New York" }, "zipOrPostalCode":{ "description":"The state or region for the property. The ZIP or postal code for the property.", "type":"string", "example":"YXA123" }, "countryCode":{ "description":"The country code for the property.", "type":"string", "example":"US" }, "latitude":{ "description":"The property latitude. Latitude must be within range -90 to +90", "type":"string", "example":12.23 }, "longitude":{ "description":"The property longitude. Longitude must be between -180 and 180", "type":"string", "example":12.34 }, "comment":{ "description":"Additional information about the property.", "type":"string", "example":"Comment" }, "tZIndex":{ "description":"The index time zone of the property.", "type":"integer", "example":20 }, "localeInfoId":{ "description":"Unique reference of the locale for the property to determine the use of decimal or thousand separators.", "type":"integer", "example":1 }, "reportingLocName":{ "description":"The location name created in Simphony Reporting.", "type":"string", "example":"Location1" }, "locRef":{ "description":"The unique reference for the location in Simphony Reporting", "type":"string", "example":"Loc1" }, "laborEnabled":{ "description":"Flag indicating if enterprise labor is enabled.", "type":"boolean", "example":false }, "inventoryEnabled":{ "description":"Flag indicating if inventory is enabled.", "type":"boolean", "example":false }, "laborLogin":{ "description":"The username to use to connect to the Simphony Labor Service. Either both laborLogin and laborPassword have to be null or non-null.", "type":"string", "example":"user123" }, "laborPassword":{ "description":"The password to use to log on to the Simphony Labor Service. Either both laborLogin and laborPassword have to be null or non-null.", "type":"string", "example":"slkdrtj132@!#$1" }, "reportingParentEnterpriseLevelName":{ "description":"The name of the parent organization level under which this location is to be reported.", "type":"string", "example":"District" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } }, "Location":{ "description":"Model for Location Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":2 }, "hierStrucId":{ "description":"Unique reference of the hierarchy structure of the property. Excluded by default.", "type":"integer", "example":2 }, "objectNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "consumerFacingName":{ "description":"A group of string objects representing the consumer facing name in the configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "phoneCountryCode":{ "description":"The phone number country code of the property.", "type":"string", "example":"US" }, "phoneNumberPrefix":{ "description":"The phone number prefix of the property.", "type":"integer", "example":1 }, "phone":{ "description":"The phone number of the property", "type":"string", "example":1234567890 }, "address1":{ "description":"The address line 1 for the property.", "type":"string", "example":"Address Line 1" }, "address2":{ "description":"The address line 2 for the property.", "type":"string", "example":"Address Line 2" }, "address3":{ "description":"The address line 3 for the property.", "type":"string", "example":1 }, "city":{ "description":"The city for the property", "type":"string", "example":"City" }, "stateOrRegionCode":{ "description":"The state or region code for the property.", "type":"string", "example":"NY" }, "stateOrRegion":{ "description":"The state or region for the property.", "type":"string", "example":"New York" }, "zipOrPostalCode":{ "description":"The state or region for the property. The ZIP or postal code for the property.", "type":"string", "example":"YXA123" }, "countryCode":{ "description":"The country code for the property.", "type":"string", "example":"US" }, "country":{ "description":"The country for the property.", "type":"string", "example":"United States" }, "latitude":{ "description":"The property latitude. Latitude must be within range -90 to +90", "type":"string", "example":12.23 }, "longitude":{ "description":"The property longitude. Longitude must be between -180 and 180", "type":"string", "example":12.34 }, "comment":{ "description":"Additional information about the property.", "type":"string", "example":"Comment" }, "tZIndex":{ "description":"The index time zone of the property.", "type":"integer", "example":20 }, "tzName":{ "description":"The name time zone of the property.", "type":"string", "example":"(GMT-06:00) Central Time (US and Canada)" }, "localeInfoId":{ "description":"Unique reference of the locale for the property to determine the use of decimal or thousand separators.", "type":"integer", "example":1 }, "localeName":{ "description":"A group of string objects representing the name of the locale for the property to determine the use of decimal or thousand separators in configured languages.", "type":"object", "example":{ "en-US":"Locale 1", "de-DE":"Gebietsschema 1", "es-MX":"Lugar 1" } }, "reportingLocName":{ "description":"The location name created in Simphony Reporting. Search operation using this field is not allowed.", "type":"string", "example":"Location1" }, "locRef":{ "description":"Unique string of the Location Reference of the property.", "type":"string", "example":"Loc1" }, "laborEnabled":{ "description":"Flag indicating if enterprise labor is enabled. Search operation using this field is not allowed.", "type":"boolean", "example":false }, "inventoryEnabled":{ "description":"Flag indicating if inventory is enabled. Search operation using this field is not allowed.", "type":"boolean", "example":false }, "laborLogin":{ "description":"The username to use to connect to the Simphony Labor Service. Search operation using this field is not allowed.", "type":"string", "example":"user123" }, "reportingParentEnterpriseLevelName":{ "description":"The name of the parent organization level under which this location is to be reported. Search operation using this field is not allowed.", "type":"string", "example":"District" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } }, "Locationv2":{ "description":"Model for Location Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":2 }, "hierStrucId":{ "description":"Unique reference of the hierarchy structure of the property. Excluded by default.", "type":"integer", "example":2 }, "objectNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "consumerFacingName":{ "description":"A group of string objects representing the consumer facing name in the configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "phoneCountryCode":{ "description":"The phone number country code of the property.", "type":"string", "example":"US" }, "phoneNumberPrefix":{ "description":"The phone number prefix of the property.", "type":"integer", "example":1 }, "phone":{ "description":"The phone number of the property", "type":"string", "example":1234567890 }, "address1":{ "description":"The address line 1 for the property.", "type":"string", "example":"Address Line 1" }, "address2":{ "description":"The address line 2 for the property.", "type":"string", "example":"Address Line 2" }, "address3":{ "description":"The address line 3 for the property.", "type":"string", "example":1 }, "city":{ "description":"The city for the property", "type":"string", "example":"City" }, "stateOrRegionCode":{ "description":"The state or region code for the property.", "type":"string", "example":"NY" }, "stateOrRegion":{ "description":"The state or region for the property.", "type":"string", "example":"New York" }, "zipOrPostalCode":{ "description":"The state or region for the property. The ZIP or postal code for the property.", "type":"string", "example":"YXA123" }, "countryCode":{ "description":"The country code for the property.", "type":"string", "example":"US" }, "country":{ "description":"The country for the property.", "type":"string", "example":"United States" }, "latitude":{ "description":"The property latitude. Latitude must be within range -90 to +90", "type":"string", "example":12.23 }, "longitude":{ "description":"The property longitude. Longitude must be between -180 and 180", "type":"string", "example":12.34 }, "comment":{ "description":"Additional information about the property.", "type":"string", "example":"Comment" }, "tZIndex":{ "description":"The index time zone of the property.", "type":"integer", "example":20 }, "tzName":{ "description":"The name time zone of the property.", "type":"string", "example":"(GMT-06:00) Central Time (US and Canada)" }, "localeInfoId":{ "description":"Unique reference of the locale for the property to determine the use of decimal or thousand separators.", "type":"integer", "example":1 }, "reportingLocName":{ "description":"The location name created in Simphony Reporting. Search operation using this field is not allowed.", "type":"string", "example":"Location1" }, "locRef":{ "description":"Unique string of the Location Reference of the property.", "type":"string", "example":"Loc1" }, "laborEnabled":{ "description":"Flag indicating if enterprise labor is enabled. Search operation using this field is not allowed.", "type":"boolean", "example":false }, "inventoryEnabled":{ "description":"Flag indicating if inventory is enabled. Search operation using this field is not allowed.", "type":"boolean", "example":false }, "laborLogin":{ "description":"The username to use to connect to the Simphony Labor Service. Search operation using this field is not allowed.", "type":"string", "example":"user123" }, "reportingParentEnterpriseLevelName":{ "description":"The name of the parent organization level under which this location is to be reported. Search operation using this field is not allowed.", "type":"string", "example":"District" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } }, "Location_dml":{ "description":"Model for Location Object", "type":"object", "required":[ "hierUnitId" ], "properties":{ "hierUnitId":{ "description":"unique hierarchy unit value", "type":"integer", "example":1 } } }, "predeletecheck_nodependency_response":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"response", "description":"Indicates existence of references to the object in the database." } }, "description":"The input Body model that needs to be given." }, "Employee_rolesv2":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the employee role is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the employee role is configured", "type":"integer", "example":26 }, "roleObjNum":{ "description":"The object number of the employee role", "type":"integer", "example":1000 } } }, "Employee_emcVisibilityv2":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the employee EMC visibility is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the employee EMC visibility is configured", "type":"integer", "example":26 }, "propagateToChildren":{ "description":"Boolean flag indicating if the EMC visibility is propagated to child nodes of the hierarchy unit", "type":"boolean", "example":true } } }, "Employee_properties_optionsExt":{ "type":"object", "properties":{ "disableWorkstationOnlinePrompt":{ "type":"boolean", "example":false, "description":"Flag indicating to allow offline workstations to automatically re-establish communication with the data center." }, "limitClkInToWorkstationsInTheClkInRVC":{ "type":"boolean", "example":false, "description":"Flag indicating to prevent the employee from clocking in unless the revenue center of the Clock-In Cycle matches the revenue center on the workstation." }, "limitClkOutToWorkstationsInTheClkOutRVC":{ "type":"boolean", "example":false, "description":"Flag indicating to prevent the employee from clocking out, unless the Current RVC field for the employee matches the revenue center on the workstation." } } }, "Employee_properties_jobCodesv2":{ "type":"object", "properties":{ "jobCodeObjNum":{ "type":"integer", "example":1, "description":"Object number of the job code" }, "regularPayRate":{ "type":"number", "example":1.23, "description":"Regular pay rate for the employee in the specified job code" }, "otPayRate":{ "type":"number", "example":2.5, "description":"Overtime pay rate for the employee in the specified job code" } } }, "Employee_operators_optionsExt":{ "type":"object", "properties":{ "requireTableNumberEntryToBeginOrPickupChecks":{ "type":"boolean", "example":false, "description":"Flag indicating to require table number entry when beginning a check." }, "requireNumberOfGuestsEntryForNewChecks":{ "type":"boolean", "example":false, "description":"Flag indicating to require number of guests entry when beginning a check." }, "requireCheckEmpNumberForNewChecks":{ "type":"boolean", "example":false, "description":"Flag indicating to require assignment of a check employee when beginning a check." }, "useEmpNumberToOpenCheckForAnotherEmployee":{ "type":"boolean", "example":false, "description":"Flag indicating to require entry of the Employee Number of the workstation operator for whom the check is being started. Deselect to require Employee ID entry of the other workstation operator." }, "onDemand":{ "type":"boolean", "example":false, "description":"Flag reflecting assignment of operator type 1. Only one of onDemand, tempOnDemand, specialByRound can be enabled at one once." }, "tempOnDemand":{ "type":"boolean", "example":false, "description":"Flag reflecting assignment of operator type 2. Only one of onDemand, tempOnDemand, specialByRound can be enabled at one once" }, "cannotPerformFastTransactions":{ "type":"boolean", "example":false, "description":"Flag indicating to require opening a check to begin each transaction." }, "isPopupOperator":{ "type":"boolean", "example":false, "description":"Flag indicating to sign the operator out of the workstation at the end of a transaction." }, "requireSeatNumberEntry":{ "type":"boolean", "example":false, "description":"Flag indicating to require the operator to have an active seat number when beginning a transaction." }, "enableAutoPopUpEntryForStaydownOperator":{ "type":"boolean", "example":false, "description":"Flag indicating to automatically sign out a staydown operator based on the Automatic Operator Popup Interval setting in Control Parameters. Deselect to allow staydown operators to remain signed on to the workstation." }, "requireGuestCheckId":{ "type":"boolean", "example":false, "description":"Flag indicating to require checks opened or picked up by the workstation operator to have a Guest Check ID." }, "sortGuestCheckSLUByTableName":{ "type":"boolean", "example":false, "description":"Flag indicating to sort the Open Checks SLU for the workstation operator by Table Name." }, "specialByRound":{ "type":"boolean", "example":false, "description":"Flag reflecting assignment of operator type 3. Only one of onDemand, tempOnDemand, specialByRound can be enabled at one once." }, "viewBlindTotals":{ "type":"boolean", "example":false, "description":"Flag indicating to allow workstation operators to view over and under calculations on count sheets." }, "allowAssignedReceptacleAccess":{ "type":"boolean", "example":false, "description":"Flag indicating to allow workstation operators to view and perform transactions for till and server bank receptacles when the workstation operator is not the owner or assigned user." }, "preventMultipleReceptacleCounts":{ "type":"boolean", "example":false, "description":"Flag indicating to prevent workstation operators from counting a till or server bank receptacle more than once." }, "preventTransactionsOnceCountIsPerformed":{ "type":"boolean", "example":false, "description":"Flag indicating to prevent operator from performing transactions once a count has occurred when option 27 (Prevent multiple receptacle counts) is enabled." } } }, "Employee_properties_operatorsv2":{ "type":"object", "properties":{ "rvcHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value of the revenue center" }, "rvcObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number associated with the revenue center" }, "cashierObjNum":{ "type":"integer", "example":1, "description":"Object number of the cashier linked to the workstation operator." }, "overrideEmployeeClassOptions":{ "type":"boolean", "example":true, "description":"A flag indicating whether the workstation operator record uses Employee Class Options or Operator Options to determine transaction behavior." }, "options":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the employee operator record at the property." }, "optionsExt":{ "$ref":"#/definitions/Employee_operators_optionsExt" }, "cmAccountingMethodObjNum":{ "type":"integer", "example":1, "description":"Object number of Cash Management session type the employee uses to record Cash Management related transactions within the revenue center" }, "cmAccountingMethodName":{ "type":"string", "example":"Session1", "description":"Name of Cash Management session" }, "serverBankingTemplateObjNum":{ "type":"integer", "example":1, "description":"Object number of the default template to use when opening a server bank." }, "cashDrawerObjNum":{ "type":"integer", "example":1, "description":"Object number of the cash drawer that is permanently assigned to each workstation operator." }, "tableCount":{ "type":"integer", "example":1, "description":"The number of tables each operator serves." }, "tmsColorObjNum":{ "type":"integer", "example":1, "description":"Object number of the color to distinguish the employee from others when using TMS." }, "tmsColorObjName":{ "type":"string", "example":"TMS1", "description":"TMS Color Name" }, "serverEfficiency":{ "type":"integer", "example":1, "description":"Efficiency of the server." } } }, "Employee_propertiesv2":{ "type":"object", "properties":{ "propertyHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value associated with the property" }, "propertyObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number associated with the property" }, "empClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the class of the employee at the property." }, "rvcHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value associated with the RVC." }, "rvcObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number associated with the RVC." }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the employee property assignment." }, "optionsExt":{ "$ref":"#/definitions/Employee_properties_optionsExt" }, "inTraining":{ "type":"boolean", "example":false, "description":"Flag indicating if employee is in training at the property." }, "ldsId":{ "type":"integer", "example":1, "description":"unique ID number to identify the employee in a Liquor Dispensing System." }, "lateClockInGrace":{ "type":"integer", "example":1, "description":"The number of minutes that the employee can clock in late without being prompted or requiring authorization." }, "jobCodes":{ "type":"array", "description":"Array of job codes assigned to the employee at the property", "items":{ "$ref":"#/definitions/Employee_properties_jobCodesv2" } }, "operators":{ "type":"array", "description":"Array of revenue center operators records for the employees", "items":{ "$ref":"#/definitions/Employee_properties_operatorsv2" } } } }, "SingleEmployee":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee in the system." }, "firstName":{ "type":"string", "example":"Employee", "description":"Employee's first name, which prints on reports." }, "lastName":{ "type":"string", "example":"Employee", "description":"Employee's last name, which prints on reports." }, "checkName":{ "type":"string", "example":"Employee Check Name", "description":"Name to print on guest checks." }, "email":{ "type":"string", "example":"employee@restaurant.com", "description":"Email address of the employee." }, "langId":{ "type":"integer", "example":1, "description":"Language Id" }, "payrollId":{ "type":"string", "example":"EMP-01", "description":"External payroll ID for the employee." }, "id":{ "type":"integer", "example":2021, "description":"ID number to identify the employee on workstations." }, "alternateId":{ "type":"integer", "example":2121, "description":"ID to use instead of the Employee ID when signing into the workstation." }, "pin":{ "type":"string", "example":2222, "description":"PIN for the employee." }, "level":{ "type":"integer", "example":1, "description":"The level of the employee. This value should be between 1-9." }, "group":{ "type":"integer", "example":1, "description":"The group of the employee." }, "isDeleted":{ "type":"boolean", "example":false, "description":"Flag indicating if the employee record is deleted. If true, the record cannot be edited." }, "terminationDate":{ "type":"string", "example":"2021-11-21T00:00:00.000Z", "description":"The date the employee was terminated.Format:YYYY-MM-DD. This value is set from Labor Management and cannot be added" }, "isDataPrivacyConsentGranted":{ "type":"boolean", "example":false, "description":"The consent status of the employee." }, "infoLine1":{ "type":"string", "example":"Information line 1", "description":"Information line 1" }, "infoLine2":{ "type":"string", "example":"Information line 2", "description":"Information line 2" }, "infoLine3":{ "type":"string", "example":"Information line 3", "description":"Information line 3" }, "infoLine4":{ "type":"string", "example":"Information line 4", "description":"Information line 4" }, "userName":{ "type":"string", "example":"empName", "description":"The login name for the EMC." }, "localeObjNum":{ "type":"integer", "example":1, "description":"The object number of the locale of the employee" }, "hasFingerprintEnrolled":{ "type":"boolean", "example":false, "description":"Flag indicating if the employee has its fingerprint enrolled. This flag cannot be modified by API." }, "roles":{ "type":"array", "description":"An array of roles associated with the employee at different hierarchy levels", "items":{ "$ref":"#/definitions/Employee_rolesv2" } }, "emcVisibility":{ "type":"array", "description":"Array of hierarchy units visible to the employee in EMC.", "items":{ "$ref":"#/definitions/Employee_emcVisibilityv2" } }, "properties":{ "type":"array", "description":"Array of properties where the employee is assigned.", "items":{ "$ref":"#/definitions/Employee_propertiesv2" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for employees", "items":{ "$ref":"#/definitions/Employee_dataExtensions" } } } }, "SalesItemizerGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Sales Itemizer objects of the organization.", "items":{ "$ref":"#/definitions/SalesItemizerv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "SalesItemizerv1":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "salesItmzrIndex":{ "description":"Sequence number of the Sales Itemizer. Acceptable values are 1-16, including 1 and 16\n", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Sales Itemizers in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } } } }, "SalesItemizerv2":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "salesItmzrIndex":{ "description":"Sequence number of the Sales Itemizer. Acceptable values are 1-16, including 1 and 16\n", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Sales Itemizers in configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 } } }, "SalesItemizerCUDRequestBody":{ "type":"object", "required":[ "hierUnitId", "salesItmzrIndex", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "salesItmzrIndex":{ "description":"Sequence number of the Sales Itemizer. Acceptable values are 1-16, including 1 and 16\n", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Sales Itemizers in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } } } }, "SalesItemizerResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "salesItmzrIndex":{ "description":"Sequence number of sales itemizer", "type":"integer", "example":1 } } }, "ServingPeriod":{ "description":"Serving Period record", "type":"object", "properties":{ "objectNum":{ "description":"Object number of the serving period.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the serving period is configured.", "type":"integer", "example":3599 }, "name":{ "description":"Serving period name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "startTime":{ "description":"Start time of the serving period in 24-hour HH:MM format.", "type":"string", "example":"03:00" }, "endTime":{ "description":"End time of the serving period in 24-hour HH:MM format.", "type":"string", "example":"05:00" }, "activeDaysOfWeek":{ "description":"A string of values 0s and 1s of length 7 representing the days of the week when the serving period is active, starting with Sunday.", "type":"string", "example":"1111111" }, "activeDaysOfWeekExt":{ "description":"An object containing the descriptive active days of week.", "type":"object", "properties":{ "activeOnSunday":{ "description":"A boolean flag representing the 1st option bit in activeDaysOfWeek, indicating serving period as active on Sunday.", "type":"boolean", "example":true }, "activeOnMonday":{ "description":"A boolean flag representing the 2nd option bit in activeDaysOfWeek, indicating serving period as active on Monday.", "type":"boolean", "example":true }, "activeOnTuesday":{ "description":"A boolean flag representing the 3rd option bit in activeDaysOfWeek, indicating serving period as active on Tuesday.", "type":"boolean", "example":true }, "activeOnWednesday":{ "description":"A boolean flag representing the 4th option bit in activeDaysOfWeek, indicating serving period as active on on Wednesday.", "type":"boolean", "example":true }, "activeOnThursday":{ "description":"A boolean flag representing the 5th option bit in activeDaysOfWeek, indicating serving period as active on Thursday.", "type":"boolean", "example":true }, "activeOnFriday":{ "description":"A boolean flag representing the 6th option bit in activeDaysOfWeek, indicating serving period as active on Friday.", "type":"boolean", "example":true }, "activeOnSaturday":{ "description":"A boolean flag representing the 7th option bit in activeDaysOfWeek, indicating serving period as active on Saturday.", "type":"boolean", "example":true } } }, "tableCount":{ "description":"Determines the number of tables available during the serving period.", "type":"integer", "example":12 }, "defaultMainLevel":{ "description":"The object number of the Default Main Level to use when the serving period is active. Valid range is [0-8].", "type":"integer", "example":1 }, "defaultSubLevel":{ "description":"The object number of the Default Sub Level to use when the serving period is active. Valid range is [0-8].", "type":"integer", "example":1 }, "taxesEnabled":{ "description":"A string of values 0s and 1s of length 64 representing the tax rates used when the serving period is active.", "type":"string", "example":"1000000000000000000000000000000000000000000000000000000000000001" }, "taxesEnabledExt":{ "description":"An object containing the descriptive taxes enabled.", "type":"object", "properties":{ "taxRate1":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 1 is enabled" }, "taxRate2":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 2 is enabled" }, "taxRate3":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 3 is enabled" }, "taxRate4":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 4 is enabled" }, "taxRate5":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 5 is enabled" }, "taxRate6":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 6 is enabled" }, "taxRate7":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 7 is enabled" }, "taxRate8":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 8 is enabled" }, "taxRate9":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 9 is enabled" }, "taxRate10":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 10 is enabled" }, "taxRate11":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 11 is enabled" }, "taxRate12":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 12 is enabled" }, "taxRate13":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 13 is enabled" }, "taxRate14":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 14 is enabled" }, "taxRate15":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 15 is enabled" }, "taxRate16":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 16 is enabled" }, "taxRate17":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 17 is enabled" }, "taxRate18":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 18 is enabled" }, "taxRate19":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 19 is enabled" }, "taxRate20":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 20 is enabled" }, "taxRate21":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 21 is enabled" }, "taxRate22":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 22 is enabled" }, "taxRate23":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 23 is enabled" }, "taxRate24":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 24 is enabled" }, "taxRate25":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 25 is enabled" }, "taxRate26":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 26 is enabled" }, "taxRate27":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 27 is enabled" }, "taxRate28":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 28 is enabled" }, "taxRate29":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 29 is enabled" }, "taxRate30":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 30 is enabled" }, "taxRate31":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 31 is enabled" }, "taxRate32":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 32 is enabled" }, "taxRate33":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 33 is enabled" }, "taxRate34":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 34 is enabled" }, "taxRate35":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 35 is enabled" }, "taxRate36":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 36 is enabled" }, "taxRate37":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 37 is enabled" }, "taxRate38":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 38 is enabled" }, "taxRate39":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 39 is enabled" }, "taxRate40":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 40 is enabled" }, "taxRate41":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 41 is enabled" }, "taxRate42":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 42 is enabled" }, "taxRate43":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 43 is enabled" }, "taxRate44":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 44 is enabled" }, "taxRate45":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 45 is enabled" }, "taxRate46":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 46 is enabled" }, "taxRate47":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 47 is enabled" }, "taxRate48":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 48 is enabled" }, "taxRate49":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 49 is enabled" }, "taxRate50":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 50 is enabled" }, "taxRate51":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 51 is enabled" }, "taxRate52":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 52 is enabled" }, "taxRate53":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 53 is enabled" }, "taxRate54":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 54 is enabled" }, "taxRate55":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 55 is enabled" }, "taxRate56":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 56 is enabled" }, "taxRate57":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 57 is enabled" }, "taxRate58":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 58 is enabled" }, "taxRate59":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 59 is enabled" }, "taxRate60":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 60 is enabled" }, "taxRate61":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 61 is enabled" }, "taxRate62":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 62 is enabled" }, "taxRate63":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 63 is enabled" }, "taxRate64":{ "type":"boolean", "example":false, "description":"A boolean flag indicating if the tax rate 64 is enabled" } } }, "dataExtensions":{ "description":"An array of data extensions for the serving period", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extention field", "type":"string", "example":"extension_Column" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"value1" } } } } } }, "KDSController":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Kitchen Display Controller", "type":"integer", "example":1 } } }, "KDSControllersGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Kitchen Display Controller objects of the organization.", "items":{ "$ref":"#/definitions/KDSControllersv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "KDSControllersv1":{ "description":"Model for KDS Controllers object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Hierarchy unit object number", "type":"integer", "example":1 }, "hierUnitName":{ "description":"Hierarchy unit name", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object number of the KDS Controller", "type":"integer", "example":1 }, "name":{ "description":"name of the KDS Controller", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "controllerId":{ "description":"The KDS Controller ID for troubleshooting purposes. This is auto-generated when adding the KDS Controller and cannot be edited.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 64 representing the enablement or disablement of the options associated with the KDS Controller.", "type":"string", "example":"0000000000000000000000000000000000000000000000000000000000000000" }, "optionsExt":{ "description":"An object containing the descriptive options list associated with the KDS Controller.", "type":"object", "properties":{ "preventChitBumpOnExpoIfExistOnPrep":{ "description":"A Boolean flag indicating to prevent a chit from being bumped on an Expo Display if the chit exists on a Prep Display.", "type":"boolean", "example":false }, "displayNextCourseAfterPrevCourseComplete":{ "description":"A Boolean flag indicating to show menu items from Course 2 on KDS Displays only after menu items from Course 1 are bumped when using dining courses.", "type":"boolean", "example":false }, "showOnlyActiveOrders":{ "description":"A Boolean flag indicating to allow SOS Displays to show only tables with open orders.", "type":"boolean", "example":false }, "expoOnlyItemsDisplayAsDone":{ "description":"A Boolean flag indicating to change the status of menu items that do not go to Prep Stations to Done when they fire.", "type":"boolean", "example":false }, "excludeCALUpdatesFromSVCHost":{ "description":"A Boolean flag indicating to exclude updates to CAL for Service Host changes made in the KDS Controller if the property does not use CAL.", "type":"boolean", "example":false }, "enableItemStartedTimings":{ "description":"A Boolean flag indicating to recalculate an order's target done time (TDT) when the item with the longest prep time is started for non-DOM KDS systems.", "type":"boolean", "example":false }, "includeThemeInDeviceName":{ "description":"A Boolean flag indicating to have the KDS show the current Kitchen Theme after the device name on the KDS status bar.", "type":"boolean", "example":false }, "enableLoadBalancing":{ "description":"A Boolean flag indicating to dynamically distribute incoming items/orders between preconfigured group(s) of prep or expo stations based on the current load of un-bumped items or orders.", "type":"boolean", "example":false }, "enableBackUpControllerAutoTakeover":{ "description":"A Boolean flag indicating to allow the backup KDS Controller to take over automatically when the primary controller is down if a Backup Service Host is configured for the KDS Controller.", "type":"boolean", "example":false }, "startHideOtherPreps":{ "description":"A Boolean flag indicating to have orders disappear from all other KDS Prep Stations when an order chit is marked as started.", "type":"boolean", "example":false }, "preventBumpWhileOrdering":{ "description":"A Boolean flag indicating to prevent bumping of items or orders and to have the chits show as ordering on the KDS in revenue centers with DOM enabled. Only applies when transactions are in progress.", "type":"boolean", "example":false }, "recallToOrgPosition":{ "description":"A Boolean flag indicating to show recalled orders in their original position prior to being bumped. Deselect to show recalled orders ahead of existing orders.", "type":"boolean", "example":false }, "enableCapacityScheduling":{ "description":"A Boolean flag indicating to display orders in the kitchen based on prep station capacity with the goal of having all items prep complete at the same time. Note that Capacity and Capacity Usage need to be defined. This option cannot be used with DOM and requires Single Item Per Sub Order to be enabled.", "type":"boolean", "example":false } } }, "dbUpdateFrequencyInSecs":{ "description":"The number of seconds the KDS Controller waits to retrieve updates from the database.", "type":"integer", "example":0 }, "waitForPrepSubOrderInSecs":{ "description":"The number of seconds the KDS waits for Prep Suborders before showing an expo order as All Prep Done.", "type":"integer", "example":0 }, "mediaViewerURL":{ "description":"The URL of the IIS website where the Media Viewer is defined.", "type":"string", "example":"https://viewer" }, "expoRecallOption":{ "description":"Indicator of where to show orders when they are recalled from an Expo or SOS Display.", "type":"integer", "example":0 }, "displayLanguage":{ "description":"The ISO code of the language used to display all non-configurable text in KDS. This includes messages, title bars, column headers, and chit elements.", "type":"string", "example":1 }, "enableResetAllTime":{ "description":"A Boolean flag indicating to enable and set the Reset All Time to determine when the KDS Controller will delete all order data daily. Typically done at start of day to prevent recalling the previous day's orders.", "type":"boolean", "example":false }, "numberOfZones":{ "description":"The number of kitchen zones to use for collecting food orders.", "type":"integer", "example":0 }, "maxItemsPerZone":{ "description":"The maximum number of items that can be added to a zone.", "type":"integer", "example":0 }, "prodCountIncrementType":{ "description":"Indicator of when to add ordered items to the production counter.", "type":"integer", "example":0 }, "prodCountDecrementType":{ "description":"Indicator of when to decrease the count of items from the production counter.", "type":"integer", "example":0 }, "autoBumpTimeInSecs":{ "description":"The wait time before automatically bumping all closed orders after reaching the Check Count.", "type":"integer", "example":0 }, "autoBumpCheckCount":{ "description":"The number of checks allowed to appear on the KDS before automatically bumping.", "type":"integer", "example":0 }, "svcHost":{ "description":"An object representing the service host details associated with the KDS controller.", "type":"object", "properties":{ "svcHostObjNum":{ "description":"Object number of the service host associated with the KDS Controller.", "type":"integer", "example":1 }, "svcHostName":{ "description":"A group of strings representing the name of the service host associated with the KDS controller.", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "num":{ "description":"Unique number of the service host. This value is read-only and cannot be added or modified.", "type":"integer", "example":59421 }, "record":{ "description":"The object number and name of the service record. For example, if a workstation, KDS Controller, and credit card driver are all running on the same Service Host, this column shows their object numbers and names. This value is read-only and cannot be added or modified.", "type":"integer", "example":"1-1" }, "port":{ "description":"The port number for each service on the selected service host.", "type":"integer", "example":8080 }, "url":{ "description":"The URL of the service for informational purposes only. It is used when constructing the full path to connect to the service. For example, Simphony services are connected using a path such as http://ServiceHostName:Port/URL. This value is read-only and cannot be added or modified.", "type":"string", "example":"EGateway/EGateway.aspx" }, "totalsCleardThrough":{ "description":"Totals on this workstation were cleared up to this datestamp. This value is read-only and cannot be added or modified.", "type":"string", "example":"2020-12-12T12:00:00" } } }, "bckupSVCHost":{ "description":"An object representing the backup service host details associated with the KDS controller.", "type":"object", "properties":{ "bckupSVCHostObjNum":{ "description":"Object number of the backup service host associated with the KDS Controller.", "type":"integer", "example":1 }, "bckupSVCHostName":{ "description":"A group of strings representing the name of the backup service host associated with the KDS Controller.", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "num":{ "description":"Unique number of the backup service host. This value is read-only and cannot be added or modified.", "type":"integer", "example":59421 }, "record":{ "description":"The object number and name of the service record. For example, if a workstation, KDS Controller, and credit card driver are all running on the same Service Host, this column shows their object numbers and names. This value is read-only and cannot be added or modified.", "type":"integer", "example":"1-1" }, "port":{ "description":"The port number for each service on the selected service host.", "type":"integer", "example":8080 }, "url":{ "description":"The URL of the service for informational purposes only. It is used when constructing the full path to connect to the service. For example, Simphony services are connected using a path such as http://ServiceHostName:Port/URL. This value is read-only and cannot be added or modified.", "type":"string", "example":"EGateway/EGateway.aspx" }, "totalsCleardThrough":{ "description":"Totals on this workstation were cleared up to this datestamp. This value is read-only and cannot be added or modified.", "type":"string", "example":"2020-12-12T12:00:00" } } }, "itemStatusColors":{ "description":"An object containing an integer value representing the item status colors as per the below mapping. 0 - Default 1 - Black 2 - White 3 - Blue 4 - Cyan5 - Dark Gray 6 - Gray 7 - Light Gray 8 - Green 9 - Magenta 10 - Orange 11 - Pink 12 - Red 13 - Yellow", "type":"object", "properties":{ "statusSentColor":{ "description":"Integer value representing the color in which items appear when workstation operators send orders to the KDS.", "type":"integer", "example":0 }, "statusFiredColor":{ "description":"Integer value representing the color in which items appear when they fire to Prep Displays.", "type":"integer", "example":0 }, "statusBumpedColor":{ "description":"Integer value representing the color in which items appear when they are bumped from Prep Displays.", "type":"integer", "example":0 }, "statusStartedColor":{ "description":"Integer value representing the color in which items appear when they are Prep started.", "type":"integer", "example":0 }, "itemSelectColor":{ "description":"Integer value representing the color of the item status background.", "type":"integer", "example":0 }, "itemMarkColor":{ "description":"Integer value representing the color of the item Mark status background.", "type":"integer", "example":0 }, "itemRecallColor":{ "description":"Integer value representing the color of the item Recall status background.", "type":"integer", "example":0 }, "itemRecallableColor":{ "description":"Integer value representing the color of the item Recallable status background.", "type":"integer", "example":0 } } }, "layoutColorsOverride":{ "description":"An object representing the layout color override.", "type":"object", "properties":{ "alert1":{ "description":"Hexadecimal value representing the RBG combination of the background color for orders exceeding the first alert time.", "type":"string", "example":"000000" }, "alert2":{ "description":"Hexadecimal value representing the RBG combination of the background color for orders exceeding the second alert time.", "type":"string", "example":"000000" }, "background":{ "description":"Hexadecimal value representing the RBG combination of the background panel color for the KDS Display.", "type":"string", "example":"000000" }, "orderSelection":{ "description":"Hexadecimal value representing the RBG combination of the color in which the border of an order appears when selecting an item.", "type":"string", "example":"000000" }, "orderBackground":{ "description":"Hexadecimal value representing the RBG combination of the background color for orders on the KDS Display.", "type":"string", "example":"000000" }, "voidItem":{ "description":"Hexadecimal value representing the RBG combination of the color in which voided items appear on the KDS.", "type":"string", "example":"000000" }, "course1Item":{ "description":"Hexadecimal value representing the RBG combination of the color in which Course 1 items appear on the KDS.", "type":"string", "example":"000000" } } }, "extPostingFile1":{ "description":"File name and directory path for the text file where the KDS transaction information is stored.", "type":"string", "example":"file1.txt" }, "extPostingFile2":{ "description":"File name and directory path for the text file where the KDS transaction information is stored.", "type":"string", "example":"file2.txt" }, "extPostingFile3":{ "description":"File name and directory path for the text file where the KDS transaction information is stored.", "type":"string", "example":"file3.txt" } } }, "KDSControllersv2":{ "description":"Model for KDS Controllers object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Hierarchy unit object number", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the KDS Controller", "type":"integer", "example":1 }, "name":{ "description":"name of the KDS Controller", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "controllerId":{ "description":"The KDS Controller ID for troubleshooting purposes. This is auto-generated when adding the KDS Controller and cannot be edited.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 64 representing the enablement or disablement of the options associated with the KDS Controller.", "type":"string", "example":"0000000000000000000000000000000000000000000000000000000000000000" }, "optionsExt":{ "description":"An object containing the descriptive options list associated with the KDS Controller.", "type":"object", "properties":{ "preventChitBumpOnExpoIfExistOnPrep":{ "description":"A Boolean flag indicating to prevent a chit from being bumped on an Expo Display if the chit exists on a Prep Display.", "type":"boolean", "example":false }, "displayNextCourseAfterPrevCourseComplete":{ "description":"A Boolean flag indicating to show menu items from Course 2 on KDS Displays only after menu items from Course 1 are bumped when using dining courses.", "type":"boolean", "example":false }, "showOnlyActiveOrders":{ "description":"A Boolean flag indicating to allow SOS Displays to show only tables with open orders.", "type":"boolean", "example":false }, "expoOnlyItemsDisplayAsDone":{ "description":"A Boolean flag indicating to change the status of menu items that do not go to Prep Stations to Done when they fire.", "type":"boolean", "example":false }, "excludeCALUpdatesFromSVCHost":{ "description":"A Boolean flag indicating to exclude updates to CAL for Service Host changes made in the KDS Controller if the property does not use CAL.", "type":"boolean", "example":false }, "enableItemStartedTimings":{ "description":"A Boolean flag indicating to recalculate an order's target done time (TDT) when the item with the longest prep time is started for non-DOM KDS systems.", "type":"boolean", "example":false }, "includeThemeInDeviceName":{ "description":"A Boolean flag indicating to have the KDS show the current Kitchen Theme after the device name on the KDS status bar.", "type":"boolean", "example":false }, "enableLoadBalancing":{ "description":"A Boolean flag indicating to dynamically distribute incoming items/orders between preconfigured group(s) of prep or expo stations based on the current load of un-bumped items or orders.", "type":"boolean", "example":false }, "enableBackUpControllerAutoTakeover":{ "description":"A Boolean flag indicating to allow the backup KDS Controller to take over automatically when the primary controller is down if a Backup Service Host is configured for the KDS Controller.", "type":"boolean", "example":false }, "startHideOtherPreps":{ "description":"A Boolean flag indicating to have orders disappear from all other KDS Prep Stations when an order chit is marked as started.", "type":"boolean", "example":false }, "preventBumpWhileOrdering":{ "description":"A Boolean flag indicating to prevent bumping of items or orders and to have the chits show as ordering on the KDS in revenue centers with DOM enabled. Only applies when transactions are in progress.", "type":"boolean", "example":false }, "recallToOrgPosition":{ "description":"A Boolean flag indicating to show recalled orders in their original position prior to being bumped. Deselect to show recalled orders ahead of existing orders.", "type":"boolean", "example":false }, "enableCapacityScheduling":{ "description":"A Boolean flag indicating to display orders in the kitchen based on prep station capacity with the goal of having all items prep complete at the same time. Note that Capacity and Capacity Usage need to be defined. This option cannot be used with DOM and requires Single Item Per Sub Order to be enabled.", "type":"boolean", "example":false } } }, "dbUpdateFrequencyInSecs":{ "description":"The number of seconds the KDS Controller waits to retrieve updates from the database.", "type":"integer", "example":0 }, "waitForPrepSubOrderInSecs":{ "description":"The number of seconds the KDS waits for Prep Suborders before showing an expo order as All Prep Done.", "type":"integer", "example":0 }, "mediaViewerURL":{ "description":"The URL of the IIS website where the Media Viewer is defined.", "type":"string", "example":"https://viewer" }, "expoRecallOption":{ "description":"Indicator of where to show orders when they are recalled from an Expo or SOS Display.", "type":"integer", "example":0 }, "displayLanguage":{ "description":"The ISO code of the language used to display all non-configurable text in KDS. This includes messages, title bars, column headers, and chit elements.", "type":"string", "example":1 }, "enableResetAllTime":{ "description":"A Boolean flag indicating to enable and set the Reset All Time to determine when the KDS Controller will delete all order data daily. Typically done at start of day to prevent recalling the previous day's orders.", "type":"boolean", "example":false }, "numberOfZones":{ "description":"The number of kitchen zones to use for collecting food orders.", "type":"integer", "example":0 }, "maxItemsPerZone":{ "description":"The maximum number of items that can be added to a zone.", "type":"integer", "example":0 }, "prodCountIncrementType":{ "description":"Indicator of when to add ordered items to the production counter.", "type":"integer", "example":0 }, "prodCountDecrementType":{ "description":"Indicator of when to decrease the count of items from the production counter.", "type":"integer", "example":0 }, "autoBumpTimeInSecs":{ "description":"The wait time before automatically bumping all closed orders after reaching the Check Count.", "type":"integer", "example":0 }, "autoBumpCheckCount":{ "description":"The number of checks allowed to appear on the KDS before automatically bumping.", "type":"integer", "example":0 }, "svcHost":{ "description":"An object representing the service host details associated with the KDS controller.", "type":"object", "properties":{ "svcHostObjNum":{ "description":"Object number of the service host associated with the KDS Controller.", "type":"integer", "example":1 }, "num":{ "description":"Unique number of the service host. This value is read-only and cannot be added or modified.", "type":"integer", "example":59421 }, "record":{ "description":"The object number and name of the service record. For example, if a workstation, KDS Controller, and credit card driver are all running on the same Service Host, this column shows their object numbers and names. This value is read-only and cannot be added or modified.", "type":"integer", "example":"1-1" }, "port":{ "description":"The port number for each service on the selected service host.", "type":"integer", "example":8080 }, "url":{ "description":"The URL of the service for informational purposes only. It is used when constructing the full path to connect to the service. For example, Simphony services are connected using a path such as http://ServiceHostName:Port/URL. This value is read-only and cannot be added or modified.", "type":"string", "example":"EGateway/EGateway.aspx" }, "totalsCleardThrough":{ "description":"Totals on this workstation were cleared up to this datestamp. This value is read-only and cannot be added or modified.", "type":"string", "example":"2020-12-12T12:00:00" } } }, "bckupSVCHost":{ "description":"An object representing the backup service host details associated with the KDS controller.", "type":"object", "properties":{ "bckupSVCHostObjNum":{ "description":"Object number of the backup service host associated with the KDS Controller.", "type":"integer", "example":1 }, "num":{ "description":"Unique number of the backup service host. This value is read-only and cannot be added or modified.", "type":"integer", "example":59421 }, "record":{ "description":"The object number and name of the service record. For example, if a workstation, KDS Controller, and credit card driver are all running on the same Service Host, this column shows their object numbers and names. This value is read-only and cannot be added or modified.", "type":"integer", "example":"1-1" }, "port":{ "description":"The port number for each service on the selected service host.", "type":"integer", "example":8080 }, "url":{ "description":"The URL of the service for informational purposes only. It is used when constructing the full path to connect to the service. For example, Simphony services are connected using a path such as http://ServiceHostName:Port/URL. This value is read-only and cannot be added or modified.", "type":"string", "example":"EGateway/EGateway.aspx" }, "totalsCleardThrough":{ "description":"Totals on this workstation were cleared up to this datestamp. This value is read-only and cannot be added or modified.", "type":"string", "example":"2020-12-12T12:00:00" } } }, "itemStatusColors":{ "description":"An object containing an integer value representing the item status colors as per the below mapping. 0 - Default 1 - Black 2 - White 3 - Blue 4 - Cyan5 - Dark Gray 6 - Gray 7 - Light Gray 8 - Green 9 - Magenta 10 - Orange 11 - Pink 12 - Red 13 - Yellow", "type":"object", "properties":{ "statusSentColor":{ "description":"Integer value representing the color in which items appear when workstation operators send orders to the KDS.", "type":"integer", "example":0 }, "statusFiredColor":{ "description":"Integer value representing the color in which items appear when they fire to Prep Displays.", "type":"integer", "example":0 }, "statusBumpedColor":{ "description":"Integer value representing the color in which items appear when they are bumped from Prep Displays.", "type":"integer", "example":0 }, "statusStartedColor":{ "description":"Integer value representing the color in which items appear when they are Prep started.", "type":"integer", "example":0 }, "itemSelectColor":{ "description":"Integer value representing the color of the item status background.", "type":"integer", "example":0 }, "itemMarkColor":{ "description":"Integer value representing the color of the item Mark status background.", "type":"integer", "example":0 }, "itemRecallColor":{ "description":"Integer value representing the color of the item Recall status background.", "type":"integer", "example":0 }, "itemRecallableColor":{ "description":"Integer value representing the color of the item Recallable status background.", "type":"integer", "example":0 } } }, "layoutColorsOverride":{ "description":"An object representing the layout color override.", "type":"object", "properties":{ "alert1":{ "description":"Hexadecimal value representing the RBG combination of the background color for orders exceeding the first alert time.", "type":"string", "example":"000000" }, "alert2":{ "description":"Hexadecimal value representing the RBG combination of the background color for orders exceeding the second alert time.", "type":"string", "example":"000000" }, "background":{ "description":"Hexadecimal value representing the RBG combination of the background panel color for the KDS Display.", "type":"string", "example":"000000" }, "orderSelection":{ "description":"Hexadecimal value representing the RBG combination of the color in which the border of an order appears when selecting an item.", "type":"string", "example":"000000" }, "orderBackground":{ "description":"Hexadecimal value representing the RBG combination of the background color for orders on the KDS Display.", "type":"string", "example":"000000" }, "voidItem":{ "description":"Hexadecimal value representing the RBG combination of the color in which voided items appear on the KDS.", "type":"string", "example":"000000" }, "course1Item":{ "description":"Hexadecimal value representing the RBG combination of the color in which Course 1 items appear on the KDS.", "type":"string", "example":"000000" } } }, "extPostingFile1":{ "description":"File name and directory path for the text file where the KDS transaction information is stored.", "type":"string", "example":"file1.txt" }, "extPostingFile2":{ "description":"File name and directory path for the text file where the KDS transaction information is stored.", "type":"string", "example":"file2.txt" }, "extPostingFile3":{ "description":"File name and directory path for the text file where the KDS transaction information is stored.", "type":"string", "example":"file3.txt" } } }, "KDSControllersCUDRequestBody":{ "description":"Model for KDS Controllers CUD Request", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the KDS Controller", "type":"integer", "example":1 }, "name":{ "description":"name of the KDS Controller", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "controllerId":{ "description":"The KDS Controller ID for troubleshooting purposes. This is auto-generated when adding the KDS Controller and cannot be edited.", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 64 representing the enablement or disablement of the options associated with the KDS Controller.", "type":"string", "example":"0000000000000000000000000000000000000000000000000000000000000000" }, "dbUpdateFrequencyInSecs":{ "description":"The number of seconds the KDS Controller waits to retrieve updates from the database.", "type":"integer", "example":0 }, "waitForPrepSubOrderInSecs":{ "description":"The number of seconds the KDS waits for Prep Suborders before showing an expo order as All Prep Done.", "type":"integer", "example":0 }, "mediaViewerURL":{ "description":"The URL of the IIS website where the Media Viewer is defined.", "type":"string", "example":"https://viewer" }, "expoRecallOption":{ "description":"Indicator of where to show orders when they are recalled from an Expo or SOS Display.", "type":"integer", "example":0 }, "displayLanguage":{ "description":"The ISO code of the language used to display all non-configurable text in KDS. This includes messages, title bars, column headers, and chit elements.", "type":"string", "example":1 }, "enableResetAllTime":{ "description":"A Boolean flag indicating to enable and set the Reset All Time to determine when the KDS Controller will delete all order data daily. Typically done at start of day to prevent recalling the previous day's orders.", "type":"boolean", "example":false }, "numberOfZones":{ "description":"The number of kitchen zones to use for collecting food orders.", "type":"integer", "example":0 }, "maxItemsPerZone":{ "description":"The maximum number of items that can be added to a zone.", "type":"integer", "example":0 }, "prodCountIncrementType":{ "description":"Indicator of when to add ordered items to the production counter.", "type":"integer", "example":0 }, "prodCountDecrementType":{ "description":"Indicator of when to decrease the count of items from the production counter.", "type":"integer", "example":0 }, "autoBumpTimeInSecs":{ "description":"The wait time before automatically bumping all closed orders after reaching the Check Count.", "type":"integer", "example":0 }, "autoBumpCheckCount":{ "description":"The number of checks allowed to appear on the KDS before automatically bumping.", "type":"integer", "example":0 }, "svcHost":{ "description":"An object representing the service host details associated with the KDS controller.", "type":"object", "properties":{ "svcHostObjNum":{ "description":"Object number of the service host associated with the KDS Controller.", "type":"integer", "example":1 } } }, "bckupSVCHost":{ "description":"An object representing the backup service host details associated with the KDS controller.", "type":"object", "properties":{ "bckupSVCHostObjNum":{ "description":"Object number of the backup service host associated with the KDS Controller.", "type":"integer", "example":1 } } }, "itemStatusColors":{ "description":"An object containing an integer value representing the item status colors as per the below mapping. 0 - Default 1 - Black 2 - White 3 - Blue 4 - Cyan5 - Dark Gray 6 - Gray 7 - Light Gray 8 - Green 9 - Magenta 10 - Orange 11 - Pink 12 - Red 13 - Yellow", "type":"object", "properties":{ "statusSentColor":{ "description":"Integer value representing the color in which items appear when workstation operators send orders to the KDS.", "type":"integer", "example":0 }, "statusFiredColor":{ "description":"Integer value representing the color in which items appear when they fire to Prep Displays.", "type":"integer", "example":0 }, "statusBumpedColor":{ "description":"Integer value representing the color in which items appear when they are bumped from Prep Displays.", "type":"integer", "example":0 }, "statusStartedColor":{ "description":"Integer value representing the color in which items appear when they are Prep started.", "type":"integer", "example":0 }, "itemSelectColor":{ "description":"Integer value representing the color of the item status background.", "type":"integer", "example":0 }, "itemMarkColor":{ "description":"Integer value representing the color of the item Mark status background.", "type":"integer", "example":0 }, "itemRecallColor":{ "description":"Integer value representing the color of the item Recall status background.", "type":"integer", "example":0 }, "itemRecallableColor":{ "description":"Integer value representing the color of the item Recallable status background.", "type":"integer", "example":0 } } }, "layoutColorsOverride":{ "description":"An object representing the layout color override.", "type":"object", "properties":{ "alert1":{ "description":"Hexadecimal value representing the RBG combination of the background color for orders exceeding the first alert time.", "type":"string", "example":"000000" }, "alert2":{ "description":"Hexadecimal value representing the RBG combination of the background color for orders exceeding the second alert time.", "type":"string", "example":"000000" }, "background":{ "description":"Hexadecimal value representing the RBG combination of the background panel color for the KDS Display.", "type":"string", "example":"000000" }, "orderSelection":{ "description":"Hexadecimal value representing the RBG combination of the color in which the border of an order appears when selecting an item.", "type":"string", "example":"000000" }, "orderBackground":{ "description":"Hexadecimal value representing the RBG combination of the background color for orders on the KDS Display.", "type":"string", "example":"000000" }, "voidItem":{ "description":"Hexadecimal value representing the RBG combination of the color in which voided items appear on the KDS.", "type":"string", "example":"000000" }, "course1Item":{ "description":"Hexadecimal value representing the RBG combination of the color in which Course 1 items appear on the KDS.", "type":"string", "example":"000000" } } }, "extPostingFile1":{ "description":"File name and directory path for the text file where the KDS transaction information is stored.", "type":"string", "example":"file1.txt" }, "extPostingFile2":{ "description":"File name and directory path for the text file where the KDS transaction information is stored.", "type":"string", "example":"file2.txt" }, "extPostingFile3":{ "description":"File name and directory path for the text file where the KDS transaction information is stored.", "type":"string", "example":"file3.txt" } } }, "SystemEmployeeProperty":{ "description":"System employee property record", "type":"object", "properties":{ "objectNum":{ "description":"Object number of the system employee.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Hierarchy unit value of property associated with employee.", "type":"integer", "example":3599 }, "employeeClassObjNum":{ "description":"Object number of the class of the system employee at the property.", "type":"integer", "example":1 }, "defaultRvcHierUnitId":{ "description":"Unique hierarchy unit value associated with the default RVC.", "type":"integer", "example":1 } } }, "OrderTypeResourceObject":{ "description":"Model for Order Type Object", "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "lineNum":{ "type":"integer", "example":1, "description":"Line number of the Order Types" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "dataExtensions":{ "description":"An array of data extensions for the Order Types", "type":"array", "items":{ "$ref":"#/definitions/OrderType_dataExtentions" } } } }, "OrderTypev2":{ "description":"Model for Order Type Object", "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "lineNum":{ "type":"integer", "example":1, "description":"Line number of the Order Types" }, "name":{ "type":"object", "description":"Order Type Name", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "dataExtensions":{ "description":"An array of data extensions for the Order Types", "type":"array", "items":{ "$ref":"#/definitions/OrderType_dataExtentions" } } } }, "OrderTypeCUDRequestBody":{ "description":"Model for Order Type CUD Request", "type":"object", "required":[ "hierUnitId", "lineNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "lineNum":{ "type":"integer", "example":1, "description":"Line number of the Order Types" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "dataExtensions":{ "description":"An array of data extensions for the Order Types", "type":"array", "items":{ "$ref":"#/definitions/OrderType_dataExtentions" } } } }, "OrderType_dataExtentions":{ "type":"object", "properties":{ "value":{ "type":"string", "example":"Value 1", "description":"Value of the extention field" }, "columnName":{ "type":"string", "example":"Extention Column 1", "description":"Name of the extention field" } } }, "OrderTypeGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of language objects of the organization.", "items":{ "$ref":"#/definitions/OrderTypeResourceObject" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "OrderTypeResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "lineNum":{ "type":"integer", "example":1, "description":"Unique reference of the Order Type" } } }, "OrderTypeDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "ServiceChargeGroupCURequestBody":{ "description":"Model for ServiceChargeGroup Object", "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 }, "details":{ "description":"An array of service charges that are part of the service charge group", "type":"array", "items":{ "type":"object", "properties":{ "sequenceNum":{ "description":"Sequence number of the service charge group detail in the service charge group", "type":"integer", "example":1 }, "svcObjNum":{ "description":"Object number of the service charge", "type":"integer", "example":1 } } } } } }, "ServiceChargeGroupGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Service Charge Group objects of the organization.", "items":{ "$ref":"#/definitions/ServiceChargeGroupResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "ServiceChargeGroupResponsev1":{ "description":"Model for ServiceChargeGroup Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 }, "details":{ "description":"An array of service charges that are part of the service charge group", "type":"array", "items":{ "type":"object", "properties":{ "sequenceNum":{ "description":"Sequence number of the service charge group detail in the service charge group", "type":"integer", "example":1 }, "svcObjNum":{ "description":"Object number of the service charge", "type":"integer", "example":1 }, "svcName":{ "type":"object", "description":"SVC Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } } } } } } }, "ServiceChargeGroupv2":{ "description":"Model for ServiceChargeGroup Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "name":{ "description":"Service Charge Group Name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 }, "details":{ "description":"An array of service charges that are part of the service charge group", "type":"array", "items":{ "type":"object", "properties":{ "sequenceNum":{ "description":"Sequence number of the service charge group detail in the service charge group", "type":"integer", "example":1 }, "svcObjNum":{ "description":"Object number of the service charge", "type":"integer", "example":1 } } } } } }, "ServiceChargeGroupResponse":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 } } }, "ServiceChargeCURequestBody":{ "description":"Model for Service Charge Object", "type":"object", "required":[ "hierUnitId", "name", "objectNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Service Charge in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "effGrpObjNum":{ "description":"Object number of the Effectivity Group for the current record", "type":"integer", "example":1 }, "consumerDisplayname":{ "description":"A group of string objects representing the name of the Service Charge in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "percent":{ "description":"Percentage for the manual ServiceCharge.", "type":"integer", "example":1 }, "amount":{ "description":"Maximum amount allowed for an open-priced or amount ServiceCharge", "type":"integer", "example":1 }, "taxClassObjNum":{ "description":"Tax Class object number for the ServiceCharge", "type":"integer", "example":1 }, "privilegeGroup":{ "description":"Privilege Group number to restrict the use of the ServiceCharge", "type":"integer", "example":1 }, "reportGroupObjNum":{ "description":"Report Group to associate with the ServiceCharge.", "type":"integer", "example":1 }, "printClassObjNum":{ "description":"Print Class object number for the service charge", "type":"integer", "example":1 }, "pickupTenderOrMediaObjNum":{ "description":"Pickup Tender Media object number for the service charge", "type":"integer", "example":1 }, "percentToTipsPaid":{ "description":"percentage of a charged tip that posts to the Tips Paid Tender/Media.", "type":"integer", "example":1 }, "halo":{ "description":"Maximum amount allowed for an open-priced or amount ServiceCharge", "type":"integer", "example":1 }, "options":{ "description":"A String of Values of 0s and 1s of length 56 representing the enablement or disablement of the options associated with ServiceCharges", "type":"string", "example":"00000000000000000000000000000000000000000000000000000000" }, "svcItmzr":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the ServiceCharge itemizers on which the ServiceCharge is computable", "type":"string", "example":"00000010" }, "menuLevels":{ "description":"An object containing the menu levels on which the ServiceCharge is active", "type":"object", "properties":{ "mainLevel":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the ServiceCharge on main levels", "type":"string", "example":"00000010" }, "sublevel":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the ServiceCharge on sub levels", "type":"string", "example":"00000010" } } }, "transDefaultMainLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Main Level after pressing the ServiceCharge", "type":"boolean", "example":false }, "mainLevelPopup":{ "description":"The Main Level that activates after pressing the ServiceCharge", "type":"integer", "example":1 }, "transDefaultSubLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Sub Level after pressing the ServiceCharge.", "type":"boolean", "example":false }, "subLevelPopup":{ "description":"The Sub Level that activates after pressing the ServiceCharge", "type":"integer", "example":1 }, "svcSLUNum":{ "description":"Object number of the Screen Lookup key for the ServiceCharge.", "type":"integer", "example":1 }, "nlu":{ "description":"A unique Number Lookup (0-9,999,999,999) for the ServiceCharge", "type":"integer", "example":1 }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } }, "ServiceChargeResponsev1":{ "description":"Model for Service Charge Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object number of the Service Charge", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Service Charge in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "effGrpObjNum":{ "description":"Object number of the Effectivity Group for the current record", "type":"integer", "example":1 }, "effGrpName":{ "description":"A group of string objects representing the name of the effectivity group for the ServiceCharge in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "consumerDisplayname":{ "description":"A group of string objects representing the name of the Service Charge in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "percent":{ "description":"Percentage for the manual ServiceCharge.", "type":"integer", "example":1 }, "amount":{ "description":"Maximum amount allowed for an open-priced or amount ServiceCharge", "type":"integer", "example":1 }, "taxClassObjNum":{ "description":"Tax Class object number for the ServiceCharge", "type":"integer", "example":1 }, "taxClassName":{ "description":"A group of string objects representing the name of the tax class to be ServiceChargeed in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "privilegeGroup":{ "description":"Privilege Group number to restrict the use of the ServiceCharge", "type":"integer", "example":1 }, "reportGroupObjNum":{ "description":"Report Group to associate with the ServiceCharge.", "type":"integer", "example":1 }, "reportGroupName":{ "description":"A group of string objects representing the name of the report group associated with the ServiceCharge in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "printClassObjNum":{ "description":"Print Class object number for the service charge", "type":"integer", "example":1 }, "printClassName":{ "description":"A group of string objects representing the name of the print class for the ServiceCharge in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "pickupTenderOrMediaObjNum":{ "description":"Pickup Tender Media object number for the service charge", "type":"integer", "example":1 }, "pickupTenderOrMediaObjName":{ "description":"A group of string objects representing the name of the Tender Media for the ServiceCharge in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "percentToTipsPaid":{ "description":"percentage of a charged tip that posts to the Tips Paid Tender/Media.", "type":"integer", "example":1 }, "halo":{ "description":"Maximum amount allowed for an open-priced or amount ServiceCharge", "type":"integer", "example":1 }, "options":{ "description":"A String of Values of 0s and 1s of length 56 representing the enablement or disablement of the options associated with ServiceCharges", "type":"string", "example":"00000000000000000000000000000000000000000000000000000000" }, "optionsExt":{ "description":"An object containing the descriptive option list", "type":"object", "properties":{ "isOpen":{ "description":"A Boolean flag indicating to make the service charge an open service charge, prompting workstation operators for the amount or percentage. Deselect to use a preset amount or preset percentage for the service charge.", "type":"boolean", "example":false }, "isAmount":{ "description":"A Boolean flag indicating to make the service charge an amount service charge. Deselect to make the service charge a percentage service charge.", "type":"boolean", "example":false }, "postToChargedTipsTotalOnTipsReport":{ "description":"A Boolean flag indicating to post the service charge to the Direct Charged Tips total and to add it to the Total Tips. When enabled (1) deselect Do Not Post to Gross Receipts, (2) select either the Post to Charged Tips Total on Tip Reports option or the Post to Service Charges Total on Tip Reports option, but not both, and (3) Workstation operators must enter a charged tip payment using a tendering key that has the Tender/Media option Post to Charged Receipts on Tip Reports enabled.", "type":"boolean", "example":false }, "postToServiceChargesTotalOnTipsReport":{ "description":"A Boolean flag indicating to post the service charge to the Service Charges total, but not the Total Tips or the Gross F&B Receipts total. You must select either option Post to Charge Tips Total on Tip Reports or Post to Service Charges Total on Tip Reports, but not both. Deselect to post the service charge to the Gross F&B Receipts, but not the Service Charges.", "type":"boolean", "example":false }, "referenceEntryRequired":{ "description":"A Boolean flag indicating to require workstation operators to enter a Reference Entry when using the Service Charge.", "type":"boolean", "example":false }, "validationRequired":{ "description":"A Boolean flag indicating to print a validation chit when using the service charge", "type":"boolean", "example":false }, "isNonRevenueServiceCharge":{ "description":"A Boolean flag indicating to create a service charge that can be paid by credit card without posting to Simphony's sales totals (for example, a service charge that is used for Gift Certificate Sales). You can track the amount, if necessary, by a tracking group total. When enabled , (1) you must program the service charge as an amount service charge, (2) a non-revenue service charge cannot be posted to a check that contains menu items unless the service charge is a Gift Card or rental deposit or the check is a Fast Transaction, and (3) if a cashier link is required for tendering, then a cashier link is also required to post a non-revenue service charge.", "type":"boolean", "example":false }, "resetItemizers":{ "description":"A Boolean flag indicating to prevent this service charge or another service charge from being applied twice to menu items that post to the same Service Charge Itemizers. Deselect to allow multiple service charges on the same Service Charge Itemizers.", "type":"boolean", "example":false }, "serviceChargeAddsToGuestCount":{ "description":"A Boolean flag indicating to increment the guest count for a transaction by one whenever the service charge is applied. This option is used for non-revenue service charges that are used as cover charges. RVC Parameters option Use Number of Seats for Guest Count overrides this option.", "type":"boolean", "example":false }, "donotPostToGrossReceipts":{ "description":"A Boolean flag indicating to prevent sales on checks with this service charge from posting to Gross F&B Receipts on Tip Reports. When enabled, the Post to Charge Tips Total on Tip Reports option must be disabled. This is for service charges that meet the U.S. Internal Revenue Service's definition of non-allocable receipts (as defined in the IRS Instructions for Form 8027). Deselect to allow this service charge to post to Gross F&B Receipts on the Tip Reports.", "type":"boolean", "example":false }, "isItemSharable":{ "description":"A Boolean flag indicating to share items between two or more seats or two or more checks when using Touch Edit or Touch Split.", "type":"boolean", "example":false }, "cashTips":{ "description":"A Boolean flag indicating to add the Direct Cash Tips total on the Tip Reports. The Post to Charge Tips on Tip Reports and Post to Service Charges on Tip Reports options override this option.", "type":"boolean", "example":false }, "usedForStoredValueTransactions":{ "description":"A Boolean flag indicating if the service charge is used for stored value transactions.", "type":"boolean", "example":false }, "useFloorAmount":{ "description":"A Boolean flag indicating option to require a minimum value for the automatic service charge. This option only applies to the service charge in revenue centers where it is used as an automatic service charge.", "type":"boolean", "example":false }, "giftCertificateSold":{ "description":"A Boolean flag indicating to create a service charge that can be paid without posting to Simphony's sales totals. This option is similar to option 7 - Non-Revenue Service Charge, except menu items can be present on the check in addition to this service charge. When enabled (1) option", "type":"boolean", "example":false }, "isRentalDeposit":{ "description":"A Boolean flag indicating to use the service charge as a rental deposit. You can enable this option for non-revenue service charges. Unlike traditional non-revenue service charges, a check can contain more than one rental deposit service charge.", "type":"boolean", "example":false }, "configureAsBanquetTip":{ "description":"A Boolean flag indicating the option to include the amount of the service charge transaction in the Tip Summary Total of the banquet check.", "type":"boolean", "example":false }, "configureAsBanquetFee":{ "description":"A Boolean flag indicating the option to include the amount of the service charge transaction in the Fees Summary Total based upon the selected service charge on the banquet check.", "type":"boolean", "example":false }, "isCashManagementTransactionItem":{ "description":"A Boolean flag indicating to include the service charge in Cash Management tracking and reporting.", "type":"boolean", "example":false }, "prorateSVCToMenuItems":{ "description":"A Boolean flag indicating if the Service Charge will be prorated based on the value of the active menu items. This will override the requirement for the minimum number of guest count for a memo check, if the minimum guest count requirement is met for the whole check", "type":"boolean", "example":false } } }, "svcItmzr":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the ServiceCharge itemizers on which the ServiceCharge is computable", "type":"string", "example":"00000010" }, "svcItmzrExt":{ "description":"An object containing the descriptive list associated with the service charge itemizers", "type":"object", "properties":{ "svcItmzr1":{ "description":"A Boolean flag indicating if the service charge is computable on service charge itemizer 1", "type":"boolean", "example":false }, "svcItmzr2":{ "description":"A Boolean flag indicating if the service charge is computable on service charge itemizer 2", "type":"boolean", "example":false }, "svcItmzr3":{ "description":"A Boolean flag indicating if the service charge is computable on service charge itemizer 3", "type":"boolean", "example":false }, "svcItmzr4":{ "description":"A Boolean flag indicating if the service charge is computable on service charge itemizer 4", "type":"boolean", "example":false }, "svcItmzr5":{ "description":"A Boolean flag indicating if the service charge is computable on service charge itemizer 5", "type":"boolean", "example":false }, "svcItmzr6":{ "description":"A Boolean flag indicating if the service charge is computable on service charge itemizer 6", "type":"boolean", "example":false }, "svcItmzr7":{ "description":"A Boolean flag indicating if the service charge is computable on service charge itemizer 7", "type":"boolean", "example":false }, "svcItmzr8":{ "description":"A Boolean flag indicating if the service charge is computable on service charge itemizer 8", "type":"boolean", "example":false } } }, "menuLevels":{ "description":"An object containing the menu levels on which the ServiceCharge is active", "type":"object", "properties":{ "mainLevel":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the ServiceCharge on main levels", "type":"string", "example":"00000010" }, "mainLevelExt":{ "description":"An object containing the descriptive list associated with the enablement or disablement of the ServiceCharge on main level", "type":"object", "properties":{ "mainLevel1":{ "description":"A Boolean flag indicating if the ServiceCharge is available at main level 1", "type":"boolean", "example":false }, "mainLevel2":{ "description":"A Boolean flag indicating if the ServiceCharge is available at main level 2", "type":"boolean", "example":false }, "mainLevel3":{ "description":"A Boolean flag indicating if the ServiceCharge is available at main level 3", "type":"boolean", "example":false }, "mainLevel4":{ "description":"A Boolean flag indicating if the ServiceCharge is available at main level 4", "type":"boolean", "example":false }, "mainLevel5":{ "description":"A Boolean flag indicating if the ServiceCharge is available at main level 5", "type":"boolean", "example":false }, "mainLevel6":{ "description":"A Boolean flag indicating if the ServiceCharge is available at main level 6", "type":"boolean", "example":false }, "mainLevel7":{ "description":"A Boolean flag indicating if the ServiceCharge is available at main level 7", "type":"boolean", "example":false }, "mainLevel8":{ "description":"A Boolean flag indicating if the ServiceCharge is available at main level 8", "type":"boolean", "example":false } } }, "sublevel":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the ServiceCharge on sub levels", "type":"string", "example":"00000010" }, "subLevelExt":{ "description":"An object containing the descriptive list associated with the enablement or disablement of the ServiceCharge on sub level", "type":"object", "properties":{ "subLevel1":{ "description":"A Boolean flag indicating if the ServiceCharge is available at sub level 1", "type":"boolean", "example":false }, "subLevel2":{ "description":"A Boolean flag indicating if the ServiceCharge is available at sub level 2", "type":"boolean", "example":false }, "subLevel3":{ "description":"A Boolean flag indicating if the ServiceCharge is available at sub level 3", "type":"boolean", "example":false }, "subLevel4":{ "description":"A Boolean flag indicating if the ServiceCharge is available at sub level 4", "type":"boolean", "example":false }, "subLevel5":{ "description":"A Boolean flag indicating if the ServiceCharge is available at sub level 5", "type":"boolean", "example":false }, "subLevel6":{ "description":"A Boolean flag indicating if the ServiceCharge is available at sub level 6", "type":"boolean", "example":false }, "subLevel7":{ "description":"A Boolean flag indicating if the ServiceCharge is available at sub level 7", "type":"boolean", "example":false }, "subLevel8":{ "description":"A Boolean flag indicating if the ServiceCharge is available at sub level 8", "type":"boolean", "example":false } } } } }, "transDefaultMainLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Main Level after pressing the ServiceCharge", "type":"boolean", "example":false }, "mainLevelPopup":{ "description":"The Main Level that activates after pressing the ServiceCharge", "type":"integer", "example":1 }, "transDefaultSubLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Sub Level after pressing the ServiceCharge.", "type":"boolean", "example":false }, "subLevelPopup":{ "description":"The Sub Level that activates after pressing the ServiceCharge", "type":"integer", "example":1 }, "svcSLUNum":{ "description":"Object number of the Screen Lookup key for the ServiceCharge.", "type":"integer", "example":1 }, "svcSLUName":{ "description":"A group of string objects representing the name of the SLU in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "nlu":{ "description":"A unique Number Lookup (0-9,999,999,999) for the ServiceCharge", "type":"integer", "example":1 }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } }, "ServiceChargeGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of service charge objects of the organization.", "items":{ "$ref":"#/definitions/ServiceChargeResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "ServiceChargev2":{ "description":"Model for Service Charge Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Service Charge in configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "effGrpObjNum":{ "description":"Object number of the Effectivity Group for the current record", "type":"integer", "example":1 }, "consumerDisplayname":{ "description":"A group of string objects representing the name of the Service Charge in configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "percent":{ "description":"Percentage for the manual ServiceCharge.", "type":"integer", "example":1 }, "amount":{ "description":"Maximum amount allowed for an open-priced or amount ServiceCharge", "type":"integer", "example":1 }, "taxClassObjNum":{ "description":"Tax Class object number for the ServiceCharge", "type":"integer", "example":1 }, "privilegeGroup":{ "description":"Privilege Group number to restrict the use of the ServiceCharge", "type":"integer", "example":1 }, "reportGroupObjNum":{ "description":"Report Group to associate with the ServiceCharge.", "type":"integer", "example":1 }, "printClassObjNum":{ "description":"Print Class object number for the service charge", "type":"integer", "example":1 }, "pickupTenderOrMediaObjNum":{ "description":"Pickup Tender Media object number for the service charge", "type":"integer", "example":1 }, "percentToTipsPaid":{ "description":"percentage of a charged tip that posts to the Tips Paid Tender/Media.", "type":"integer", "example":1 }, "halo":{ "description":"Maximum amount allowed for an open-priced or amount ServiceCharge", "type":"integer", "example":1 }, "options":{ "description":"A String of Values of 0s and 1s of length 56 representing the enablement or disablement of the options associated with ServiceCharges", "type":"string", "example":"00000000000000000000000000000000000000000000000000000000" }, "optionsExt":{ "description":"An object containing the descriptive option list", "type":"object", "properties":{ "isOpen":{ "description":"A Boolean flag indicating to make the service charge an open service charge, prompting workstation operators for the amount or percentage. Deselect to use a preset amount or preset percentage for the service charge.", "type":"boolean", "example":false }, "isAmount":{ "description":"A Boolean flag indicating to make the service charge an amount service charge. Deselect to make the service charge a percentage service charge.", "type":"boolean", "example":false }, "postToChargedTipsTotalOnTipsReport":{ "description":"A Boolean flag indicating to post the service charge to the Direct Charged Tips total and to add it to the Total Tips. When enabled (1) deselect Do Not Post to Gross Receipts, (2) select either the Post to Charged Tips Total on Tip Reports option or the Post to Service Charges Total on Tip Reports option, but not both, and (3) Workstation operators must enter a charged tip payment using a tendering key that has the Tender/Media option Post to Charged Receipts on Tip Reports enabled.", "type":"boolean", "example":false }, "postToServiceChargesTotalOnTipsReport":{ "description":"A Boolean flag indicating to post the service charge to the Service Charges total, but not the Total Tips or the Gross F&B Receipts total. You must select either option Post to Charge Tips Total on Tip Reports or Post to Service Charges Total on Tip Reports, but not both. Deselect to post the service charge to the Gross F&B Receipts, but not the Service Charges.", "type":"boolean", "example":false }, "referenceEntryRequired":{ "description":"A Boolean flag indicating to require workstation operators to enter a Reference Entry when using the Service Charge.", "type":"boolean", "example":false }, "validationRequired":{ "description":"A Boolean flag indicating to print a validation chit when using the service charge", "type":"boolean", "example":false }, "isNonRevenueServiceCharge":{ "description":"A Boolean flag indicating to create a service charge that can be paid by credit card without posting to Simphony's sales totals (for example, a service charge that is used for Gift Certificate Sales). You can track the amount, if necessary, by a tracking group total. When enabled , (1) you must program the service charge as an amount service charge, (2) a non-revenue service charge cannot be posted to a check that contains menu items unless the service charge is a Gift Card or rental deposit or the check is a Fast Transaction, and (3) if a cashier link is required for tendering, then a cashier link is also required to post a non-revenue service charge.", "type":"boolean", "example":false }, "resetItemizers":{ "description":"A Boolean flag indicating to prevent this service charge or another service charge from being applied twice to menu items that post to the same Service Charge Itemizers. Deselect to allow multiple service charges on the same Service Charge Itemizers.", "type":"boolean", "example":false }, "serviceChargeAddsToGuestCount":{ "description":"A Boolean flag indicating to increment the guest count for a transaction by one whenever the service charge is applied. This option is used for non-revenue service charges that are used as cover charges. RVC Parameters option Use Number of Seats for Guest Count overrides this option.", "type":"boolean", "example":false }, "donotPostToGrossReceipts":{ "description":"A Boolean flag indicating to prevent sales on checks with this service charge from posting to Gross F&B Receipts on Tip Reports. When enabled, the Post to Charge Tips Total on Tip Reports option must be disabled. This is for service charges that meet the U.S. Internal Revenue Service's definition of non-allocable receipts (as defined in the IRS Instructions for Form 8027). Deselect to allow this service charge to post to Gross F&B Receipts on the Tip Reports.", "type":"boolean", "example":false }, "isItemSharable":{ "description":"A Boolean flag indicating to share items between two or more seats or two or more checks when using Touch Edit or Touch Split.", "type":"boolean", "example":false }, "cashTips":{ "description":"A Boolean flag indicating to add the Direct Cash Tips total on the Tip Reports. The Post to Charge Tips on Tip Reports and Post to Service Charges on Tip Reports options override this option.", "type":"boolean", "example":false }, "usedForStoredValueTransactions":{ "description":"A Boolean flag indicating if the service charge is used for stored value transactions.", "type":"boolean", "example":false }, "useFloorAmount":{ "description":"A Boolean flag indicating option to require a minimum value for the automatic service charge. This option only applies to the service charge in revenue centers where it is used as an automatic service charge.", "type":"boolean", "example":false }, "giftCertificateSold":{ "description":"A Boolean flag indicating to create a service charge that can be paid without posting to Simphony's sales totals. This option is similar to option 7 - Non-Revenue Service Charge, except menu items can be present on the check in addition to this service charge. When enabled (1) option", "type":"boolean", "example":false }, "isRentalDeposit":{ "description":"A Boolean flag indicating to use the service charge as a rental deposit. You can enable this option for non-revenue service charges. Unlike traditional non-revenue service charges, a check can contain more than one rental deposit service charge.", "type":"boolean", "example":false }, "configureAsBanquetTip":{ "description":"A Boolean flag indicating the option to include the amount of the service charge transaction in the Tip Summary Total of the banquet check.", "type":"boolean", "example":false }, "configureAsBanquetFee":{ "description":"A Boolean flag indicating the option to include the amount of the service charge transaction in the Fees Summary Total based upon the selected service charge on the banquet check.", "type":"boolean", "example":false }, "isCashManagementTransactionItem":{ "description":"A Boolean flag indicating to include the service charge in Cash Management tracking and reporting.", "type":"boolean", "example":false }, "prorateSVCToMenuItems":{ "description":"A Boolean flag indicating if the Service Charge will be prorated based on the value of the active menu items. This will override the requirement for the minimum number of guest count for a memo check, if the minimum guest count requirement is met for the whole check", "type":"boolean", "example":false } } }, "svcItmzr":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the ServiceCharge itemizers on which the ServiceCharge is computable", "type":"string", "example":"00000010" }, "svcItmzrExt":{ "description":"An object containing the descriptive list associated with the service charge itemizers", "type":"object", "properties":{ "svcItmzr1":{ "description":"A Boolean flag indicating if the service charge is computable on service charge itemizer 1", "type":"boolean", "example":false }, "svcItmzr2":{ "description":"A Boolean flag indicating if the service charge is computable on service charge itemizer 2", "type":"boolean", "example":false }, "svcItmzr3":{ "description":"A Boolean flag indicating if the service charge is computable on service charge itemizer 3", "type":"boolean", "example":false }, "svcItmzr4":{ "description":"A Boolean flag indicating if the service charge is computable on service charge itemizer 4", "type":"boolean", "example":false }, "svcItmzr5":{ "description":"A Boolean flag indicating if the service charge is computable on service charge itemizer 5", "type":"boolean", "example":false }, "svcItmzr6":{ "description":"A Boolean flag indicating if the service charge is computable on service charge itemizer 6", "type":"boolean", "example":false }, "svcItmzr7":{ "description":"A Boolean flag indicating if the service charge is computable on service charge itemizer 7", "type":"boolean", "example":false }, "svcItmzr8":{ "description":"A Boolean flag indicating if the service charge is computable on service charge itemizer 8", "type":"boolean", "example":false } } }, "menuLevels":{ "description":"An object containing the menu levels on which the ServiceCharge is active", "type":"object", "properties":{ "mainLevel":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the ServiceCharge on main levels", "type":"string", "example":"00000010" }, "mainLevelExt":{ "description":"An object containing the descriptive list associated with the enablement or disablement of the ServiceCharge on main level", "type":"object", "properties":{ "mainLevel1":{ "description":"A Boolean flag indicating if the ServiceCharge is available at main level 1", "type":"boolean", "example":false }, "mainLevel2":{ "description":"A Boolean flag indicating if the ServiceCharge is available at main level 2", "type":"boolean", "example":false }, "mainLevel3":{ "description":"A Boolean flag indicating if the ServiceCharge is available at main level 3", "type":"boolean", "example":false }, "mainLevel4":{ "description":"A Boolean flag indicating if the ServiceCharge is available at main level 4", "type":"boolean", "example":false }, "mainLevel5":{ "description":"A Boolean flag indicating if the ServiceCharge is available at main level 5", "type":"boolean", "example":false }, "mainLevel6":{ "description":"A Boolean flag indicating if the ServiceCharge is available at main level 6", "type":"boolean", "example":false }, "mainLevel7":{ "description":"A Boolean flag indicating if the ServiceCharge is available at main level 7", "type":"boolean", "example":false }, "mainLevel8":{ "description":"A Boolean flag indicating if the ServiceCharge is available at main level 8", "type":"boolean", "example":false } } }, "sublevel":{ "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the ServiceCharge on sub levels", "type":"string", "example":"00000010" }, "subLevelExt":{ "description":"An object containing the descriptive list associated with the enablement or disablement of the ServiceCharge on sub level", "type":"object", "properties":{ "subLevel1":{ "description":"A Boolean flag indicating if the ServiceCharge is available at sub level 1", "type":"boolean", "example":false }, "subLevel2":{ "description":"A Boolean flag indicating if the ServiceCharge is available at sub level 2", "type":"boolean", "example":false }, "subLevel3":{ "description":"A Boolean flag indicating if the ServiceCharge is available at sub level 3", "type":"boolean", "example":false }, "subLevel4":{ "description":"A Boolean flag indicating if the ServiceCharge is available at sub level 4", "type":"boolean", "example":false }, "subLevel5":{ "description":"A Boolean flag indicating if the ServiceCharge is available at sub level 5", "type":"boolean", "example":false }, "subLevel6":{ "description":"A Boolean flag indicating if the ServiceCharge is available at sub level 6", "type":"boolean", "example":false }, "subLevel7":{ "description":"A Boolean flag indicating if the ServiceCharge is available at sub level 7", "type":"boolean", "example":false }, "subLevel8":{ "description":"A Boolean flag indicating if the ServiceCharge is available at sub level 8", "type":"boolean", "example":false } } } } }, "transDefaultMainLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Main Level after pressing the ServiceCharge", "type":"boolean", "example":false }, "mainLevelPopup":{ "description":"The Main Level that activates after pressing the ServiceCharge", "type":"integer", "example":1 }, "transDefaultSubLevel":{ "description":"A Boolean flag indicating to return the transaction to the default Sub Level after pressing the ServiceCharge.", "type":"boolean", "example":false }, "subLevelPopup":{ "description":"The Sub Level that activates after pressing the ServiceCharge", "type":"integer", "example":1 }, "svcSLUNum":{ "description":"Object number of the Screen Lookup key for the ServiceCharge.", "type":"integer", "example":1 }, "nlu":{ "description":"A unique Number Lookup (0-9,999,999,999) for the ServiceCharge", "type":"integer", "example":1 }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" }, "dataExtensions":{ "description":"An array of data extensions", "type":"array", "items":{ "properties":{ "columnName":{ "description":"Name of the extension field", "type":"string", "example":"extension column 1" }, "value":{ "description":"Value of the extension field", "type":"string", "example":"Value1" } } } } } }, "ServiceChargeAddUpdateResponse":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge", "type":"integer", "example":1 }, "effGrpObjNum":{ "description":"Object number of the Effectivity Group for the current record", "type":"integer", "example":1 } } }, "ServiceChargeGroupDetailGetRequest":{ "description":"The input Body model that needs to be given.", "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order" }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations", "description":"Objects included in response" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned" }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 } } }, "ServiceChargeGroupDetailUpdateRequestBody":{ "description":"Model for ServiceChargeGroupDetail Object", "type":"object", "required":[ "hierUnitId", "objectNum", "svcObjNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence number of the service charge group detail in the service charge group", "type":"integer", "example":1 }, "svcObjNum":{ "description":"Object number of the service charge", "type":"integer", "example":1 } } }, "ServiceChargeGroupDetail":{ "description":"Model for ServiceChargeGroupDetail Object", "type":"object", "required":[ "hierUnitId", "objectNum", "sequenceNum", "svcObjNum" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence number of the service charge group detail in the service charge group", "type":"integer", "example":1 }, "svcObjNum":{ "description":"Object number of the service charge", "type":"integer", "example":1 }, "svcName":{ "type":"object", "description":"SVC Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } } } }, "ServiceChargeGroupDetailGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Service Charge Group Detail objects of the organization.", "items":{ "$ref":"#/definitions/ServiceChargeGroupDetailResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "ServiceChargeGroupDetailResponsev1":{ "description":"Model for ServiceChargeGroupDetail Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence number of the service charge group detail in the service charge group", "type":"integer", "example":1 }, "svcObjNum":{ "description":"Object number of the service charge", "type":"integer", "example":1 }, "svcName":{ "type":"object", "description":"SVC Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } } } }, "ServiceChargeGroupDetailv2":{ "description":"Model for ServiceChargeGroupDetail Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence number of the service charge group detail in the service charge group", "type":"integer", "example":1 }, "svcObjNum":{ "description":"Object number of the service charge", "type":"integer", "example":1 } } }, "ServiceChargeGroupDetailResponse":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the Service Charge Group", "type":"integer", "example":1 }, "sequenceNum":{ "description":"Sequence number of the service charge group detail in the service charge group", "type":"integer", "example":1 } } }, "DeploymentScheduleGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Deployment Schedule objects of the organization.", "items":{ "$ref":"#/definitions/DeploymentScheduleResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "DeploymentScheduleResponsev1":{ "description":"Model for CAL Deployment Schedule Object", "type":"object", "properties":{ "deploymentId":{ "description":"Unique reference of the CAL deployment schedule.", "type":"integer", "example":111 }, "packageId":{ "description":"Unique reference of the CAL Package", "type":"integer", "example":101 }, "packageName":{ "description":"Name of the CAL deployment package", "type":"string", "example":"CAPSOnIIS.19.3.3" }, "version":{ "description":"Version of the CAL deployment package", "type":"string", "example":"19.3.3" }, "deploymentType":{ "description":"The Type of the deployment. 1 - Property / Enterprise, 2 - Specific Service Host", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of hierarchy unit where the CAL package is to be downloaded. This could either the property where the package downloads or the Enterprise. Applicable only if the deploymentType = 1", "type":"integer", "example":3588 }, "svcHostObjNum":{ "description":"Object number of the service host or workstations where the package is downloaded. Applicable only if deploymentType = 2", "type":"integer", "example":141 }, "svcHostName":{ "type":"object", "description":"SVC Host Name", "example":{ "en-US":"SVC Host 1", "sp-SP":"Host de servicio 1" } }, "actionToTake":{ "description":"Action to take while downloading the package. \nSelect 0 for installations to proceed, Select 1 to Skip to prevent downloading a package.\n", "type":"integer", "example":0 }, "effectiveFrom":{ "description":"The start date when this package becomes active (also used to schedule upgrades).", "type":"string", "example":"14-04-2022T13:00:00" }, "effectiveTo":{ "description":"The end date when this package becomes inactive (also used to schedule upgrades).", "type":"string", "example":"14-04-2022T13:00:00" } } }, "CALDeploymentSchedulev2":{ "description":"Model for CAL Deployment Schedule Object", "type":"object", "properties":{ "deploymentId":{ "description":"Unique reference of the CAL deployment schedule.", "type":"integer", "example":111 }, "packageId":{ "description":"Unique reference of the CAL Package", "type":"integer", "example":101 }, "packageName":{ "description":"Name of the CAL deployment package", "type":"string", "example":"CAPSOnIIS.19.3.3" }, "version":{ "description":"Version of the CAL deployment package", "type":"string", "example":"19.3.3" }, "deploymentType":{ "description":"The Type of the deployment. 1 - Property / Enterprise, 2 - Specific Service Host", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of hierarchy unit where the CAL package is to be downloaded. This could either the property where the package downloads or the Enterprise. Applicable only if the deploymentType = 1", "type":"integer", "example":3588 }, "svcHostObjNum":{ "description":"Object number of the service host or workstations where the package is downloaded. Applicable only if deploymentType = 2", "type":"integer", "example":141 }, "actionToTake":{ "description":"Action to take while downloading the package. \nSelect 0 for installations to proceed, Select 1 to Skip to prevent downloading a package.\n", "type":"integer", "example":0 }, "effectiveFrom":{ "description":"The start date when this package becomes active (also used to schedule upgrades).", "type":"string", "example":"14-04-2022T13:00:00" }, "effectiveTo":{ "description":"The end date when this package becomes inactive (also used to schedule upgrades).", "type":"string", "example":"14-04-2022T13:00:00" } } }, "UpdateDeploymentSchedule":{ "description":"Model for Update CAL Deployment Schedule Object", "type":"object", "required":[ "packageId" ], "properties":{ "deploymentId":{ "description":"Unique reference of the CAL deployment schedule.", "type":"integer", "example":111 }, "packageId":{ "description":"Unique reference of the CAL Package", "type":"integer", "example":101 }, "hierUnitId":{ "description":"Unique reference of hierarchy unit where the CAL package is to be downloaded. This could either the property where the package downloads or the Enterprise. Applicable only if the deploymentType = 1", "type":"integer", "example":3588 }, "svcHostObjNum":{ "description":"Object number of the service host or workstations where the package is downloaded. Applicable only if deploymentType = 2", "type":"integer", "example":141 }, "actionToTake":{ "description":"Action to take while downloading the package. \nSelect 0 for installations to proceed, Select 1 to Skip to prevent downloading a package.\n", "type":"integer", "example":0 }, "version":{ "description":"Version of the CAL deployment package", "type":"string", "example":"19.3.3" }, "deploymentType":{ "description":"The Type of the deployment. 1 - Property / Enterprise, 2 - Specific Service Host", "type":"integer", "example":1 }, "effectiveFrom":{ "description":"The start date when this package becomes active (also used to schedule upgrades).", "type":"string", "example":"14-04-2022T13:00:00" }, "effectiveTo":{ "description":"The end date when this package becomes inactive (also used to schedule upgrades).", "type":"string", "example":"14-04-2022T13:00:00" } } }, "ResponseObjectDeploymentSchedule":{ "description":"Model for CAL Deployment Schedule Response Object", "type":"object", "properties":{ "deploymentId":{ "description":"Unique reference of the CAL deployment schedule.", "type":"integer", "example":111 } } }, "DiscountItemzrsResponse":{ "type":"object", "properties":{ "dscItmzrIndex":{ "description":"Unique reference of the Discount Itemizer", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique Hierarchy Unit Value", "type":"integer", "example":1 } } }, "DiscountItmzrsCURequestBody":{ "description":"Model for Discount Itmzrs", "type":"object", "required":[ "dscItmzrIndex", "hierUnitId", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "dscItmzrIndex":{ "description":"Object number of the Discount Itemizer", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Discounts Itmzrs in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } } } }, "DiscountItemizers":{ "description":"Model for Discount Itmzrs", "type":"object", "required":[ "dscItmzrIndex", "hierUnitId", "name" ], "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "dscItmzrIndex":{ "description":"Object number of the Discount Itemizer", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Discounts Itmzrs in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } } } }, "DiscountItemizersResponsev1":{ "description":"Model for Discount Itmzrs", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "hierUnitName":{ "description":"A group of string objects representing the name of the hierarchy unit configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "dscItmzrIndex":{ "description":"Object number of the Discount Itemizer", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Discounts Itmzrs in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } } } }, "DiscountItemizersGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Discount Itemizer objects of the organization.", "items":{ "$ref":"#/definitions/DiscountItemizersResponsev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "DiscountItemizerv2":{ "description":"Model for Discount Itmzrs", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit", "type":"integer", "example":1 }, "dscItmzrIndex":{ "description":"Object number of the Discount Itemizer", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the Discounts Itmzrs in configured languages", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } } } }, "GetReportingHierarchyLevelsResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":1, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":false, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Available Reporting Hierarchy Levels of the organization.", "items":{ "$ref":"#/definitions/ReportingHierarchyLevels" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "GetReportingHierarchyRelationshipResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":1, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":false, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":1, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of reporting hierarchy relationships", "items":{ "$ref":"#/definitions/ReportingHierarchyRelationships" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "ReportingHierarchyLevels":{ "type":"object", "properties":{ "reportingHierarchyName":{ "description":"Name of available reporting hierarchies present in the organization", "type":"string", "items":{ "type":"string" }, "example":"ReportingHierarchy" }, "levels":{ "description":"An array of available levels.", "type":"array", "items":{ "$ref":"#/definitions/level" } } } }, "level":{ "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "description":"name of the level", "example":"Corporate" } } }, "ReportingHierarchyRelationships":{ "type":"object", "required":[ "reportingHierarchyName", "parentReportingLevelName" ], "properties":{ "reportingHierarchyName":{ "type":"string", "description":"The name of reporting hierarchy where the parent level is assigned.", "example":"TestReportingHierarhy" }, "parentReportingLevelName":{ "type":"string", "description":"The name of parent enterprise level within the reporting hierarchy.", "example":"Corporate" } } }, "UpdateReportingHierarchyRelationshipResponse":{ "description":"The input body model that needs to be given for the update request.", "type":"object", "properties":{ "locRef":{ "type":"string", "description":"The unique reference for the reporting location", "example":"locRef1" } } }, "menuItemPricesGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Price objects.", "items":{ "$ref":"#/definitions/MenuItemPrice" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "MenuItemPriceGetRequestBody":{ "type":"object", "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId,1012)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." }, "hierUnitId":{ "type":"integer", "example":1012, "description":"Unique Hierarchy unit reference. This is an optional field. Alternatively, searchCriteria can be used to get results for a particular hierUnitId." } } }, "MenuItemPrice":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy unit unique reference" }, "menuItemMasterObjNum":{ "type":"integer", "example":101, "description":"Menu item master object number" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" }, "menuItemDefinitionId":{ "type":"integer", "example":501, "description":"Unique menu item definition reference" }, "defSequenceNum":{ "type":"integer", "example":5, "description":"Definition sequence number" }, "priceSequenceNum":{ "type":"integer", "example":3, "description":"Price record number" }, "menuItemPriceId":{ "type":"number", "example":5.16, "description":"Unique menu item price reference" }, "activeOnMenuLevel":{ "type":"number", "example":0.18, "description":"Menu Level Value" }, "prepCost":{ "type":"number", "example":0.18, "description":"Preparation cost" }, "price":{ "type":"number", "example":0.18, "description":"Menu item price. Note that precision is determined by currency settings." }, "taxClassOverrideObjNum":{ "type":"number", "example":0.18, "description":"Overrides menu item tax class setting (main item only)" }, "condimentParentTaxClassOverrideObjNum":{ "type":"number", "example":0.18, "description":"Specifies the parent item's tax class override (condiment item only)" }, "serviceChargeGroupObjNum":{ "type":"number", "example":0.18, "description":"Service charge group object number" }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing enabled or disabled options" }, "optionsExt":{ "description":"An object containing the descriptive options list associated with the menu item prices", "type":"object", "properties":{ "enableMenuItemTaxClassOverrideOverCondimentParent":{ "type":"boolean", "example":false, "description":"A flag indicating that menu item tax class override takes precedence over condiment parent tax class (Condiment only)" }, "excludeCondimentParentItemFromMenuItemTaxClassOverride":{ "type":"boolean", "example":false, "description":"A flag indicating to exclude condiment parent item from menu item tax class override count (Condiment only)" } } }, "effectivityGroupObjNum":{ "type":"number", "example":0.18, "description":"Effectivity group option numbers" }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" } }, "description":"Model for Menu Item Price object" }, "menuItemPricesUpdateRequestBody":{ "type":"object", "required":[ "hierUnitId", "menuItemDefinitionId", "priceSequenceNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy unit unique reference" }, "menuItemMasterObjNum":{ "type":"integer", "example":101, "description":"Menu item master object number" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" }, "menuItemDefinitionId":{ "type":"integer", "example":501, "description":"Unique menu item definition reference" }, "defSequenceNum":{ "type":"integer", "example":5, "description":"Definition sequence number" }, "priceSequenceNum":{ "type":"integer", "example":3, "description":"Price record number" }, "menuItemPriceId":{ "type":"number", "example":5.16, "description":"Unique menu item price reference" }, "activeOnMenuLevel":{ "type":"number", "example":0.18, "description":"Menu Level Value" }, "prepCost":{ "type":"number", "example":0.18, "description":"Preparation cost" }, "price":{ "type":"number", "example":0.18, "description":"Menu item price. Note that precision is determined by currency settings." }, "taxClassOverrideObjNum":{ "type":"number", "example":0.18, "description":"Overrides menu item tax class setting (main item only)" }, "condimentParentTaxClassOverrideObjNum":{ "type":"number", "example":0.18, "description":"Specifies the parent item's tax class override (condiment item only)" }, "serviceChargeGroupObjNum":{ "type":"number", "example":0.18, "description":"Service charge group object number" }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing enabled or disabled options" }, "effectivityGroupObjNum":{ "type":"number", "example":0.18, "description":"Effectivity group option numbers" }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" } }, "description":"Model for Menu Item Price object" }, "menuItemPricesResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy unit unique reference" }, "menuItemDefinitionId":{ "type":"integer", "example":501, "description":"Unique menu item definition reference" }, "defSequenceNum":{ "type":"integer", "example":5, "description":"Definition sequence number" }, "priceSequenceNum":{ "type":"integer", "example":3, "description":"Price record number" }, "menuItemPriceId":{ "type":"integer", "example":1, "description":"Unique menu item price reference" } } }, "MenuItemDefinitionResponseV1":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy unit unique reference" }, "menuItemMasterObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"The unique reference for the Menu Item Master" }, "menuItemDefinitionId":{ "type":"integer", "example":1, "description":"The unique reference for the Menu Item Definition" }, "defSequenceNum":{ "type":"integer", "example":1, "description":"Indicates the definition sequence number, which is the number of the definition in the revenue center for this master record.Sequence Number should be with 1-64" }, "firstName":{ "type":"object", "description":"First Name.", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "secondName":{ "type":"object", "description":"Second Name.", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "thirdName":{ "type":"object", "description":"Third Name.", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "longDescriptor":{ "type":"object", "description":"Long Descriptor.", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "menuItemClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item Class" }, "overridePrintClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Print Class" }, "mainLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing main levels on which the definition is active." }, "subLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing Sub Levels on which the definition is active" }, "slu1ObjNum":{ "type":"integer", "example":200, "description":"Object number of SLU 1 to which the Menu Item Definition belongs" }, "slu2ObjNum":{ "type":"integer", "example":201, "description":"Object number of SLU 2 to which the Menu Item Definition belongs" }, "slu3ObjNum":{ "type":"integer", "example":202, "description":"Object number of SLU 3 to which the Menu Item Definition belongs" }, "slu4ObjNum":{ "type":"integer", "example":203, "description":"Object number of SLU 4 to which the Menu Item Definition belongs" }, "slu5ObjNum":{ "type":"integer", "example":204, "description":"Object number of SLU 5 to which the Menu Item Definition belongs" }, "slu6ObjNum":{ "type":"integer", "example":205, "description":"Object number of SLU 6 to which the Menu Item Definition belongs" }, "slu7ObjNum":{ "type":"integer", "example":206, "description":"Object number of SLU 7 to which the Menu Item Definition belongs" }, "slu8ObjNum":{ "type":"integer", "example":207, "description":"Object number of SLU 8 to which the Menu Item Definition belongs" }, "sluSortPriority":{ "type":"integer", "example":0, "description":"Use this field when Page Design Layout option" }, "nluGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the NLU Group associated with this menu item" }, "nluNum":{ "type":"integer", "example":1, "description":"Unique NLU number for this menu item (up to 12 digits)." }, "tareWeight":{ "type":"integer", "example":"1.23", "description":"Weight of the empty package for an item sold by weight" }, "surcharge":{ "type":"integer", "example":1, "description":"Surcharge for the menu item" }, "quantity":{ "type":"integer", "example":1, "description":"Quantity of a Menu Item" }, "overrideAllergenClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Allergen Class for the menu item definition to override its menu item class setting" }, "kdsPrepTime":{ "type":"integer", "example":"10.3", "description":"The number of minutes necessary to prepare this item" }, "prefixLevelOverride":{ "type":"integer", "example":1, "description":"Select to allow the condiment prefix to override the price level of the item it modifies." }, "guestCount":{ "type":"integer", "example":1, "description":"Guest count for the menu item to increment the check guest count when added." }, "consumerAdvisoryDesc":{ "type":"string", "example":"Menu Item 1", "description":"The consumer advisory description of the menu item" }, "consumerItemName":{ "type":"object", "description":"Consumer Item Name.", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "consumerItemDescription":{ "type":"object", "description":"Consumer Item Description. Maximum length supported is 1024 characters.", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "images":{ "type":"array", "description":"An array of images associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_image" } }, "customMenuLevels":{ "type":"array", "description":"An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured", "items":{ "$ref":"#/definitions/MenuItem_customMenuLevel" } }, "defaultCondiments":{ "type":"array", "description":"An array of Default Condiment of a Menu Item", "items":{ "$ref":"#/definitions/MenuItem_defaultCondiment" } }, "productionItems":{ "type":"array", "description":"An array of production items associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_productionItem" } }, "components":{ "type":"array", "description":"An array of components associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_component" } }, "tags":{ "type":"array", "description":"An array of tags associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_tag" } }, "nutrients":{ "type":"array", "description":"An array of nutrients of the menu item", "items":{ "$ref":"#/definitions/MenuItem_nutrient" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item", "items":{ "$ref":"#/definitions/MenuItem_dataExtensions" } } } }, "MenuItemDefinitionGetResponseV1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Definition objects.", "items":{ "$ref":"#/definitions/MenuItemDefinitionResponseV1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "MenuItemDefinitionResponseV2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy unit unique reference" }, "menuItemMasterObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"The unique reference for the Menu Item Master" }, "menuItemDefinitionId":{ "type":"integer", "example":1, "description":"The unique reference for the Menu Item Definition" }, "defSequenceNum":{ "type":"integer", "example":1, "description":"Indicates the definition sequence number, which is the number of the definition in the revenue center for this master record.Sequence Number should be with 1-64" }, "firstName":{ "type":"object", "description":"First Name", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "secondName":{ "type":"object", "description":"Second Name", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "thirdName":{ "type":"object", "description":"Third Name", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe'" } }, "longDescriptor":{ "type":"object", "description":"Long Descriptor", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "menuItemClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item Class" }, "overridePrintClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Print Class" }, "mainLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing main levels on which the definition is active." }, "subLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing Sub Levels on which the definition is active" }, "slu1ObjNum":{ "type":"integer", "example":200, "description":"Object number of SLU 1 to which the Menu Item Definition belongs" }, "slu2ObjNum":{ "type":"integer", "example":201, "description":"Object number of SLU 2 to which the Menu Item Definition belongs" }, "slu3ObjNum":{ "type":"integer", "example":202, "description":"Object number of SLU 3 to which the Menu Item Definition belongs" }, "slu4ObjNum":{ "type":"integer", "example":203, "description":"Object number of SLU 4 to which the Menu Item Definition belongs" }, "slu5ObjNum":{ "type":"integer", "example":204, "description":"Object number of SLU 5 to which the Menu Item Definition belongs" }, "slu6ObjNum":{ "type":"integer", "example":205, "description":"Object number of SLU 6 to which the Menu Item Definition belongs" }, "slu7ObjNum":{ "type":"integer", "example":206, "description":"Object number of SLU 7 to which the Menu Item Definition belongs" }, "slu8ObjNum":{ "type":"integer", "example":207, "description":"Object number of SLU 8 to which the Menu Item Definition belongs" }, "sluSortPriority":{ "type":"integer", "example":0, "description":"Use this field when Page Design Layout option" }, "nluGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the NLU Group associated with this menu item" }, "nluNum":{ "type":"integer", "example":1, "description":"Unique NLU number for this menu item (up to 12 digits)." }, "tareWeight":{ "type":"integer", "example":"1.23", "description":"Weight of the empty package for an item sold by weight" }, "surcharge":{ "type":"integer", "example":1, "description":"Surcharge for the menu item" }, "quantity":{ "type":"integer", "example":1, "description":"Quantity of a Menu Item" }, "overrideAllergenClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Allergen Class for the menu item definition to override its menu item class setting" }, "kdsPrepTime":{ "type":"integer", "example":"10.3", "description":"The number of minutes necessary to prepare this item" }, "prefixLevelOverride":{ "type":"integer", "example":1, "description":"Select to allow the condiment prefix to override the price level of the item it modifies." }, "guestCount":{ "type":"integer", "example":1, "description":"Guest count for the menu item to increment the check guest count when added." }, "consumerAdvisoryDesc":{ "type":"string", "example":"Menu Item 1", "description":"The consumer advisory description of the menu item" }, "consumerItemName":{ "type":"object", "description":"Consumer Item Name", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "consumerItemDescription":{ "type":"object", "description":"Consumer Item Description. Maximum length supported is 1024 characters.", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "images":{ "type":"array", "description":"An array of images associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_image" } }, "customMenuLevels":{ "type":"array", "description":"An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured", "items":{ "$ref":"#/definitions/MenuItem_customMenuLevel" } }, "defaultCondiments":{ "type":"array", "description":"An array of Default Condiment of a Menu Item", "items":{ "$ref":"#/definitions/MenuItem_defaultCondiment" } }, "productionItems":{ "type":"array", "description":"An array of production items associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_productionItem" } }, "components":{ "type":"array", "description":"An array of components associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_component" } }, "tags":{ "type":"array", "description":"An array of tags associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_tag" } }, "nutrients":{ "type":"array", "description":"An array of nutrients of the menu item", "items":{ "$ref":"#/definitions/MenuItem_nutrient" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item", "items":{ "$ref":"#/definitions/MenuItem_dataExtensions" } } } }, "MenuItemDefinitionInsertRequestBody":{ "type":"object", "required":[ "hierUnitId", "menuItemMasterId", "defSequenceNum" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy unit unique reference" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"The unique reference for the Menu Item Master" }, "defSequenceNum":{ "type":"integer", "example":1, "description":"Indicates the definition sequence number, which is the number of the definition in the revenue center for this master record.Sequence Number should be with 1-64" }, "firstName":{ "type":"object", "description":"First Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "secondName":{ "type":"object", "description":"Second Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "thirdName":{ "type":"object", "description":"Third Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "longDescriptor":{ "type":"object", "description":"Long Descriptor", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "menuItemClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item Class" }, "overridePrintClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Print Class" }, "mainLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing main levels on which the definition is active." }, "subLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing Sub Levels on which the definition is active" }, "slu1ObjNum":{ "type":"integer", "example":200, "description":"Object number of SLU 1 to which the Menu Item Definition belongs" }, "slu2ObjNum":{ "type":"integer", "example":201, "description":"Object number of SLU 2 to which the Menu Item Definition belongs" }, "slu3ObjNum":{ "type":"integer", "example":202, "description":"Object number of SLU 3 to which the Menu Item Definition belongs" }, "slu4ObjNum":{ "type":"integer", "example":203, "description":"Object number of SLU 4 to which the Menu Item Definition belongs" }, "slu5ObjNum":{ "type":"integer", "example":204, "description":"Object number of SLU 5 to which the Menu Item Definition belongs" }, "slu6ObjNum":{ "type":"integer", "example":205, "description":"Object number of SLU 6 to which the Menu Item Definition belongs" }, "slu7ObjNum":{ "type":"integer", "example":206, "description":"Object number of SLU 7 to which the Menu Item Definition belongs" }, "slu8ObjNum":{ "type":"integer", "example":207, "description":"Object number of SLU 8 to which the Menu Item Definition belongs" }, "sluSortPriority":{ "type":"integer", "example":0, "description":"Use this field when Page Design Layout option" }, "nluGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the NLU Group associated with this menu item" }, "nluNum":{ "type":"integer", "example":1, "description":"Unique NLU number for this menu item (up to 12 digits)." }, "tareWeight":{ "type":"integer", "example":"1.23", "description":"Weight of the empty package for an item sold by weight" }, "surcharge":{ "type":"integer", "example":1, "description":"Surcharge for the menu item" }, "quantity":{ "type":"integer", "example":1, "description":"Quantity of a Menu Item" }, "overrideAllergenClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Allergen Class for the menu item definition to override its menu item class setting" }, "kdsPrepTime":{ "type":"integer", "example":"10.3", "description":"The number of minutes necessary to prepare this item" }, "prefixLevelOverride":{ "type":"integer", "example":1, "description":"Select to allow the condiment prefix to override the price level of the item it modifies." }, "guestCount":{ "type":"integer", "example":1, "description":"Guest count for the menu item to increment the check guest count when added." }, "consumerAdvisoryDesc":{ "type":"string", "example":"Menu Item 1", "description":"The consumer advisory description of the menu item" }, "consumerItemName":{ "type":"object", "description":"Consumer Item Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "consumerItemDescription":{ "type":"object", "description":"Consumer Item Description. Maximum length supported is 1024 characters.", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "images":{ "type":"array", "description":"An array of images associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_image" } }, "customMenuLevels":{ "type":"array", "description":"An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured", "items":{ "$ref":"#/definitions/MenuItem_customMenuLevel" } }, "defaultCondiments":{ "type":"array", "description":"An array of Default Condiment of a Menu Item", "items":{ "$ref":"#/definitions/MenuItem_defaultCondiment" } }, "productionItems":{ "type":"array", "description":"An array of production items associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_productionItem" } }, "components":{ "type":"array", "description":"An array of components associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_component" } }, "tags":{ "type":"array", "description":"An array of tags associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_tag" } }, "nutrients":{ "type":"array", "description":"An array of nutrients of the menu item", "items":{ "$ref":"#/definitions/MenuItem_nutrient" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item", "items":{ "$ref":"#/definitions/MenuItem_dataExtensions" } } } }, "MenuItemDefinitionUpdateRequestBody":{ "type":"object", "required":[ "hierUnitId", "menuItemDefinitionId" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy unit unique reference" }, "menuItemDefinitionId":{ "type":"integer", "example":1, "description":"The unique reference for the Menu Item Definition" }, "firstName":{ "type":"object", "description":"First Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "secondName":{ "type":"object", "description":"Second Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "thirdName":{ "type":"object", "description":"Third Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "longDescriptor":{ "type":"object", "description":"Long Descriptor", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "menuItemClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item Class" }, "overridePrintClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Print Class" }, "mainLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing main levels on which the definition is active." }, "subLevel":{ "type":"string", "example":"11001111", "description":"A string value of 0s & 1s of length 8 representing Sub Levels on which the definition is active" }, "slu1ObjNum":{ "type":"integer", "example":200, "description":"Object number of SLU 1 to which the Menu Item Definition belongs" }, "slu2ObjNum":{ "type":"integer", "example":201, "description":"Object number of SLU 2 to which the Menu Item Definition belongs" }, "slu3ObjNum":{ "type":"integer", "example":202, "description":"Object number of SLU 3 to which the Menu Item Definition belongs" }, "slu4ObjNum":{ "type":"integer", "example":203, "description":"Object number of SLU 4 to which the Menu Item Definition belongs" }, "slu5ObjNum":{ "type":"integer", "example":204, "description":"Object number of SLU 5 to which the Menu Item Definition belongs" }, "slu6ObjNum":{ "type":"integer", "example":205, "description":"Object number of SLU 6 to which the Menu Item Definition belongs" }, "slu7ObjNum":{ "type":"integer", "example":206, "description":"Object number of SLU 7 to which the Menu Item Definition belongs" }, "slu8ObjNum":{ "type":"integer", "example":207, "description":"Object number of SLU 8 to which the Menu Item Definition belongs" }, "sluSortPriority":{ "type":"integer", "example":0, "description":"Use this field when Page Design Layout option" }, "nluGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the NLU Group associated with this menu item" }, "nluNum":{ "type":"integer", "example":1, "description":"Unique NLU number for this menu item (up to 12 digits)." }, "tareWeight":{ "type":"integer", "example":"1.23", "description":"Weight of the empty package for an item sold by weight" }, "surcharge":{ "type":"integer", "example":1, "description":"Surcharge for the menu item" }, "quantity":{ "type":"integer", "example":1, "description":"Quantity of a Menu Item" }, "overrideAllergenClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Allergen Class for the menu item definition to override its menu item class setting" }, "kdsPrepTime":{ "type":"integer", "example":"10.3", "description":"The number of minutes necessary to prepare this item" }, "prefixLevelOverride":{ "type":"integer", "example":1, "description":"Select to allow the condiment prefix to override the price level of the item it modifies." }, "guestCount":{ "type":"integer", "example":1, "description":"Guest count for the menu item to increment the check guest count when added." }, "consumerAdvisoryDesc":{ "type":"string", "example":"Menu Item 1", "description":"The consumer advisory description of the menu item" }, "consumerItemName":{ "type":"object", "description":"Consumer Item Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "consumerItemDescription":{ "type":"object", "description":"Consumer Item Description. Maximum length supported is 1024 characters.", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "images":{ "type":"array", "description":"An array of images associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_image" } }, "customMenuLevels":{ "type":"array", "description":"An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured", "items":{ "$ref":"#/definitions/MenuItem_customMenuLevel" } }, "defaultCondiments":{ "type":"array", "description":"An array of Default Condiment of a Menu Item", "items":{ "$ref":"#/definitions/MenuItem_defaultCondiment" } }, "productionItems":{ "type":"array", "description":"An array of production items associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_productionItem" } }, "components":{ "type":"array", "description":"An array of components associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_component" } }, "tags":{ "type":"array", "description":"An array of tags associated with the menu item", "items":{ "$ref":"#/definitions/MenuItem_tag" } }, "nutrients":{ "type":"array", "description":"An array of nutrients of the menu item", "items":{ "$ref":"#/definitions/MenuItem_nutrient" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item", "items":{ "$ref":"#/definitions/MenuItem_dataExtensions" } } } }, "MenuItemDefintionResponse":{ "type":"object", "properties":{ "menuItemMasterId":{ "type":"integer", "example":1, "description":"The unique reference for the Menu Item Master" }, "menuItemDefinitionId":{ "type":"integer", "example":1, "description":"The unique reference for the Menu Item Definition" }, "defSequenceNum":{ "type":"integer", "example":1, "description":"Indicates the definition sequence number, which is the number of the definition in the revenue center for this master record.Sequence Number should be with 1-64" }, "menuItemMasterObjNum":{ "type":"integer", "example":1, "description":"Menu item master object number." }, "menuItemMasterHierUnitId":{ "type":"integer", "example":1, "description":"Hierarchy location of the master the definition was added to." }, "menuItemDefitinitionHierUnitId":{ "type":"integer", "example":1, "description":"Hierarchy unit unique reference where definition was created." } } }, "MenuItemDefintionUpdateResponse":{ "type":"object", "properties":{ "menuItemMasterId":{ "type":"integer", "example":1, "description":"The unique reference for the Menu Item Master" }, "menuItemDefinitionId":{ "type":"integer", "example":1, "description":"The unique reference for the Menu Item Definition" }, "defSequenceNum":{ "type":"integer", "example":1, "description":"Indicates the definition sequence number, which is the number of the definition in the revenue center for this master record.Sequence Number should be with 1-64" }, "menuItemMasterObjNum":{ "type":"integer", "example":1, "description":"Menu item master object number." }, "menuItemMasterHierUnitId":{ "type":"integer", "example":1, "description":"Hierarchy location of the master the definition was added to." }, "menuItemDefitinitionHierUnitId":{ "type":"integer", "example":1, "description":"Hierarchy unit unique reference where definition was created." } } }, "MenuItemDefinitionGetRequestBody":{ "type":"object", "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId,1012)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." }, "hierUnitId":{ "type":"integer", "example":1012, "description":"Unique Hierarchy unit reference. This is an optional field. Alternatively, searchCriteria can be used to get results for a particular hierUnitId." } } }, "menuitemdefinition_dml":{ "type":"object", "required":[ "menuItemDefinitionId", "hierUnitId" ], "properties":{ "menuItemDefinitionId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" }, "hierUnitId":{ "type":"integer", "example":1012, "description":"Hierarchy unit unique reference" } } }, "MenuLevelCUDRequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number the menu level" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "menuLevelType":{ "type":"string", "example":"Main", "description":"Specifies whether the Menu Level Set refers to the Main Levels, Sub Levels, or to the levels defined within the record. Following values are supported Main, Sub and Custom" }, "defaultMIMstrGrpObjNum":{ "type":"integer", "example":1, "description":"Object number of default menu item master group associated with the Menu Level." }, "options":{ "type":"string", "example":"10000000", "description":"A string value of 0s and 1s of length 8 representing the enablement or disablement of the options associated." }, "menuLevelEntries":{ "type":"array", "items":{ "$ref":"#/definitions/MenuLevel_menuLevelEntries_CUD" } } }, "description":"Model for Menu Level for an organization" }, "MenuLevelGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Level objects of the organization.", "items":{ "$ref":"#/definitions/MenuLevelv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "MenuLevelv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number the menu level" }, "name":{ "description":"Menu Level Name", "type":"object", "example":{ "1":"Property", "2":"Eigentum", "3":"Propiedad" } }, "menuLevelType":{ "type":"string", "example":"Main", "description":"Specifies whether the Menu Level Set refers to the Main Levels, Sub Levels, or to the levels defined within the record. Following values are supported Main, Sub and Custom" }, "defaultMIMstrGrpObjNum":{ "type":"integer", "example":1, "description":"Object number of default menu item master group associated with the Menu Level." }, "options":{ "type":"string", "example":"10000000", "description":"A string value of 0s and 1s of length 8 representing the enablement or disablement of the options associated." }, "optionsExt":{ "$ref":"#/definitions/MenuLevel_optionsExt" }, "menuLevelEntries":{ "type":"array", "items":{ "$ref":"#/definitions/MenuLevel_menuLevelEntriesv2" } } }, "description":"Model for Menu Level for an organization" }, "MenuLevelv1":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "objectNum":{ "type":"integer", "example":1, "description":"Object number the menu level" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "menuLevelType":{ "type":"string", "example":"Main", "description":"Specifies whether the Menu Level Set refers to the Main Levels, Sub Levels, or to the levels defined within the record. Following values are supported Main, Sub and Custom" }, "defaultMIMstrGrpObjNum":{ "type":"integer", "example":1, "description":"Object number of default menu item master group associated with the Menu Level." }, "defaultMIMstrGrpName":{ "type":"object", "description":"Default MIMS Group Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "options":{ "type":"string", "example":"10000000", "description":"A string value of 0s and 1s of length 8 representing the enablement or disablement of the options associated." }, "optionsExt":{ "$ref":"#/definitions/MenuLevel_optionsExt" }, "menuLevelEntries":{ "type":"array", "items":{ "$ref":"#/definitions/MenuLevel_menuLevelEntries" } } }, "description":"Model for Menu Level for an organization" }, "MenuLevel_menuLevelEntries":{ "type":"object", "properties":{ "index":{ "type":"integer", "example":1, "description":"Index of the menu level entry" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "prefix":{ "type":"object", "description":"Prefix for a Menu Level Entry", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "suffix":{ "type":"object", "description":"Suffix for a Menu Level Entry", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s and 1s of length 8 representing the enablement and disablement of options associated." }, "optionsExt":{ "$ref":"#/definitions/MenuLevel_menuLevelEntries_optionsExt" } }, "description":"An array of the entries associated with the menu level" }, "MenuLevel_menuLevelEntriesv2":{ "type":"object", "properties":{ "index":{ "type":"integer", "example":1, "description":"Index of the menu level entry" }, "name":{ "description":"Menu Level Entry Name", "type":"object", "example":{ "1":"Property", "2":"Eigentum", "3":"Propiedad" } }, "prefix":{ "description":"Prefix for a Menu Level Entry", "type":"object", "example":{ "1":"Property", "2":"Eigentum", "3":"Propiedad" } }, "suffix":{ "description":"Suffix for a Menu Level Entry", "type":"object", "example":{ "1":"Property", "2":"Eigentum", "3":"Propiedad" } }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s and 1s of length 8 representing the enablement and disablement of options associated." }, "optionsExt":{ "$ref":"#/definitions/MenuLevel_menuLevelEntries_optionsExt" } }, "description":"An array of the entries associated with the menu level" }, "MenuLevel_menuLevelEntries_CUD":{ "type":"object", "properties":{ "index":{ "type":"integer", "example":1, "description":"Index of the menu level entry" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "prefix":{ "type":"object", "description":"Prefix for a Menu Level Entry", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "suffix":{ "type":"object", "description":"Suffix for a Menu Level Entry", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s and 1s of length 8 representing the enablement and disablement of options associated." } }, "description":"An array of the entries associated with the menu level" }, "MenuLevel_menuLevelEntries_CUDv2":{ "type":"object", "properties":{ "index":{ "type":"integer", "example":1, "description":"Index of the menu level entry" }, "name":{ "description":"Menu Level Entry Name", "type":"object", "example":{ "1":"Property", "2":"Eigentum", "3":"Propiedad" } }, "prefix":{ "description":"Prefix", "type":"object", "example":{ "1":"Property", "2":"Eigentum", "3":"Propiedad" } }, "suffix":{ "description":"Suffix", "type":"object", "example":{ "1":"Property", "2":"Eigentum", "3":"Propiedad" } }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s and 1s of length 8 representing the enablement and disablement of options associated." } }, "description":"An array of the entries associated with the menu level" }, "MenuLevel_menuLevelEntries_optionsExt":{ "type":"object", "properties":{ "defaults":{ "type":"boolean", "example":false, "description":"Select to mark this menu level as the default level for the Menu Level Set." }, "anonymous":{ "type":"boolean", "example":false, "description":"Select to mark this menu level as the anonymous level for the Menu Level Set." } }, "description":"An object containing the descriptive options list associated with the Menu level Entry." }, "MenuLevel_optionsExt":{ "type":"object", "properties":{ "enableBoundToParent":{ "type":"boolean", "example":false, "description":"Select to switch the active parent menu item when the active menu level changes." }, "enableRevertToDefaultLevelOnKeyPress":{ "type":"boolean", "example":false, "description":"Select to change the menu level to the default level when the workstation operator presses a touchscreen button corresponding to any menu level in this menu level set again." } }, "description":"An object containing the descriptive options list associated with the Menu Level" }, "MenuLevelDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "MenuLevelResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number the menu level" } } }, "EmployeeClassOperatorGetRequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum" ], "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations", "description":"Objects to be included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the Employee Class" }, "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value where the employee class is configured." } } }, "EmployeeClassOperatorGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Employee Property Operator objects of the organization.", "items":{ "$ref":"#/definitions/EmployeeClassOperatorv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "EmployeeClassOperatorv1":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "hierUnitObjNum":{ "type":"integer", "example":2, "description":"Hierarchy unit object number" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the employee Class." }, "className":{ "type":"object", "description":"Class Name", "example":{ "en-US":"Employee class", "de-DE":"Mitarbeiterklasse", "es-MX":"Clase de Empleado" } }, "rvcObjNum":{ "type":"integer", "example":1, "description":"Object number of the revenue center." }, "rvcName":{ "type":"object", "description":"RVC Name", "example":{ "en-US":"Revenue Center", "de-DE":"Einnahmenzentrum", "es-MX":"Centro de Ingresos" } }, "options":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the Revenue Center Operator record" }, "optionsExt":{ "$ref":"#/definitions/Employee_operators_optionsExt" } } }, "EmployeeClassOperatorv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "hierUnitObjNum":{ "type":"integer", "example":2, "description":"Hierarchy unit object number" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the employee Class." }, "rvcObjNum":{ "type":"integer", "example":1, "description":"Object number of the revenue center." }, "options":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the Revenue Center Operator record" }, "optionsExt":{ "$ref":"#/definitions/Employee_operators_optionsExt" } } }, "EmployeeClassOperatorResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value where the employee class is configured" }, "objectNum":{ "type":"integer", "example":2, "description":"Object number of the Employee Class" }, "rvcObjNum":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value where the employee class is configured" } } }, "deviceStatus":{ "description":"Device Status record", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit reference", "type":"integer", "example":100 }, "serviceHostId":{ "description":"Unique service host reference", "type":"integer", "example":244 }, "clientVersion":{ "type":"string", "description":"Simphony software version", "example":"19.5.0.0.299" }, "calVersion":{ "type":"string", "description":"CAL client version", "example":"108.1.4.16" }, "lastReceivedTime":{ "type":"string", "description":"The last time metrics were updated", "example":"2022-01-23T09:21:00" }, "serviceHostOverallStatus":{ "type":"integer", "description":"Service Host health status (1 - healthy ; 0 - not healthy). Review status details for more information.", "example":1 } } }, "RevenueCenterParameter_addOrTransferRVCs":{ "type":"object", "description":"An object representing the eight revenue centers from which checks can be transferred into this revenue center.", "properties":{ "rvc1ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 1st revenue center from which checks can be transferred into this revenue center" }, "rvc2ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 2nd revenue center from which checks can be transferred into this revenue center" }, "rvc3ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 3rd revenue center from which checks can be transferred into this revenue center" }, "rvc4ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 4th revenue center from which checks can be transferred into this revenue center" }, "rvc5ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 5th revenue center from which checks can be transferred into this revenue center" }, "rvc6ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 6th revenue center from which checks can be transferred into this revenue center" }, "rvc7ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 7th revenue center from which checks can be transferred into this revenue center" }, "rvc8ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 8th revenue center from which checks can be transferred into this revenue center" } } }, "RevenueCenterParameter_optionsExt":{ "type":"object", "description":"An object containing the descriptive options list associated with the Revenue Center Parameter.", "properties":{ "operatorAssignsCheckNumbers":{ "type":"boolean", "example":false, "description":"A flag indicating if workstation operators require to assign a guest check number when beginning a new transaction. Deselect to have the system assign sequential guest check numbers." }, "useEmpNumberWithTipsPaid":{ "type":"boolean", "example":false, "description":"A flag indicating if workstation operators require to enter the employee number when declaring tips paid." }, "useEmpNumWithEmpMeal":{ "type":"boolean", "example":false, "description":"A flag indicating if workstation operators require to enter the employee number when posting an employee meal. Deselect to require the employee ID number." }, "prorateItmzrWhenPostingPartialTender":{ "type":"boolean", "example":false, "description":"A flag indicating to prorate itemizers (sales, service charges, discounts, and taxes) on a partially-tendered guest check and post those amounts to a PMS. Deselect to post all itemizers during tendering." }, "validateEmpTipsDeclaredTransactions":{ "type":"boolean", "example":false, "description":"A flag indicating to print declared tips transactions at the designated validation printer." }, "useNumberOfSeatsForGuestCount":{ "type":"boolean", "example":false, "description":"A flag indicating to cause guest counts for transactions to be determined by the number of seats entered on guest checks. If the workstation operator presses the (Number of Guests) key during a transaction, the guest count no longer increments when seats are added to the check, and going forward, the operator must manually maintain the guest count." }, "onDemandCustomerReceipts":{ "type":"boolean", "example":false, "description":"A flag indicating that the workstation functions as though the Workstation option Do Not Clear Screen After Transaction is enabled." }, "autoSVCDefaultsToOff":{ "type":"boolean", "example":false, "description":"A flag indicating option for one of the following purposes:\n\n1. If # of Guests Before Auto Service Charge is set to a value greater than 0, enabling this causes the Auto Service Charge to default to off, but when a transaction has the number of guests specified in the # of Guests Before Auto Service Charge, the Auto Service Charge becomes active.\n\n2. If # of Guests Before Auto Service Charge is 0, the workstation operator can apply the appropriate service charge.\n\nDeselect to apply the Automatic Service Charge programmed in the Tender Parameters module on every transaction. \n" }, "operatorRecordMustForAuthAndChangesinWSRVC":{ "type":"boolean", "example":false, "description":"A flag indicating to prevent workstation operators from changing to a revenue center where they do not have an operator record. This prevents an employee without an operator record for a revenue center from performing authorizations. Oracle recommends enabling this option." }, "printSplitCheckIfTableNumberIsZero":{ "type":"boolean", "example":false, "description":"A flag indicating to automatically print split checks if the table number is 0. Set this option in environments where guest checks are begun and picked up by check number." }, "allowFastTransactions":{ "type":"boolean", "example":false, "description":"A flag indicating to allow privileged workstation operators to perform fast transactions. Deselect to require workstation operators to begin transactions using a Begin Check key." }, "dontAllowServiceTotalOfFastTransactions":{ "type":"boolean", "example":false, "description":"A flag indicating to prevent workstation operators from service totaling a fast transaction. Deselect to allow workstation operators to convert a fast transaction to a guest check transaction by pressing a service total key." }, "useFiveDigitTableNumber":{ "type":"boolean", "example":false, "description":"A flag indicating to use the 5-digit table numbers programmed in the Tables module. Deselect to use the 4-character Table Name entered in the Tables module. Deselect when using International LDS." }, "blankRearCustomerDisplayIfNoEmpSignedIn":{ "type":"boolean", "example":false, "description":"A flag indicating to show a blank screen on the workstation's rear customer display (or remote pole display) when no operator is signed into the workstation. Deselect to show Closed when no workstation operator is signed in." }, "retainCurrentMainLevelAfterTransaction":{ "type":"boolean", "example":false, "description":"A flag indicating to remain at the current Main Level upon completion of a transaction. Deselect to maintain the default Main Level." }, "retainCurrentSubLevelAfterTransaction":{ "type":"boolean", "example":false, "description":"A flag indicating to remain at the current Sub Level upon completion of a transaction. Deselect to maintain the default Sub Level." }, "assignSeatNumToAddedCheckDetail":{ "type":"boolean", "example":false, "description":"A flag indicating to begin the seat numbers of the source check at the next available seat number on the destination check. The source check is the guest check that was added to the destination (original) guest check. Deselect to post all detail entry from the source check to seat 0 (no seat)." }, "defaultSeatNumToOneAtBeginTransaction":{ "type":"boolean", "example":false, "description":"A flag indicating to automatically set the seat number of a new guest check to 1. Deselect to force workstation operators to use the Seat /Next Seat key to activate a seat number before posting detail items to a guest check" }, "numOfSeatsMayNotExceedNumOfGuests":{ "type":"boolean", "example":false, "description":"A flag indicating to limit the number of seats on a guest check from exceeding a check's specified guest count. Deselect to allow any number of seats on a guest check." }, "testForSKUValidityUsingCheckDigit":{ "type":"boolean", "example":false, "description":"A flag indicating to test SKUs entered in this revenue center for checksum validity using the check digit appended to the number. Deselect to suppress the SKU validity test." }, "acceptEUNumberingBarcodes":{ "type":"boolean", "example":false, "description":"A flag indicating to allow this revenue center to accept barcodes that use European Article Numbering (EAN). Deselect to prevent EAN barcodes from being accepted in this revenue center." }, "enableUPCAlgoForBarcodesNLUEntries":{ "type":"boolean", "example":false, "description":"The last digit in a UPC number is a check digit. A Check Digit Verification (CDV) algorithm can be used to test an NLU entry to ensure that it is a valid UPC number." }, "convertUPCEtoUPCA":{ "type":"boolean", "example":false, "description":"A flag indicating to expand barcodes entered in 8-digit (UPC-E) format to 12-digit (UPC-A) format." }, "noOverTenderingIfChargeTipIsRequired":{ "type":"boolean", "example":false, "description":"A flag indicating to prevent transactions from prompting for charged tips or allowing change due for Tender/Media keys that are programmed to prompt for charged tips." }, "useBeverageControl":{ "type":"boolean", "example":false, "description":"A flag indicating to enable the Beverage Control feature, which controls and tracks whether a beverage has been included on a guest check." }, "useGuestForBeverageControl":{ "type":"boolean", "example":false, "description":"A flag indicating to have the Beverage Control feature compare the number of beverages included in the guest check detail to the number of guests" }, "keepSeatNumOnAddedCheckDetail":{ "type":"boolean", "example":false, "description":"A flag indicating to keep seat numbers assigned to check detail when the check is added or transferred to another check." }, "usePayrollIdWithEmpMeal":{ "type":"boolean", "example":false, "description":"A flag indicating to prompt for the employee's Payroll ID during an employee discount/employee meal transaction." }, "supressChargeTipAmountToZero":{ "type":"boolean", "example":false, "description":"A flag indicating to suppress the workstation from displaying the Charge Tip Amount is 0.00? prompt." }, "disallowPaymentOrSvcTotalOfInsufficientBvgChks":{ "type":"boolean", "example":false, "description":"A flag indicating to prevent unauthorized users from paying or service totaling checks that have an Insufficient Beverage Count. The employee role privilege, Authorize/Perform Payment and Service Total of Insufficient Beverage Checks, allows users to pay and service total Insufficient Beverage Checks, even if this RVC Parameter option is enabled." }, "enableAutoDiscountsByDefault":{ "type":"boolean", "example":false, "description":"A flag indicating to allow Automatic Discounts to be applied in this revenue center." }, "enableDOM":{ "type":"boolean", "example":false, "description":"A flag indicating to enable Dynamic Order Mode for this revenue center. When DOM is enabled, the Cancel Order function voids previous round items and then marks the check as cancelled." }, "allowAutoCMBRecognitionWithComboKey":{ "type":"boolean", "example":false, "description":"A flag indicating to use the Combo key with Auto Combo Meal recognition." }, "allowCMBCreationFromPrevRoundMenuItems":{ "type":"boolean", "example":false, "description":"A flag indicating to enable Auto Combo Meal recognition to create combo meals from menu items ordered in previous rounds." }, "useRVCCheckNumbers":{ "type":"boolean", "example":false, "description":"A flag indicating to assign check numbers by revenue center (from the Check and Posting Service)." }, "showComboMealChoices":{ "type":"boolean", "example":false, "description":"A flag indicating to show a list of combo meals when attempting to create meals from the menu items already on the check." }, "allowSignInWithNoOperator":{ "type":"boolean", "example":false, "description":"A flag indicating to allow Sign In with no Operator record." }, "printClosedCheckEditMSgOnGuestChecks":{ "type":"boolean", "example":false, "description":"A flag indicating to print the Closed Check Edit message on guest checks and customer receipts if the closed check was adjusted." }, "autoComboItemsOnTheFly":{ "type":"boolean", "example":false, "description":"A flag indicating to attempt to create combo meals from menu items added to the check in the current round. The system looks for combo meals after adding each menu item." }, "enableSuspendOrResume":{ "type":"boolean", "example":false, "description":"A flag indicating to enable the Suspend/Resume functionality." }, "allowCMBSideSusbstitueWithoutComboOrderer":{ "type":"boolean", "example":false, "description":"A flag indicating to allow combo meal substitution when the replacement menu item is ordered from a non-Combo Meal Orderer page." }, "supressDisplayOfOutOfItemMenuItems":{ "type":"boolean", "example":false, "description":"A flag indicating to suppress the display of menu items with an availability count of zero or with the Out of Item status set to true." }, "sortGuestCheckSLUByTableName":{ "type":"boolean", "example":false, "description":"A flag indicating to sort the Open Checks SLU in this revenue center by table name." }, "manageOutOfItemAvailabilityForMenuItemDef":{ "type":"boolean", "example":false, "description":"A flag indicating to edit and track Menu Item Availability and Out of Menu Item for all definitions of a menu item." }, "useSVCAsForfeitReturnItem":{ "type":"boolean", "example":false, "description":"A flag indicating to use Service Charge as Deposit Forfeit Return Item." }, "enableFollowMe":{ "type":"boolean", "example":false, "description":"A flag indicating to enable the Follow Me feature for this revenue center." }, "autoComboReturnedMenuItems":{ "type":"boolean", "example":false, "description":"A flag indicating to create combo meals from returned menu items." }, "enableHoldAndFire":{ "type":"boolean", "example":false, "description":"A flag indicating to activate Hold and Fire and Timed Fire for this revenue center." }, "changePriceMainLevelSetsActiveMainLevel":{ "type":"boolean", "example":false, "description":"A flag indicating to set the active Main Level for the current round after using Change Price Main Level." }, "changePriceSubLevelSetsActiveSubLevel":{ "type":"boolean", "example":false, "description":"A flag indicating to set the active Sub Level for the current round after using Change Price Sub Level." }, "keepTheSameCheckNumWhenAClosedCheckIsVoided":{ "type":"boolean", "example":false, "description":"A flag indicating to cause a voided closed guest check to retain its original guest check number." }, "enableSTSGen2":{ "type":"boolean", "example":false, "description":"A flag indicating to enable Simphony Transaction Services Gen 2 this revenue center." } } }, "RevenueCenterParameter_postingOptionsExt":{ "type":"object", "description":"An object containing the descriptive options list associated with the Revenue Center Parameter.", "properties":{ "dontPostTransactionsToTipReportTotals":{ "type":"boolean", "example":false, "description":"A flag indicating to prevent posting sales in this revenue center to the Gross F&B Receipts and Charged Receipts totals on Tip Reports." }, "roundDiscountPercentEntries":{ "type":"boolean", "example":false, "description":"A flag indicating to round percentage discount amounts according to the Round Discount % to 0, 10 and Round Discount % based on 10s digit option settings. Deselect to round the amounts to the nearest least significant digit." }, "roundDiscountPercentTo0Or10":{ "type":"boolean", "example":false, "description":"A flag indicating to round percentage amounts to the nearest 0 or 10 increment. Deselect to round percentage amounts to the nearest 0, 5, or 10 increment." }, "roundDiscountPercentBasedUpon10sDigit":{ "type":"boolean", "example":false, "description":"A flag indicating to round percentage amounts based on the second least significant digit." }, "dontAddZeroOrNegativeTransactionsToCounts":{ "type":"boolean", "example":false, "description":"A flag indicating to prevent transactions with a zero balance or a negative balance from incrementing the guest count or the guest check count." }, "postTotalsAndTenderToTransOperator":{ "type":"boolean", "example":false, "description":"A flag indicating to post sales totals, tenders, and tips to the transaction operator's report totals. Deselect to post sales totals, tenders, and tips to the check operator." }, "postOnlyTenderToTransOperator":{ "type":"boolean", "example":false, "description":"A flag indicating to post tenders and tips to the transaction operator's tracking group totals." }, "postToCheckOperatorCahsierTotalsIfNoTransOperatorTotals":{ "type":"boolean", "example":false, "description":"A flag indicating to post totals to the Cashier Totals of the check operator (the employee who began the check) if the transaction operator (the employee who picked up the check, or for whom the check was begun) does not have an active Cashier Totals link." }, "postNegativeCoversToPMSAndTotals":{ "type":"boolean", "example":false, "description":"A flag indicating to decrement the guest count (wherever guest counts are posted) when a guest check is driven less than zero, including PMS interfaces and SIM scripts." }, "useBeginServingPeriod":{ "type":"boolean", "example":false, "description":"A flag indicating to post totals and PMS charges using the serving period that is active when beginning the check." }, "postTenderVoidsToOriginalTenderEmployee":{ "type":"boolean", "example":false, "description":"A flag indicating to post voided tender totals to the original tendering employee." }, "roundSVCPercentEntries":{ "type":"boolean", "example":false, "description":"A flag indicating to round percentage service charge amounts according to the Round Service Charge % to 0, 10 and Round Service Charge % based on 10s digit option settings." }, "roundSVCPercentTo0Or10":{ "type":"boolean", "example":false, "description":"A flag indicating to round percentage service charge amounts to the nearest 0 or 10 increment. Deselect to round the percentage amounts to the nearest 0, 5, or 10 increment. You must also select Round Service Charge % Entries." }, "roundSVCPercentBasedUpon10sDigit":{ "type":"boolean", "example":false, "description":"A flag indicating to round percentage service charged amounts based on the second least significant digit. Deselect to round the percentage amounts based on the least significant digit." }, "postToCheckOrderType":{ "type":"boolean", "example":false, "description":"A flag indicating to post sales to a check's Order Type for items belonging to other Order Types." } } }, "RevenueCenterParameter_interfaces":{ "type":"object", "description":"An object representing the eight revenue centers from which checks can be transferred into this revenue center.", "properties":{ "interface1ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 1st interface associated with the revenue center." }, "interface2ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 2nd interface associated with the revenue center." }, "interface3ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 3rd interface associated with the revenue center" }, "interface4ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 4th interface associated with the revenue center" }, "interface5ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 5th interface associated with the revenue center" }, "interface6ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 6th interface associated with the revenue center" }, "interface7ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 7th interface associated with the revenue center" }, "interface8ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 8th interface associated with the revenue center" }, "interface9ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 9th interface associated with the revenue center" }, "interface10ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 10th interface associated with the revenue center" }, "interface11ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 11th interface associated with the revenue center" }, "interface12ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 12th interface associated with the revenue center" }, "interface13ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 13th interface associated with the revenue center" }, "interface14ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 14th interface associated with the revenue center" }, "interface15ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 15th interface associated with the revenue center" }, "interface16ObjNum":{ "type":"integer", "example":0, "description":"Object number of the 16th interface associated with the revenue center" } } }, "RevenueCenterParameters_tmsOptionsExt":{ "type":"object", "properties":{ "sendCheckStatusMessagesToTMS":{ "type":"boolean", "example":false, "description":"A flag indicating to automatically send check status messages to TMS." }, "enableCRMTMSInterface":{ "type":"boolean", "example":false, "description":"A flag indicating to enable CRM/TMS interface options, the enhanced features for the CRM/TMS Interface." }, "sendClosedCheckTotalToCRMTMS":{ "type":"boolean", "example":false, "description":"A flag indicating to send closed check totals to the CRM/TMS interface." }, "sendClosedCheckDetailToCRMTMS":{ "type":"boolean", "example":false, "description":"A flag indicating to send closed check detail data to the CRM/TMS interface." }, "sendCourseTimingDateToCRMTMS":{ "type":"boolean", "example":false, "description":"A flag indicating to send course timing data to the CRM/TMS interface." }, "resendTMSMessagesWithoutPrompting":{ "type":"boolean", "example":false, "description":"A flag indicating to retry sending failed TMS messages without user intervention." }, "sendGuestCountUpdatesToTMS":{ "type":"boolean", "example":false, "description":"A flag indicating to send guest count update messages to TMS when the guest count changes." } } }, "RevenueCenterParameter_tmsInterfaceOptions":{ "type":"object", "description":"An object containing the table management system interface options for the revenue center", "properties":{ "tmsOperatorObjNum":{ "type":"integer", "example":0, "description":"Object number of the workstation operator to assign for checks that are opened by the TMS before being picked up by a server." }, "tmsOperatorName":{ "type":"string", "example":"Operator 1", "description":"The name of the workstation operator to assign for checks that are opened by the TMS before being picked up by a server." }, "tmsUserWorkstationObjNum":{ "type":"integer", "example":0, "description":"Object number of the workstation to assign for checks that are opened by the TMS." }, "tmsUserWorkstationName":{ "type":"object", "description":"TMS User Work Station Name", "example":{ "en-US":"Workstation", "de-DE":"Arbeitsplatz", "es-MX":"puesto de trabajo" } }, "tmsLinkNum":{ "type":"integer", "example":0, "description":"Object number of the Table Management System (from the Enterprise Interface file) that accepts postings from this revenue center." }, "tmsLinkName":{ "type":"object", "description":"TMS Link Name", "example":{ "en-US":"TMS", "de-DE":"TMS", "es-MX":"TMS" } }, "tmsOptions":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the TMS options associated with the revenue center parameter." }, "tmsOptionsExt":{ "$ref":"#/definitions/RevenueCenterParameters_tmsOptionsExt" } } }, "RevenueCenterParameter_tmsInterfaceOptionsv2":{ "type":"object", "description":"An object containing the table management system interface options for the revenue center", "properties":{ "tmsOperatorObjNum":{ "type":"integer", "example":0, "description":"Object number of the workstation operator to assign for checks that are opened by the TMS before being picked up by a server." }, "tmsOperatorName":{ "type":"string", "example":"Operator 1", "description":"The name of the workstation operator to assign for checks that are opened by the TMS before being picked up by a server." }, "tmsUserWorkstationObjNum":{ "type":"integer", "example":0, "description":"Object number of the workstation to assign for checks that are opened by the TMS." }, "tmsLinkNum":{ "type":"integer", "example":0, "description":"Object number of the Table Management System (from the Enterprise Interface file) that accepts postings from this revenue center." }, "tmsOptions":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the TMS options associated with the revenue center parameter." }, "tmsOptionsExt":{ "$ref":"#/definitions/RevenueCenterParameters_tmsOptionsExt" } } }, "RevenueCenterParameter_autoFireOptionsExt":{ "type":"object", "description":"An object containing the descriptive autofire options list associated with the Revenue Center Parameter", "properties":{ "printAutoFireMemoAtTimeOfEntry":{ "type":"boolean", "example":false, "description":"A flag indicating to automatically print a memo chit when entering an Autofire check in this revenue center" }, "printGuestCheckAtTimeOfAutoFire":{ "type":"boolean", "example":false, "description":"A flag indicating to print a guest check when firing an Autofire check." }, "enableAutoFireInThisRVC":{ "type":"boolean", "example":false, "description":"A flag indicating to allow Autofire checks in this revenue center." } } }, "RevenueCenterParameter_creditCardOptionsExt":{ "type":"object", "description":"An object containing the descriptive credit card options list associated with the Revenue Center Parameter", "properties":{ "promptBeforePrintingSecondVoucher":{ "type":"boolean", "example":false, "description":"A flag indicating to prompt the operator before printing a second voucher." }, "dontEstimateTipsOfCCAuth":{ "type":"boolean", "example":false, "description":"A flag indicating to set an estimated tip percentage for a particular tender to zero (0) when performing a credit card authorization." }, "printTwoCCVouchers":{ "type":"boolean", "example":false, "description":"A flag indicating to print two credit card vouchers when using a CC Authorize key." }, "print3CServiceCodeOnCCVoucher":{ "type":"boolean", "example":false, "description":"A flag indicating to print the 3C service code on all credit card vouchers." }, "noTrailerOnSecondCCVoucher":{ "type":"boolean", "example":false, "description":"A flag indicating to prevent the trailer from printing on the second credit card authorization voucher." }, "printTwoLinesOfDiscretionaryDriverData":{ "type":"boolean", "example":false, "description":"A flag indicating to enable printing of discretionary data, such as transaction type, card start date, card issue number, merchant ID number, terminal number, or transaction number." }, "enableQuickServiceTransactions":{ "type":"boolean", "example":false, "description":"A flag indicating to use Quick Service Transactions in the revenue center." }, "printPrepaidCardBalanceOnCCVoucher":{ "type":"boolean", "example":false, "description":"A flag indicating to print the remaining balance of a prepaid credit card on the credit card voucher." } } }, "RevenueCenterParameter_overridenSODTimes":{ "type":"object", "properties":{ "dayOfWeek":{ "type":"integer", "example":1, "description":"An integer representing day of the week." }, "sodTime":{ "type":"string", "example":"00:00", "description":"The start of day time for the day." }, "runManually":{ "type":"boolean", "example":false, "description":"A flag indicating to manually run the start of day for this business date." } } }, "RevenueCenterParameter":{ "type":"object", "properties":{ "locHierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "locObjNum":{ "description":"Object number of the location.", "type":"integer", "example":1 }, "locName":{ "description":"A group of string objects representing the name of the location in configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "hierUnitId":{ "description":"Unique hierarchy unit value of the revenue center", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the revenue center", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the revenue center configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "defaultOrderTypeObjNum":{ "description":"Object number of the default Order Type for this revenue center.", "type":"integer", "example":1 }, "defaultMainLvlIndex":{ "description":"Object number of the default Main Level for this revenue center.", "type":"integer", "example":1 }, "defaultSubLevelIndex":{ "description":"Object number of the default sub level for this revenue center", "type":"integer", "example":1 }, "diningTableStatusSet":{ "description":"Default dining table status definitions to use in this revenue center.", "type":"integer", "example":1 }, "defaultCondimentOrderingPopup":{ "description":"Default Ordering Popup Condiment Orderer Page for the revenue center.", "type":"integer", "example":1 }, "defaultCondimentEditingPopup":{ "description":"Default Editing Popup Condiment Orderer Page for the revenue center.", "type":"integer", "example":0 }, "depositForfeitReturnMIObjNum":{ "description":"Deposit Forfeit Return Item for the revenue center", "type":"integer", "example":0 }, "minGuestCheckNum":{ "description":"The lowest check number allowed for checks in the revenue center", "type":"integer", "example":1 }, "maxGuestCheckNum":{ "description":"The highest check number allowed for checks in the revenue center. You can enter up to 8 digits from 1 to 99999999.When the maximum check number threshold is reached during transactions, the next check begins with the value in the Minimum Check Number field", "type":"integer", "example":99999999 }, "numGuestsBeforeAutoSVC":{ "description":"The number of guests required to trigger the automatic service charge for a transaction", "type":"integer", "example":1 }, "tableCount":{ "description":"The number of tables served by the revenue center.", "type":"integer", "example":1 }, "purgeOrderThresholdInMinutes":{ "description":"The purge order threshold in minutes for this revenue center. The minimum valid value is 30.", "type":"integer", "example":30 }, "orderRoutingThresholdAmount":{ "description":"An amount to determine if the Below Threshold Print Class of a Tender/Media will be used.", "type":"number", "example":0 }, "addOrTransferRVCs":{ "$ref":"#/definitions/RevenueCenterParameter_addOrTransferRVCs" }, "options":{ "type":"string", "example":"000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 96 representing the enablement or disablement of the options associated with the revenue center parameter. If not specified, this will represent the default options associated with the Revenue Center parameter" }, "optionsExt":{ "$ref":"#/definitions/RevenueCenterParameter_optionsExt" }, "postingOptions":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the posting options associated with the revenue center parameter." }, "postingOptionsExt":{ "$ref":"#/definitions/RevenueCenterParameter_postingOptionsExt" }, "interfaces":{ "$ref":"#/definitions/RevenueCenterParameter_interfaces" }, "tmsInterfaceOptions":{ "$ref":"#/definitions/RevenueCenterParameter_tmsInterfaceOptions" }, "enableUberEatsIntegration":{ "type":"boolean", "example":false, "description":"A flag indicating to enable delivery platform integration with Uber Eats." }, "enableDeliverooIntegration":{ "type":"boolean", "example":false, "description":"A flag indicating to enable delivery platform integrations with Deliveroo." }, "taxNumberPrefix":{ "type":"string", "example":"TW", "description":"Taiwanese tax number prefix for the revenue center." }, "endOfRangeThreshold":{ "type":"integer", "example":0, "description":"End of Range Threshold for the Revenue Center Serial Number, as required for the Taiwanese tax structure." }, "minRVCSerialNumber1":{ "type":"integer", "example":1, "description":"Minimum serial number 1 for the revenue center." }, "maxRVCSerialNumber1":{ "type":"integer", "example":99999, "description":"Maximum serial number 1 for the revenue center" }, "minRVCSerialNumber2":{ "type":"integer", "example":1, "description":"Minimum serial number 2 for the revenue center" }, "maxRVCSerialNumber2":{ "type":"integer", "example":99999, "description":"Maximum serial number 2 for the revenue center" }, "autoFireEmpObjNum":{ "type":"integer", "example":0, "description":"Object number of the employee whose totals are associated with Autofire checks when the check is fired." }, "autoFireEmpName":{ "description":"A string that contains Auto Fire Employee Name", "type":"string", "example":"Employee" }, "autoFireWSNum":{ "type":"integer", "example":1, "description":"Object number of the workstation where Autofire checks are fired and printed." }, "autofireWSName":{ "type":"object", "description":"Auto Fire WS Name", "example":{ "en-US":"Workstation", "de-DE":"Arbeitsplatz", "es-MX":"Puesto de trabajo" } }, "defaultAutoFireTenderMediaNum":{ "type":"integer", "example":0, "description":"Object number of the default Tender/Media for Autofire checks in the revenue center." }, "defaultAutoFireTenderMediaName":{ "type":"object", "description":"Default Auto Fire Tender Media Name", "example":{ "en-US":"Cash", "de-DE":"Kasse", "es-MX":"Dinero" } }, "backAutoFireDelayInMinutes":{ "type":"integer", "example":1, "description":"The amount of time (in minutes) that the specified Autofire workstation attempts to Autofire a check." }, "maximumDays":{ "type":"integer", "example":1, "description":"The maximum number of days (in the future) that Autofire checks can be scheduled." }, "autoFireOptions":{ "type":"string", "example":"000000000000000000000000", "description":"A string value of 0s & 1s of length 24 representing the enablement or disablement of the autofire options associated with the revenue center parameter." }, "autoFireOptionsExt":{ "$ref":"#/definitions/RevenueCenterParameter_autoFireOptionsExt" }, "creditCardOptions":{ "type":"string", "example":"000000000000000000000000", "description":"A string value of 0s & 1s of length 24 representing the enablement or disablement of the credit card options associated with the revenue center parameter." }, "creditCardOptionsExt":{ "$ref":"#/definitions/RevenueCenterParameter_creditCardOptionsExt" }, "currentBusinessDate":{ "type":"string", "example":"01/03/2022", "description":"A string representing the current business date at the revenue center" }, "startedAt":{ "type":"string", "example":"01/03/2022 03:00:00 AM", "description":"A string representing the date and time the current business date started at the revenue center" }, "dontResetEmpFinancialShiftsWithSOD":{ "type":"boolean", "example":false, "description":"A flag indicating to prevent Employee Financial Shifts from resetting with the start of each business day." }, "dontResetCashierFinancialShiftsWithSOD":{ "type":"boolean", "example":false, "description":"A flag indicating to prevent Cashier Financial Shifts from resetting with the start of each business day." }, "enableOverridePropertySODtimes":{ "type":"boolean", "example":false, "description":"A flag indicating to allow this revenue center to have its start of day run at a different time than the time set for the property." }, "overridenSODTimes":{ "type":"array", "description":"An array of overridden start of day times.", "items":{ "$ref":"#/definitions/RevenueCenterParameter_overridenSODTimes" } }, "defaultOrderChannelObjNum":{ "description":"Object number of the default Order Channel for this revenue center.", "type":"integer", "example":1 } } }, "RevenueCenterParameterv2":{ "type":"object", "properties":{ "locHierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "locObjNum":{ "description":"Object number of the location.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique hierarchy unit value of the revenue center", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the revenue center", "type":"integer", "example":1 }, "defaultOrderTypeObjNum":{ "description":"Object number of the default Order Type for this revenue center.", "type":"integer", "example":1 }, "defaultMainLvlIndex":{ "description":"Object number of the default Main Level for this revenue center.", "type":"integer", "example":1 }, "defaultSubLevelIndex":{ "description":"Object number of the default sub level for this revenue center", "type":"integer", "example":1 }, "diningTableStatusSet":{ "description":"Default dining table status definitions to use in this revenue center.", "type":"integer", "example":1 }, "defaultCondimentOrderingPopup":{ "description":"Default Ordering Popup Condiment Orderer Page for the revenue center.", "type":"integer", "example":1 }, "defaultCondimentEditingPopup":{ "description":"Default Editing Popup Condiment Orderer Page for the revenue center.", "type":"integer", "example":0 }, "depositForfeitReturnMIObjNum":{ "description":"Deposit Forfeit Return Item for the revenue center", "type":"integer", "example":0 }, "minGuestCheckNum":{ "description":"The lowest check number allowed for checks in the revenue center", "type":"integer", "example":1 }, "maxGuestCheckNum":{ "description":"The highest check number allowed for checks in the revenue center. You can enter up to 8 digits from 1 to 99999999.When the maximum check number threshold is reached during transactions, the next check begins with the value in the Minimum Check Number field", "type":"integer", "example":99999999 }, "numGuestsBeforeAutoSVC":{ "description":"The number of guests required to trigger the automatic service charge for a transaction", "type":"integer", "example":1 }, "tableCount":{ "description":"The number of tables served by the revenue center.", "type":"integer", "example":1 }, "purgeOrderThresholdInMinutes":{ "description":"The purge order threshold in minutes for this revenue center. The minimum valid value is 30.", "type":"integer", "example":30 }, "orderRoutingThresholdAmount":{ "description":"An amount to determine if the Below Threshold Print Class of a Tender/Media will be used.", "type":"number", "example":0 }, "addOrTransferRVCs":{ "$ref":"#/definitions/RevenueCenterParameter_addOrTransferRVCs" }, "options":{ "type":"string", "example":"000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 96 representing the enablement or disablement of the options associated with the revenue center parameter. If not specified, this will represent the default options associated with the Revenue Center parameter" }, "optionsExt":{ "$ref":"#/definitions/RevenueCenterParameter_optionsExt" }, "postingOptions":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the posting options associated with the revenue center parameter." }, "postingOptionsExt":{ "$ref":"#/definitions/RevenueCenterParameter_postingOptionsExt" }, "interfaces":{ "$ref":"#/definitions/RevenueCenterParameter_interfaces" }, "tmsInterfaceOptions":{ "$ref":"#/definitions/RevenueCenterParameter_tmsInterfaceOptionsv2" }, "enableUberEatsIntegration":{ "type":"boolean", "example":false, "description":"A flag indicating to enable delivery platform integration with Uber Eats." }, "enableDeliverooIntegration":{ "type":"boolean", "example":false, "description":"A flag indicating to enable delivery platform integrations with Deliveroo." }, "taxNumberPrefix":{ "type":"string", "example":"TW", "description":"Taiwanese tax number prefix for the revenue center." }, "endOfRangeThreshold":{ "type":"integer", "example":0, "description":"End of Range Threshold for the Revenue Center Serial Number, as required for the Taiwanese tax structure." }, "minRVCSerialNumber1":{ "type":"integer", "example":1, "description":"Minimum serial number 1 for the revenue center." }, "maxRVCSerialNumber1":{ "type":"integer", "example":99999, "description":"Maximum serial number 1 for the revenue center" }, "minRVCSerialNumber2":{ "type":"integer", "example":1, "description":"Minimum serial number 2 for the revenue center" }, "maxRVCSerialNumber2":{ "type":"integer", "example":99999, "description":"Maximum serial number 2 for the revenue center" }, "autoFireEmpObjNum":{ "type":"integer", "example":0, "description":"Object number of the employee whose totals are associated with Autofire checks when the check is fired." }, "autoFireEmpName":{ "description":"A string that contains Auto Fire Employee Name", "type":"string", "example":"Employee" }, "autoFireWSNum":{ "type":"integer", "example":1, "description":"Object number of the workstation where Autofire checks are fired and printed." }, "defaultAutoFireTenderMediaNum":{ "type":"integer", "example":0, "description":"Object number of the default Tender/Media for Autofire checks in the revenue center." }, "backAutoFireDelayInMinutes":{ "type":"integer", "example":1, "description":"The amount of time (in minutes) that the specified Autofire workstation attempts to Autofire a check." }, "maximumDays":{ "type":"integer", "example":1, "description":"The maximum number of days (in the future) that Autofire checks can be scheduled." }, "autoFireOptions":{ "type":"string", "example":"000000000000000000000000", "description":"A string value of 0s & 1s of length 24 representing the enablement or disablement of the autofire options associated with the revenue center parameter." }, "autoFireOptionsExt":{ "$ref":"#/definitions/RevenueCenterParameter_autoFireOptionsExt" }, "creditCardOptions":{ "type":"string", "example":"000000000000000000000000", "description":"A string value of 0s & 1s of length 24 representing the enablement or disablement of the credit card options associated with the revenue center parameter." }, "creditCardOptionsExt":{ "$ref":"#/definitions/RevenueCenterParameter_creditCardOptionsExt" }, "currentBusinessDate":{ "type":"string", "example":"01/03/2022", "description":"A string representing the current business date at the revenue center" }, "startedAt":{ "type":"string", "example":"01/03/2022 03:00:00 AM", "description":"A string representing the date and time the current business date started at the revenue center" }, "dontResetEmpFinancialShiftsWithSOD":{ "type":"boolean", "example":false, "description":"A flag indicating to prevent Employee Financial Shifts from resetting with the start of each business day." }, "dontResetCashierFinancialShiftsWithSOD":{ "type":"boolean", "example":false, "description":"A flag indicating to prevent Cashier Financial Shifts from resetting with the start of each business day." }, "enableOverridePropertySODtimes":{ "type":"boolean", "example":false, "description":"A flag indicating to allow this revenue center to have its start of day run at a different time than the time set for the property." }, "overridenSODTimes":{ "type":"array", "description":"An array of overridden start of day times.", "items":{ "$ref":"#/definitions/RevenueCenterParameter_overridenSODTimes" } }, "defaultOrderChannelObjNum":{ "description":"Object number of the default Order Channel for this revenue center.", "type":"integer", "example":1 } } }, "RevenueCenterParameterGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Revenue Center Parameter objects of the organization.", "items":{ "$ref":"#/definitions/RevenueCenterParameter" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "RevenueCenterParameterGetRequestBody":{ "type":"object", "required":[ "hierUnitId" ], "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." }, "hierUnitId":{ "type":"integer", "example":1, "description":"unique hierUnitId value of the revenue center" } } }, "RevenueCenterParameterResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"unique HierUnitId of the RVC" } } }, "EmployeeEMCVisbilityResponse":{ "description":"Model for the response", "type":"object", "properties":{ "objectNum":{ "description":"Unique reference of the Employee", "type":"integer" }, "hierUnitId":{ "description":"Unique hierarchy unit value", "type":"integer" } } }, "EMCVisibilityGetResponseV1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Employee EMC Visibility objects of the organization.", "items":{ "$ref":"#/definitions/EmployeeEMCVisibilityv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "EmployeeEMCVisibilityv1":{ "description":"Model for an Employee EMC Visibility Object", "type":"object", "properties":{ "objectNum":{ "description":"Unique reference of the employee in the system.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the employee EMC visibility is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the employee EMC visibility is configured", "type":"integer", "example":26 }, "hierUnitName":{ "type":"object", "description":"A group of string objects representing the name of the hierarchy unit configured languages.", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "propagateToChildren":{ "description":"Boolean flag indicating if the EMC visibility is propagated to child nodes of the hierarchy unit", "type":"boolean", "example":true } } }, "EmployeeEMCVisibilityv2":{ "description":"Model for an Employee EMC Visibility Object", "type":"object", "properties":{ "objectNum":{ "description":"Unique reference of the employee in the system.", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the employee EMC visibility is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the employee EMC visibility is configured", "type":"integer", "example":26 }, "propagateToChildren":{ "description":"Boolean flag indicating if the EMC visibility is propagated to child nodes of the hierarchy unit", "type":"boolean", "example":true } } }, "EMCVisibilityGetRequestBodyv1":{ "description":"The input Body model that needs to be given.", "type":"object", "required":[ "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum,1)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"hierUnitId", "description":"Objects included in the response." }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, es-ES, es-MX", "description":"If specified, limits the translated strings returned." }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index. Not required if paging parameters are not supported." }, "limit":{ "type":"integer", "example":0, "description":"If using paging, number of results returned in this page." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." }, "objectNum":{ "type":"integer", "description":"Unique reference of the employee in the system.", "example":1 } } }, "menuItemMasterResponseV1":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "familyGroupObjectNum":{ "type":"integer", "example":1, "description":"Family group object number" }, "majorGroupObjectNum":{ "type":"integer", "example":2, "description":"Major group object number" }, "masterGroupObjectNum":{ "type":"integer", "example":2, "description":"Master group object number" }, "reportGroupObjectNum":{ "type":"integer", "example":2, "description":"Report group object number" }, "miMasterOptions":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enabled or disabled options, default 00000000." }, "miMasterOptionsExt":{ "$ref":"#/definitions/MenuItem_miMasterOptionsExt" }, "dietaryLabels":{ "type":"array", "description":"An array of dietary labels for menu item", "items":{ "$ref":"#/definitions/MenuItemMaster_dietaryLabels" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item", "items":{ "$ref":"#/definitions/MenuItem_dataExtensions" } }, "effectivityGroups":{ "type":"array", "description":"An array of effectivity groups for the menu item. Excluded from the response by default. Use this field in 'include' filter or use the 'includeAll' filter to get it.", "items":{ "$ref":"#/definitions/MenuItem_effectivityGroups" } }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" } } }, "menuItemMasterGetResponseV1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Item Master objects.", "items":{ "$ref":"#/definitions/menuItemMasterResponseV1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "menuItemMasterV2":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" }, "name":{ "type":"object", "description":"Name", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "name2":{ "type":"object", "description":"Menu Item Master Name2", "example":{ "1":"Coffee", "2":"Kaffee", "3":"Cafe" } }, "familyGroupObjectNum":{ "type":"integer", "example":1, "description":"Family group object number" }, "majorGroupObjectNum":{ "type":"integer", "example":2, "description":"Major group object number" }, "masterGroupObjectNum":{ "type":"integer", "example":2, "description":"Master group object number" }, "reportGroupObjectNum":{ "type":"integer", "example":2, "description":"Report group object number" }, "miMasterOptions":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enabled or disabled options, default 00000000." }, "miMasterOptionsExt":{ "$ref":"#/definitions/MenuItem_miMasterOptionsExt" }, "dietaryLabels":{ "type":"array", "description":"An array of dietary labels for menu item", "items":{ "$ref":"#/definitions/MenuItemMaster_dietaryLabels" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item", "items":{ "$ref":"#/definitions/MenuItem_dataExtensions" } }, "effectivityGroups":{ "type":"array", "description":"An array of effectivity groups for the menu item. Excluded from the response by default. Use this field in 'include' filter or use the 'includeAll' filter to get it.", "items":{ "$ref":"#/definitions/MenuItem_effectivityGroupsv2" } }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" } } }, "menuItemMasterInsertRequestBody":{ "type":"object", "required":[ "objectNum", "hierUnitId" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "familyGroupObjectNum":{ "type":"integer", "example":1, "description":"Family group object number" }, "majorGroupObjectNum":{ "type":"integer", "example":2, "description":"Major group object number" }, "masterGroupObjectNum":{ "type":"integer", "example":2, "description":"Master group object number" }, "reportGroupObjectNum":{ "type":"integer", "example":2, "description":"Report group object number" }, "miMasterOptions":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enabled or disabled options, default 00000000." }, "miMasterOptionsExt":{ "$ref":"#/definitions/MenuItem_miMasterOptionsExt" }, "dietaryLabels":{ "type":"array", "description":"An array of dietary labels for menu item", "items":{ "$ref":"#/definitions/MenuItemMaster_dietaryLabels" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item", "items":{ "$ref":"#/definitions/MenuItem_dataExtensions" } }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" } } }, "menuItemMasterUpdateRequestBody":{ "type":"object", "required":[ "objectNum", "hierUnitId", "menuItemMasterId" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Coffee", "de-DE":"Kaffee", "es-MX":"Cafe" } }, "familyGroupObjectNum":{ "type":"integer", "example":1, "description":"Family group object number" }, "majorGroupObjectNum":{ "type":"integer", "example":2, "description":"Major group object number" }, "masterGroupObjectNum":{ "type":"integer", "example":2, "description":"Master group object number" }, "reportGroupObjectNum":{ "type":"integer", "example":2, "description":"Report group object number" }, "miMasterOptions":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enabled or disabled options, default 00000000." }, "miMasterOptionsExt":{ "$ref":"#/definitions/MenuItem_miMasterOptionsExt" }, "dietaryLabels":{ "type":"array", "description":"An array of dietary labels for menu item", "items":{ "$ref":"#/definitions/MenuItemMaster_dietaryLabels" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item", "items":{ "$ref":"#/definitions/MenuItem_dataExtensions" } }, "externalReference1":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference1" }, "externalReference2":{ "description":"An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32", "type":"string", "example":"ExternalReference2" } } }, "menuItemMasterResponse":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Menu item master object number" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit reference" }, "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" } } }, "MenuItemMastersGetRequestBody":{ "type":"object", "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId,1012)", "description":"Search criteria to filter results based on field value." }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." }, "hierUnitId":{ "type":"integer", "example":1012, "description":"Unique Hierarchy unit reference. This is an optional field. Alternatively, searchCriteria can be used to get results for a particular hierUnitId." } } }, "menuitemmaster_dml":{ "type":"object", "required":[ "menuItemMasterId" ], "properties":{ "menuItemMasterId":{ "type":"integer", "example":1, "description":"Unique menu item master reference" } } }, "MenuItemMaster_dietaryLabels":{ "type":"object", "properties":{ "dietaryLabelName":{ "type":"string", "example":"Dietary Label 1", "description":"Name of the dietary label" } } }, "MenuItem_effectivityGroupsv2":{ "type":"object", "properties":{ "effectivityGroupObjectNum":{ "type":"integer", "example":1, "description":"effectivity group object number" }, "hierUnitId":{ "type":"integer", "example":14102, "description":"hierarchy where the effectivity group is configured" } } }, "BulkRequestSubmitResponse":{ "type":"object", "description":"Bulk request response", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The request ID which can be used to obtain request processing status updates" }, "requestTimeStampUTC":{ "type":"string", "example":"2024-05-21T09:15:08.5909324Z", "description":"The UTC time stamp when the request was submitted." }, "message":{ "type":"string", "example":"No Entities found!!", "description":"Status information regarding the submitted request" } } }, "isl_optionsExt":{ "type":"object", "properties":{ "islEmployeeOption1":{ "type":"boolean", "example":false, "description":"Flag to allow/prevent employees in the Employee Class to execute Interface Script Language (ISL) script with Employee Option \\#1 enabled." }, "islEmployeeOption2":{ "type":"boolean", "example":false, "description":"Flag to allow/prevent employees in the Employee Class to execute Interface Script Language (ISL) script with Employee Option \\#2 enabled." }, "islEmployeeOption3":{ "type":"boolean", "example":false, "description":"Flag to allow/prevent employees in the Employee Class to execute Interface Script Language (ISL) script with Employee Option \\#3 enabled." }, "islEmployeeOption4":{ "type":"boolean", "example":false, "description":"Flag to allow/prevent employees in the Employee Class to execute Interface Script Language (ISL) script with Employee Option \\#4 enabled." }, "islEmployeeOption5":{ "type":"boolean", "example":false, "description":"Flag to allow/prevent employees in the Employee Class to execute Interface Script Language (ISL) script with Employee Option \\#5 enabled." }, "islEmployeeOption6":{ "type":"boolean", "example":false, "description":"Flag to allow/prevent employees in the Employee Class to execute Interface Script Language (ISL) script with Employee Option \\#6 enabled." }, "islEmployeeOption7":{ "type":"boolean", "example":false, "description":"Flag to allow/prevent employees in the Employee Class to execute Interface Script Language (ISL) script with Employee Option \\#7 enabled." }, "islEmployeeOption8":{ "type":"boolean", "example":false, "description":"Flag to allow/prevent employees in the Employee Class to execute Interface Script Language (ISL) script with Employee Option \\#8 enabled." } } }, "EmployeeClass_rvcOperatorOptions":{ "type":"object", "properties":{ "rvcObjNum":{ "type":"integer", "example":1, "description":"Object number of the revenue center." }, "rvcName":{ "description":"A string that contains translations of name of revenue center into multiple languages", "type":"object", "example":{ "en-US":"Revenue Center", "de-DE":"Einnahmenzentrum", "es-MX":"Centro de ingresos" } }, "options":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the Revenue Center Operator record" }, "optionsExt":{ "$ref":"#/definitions/Employee_operators_optionsExt" } } }, "EmployeeClass_rvcOperatorOptionsV2":{ "type":"object", "properties":{ "rvcObjNum":{ "type":"integer", "example":1, "description":"Object number of the revenue center." }, "options":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the Revenue Center Operator record" }, "optionsExt":{ "$ref":"#/definitions/Employee_operators_optionsExt" } } }, "EmployeeClass_rvcOperatorOptionsCU":{ "type":"object", "properties":{ "rvcObjNum":{ "type":"integer", "example":1, "description":"Object number of the revenue center." }, "options":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the Revenue Center Operator record" } } }, "EmployeeClassV1":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "hierUnitObjNum":{ "type":"integer", "example":2, "description":"Hierarchy unit object number" }, "hierUnitName":{ "type":"object", "description":"A group of string objects representing the name of the hierarchy unit configured languages.", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee class." }, "className":{ "type":"object", "description":"ClassName of module", "example":{ "en-US":"Employee class", "de-DE":"Mitarbeiterklasse", "es-MX":"Clase de empleado" } }, "islOptions":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the employee property assignment." }, "islOptionsExt":{ "$ref":"#/definitions/isl_optionsExt" }, "cmAccountingMethodObjNum":{ "type":"integer", "example":1, "description":"Object number of Cash Management session type the employee uses to record Cash Management related transactions within the revenue center" }, "cmAccountingMethodName":{ "description":"Name of Cash Management session type the employee uses to record Cash Management related transactions within the revenue center", "type":"string", "example":"Till Banking" }, "serverBankingTemplateObjNum":{ "type":"integer", "example":1, "description":"Object number of the default template to use when opening a server bank." }, "serverBankingTemplateName":{ "description":"A string that contains translations of serverBankingTemplateName into multiple languages", "type":"object", "example":{ "en-US":"Template", "de-DE":"Schablone", "es-MX":"Plantilla" } }, "rvcOperatorOptions":{ "type":"array", "description":"An array of revenue center operator options", "items":{ "$ref":"#/definitions/EmployeeClass_rvcOperatorOptions" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for Employee Class Revenue Center Operator Options", "items":{ "$ref":"#/definitions/Employee_dataExtensions" } } } }, "EmployeeClassV2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "hierUnitObjNum":{ "type":"integer", "example":2, "description":"Hierarchy unit object number" }, "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee class." }, "className":{ "type":"object", "example":{ "1":"Employee class", "2":"Mitarbeiterklasse", "3":"Clase de empleado" } }, "islOptions":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the employee property assignment." }, "islOptionsExt":{ "$ref":"#/definitions/isl_optionsExt" }, "cmAccountingMethodObjNum":{ "type":"integer", "example":1, "description":"Object number of Cash Management session type the employee uses to record Cash Management related transactions within the revenue center" }, "serverBankingTemplateObjNum":{ "type":"integer", "example":1, "description":"Object number of the default template to use when opening a server bank." }, "rvcOperatorOptions":{ "type":"array", "description":"An array of revenue center operator options", "items":{ "$ref":"#/definitions/EmployeeClass_rvcOperatorOptionsV2" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for Employee Class Revenue Center Operator Options", "items":{ "$ref":"#/definitions/Employee_dataExtensions" } }, "cmAccountingMethodName":{ "description":"Name of Cash Management session type the employee uses to record Cash Management related transactions within the revenue center", "type":"string", "example":"Till Banking" } } }, "EmployeeClassCUDRequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum", "className" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee class." }, "className":{ "type":"object", "description":"ClassName of module", "example":{ "en-US":"Employee class", "de-DE":"Mitarbeiterklasse", "es-MX":"Clase de empleado" } }, "islOptions":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the employee property assignment." }, "cmAccountingMethodObjNum":{ "type":"integer", "example":1, "description":"Object number of Cash Management session type the employee uses to record Cash Management related transactions within the revenue center" }, "serverBankingTemplateObjNum":{ "type":"integer", "example":1, "description":"Object number of the default template to use when opening a server bank." }, "rvcOperatorOptions":{ "type":"array", "description":"An array of revenue center operator options", "items":{ "$ref":"#/definitions/EmployeeClass_rvcOperatorOptionsCU" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for Employee Class Revenue Center Operator Options", "items":{ "$ref":"#/definitions/Employee_dataExtensions" } } } }, "EmployeeClassGetResponseV1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Employee Classes objects of the organization.", "items":{ "$ref":"#/definitions/EmployeeClassV1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "EmployeeClassResponse":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object number of the Employee Class" }, "hierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value where the employee class is configured" } } }, "EmployeeJobCodeGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Employee Job Code objects of the organization.", "items":{ "$ref":"#/definitions/EmployeeJobCodev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "EmployeeJobCodev1":{ "description":"Model for an Employee Job Code Object", "type":"object", "properties":{ "objectNum":{ "description":"Unique reference of the employee in the system.", "type":"integer", "example":1 }, "propertyHierUnitId":{ "description":"Unique reference of the hierarchy unit associated with the property", "type":"integer", "example":3599 }, "propertyObjNum":{ "description":"Object number of the hierarchy unit associated with the property", "type":"integer", "example":5 }, "propertyName":{ "type":"object", "description":"Property Name.", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "jobCodeObjNum":{ "description":"The object number of the employee job code", "type":"integer", "example":1 }, "jobCodeName":{ "type":"object", "description":"Job Code Name", "example":{ "en-US":"Job Code", "es-MX":"C??digo de Trabajo" } }, "regularPayRate":{ "description":"Regular pay rate for the employee in the specified job code", "type":"number", "example":10.75 }, "otPayRate":{ "description":"Overtime pay rate for the employee in the specified job code", "type":"number", "example":20.5 }, "reportGroup":{ "description":"Object number of the Report Group.", "type":"integer", "example":1 } } }, "EmployeeJobCodev2":{ "description":"Model for an Employee Job Code Object", "type":"object", "properties":{ "objectNum":{ "description":"Unique reference of the employee in the system.", "type":"integer", "example":1 }, "propertyHierUnitId":{ "description":"Unique reference of the hierarchy unit associated with the property", "type":"integer", "example":3599 }, "propertyObjNum":{ "description":"Object number of the hierarchy unit associated with the property", "type":"integer", "example":5 }, "jobCodeObjNum":{ "description":"The object number of the employee job code", "type":"integer", "example":1 }, "regularPayRate":{ "description":"Regular pay rate for the employee in the specified job code", "type":"number", "example":10.75 }, "otPayRate":{ "description":"Overtime pay rate for the employee in the specified job code", "type":"number", "example":20.5 }, "reportGroup":{ "description":"Object number of the Report Group.", "type":"integer", "example":1 } } }, "EmployeeJobCodesGetRequestBodyv1":{ "description":"The input Body model that needs to be given.", "type":"object", "required":[ "propertyHierUnitId", "objectNum" ], "properties":{ "searchCriteria":{ "type":"string", "example":"where equals(objectNum, 2)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"objectNum", "description":"Objects included in response" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "description":"If specified, limits translated strings returned", "example":"en-US, es-ES, es-MX" }, "offset":{ "type":"integer", "description":"Starting resource record index. Not required if paging parameters are not supported", "example":0 }, "limit":{ "type":"integer", "description":"If using paging, number of results returned in this page.", "example":100 }, "objectNum":{ "type":"integer", "description":"Object number of the employee", "example":2 }, "propertyHierUnitId":{ "type":"integer", "description":"Unique reference of the hierarchy unit associated with the property", "example":2 } } }, "EmployeeResponse":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" } } }, "EmployeeGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Employee objects of the organization.", "items":{ "$ref":"#/definitions/Employee" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "Employee_roles":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the employee role is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the employee role is configured", "type":"integer", "example":26 }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "roleObjNum":{ "description":"The object number of the employee role", "type":"integer", "example":1000 }, "roleName":{ "type":"object", "description":"Role Name", "example":{ "en-US":"Cashier", "de-DE":"Kassierer", "es-MX":"Cajero" } } } }, "Employee_roles_CUD":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the employee role is configured", "type":"integer", "example":3599 }, "roleObjNum":{ "description":"The object number of the employee role", "type":"integer", "example":1000 } } }, "Employee_emcVisibility":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the employee EMC visibility is configured", "type":"integer", "example":3599 }, "hierUnitObjNum":{ "description":"Object number of the hierarchy unit where the employee EMC visibility is configured", "type":"integer", "example":26 }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "propagateToChildren":{ "description":"Boolean flag indicating if the EMC visibility is propagated to child nodes of the hierarchy unit", "type":"boolean", "example":true } } }, "Employee_emcVisibility_CUD":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the employee EMC visibility is configured", "type":"integer", "example":3599 }, "propagateToChildren":{ "description":"Boolean flag indicating if the EMC visibility is propagated to child nodes of the hierarchy unit", "type":"boolean", "example":true } } }, "Employee_properties_jobCodes":{ "type":"object", "properties":{ "jobCodeObjNum":{ "type":"integer", "example":1, "description":"Object number of the job code" }, "jobCodeName":{ "type":"object", "description":"Job Code Name", "example":{ "en-US":"Job Code", "de-DE":"Arbeit Code", "es-MX":"C??digo de Trabajo" } }, "regularPayRate":{ "type":"number", "example":1.23, "description":"Regular pay rate for the employee in the specified job code" }, "otPayRate":{ "type":"number", "example":2.5, "description":"Overtime pay rate for the employee in the specified job code" } } }, "Employee_properties_operators":{ "type":"object", "properties":{ "rvcHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value of the revenue center" }, "rvcObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number associated with the revenue center" }, "rvcName":{ "type":"object", "description":"RVC Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "cashierObjNum":{ "type":"integer", "example":1, "description":"Object number of the cashier linked to the workstation operator." }, "cashierName":{ "type":"object", "description":"Cashier Name", "example":{ "en-US":"Cashier", "de-DE":"Kassierer", "es-MX":"Cajero" } }, "overrideEmployeeClassOptions":{ "type":"boolean", "example":true, "description":"A flag indicating whether the workstation operator record uses Employee Class Options or Operator Options to determine transaction behavior." }, "options":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the employee operator record at the property." }, "optionsExt":{ "$ref":"#/definitions/Employee_operators_optionsExt" }, "cmAccountingMethodObjNum":{ "type":"integer", "example":1, "description":"Object number of Cash Management session type the employee uses to record Cash Management related transactions within the revenue center" }, "cmAccountingMethodName":{ "type":"string", "example":"Session1", "description":"Name of Cash Management session" }, "serverBankingTemplateObjNum":{ "type":"integer", "example":1, "description":"Object number of the default template to use when opening a server bank." }, "cashDrawerObjNum":{ "type":"integer", "example":1, "description":"Object number of the cash drawer that is permanently assigned to each workstation operator." }, "tableCount":{ "type":"integer", "example":1, "description":"The number of tables each operator serves." }, "tmsColorObjNum":{ "type":"integer", "example":1, "description":"Object number of the color to distinguish the employee from others when using TMS." }, "tmsColorObjName":{ "type":"string", "example":"TMS1", "description":"TMS Color Name" }, "serverEfficiency":{ "type":"integer", "example":1, "description":"Efficiency of the server." } } }, "Employee_properties_operators_CUD":{ "type":"object", "properties":{ "rvcHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value of the revenue center" }, "cashierObjNum":{ "type":"integer", "example":1, "description":"Object number of the cashier linked to the workstation operator." }, "overrideEmployeeClassOptions":{ "type":"boolean", "example":true, "description":"A flag indicating whether the workstation operator record uses Employee Class Options or Operator Options to determine transaction behavior." }, "options":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the employee operator record at the property." }, "cmAccountingMethodObjNum":{ "type":"integer", "example":1, "description":"Object number of Cash Management session type the employee uses to record Cash Management related transactions within the revenue center" }, "serverBankingTemplateObjNum":{ "type":"integer", "example":1, "description":"Object number of the default template to use when opening a server bank." }, "cashDrawerObjNum":{ "type":"integer", "example":1, "description":"Object number of the cash drawer that is permanently assigned to each workstation operator." }, "tableCount":{ "type":"integer", "example":1, "description":"The number of tables each operator serves." }, "tmsColorObjNum":{ "type":"integer", "example":1, "description":"Object number of the color to distinguish the employee from others when using TMS." }, "serverEfficiency":{ "type":"integer", "example":1, "description":"Efficiency of the server." } } }, "Employee_properties":{ "type":"object", "properties":{ "propertyHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value associated with the property" }, "propertyObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number associated with the property" }, "propertyName":{ "type":"object", "description":"Property Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "empClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the class of the employee at the property." }, "empClassName":{ "type":"object", "description":"Employee Class Name", "example":{ "en-US":"Employee class", "de-DE":"Mitarbeiterklasse", "es-MX":"Clase de Empleado" } }, "rvcHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value associated with the RVC." }, "rvcObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number associated with the RVC." }, "rvcName":{ "type":"object", "description":"RVC Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the employee property assignment." }, "optionsExt":{ "$ref":"#/definitions/Employee_properties_optionsExt" }, "inTraining":{ "type":"boolean", "example":false, "description":"Flag indicating if employee is in training at the property." }, "ldsId":{ "type":"integer", "example":1, "description":"unique ID number to identify the employee in a Liquor Dispensing System." }, "lateClockInGrace":{ "type":"integer", "example":1, "description":"The number of minutes that the employee can clock in late without being prompted or requiring authorization." }, "jobCodes":{ "type":"array", "description":"Array of job codes assigned to the employee at the property", "items":{ "$ref":"#/definitions/Employee_properties_jobCodes" } }, "operators":{ "type":"array", "description":"Array of revenue center operators records for the employees", "items":{ "$ref":"#/definitions/Employee_properties_operators" } } } }, "Employee_properties_CUD":{ "type":"object", "properties":{ "propertyHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value associated with the property" }, "empClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the class of the employee at the property." }, "rvcHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value associated with the RVC." }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the employee property assignment." }, "inTraining":{ "type":"boolean", "example":false, "description":"Flag indicating if employee is in training at the property." }, "ldsId":{ "type":"integer", "example":1, "description":"unique ID number to identify the employee in a Liquor Dispensing System." }, "lateClockInGrace":{ "type":"integer", "example":1, "description":"The number of minutes that the employee can clock in late without being prompted or requiring authorization." }, "operators":{ "type":"array", "description":"Array of revenue center operators records for the employees", "items":{ "$ref":"#/definitions/Employee_properties_operators_CUD" } } } }, "Employee":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee in the system." }, "firstName":{ "type":"string", "example":"Employee", "description":"Employee's first name, which prints on reports." }, "lastName":{ "type":"string", "example":"Employee", "description":"Employee's last name, which prints on reports." }, "checkName":{ "type":"string", "example":"Employee Check Name", "description":"Name to print on guest checks." }, "email":{ "type":"string", "example":"employee@restaurant.com", "description":"Email address of the employee." }, "languageObjNum":{ "type":"integer", "example":1, "description":"The object number of the default language for the employee on the EMC and the workstation." }, "language":{ "description":"A string that contains translations of default language name for the employee on the EMC and the workstation into multiple languages", "type":"object", "example":{ "en-US":"Spanish", "de-DE":"Spanisch", "es-MX":"Espanol" } }, "payrollId":{ "type":"string", "example":"EMP-01", "description":"External payroll ID for the employee." }, "id":{ "type":"integer", "example":2021, "description":"ID number to identify the employee on workstations." }, "alternateId":{ "type":"integer", "example":2121, "description":"ID to use instead of the Employee ID when signing into the workstation." }, "pin":{ "type":"string", "example":2222, "description":"PIN for the employee." }, "level":{ "type":"integer", "example":1, "description":"The level of the employee. This value should be between 1-9." }, "group":{ "type":"integer", "example":1, "description":"The group of the employee." }, "isDeleted":{ "type":"boolean", "example":false, "description":"Flag indicating if the employee record is deleted. If true, the record cannot be edited." }, "terminationDate":{ "type":"string", "example":"2021-11-21T00:00:00.000Z", "description":"The date the employee was terminated.Format:YYYY-MM-DD. This value is set from Labor Management and cannot be added" }, "isDataPrivacyConsentGranted":{ "type":"boolean", "example":false, "description":"The consent status of the employee." }, "infoLine1":{ "type":"string", "example":"Information line 1", "description":"Information line 1" }, "infoLine2":{ "type":"string", "example":"Information line 2", "description":"Information line 2" }, "infoLine3":{ "type":"string", "example":"Information line 3", "description":"Information line 3" }, "infoLine4":{ "type":"string", "example":"Information line 4", "description":"Information line 4" }, "userName":{ "type":"string", "example":"empName", "description":"The login name for the EMC." }, "localeObjNum":{ "type":"integer", "example":1, "description":"The object number of the locale of the employee" }, "locale":{ "description":"A string that contains translations of locale name for the employee to use in the EMC into multiple languages", "type":"object", "example":{ "en-US":"es-Spain", "de-DE":"es-Spanien", "es-MX":"es-Espana" } }, "hasFingerprintEnrolled":{ "type":"boolean", "example":false, "description":"Flag indicating if the employee has its fingerprint enrolled. This flag cannot be modified by API." }, "roles":{ "type":"array", "description":"An array of roles associated with the employee at different hierarchy levels", "items":{ "$ref":"#/definitions/Employee_roles" } }, "emcVisibility":{ "type":"array", "description":"Array of hierarchy units visible to the employee in EMC.", "items":{ "$ref":"#/definitions/Employee_emcVisibility" } }, "properties":{ "type":"array", "description":"Array of properties where the employee is assigned.", "items":{ "$ref":"#/definitions/Employee_properties" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for employees", "items":{ "$ref":"#/definitions/Employee_dataExtensions" } } } }, "Employeev2":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee in the system." }, "firstName":{ "type":"string", "example":"Employee", "description":"Employee's first name, which prints on reports." }, "lastName":{ "type":"string", "example":"Employee", "description":"Employee's last name, which prints on reports." }, "checkName":{ "type":"string", "example":"Employee Check Name", "description":"Name to print on guest checks." }, "email":{ "type":"string", "example":"employee@restaurant.com", "description":"Email address of the employee." }, "languageObjNum":{ "type":"integer", "example":1, "description":"The object number of the default language for the employee on the EMC and the workstation." }, "langId":{ "type":"integer", "example":1, "description":"Language Id" }, "payrollId":{ "type":"string", "example":"EMP-01", "description":"External payroll ID for the employee." }, "id":{ "type":"integer", "example":2021, "description":"ID number to identify the employee on workstations." }, "alternateId":{ "type":"integer", "example":2121, "description":"ID to use instead of the Employee ID when signing into the workstation." }, "pin":{ "type":"string", "example":2222, "description":"PIN for the employee." }, "level":{ "type":"integer", "example":1, "description":"The level of the employee. This value should be between 1-9." }, "group":{ "type":"integer", "example":1, "description":"The group of the employee." }, "isDeleted":{ "type":"boolean", "example":false, "description":"Flag indicating if the employee record is deleted. If true, the record cannot be edited." }, "terminationDate":{ "type":"string", "example":"2021-11-21T00:00:00.000Z", "description":"The date the employee was terminated.Format:YYYY-MM-DD. This value is set from Labor Management and cannot be added" }, "isDataPrivacyConsentGranted":{ "type":"boolean", "example":false, "description":"The consent status of the employee." }, "infoLine1":{ "type":"string", "example":"Information line 1", "description":"Information line 1" }, "infoLine2":{ "type":"string", "example":"Information line 2", "description":"Information line 2" }, "infoLine3":{ "type":"string", "example":"Information line 3", "description":"Information line 3" }, "infoLine4":{ "type":"string", "example":"Information line 4", "description":"Information line 4" }, "userName":{ "type":"string", "example":"empName", "description":"The login name for the EMC." }, "localeObjNum":{ "type":"integer", "example":1, "description":"The object number of the locale of the employee" }, "hasFingerprintEnrolled":{ "type":"boolean", "example":false, "description":"Flag indicating if the employee has its fingerprint enrolled. This flag cannot be modified by API." }, "roles":{ "type":"array", "description":"An array of roles associated with the employee at different hierarchy levels", "items":{ "$ref":"#/definitions/Employee_rolesv2" } }, "emcVisibility":{ "type":"array", "description":"Array of hierarchy units visible to the employee in EMC.", "items":{ "$ref":"#/definitions/Employee_emcVisibilityv2" } }, "properties":{ "type":"array", "description":"Array of properties where the employee is assigned.", "items":{ "$ref":"#/definitions/Employee_propertiesv2" } }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for employees", "items":{ "$ref":"#/definitions/Employee_dataExtensions" } } } }, "EmployeePropertyGetRequestBody":{ "type":"object", "required":[ "objectNum" ], "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." }, "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" } } }, "EmployeePropertyGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Employee objects of the organization.", "items":{ "$ref":"#/definitions/EmployeeProperty" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "EmployeeProperty":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee in the system." }, "propertyHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value associated with the property" }, "propertyObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number associated with the property" }, "propertyName":{ "description":"Property Name", "type":"object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "empClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the class of the employee at the property." }, "empClassName":{ "description":"Employee Class Name", "type":"object", "example":{ "en-US":"Employee class", "de-DE":"Mitarbeiterklasse", "es-MX":"Clase de empleado" } }, "rvcHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value associated with the RVC." }, "rvcObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number associated with the RVC." }, "rvcName":{ "description":"RVC Name", "type":"object", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the employee property assignment." }, "optionsExt":{ "$ref":"#/definitions/Employee_properties_optionsExt" }, "inTraining":{ "type":"boolean", "example":false, "description":"Flag indicating if employee is in training at the property." }, "ldsId":{ "type":"integer", "example":1, "description":"unique ID number to identify the employee in a Liquor Dispensing System." }, "lateClockInGrace":{ "type":"integer", "example":1, "description":"The number of minutes that the employee can clock in late without being prompted or requiring authorization." }, "jobCodes":{ "type":"array", "description":"Array of job codes assigned to the employee at the property", "items":{ "$ref":"#/definitions/Employee_properties_jobCodes" } }, "operators":{ "type":"array", "description":"Array of revenue center operators records for the employees", "items":{ "$ref":"#/definitions/Employee_properties_operators" } } } }, "EmployeePropertyv2":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee in the system." }, "propertyHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value associated with the property" }, "propertyObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number associated with the property" }, "empClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the class of the employee at the property." }, "rvcHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value associated with the RVC." }, "rvcObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number associated with the RVC." }, "options":{ "type":"string", "example":"0000000000000000", "description":"A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the employee property assignment." }, "optionsExt":{ "$ref":"#/definitions/Employee_properties_optionsExt" }, "inTraining":{ "type":"boolean", "example":false, "description":"Flag indicating if employee is in training at the property." }, "ldsId":{ "type":"integer", "example":1, "description":"unique ID number to identify the employee in a Liquor Dispensing System." }, "lateClockInGrace":{ "type":"integer", "example":1, "description":"The number of minutes that the employee can clock in late without being prompted or requiring authorization." }, "jobCodes":{ "type":"array", "description":"Array of job codes assigned to the employee at the property", "items":{ "$ref":"#/definitions/Employee_properties_jobCodesv2" } }, "operators":{ "type":"array", "description":"Array of revenue center operators records for the employees", "items":{ "$ref":"#/definitions/Employee_properties_operatorsv2" } } } }, "EmployeePropertyResponse":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" }, "propertyHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value of the property" } } }, "EmployeePropertyJobCodeGetRequestBody":{ "type":"object", "required":[ "objectNum", "propertyHierUnitId" ], "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum:asc", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(active,1)", "description":"Search criteria to filter results based on field value" }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." }, "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" }, "propertyHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value of the property" } } }, "EmployeePropertyOperatorGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Employee Property Operator objects of the organization.", "items":{ "$ref":"#/definitions/EmployeePropertyOperatorv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "EmployeePropertyOperatorv1":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee in the system." }, "propertyHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value associated with the property" }, "propertyObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number associated with the property" }, "propertyName":{ "type":"object", "description":"Property Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "rvcHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value of the revenue center" }, "rvcObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number associated with the revenue center" }, "rvcName":{ "type":"object", "description":"RVC Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "cashierObjNum":{ "type":"integer", "example":1, "description":"Object number of the cashier linked to the workstation operator." }, "cashierName":{ "type":"object", "description":"Cashier Name", "example":{ "en-US":"Cashier", "de-DE":"Kassierer", "es-MX":"Cajero" } }, "overrideEmployeeClassOptions":{ "type":"boolean", "example":true, "description":"A flag indicating whether the workstation operator record uses Employee Class Options or Operator Options to determine transaction behavior." }, "options":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the employee operator record at the property." }, "optionsExt":{ "$ref":"#/definitions/Employee_operators_optionsExt" }, "cmAccountingMethodObjNum":{ "type":"integer", "example":1, "description":"Object number of Cash Management session type the employee uses to record Cash Management related transactions within the revenue center" }, "cmAccountingMethodName":{ "type":"string", "description":"CM Accounting Method Name", "example":"Till Banking" }, "serverBankingTemplateObjNum":{ "type":"integer", "example":1, "description":"Object number of the default template to use when opening a server bank." }, "cashDrawerObjNum":{ "type":"integer", "example":1, "description":"Object number of the cash drawer that is permanently assigned to each workstation operator." }, "tableCount":{ "type":"integer", "example":1, "description":"The number of tables each operator serves." }, "tmsColorObjNum":{ "type":"integer", "example":1, "description":"Object number of the color to distinguish the employee from others when using TMS." }, "tmsColorObjName":{ "type":"string", "description":"TMS Color Obj Name.", "example":"Blanco" }, "serverEfficiency":{ "type":"integer", "example":1, "description":"Efficiency of the server." } } }, "EmployeePropertyOperatorv2":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the employee in the system." }, "propertyHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value associated with the property" }, "propertyObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number associated with the property" }, "rvcHierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value of the revenue center" }, "rvcObjNum":{ "type":"integer", "example":1, "description":"Hierarchy unit object number associated with the revenue center" }, "cashierObjNum":{ "type":"integer", "example":1, "description":"Object number of the cashier linked to the workstation operator." }, "overrideEmployeeClassOptions":{ "type":"boolean", "example":true, "description":"A flag indicating whether the workstation operator record uses Employee Class Options or Operator Options to determine transaction behavior." }, "options":{ "type":"string", "example":"00000000000000000000000000000000", "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the employee operator record at the property." }, "optionsExt":{ "$ref":"#/definitions/Employee_operators_optionsExt" }, "cmAccountingMethodObjNum":{ "type":"integer", "example":1, "description":"Object number of Cash Management session type the employee uses to record Cash Management related transactions within the revenue center" }, "serverBankingTemplateObjNum":{ "type":"integer", "example":1, "description":"Object number of the default template to use when opening a server bank." }, "cashDrawerObjNum":{ "type":"integer", "example":1, "description":"Object number of the cash drawer that is permanently assigned to each workstation operator." }, "tableCount":{ "type":"integer", "example":1, "description":"The number of tables each operator serves." }, "tmsColorObjNum":{ "type":"integer", "example":1, "description":"Object number of the color to distinguish the employee from others when using TMS." }, "serverEfficiency":{ "type":"integer", "example":1, "description":"Efficiency of the server." }, "tmsColorObjName":{ "type":"string", "description":"TMS Color Obj Name.", "example":"Blanco" }, "cmAccountingMethodName":{ "type":"string", "description":"CM Accounting Method Name", "example":"Till Banking" } } }, "EmployeePropertyOperatorResponse":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Unique reference of the Employee" }, "propertyHierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value of the property" }, "rvcHierUnitId":{ "type":"integer", "example":2, "description":"Unique hierarchy unit value of the revenue center." } } }, "SystemEmployee":{ "description":"System employee record", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the system employee is configured.", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object number of the system employee.", "type":"integer", "example":1 }, "firstName":{ "description":"System employee's first name, which prints on reports.", "type":"string", "example":"Employee" }, "lastName":{ "description":"System employee's last name, which prints on reports.", "type":"string", "example":"Employee" }, "checkName":{ "description":"Name to print on guest checks.", "type":"string", "example":"SystemEmpCheckName" }, "langId":{ "description":"LangId of default language for the system employee", "type":"integer", "example":1 } } }, "MenuItemClass2_optionsExt":{ "type":"object", "description":"An object containing the descriptive options", "properties":{ "enableOpenPricedMenuItems":{ "type":"boolean", "example":false, "description":"Flag indicating if users asked for amount each time a menu item in this class is ordered." }, "enableCondimentMenuItems":{ "type":"boolean", "example":false, "description":"Flag indicating to designate menu items as condiments." }, "enableNegativePricedMenuItems":{ "type":"boolean", "example":false, "description":"Flag indicating to have menu items in this class post a negative price/sales amount." }, "incrementSeatNumberWithSaleOfMenuItems":{ "type":"boolean", "example":false, "description":"Flag indicating to increment the seat number each time a menu item in this class is ordered." }, "ReferenceEntryRequired":{ "type":"boolean", "example":false, "description":"Flag indicating to require a reference entry for menu items assigned to this class." }, "validationRequired":{ "type":"boolean", "example":false, "description":"Flag indicating to allow menu items in this class to be discounted with an item discount." }, "applyItemDiscountsToMenuItems":{ "type":"boolean", "example":false, "description":"Flag indicating to allow menu items in this class to be discounted with an item discount." }, "allowNonPricedMenuItems":{ "type":"boolean", "example":false, "description":"Flag indicating to allow menu items in this class to be non-priced." }, "allowCondimentChangesPrintGroupOfParentClass":{ "type":"boolean", "example":false, "description":"Flag indicating to force a parent menu item that is modified by a condiment." }, "useSubLevelPricing":{ "type":"boolean", "example":false, "description":"Flag indicating to use Sub Level pricing for this menu item class." }, "addToGuestCount":{ "type":"boolean", "example":false, "description":"Flag indicating to increase the guest count when menu items in this class are ordered." }, "addToAutoSVCItmzr":{ "type":"boolean", "example":false, "description":"Flag indicating to add menu items in this class to the Automatic Service Charge itemizer." }, "printPricetoOrderchit":{ "type":"boolean", "example":false, "description":"Flag indicating to print the price of open-priced items on order chits." }, "doNotPutInTransactionDetail":{ "type":"boolean", "example":false, "description":"Flag indicating to prevent menu items in this class that have a 0.00 price, or no price record assigned, from printing, appearing, or posting." }, "weighedItems":{ "type":"boolean", "example":false, "description":"Flag indicating if all menu items in this class are sold by weight." }, "printName1And2OnChecks":{ "type":"boolean", "example":false, "description":"Flag indicating to print the First Name and the Second Name." }, "printName2OnOrderOutput":{ "type":"boolean", "example":false, "description":"Flag indicating to print the Second Name on Order Device output." }, "useName2OnTouchScreens":{ "type":"boolean", "example":false, "description":"Flag indicating to show the Second Name, if defined, of menu items assigned to this class on workstation touchscreen keys." }, "requireNumberOfCondimentsToMatchParent":{ "type":"boolean", "example":false, "description":"Flag indicating to require the number of required condiments to match the number of parent menu items ordered." }, "useOwnOuputLink":{ "type":"boolean", "example":false, "description":"Flag indicating to have condiments in this class print to their own order devices." }, "addCondimentPriceToParentItem":{ "type":"boolean", "example":false, "description":"Flag indicating to add Condiment Price to Parent Item." }, "ldsItems":{ "type":"boolean", "example":false, "description":"Flag indicating if all menu items in this class can be ordered using an International Liquor Dispensing System (ILDS)." }, "useWithRepeatRoundKey":{ "type":"boolean", "example":false, "description":"Flag indicating if all menu items in this class can be reposted on guest checks using the Repeat Round key." }, "keepMainLevelWithRepeatRounds":{ "type":"boolean", "example":false, "description":"Flag indicating to enforce items in this class to use the same Main Menu Level that was in effect during the most recent service round when ordered using the Repeat Round key." }, "keepSubLevelWithRepeatRounds":{ "type":"boolean", "example":false, "description":"Flag indicating to enforce items in this class to use the same Sub Menu Level that was in effect during the most recent service round when ordered using the Repeat Round key." }, "printMainLevelPrefixAndSuffix":{ "type":"boolean", "example":false, "description":"Flag indicating to have the Main level prefix or suffix show on the check detail area and to print on order output devices, guest checks, and customer receipts." }, "printSubLevelPrefixAndSuffix":{ "type":"boolean", "example":false, "description":"Flag indicating to have the Sub level prefix or suffix show on the check detail area and to print on order output devices, guest checks, and customer receipts." }, "sortCondimentsByPrintGroup":{ "type":"boolean", "example":false, "description":"Flag indicating to sort condiment display and printing tasks according to their Print Group assignment." }, "promptForSeatNumWithEachItem":{ "type":"boolean", "example":false, "description":"Flag indicating to prompt Enter Seat Number after adding each parent item with this Menu Item Class." }, "isBeverageItem":{ "type":"boolean", "example":false, "description":"Flag indicating if all items in this Menu Item Class are beverages." }, "isShareableItem":{ "type":"boolean", "example":false, "description":"Flag indicating to allow sharing of menu items in this class between two or more seats, or two or more checks." }, "isRetailItem":{ "type":"boolean", "example":false, "description":"Flag indicating whether item is retailable or not." }, "consolidateMenuItemWithCondimentsOnOrderOutput":{ "type":"boolean", "example":false, "description":"Flag indicating to consolidate parent menu items on Order Device Output, and then to print each condiment with the seat number." }, "consolidateParentsWithMatchingCondimentsOnOrderOutput":{ "type":"boolean", "example":false, "description":"Flag indicating to consolidate parent menu items with identical (matching) condiments." }, "includeInCRMOrTMSCheckDetilUpdate":{ "type":"boolean", "example":false, "description":"Flag indicating to indicate whether a menu item is sent to the TMS Interface with the check detail status message." }, "useKDSDiningCourseNumber":{ "type":"boolean", "example":false, "description":"Flag indicating to use KDS/Dining Coursing with this Menu Item Class." }, "overrideKDSCourseNumOfParentClass":{ "type":"boolean", "example":false, "description":"Flag indicating to allow a parent menu item modified by a condiment in this Menu Item Class to use the KDS Course of the condiment." }, "participatesInMenuItemSwitching":{ "type":"boolean", "example":false, "description":"Flag indicating to switch a parent menu item based a menu level change." }, "isAnonymousMenuItem":{ "type":"boolean", "example":false, "description":"Flag indicating to allow placeholder or anonymous menu items, which can be replaced with the actual parent menu items during the ordering process." }, "itemMustCompleteBeforeNextItem":{ "type":"boolean", "example":false, "description":"Flag indicating to prevent operators from adding a second menu item before completing the first item." }, "promptToBeginNextItemIfItemIsIncomplete":{ "type":"boolean", "example":false, "description":"Flag indicating to prompt to move to the next item before completing a menu item order." }, "removeItemOnSubsequentPressIfExclusiveOrderingType":{ "type":"boolean", "example":false, "description":"Flag indicating to remove a condiment item and revert the parent menu item to the default state." }, "condimentEntryRelationaltoParentItemsQuantity":{ "type":"boolean", "example":false, "description":"Flag indicating to show the number of condiments for each parent menu item." }, "discountsApplyToPricedCondiments":{ "type":"boolean", "example":false, "description":"Flag indicating to apply discounts to parent items in this class and all priced condiments associated with the items." }, "parentItemsAppearOnCondimentOrderDevices":{ "type":"boolean", "example":false, "description":"Flag indicating to send the parent item to the order devices programmed for this class." }, "condimentOrderDeviceProgrammingOverridesThatOfParent":{ "type":"boolean", "example":false, "description":"Flag indicating to allow the order devices programmed for this condiments class to override the order devices defined for the parent items." }, "allowItemIncompleteBasedOnRole":{ "type":"boolean", "example":false, "description":"Flag indicating to allow the employee to add the parent menu item without the required condiments." }, "placeHolder":{ "type":"boolean", "example":false, "description":"Flag indicating for menu items that serve as a placeholder during Combo Meal ordering." }, "noPlaceHolderDisplay":{ "type":"boolean", "example":false, "description":"Flag indicating to hide placeholder items from the check detail area." }, "countMenuItem":{ "type":"boolean", "example":false, "description":"Flag indicating to allow the menu item count to appear on the KDS or at the bottom of the requisition chit from a local or remote printer." }, "autoFill":{ "type":"boolean", "example":false, "description":"Flag indicating to adjust the quantity to satisfy the required condiments when adding the condiment with a required condiment group that has Min/Max set, and more than one condiment is still needed." }, "rentalDeposit":{ "type":"boolean", "example":false, "description":"Flag indicating to make all items in this class Rental Deposits." }, "supportEnhancedPrefixMode":{ "type":"boolean", "example":false, "description":"Flag indicating to turn on Enhanced Prefix Support for non-condiment menu items in this class." }, "printName3OnOrderOutputInsteadOfName1":{ "type":"boolean", "example":false, "description":"Flag indicating to print the menu item definition's Third Name (if defined) on order devices for menu items in this class." }, "useName3OnTouchscreensInsteadOfName1":{ "type":"boolean", "example":false, "description":"Flag indicating to show the third name (if defined) on system generated touchscreen keys." }, "printName3OnChecks":{ "type":"boolean", "example":false, "description":"Flag indicating to print the menu item definition's Third Name (if defined) on guest checks for menu items in this class." }, "promptToLookupMenuItemDefinitionbasedOncurrentMenuLevels":{ "type":"boolean", "example":false, "description":"Flag indicating to prompt the operator to look up a menu item definition based on the current menu levels when a repeatable menu item is unavailable." }, "useName2OnOCBInsteadOfName1":{ "type":"boolean", "example":false, "description":"Flag indicating to show the menu item definition's Second Name (if defined) on an Order Confirmation Board." }, "useName3OnOCBInsteadOfName1":{ "type":"boolean", "example":false, "description":"Flag indicating to show the third name (if defined) on an Order Confirmation Board. If no third name is defined, the first name is used." }, "enableRefill":{ "type":"boolean", "example":false, "description":"Flag indicating for customers to pay once for selected menu items, while receiving multiple servings or refills." }, "PreventMenuItemsFromBeingHeld":{ "type":"boolean", "example":false, "description":"Flag indicating to prevent menu items belonging to this Menu Item Class from being held." }, "kdsSortPriorityAboveNormal":{ "type":"boolean", "example":false, "description":"Flag indicating to allow menu items assigned to this class to use a higher sort priority than normal." }, "postSalesCountToKDSReports":{ "type":"boolean", "example":false, "description":"Flag indicating to allow the menu item count to add to the Menu Item Count totals on the KDS reports." }, "onlyAllowCondimentsWithAnActivePriceRecord":{ "type":"boolean", "example":false, "description":"Flag indicating to prevent condiments that do not have an effective price record from being displayed in SLU's or added to a parent item from a direct access button." }, "forgiveInclusiveTax":{ "type":"boolean", "example":false, "description":"Flag indicating to forgive Inclusive Tax for this class." }, "doNotPrintUnPricedCondimentsOnGuestChecks":{ "type":"boolean", "example":false, "description":"Flag indicating to stop unpriced condiments from printing on guest checks and customer receipts." }, "containsAlcohol":{ "type":"boolean", "example":false, "description":"Flag indicating for menu items in this class to be marked as containing alcohol." }, "ignoreKDSPrepTime":{ "type":"boolean", "example":false, "description":"Flag indicating for menu items in this class to be displayed at a KDS display as soon capacity is available, ignoring having all menu items prep complete at the same time." }, "overrideParentsIgnoreKDSPrepTimeOption":{ "type":"boolean", "example":false, "description":"Flag indicating to override Option 83 of Parent Class." } } }, "MenuItemClass2_dataExtensions":{ "type":"object", "properties":{ "columnName":{ "type":"string", "example":"extension column 1", "description":"Name of the extention field" }, "value":{ "type":"string", "example":"value 1", "description":"Value of the extention field" } } }, "MenuItemClass2_requiredCondimentGroups_forceOptions":{ "type":"object", "properties":{ "minimum":{ "type":"integer", "example":1, "description":"Minimum number of items in the condiment group" }, "maximum":{ "type":"integer", "example":1, "description":"Maximum number of items allowed in the condiment group" }, "threshold1":{ "type":"integer", "example":1, "description":"Threshold 1 count of the condiment group" }, "thresholdLevel1":{ "type":"integer", "example":1, "description":"Threshold Level 1 of the condiment group" }, "threshold2":{ "type":"integer", "example":1, "description":"Threshold 2 count of the condiment group" }, "thresholdLevel2":{ "type":"integer", "example":1, "description":"Threshold Level 2 of the condiment group" } } }, "MenuItemClass2_requiredCondimentGroups":{ "type":"object", "properties":{ "condimentGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the condiment group" }, "forceOptions":{ "type":"array", "description":"Force Options of the condiment group", "items":{ "$ref":"#/definitions/MenuItemClass2_requiredCondimentGroups_forceOptions" } } } }, "MenuItemClass2_condimentGroups":{ "type":"object", "description":"List of condiment groups that are associated with the Menu Item Class", "properties":{ "requiredCondimentGroups":{ "type":"array", "description":"Array of the Condiment Groups that are required when ordering items assigned to this Menu Item Class.", "items":{ "$ref":"#/definitions/MenuItemClass2_requiredCondimentGroups" } }, "allowedCondimentGroupOptions":{ "type":"string", "example":"010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 256 representing the enablement or disablement of the options associated with Condiment Groups that are allowed when adding items in this Menu Item Class." }, "memberCondimentGroupOptions":{ "type":"string", "example":"010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 256 representing the enablement or disablement of the options associated with the Condiment Groups to which items in this Menu Item Class belong. " } } }, "MenuItemClass2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique hierarchy unit value" }, "hierUnitObjNum":{ "type":"integer", "example":2, "description":"Hierarchy unit object number" }, "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the menu item Class." }, "name":{ "type":"object", "description":"Menu Item Class Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "taxClassObjNum":{ "type":"integer", "example":1, "description":"Tax Class object for the Menu Item class" }, "mainLevelPopupIndex":{ "type":"integer", "example":1, "description":"Main Level of the transaction to become active after adding an item from this Menu Item Class." }, "mainLevelDefault":{ "type":"boolean", "example":false, "description":"Select Main Level Dflt to return the Main Level of the transaction to the default Main Level after adding an item from this Menu Item Class." }, "subLevelPopupIndex":{ "type":"integer", "example":1, "description":"Sub Level of the transaction to become active after adding an item from this Menu Item Class." }, "subLevelDefault":{ "type":"boolean", "example":false, "description":"Select Sub Level Dflt to return the Sub Level of the transaction to the default Sub Level after adding an item from this Menu Item Class." }, "privilegeGroup":{ "type":"integer", "example":1, "description":"Privilege Group number to restrict the use of items in this Menu Item Class to employees who are linked to the same Privilege Group" }, "slsItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Sales Itemizer used to sort Menu Item Classes." }, "dscItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Discount Itemizer associated with this Menu Item Class." }, "svcItmzrIndex":{ "type":"integer", "example":1, "description":"Index of the Service Charge Itemizer associated with menus items assigned to this Menu item Class." }, "halo":{ "type":"integer", "example":1, "description":"High Amount Lock Out (HALO) value for items in this Menu Item Class." }, "kdsCourseObjNum":{ "type":"integer", "example":1, "description":"Object number of the course to which items in this Menu Item Class belong." }, "defaultMasterGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the default parent item for a condiment during conversational ordering." }, "condimentOrderType":{ "type":"integer", "example":1, "description":"Method for adding a condiment to a check. Value should be between 0-4." }, "condimentOrderPopup":{ "type":"integer", "example":1, "description":"Popup Condiment Orderer page to automatically pop up when adding a menu item with required condiments." }, "condimentEditPopup":{ "type":"integer", "example":0, "description":"Condiment Orderer page to automatically pop up when selecting a menu item with required condiments in the check detail." }, "priceCalculation":{ "type":"integer", "example":0, "description":"Calculation method to use for pricing menu items in the class when entering a decimal count." }, "countDisplay":{ "type":"integer", "example":1, "description":"Count that appear on the workstation and printers." }, "countEntry":{ "type":"integer", "example":1, "description":"Select the operator entry method for item sales count." }, "printGroup":{ "type":"integer", "example":1, "description":"The sorting mechanism uses this value for receipt printing, check detail, and order output devices." }, "printClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Print Class for the menu item class." }, "kdsHighlightScheme":{ "type":"integer", "example":1, "description":"Object number of the KDS Highlight Scheme color to display menu items on the KDS." }, "condimentPrefixType":{ "type":"integer", "example":1, "description":"Prefix Type associated with a Condiment type." }, "condimentHandlingWithParentItemSwitching":{ "type":"integer", "example":0, "description":"Condiment behavior to use for Default and other Condiments when the parent item is switched in Conversational Ordering." }, "nextPage":{ "type":"integer", "example":0, "description":"Next screen or page to which the workstation user is directed." }, "nextPanel":{ "type":"integer", "example":0, "description":"Panel specifies which Tab to navigate." }, "maxRefillCount":{ "type":"integer", "example":1, "description":"Maximum number of Refills allowed for a Menu item." }, "refillDescriptor":{ "type":"object", "description":"Refill Descriptor", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "svcGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the Service Charge Group to apply to this Menu Item Class." }, "preProdChitPrintClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Pre Production Chit Print Class for the Menu Item Class." }, "allergenClassObjNum":{ "type":"integer", "example":1, "description":"Object number of the Allergen Class for the Menu Item Class." }, "options":{ "type":"string", "example":"010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 96 representing the enablement or disablement of the options associated with the Menu Item Class." }, "optionsExt":{ "$ref":"#/definitions/MenuItemClass2_optionsExt" }, "condimentGroups":{ "$ref":"#/definitions/MenuItemClass2_condimentGroups" }, "dataExtensions":{ "type":"array", "description":"An array of data extensions for the menu item class", "items":{ "$ref":"#/definitions/MenuItemClass2_dataExtensions" } } } }, "HeadersTrailersByChannelType":{ "description":"Headers Trailers by Channel Type record", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the descriptor is configured.", "type":"integer", "example":3599 }, "objectNum":{ "description":"Object number of the descriptor.", "type":"integer", "example":1 }, "name":{ "description":"Descriptor name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "descriptorTypeNum":{ "description":"Descriptor type number. The valid values are - 55 => Check Header - Order Type/Order Channel, 56 => Check Trailer - Order Type/Order Channel, 57 => Receipt Header - Order Type/Order Channel.", "type":"integer", "example":55 }, "descriptorLines":{ "description":"An array of descriptor lines", "type":"array", "items":{ "properties":{ "lineNum":{ "description":"Line Number of the Header/Trailer. The valid range for lineNum for headers is 1-6 and for trailers is 1-12.", "type":"integer", "example":55 }, "useLogo":{ "description":"Boolean flag for using either logoObjectNum(true) or text(false) for the specified lineNum. Automatically set to false if value is not specified.", "type":"boolean", "example":false }, "text":{ "description":"A string that contains the text of a line in multiple languages.", "type":"object", "example":{ "1":"Please visit again!", "2":"Bitte schauen Sie noch einmal vorbei!", "3":"Por favor visite de nuevo!" } }, "logoObjectNum":{ "description":"Object Number of the logo.", "type":"integer", "example":0 } } } } } }, "ReasonCode":{ "description":"Reason Code", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit where the reason code is configured.", "type":"integer", "example":7 }, "objectNum":{ "description":"Object Number of the Reason Code.", "type":"integer", "example":2 }, "descriptorTypeNum":{ "description":"

    Descriptor type number of the reason code.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Descriptor Type NameDescriptor Type NumMax Count
    Payment 30 32
    Loan 28 32
    Pickup 27 32
    Service total 29 32
    Void/Return/Waste 48 64
    Cash Management
    Adjust Starting Amount: 38
    Adjust Count: 39
    Adjust Paid-in: 40
    Adjust Paid-out: 41
    Transfer: 42
    Adjust Cash Deposit: 43
    Over/Short: 44
    Adjust Bank Deposit Reference: 45
    No Sale Reason: 49
    \n", "type":"integer", "example":30 }, "text":{ "type":"object", "description":"Name of the Reason Code.", "maxLength":128, "example":{ "1":"Inventory purchase", "2":"Inventory purchase", "3":"Inventory purchase" } }, "options":{ "description":"A string value of 0s & 1s of length 16 indicating the use of Reasons for Voids/Returns and Waste.", "type":"integer", "example":"1100000000000000" }, "optionsExt":{ "type":"object", "properties":{ "useVoidReturn":{ "type":"boolean", "example":false, "description":"Flag indicating the use of reason code for voids and return menu items." }, "useWaste":{ "type":"boolean", "example":false, "description":"Flag indicating the use of reason code for Waste menu items." } }, "description":"An object containing the descriptive options list associated with the Void/Return/Waste reasons." } } }, "NutritionNamesv2":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Nutrition Name object number" }, "name":{ "type":"object", "description":"Name", "example":{ "1":"Calories" } } } }, "RevenueCenterResponse":{ "type":"object", "properties":{ "locHierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the revenue center", "type":"integer", "example":2 } } }, "RevenueCenterInsert":{ "required":[ "locHierUnitId", "objectNum", "name" ], "description":"Model for RevenueCenter Object", "type":"object", "properties":{ "locHierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the revenue center", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the revenue center configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "ConsumerFacingName":{ "description":"A group of string objects representing the consumer facing name of the revenue center in the configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "phoneCountryCode":{ "description":"The phone number country code of the revenue center. It cannot be null when assigning a phone number to the property.", "type":"string", "example":"US" }, "phone":{ "description":"The phone number of the revenue center. If it is not null, the phoneCountryCode is required.", "type":"string", "example":"1234567890" }, "address1":{ "description":"The address line 1 for the revenue center.", "type":"string", "example":"Address Line 1" }, "address2":{ "description":"The address line 2 for the revenue center.", "type":"string", "example":"Address Line 2" }, "address3":{ "description":"The address line 3 for the revenue center.", "type":"string", "example":"Address Line 3" }, "city":{ "description":"The city for the revenue center.", "type":"string", "example":"City" }, "stateOrRegionCode":{ "description":"The state or region code for the revenue center. It cannot be null when stateOrRegion is not null.", "type":"string", "example":"NY" }, "stateOrRegion":{ "description":"The state or region for the revenue center. It cannot be null when stateOrRegionCode is not null.", "type":"string", "example":"New York" }, "zipOrPostalCode":{ "description":"The ZIP or postal code for the revenue center.", "type":"string", "example":"YXA123" }, "countryCode":{ "description":"The country code for the revenue center.", "type":"string", "example":"US" }, "latitude":{ "description":"The revenue center latitude. Latitude must be within range -90 to +90", "type":"string", "example":12.23 }, "longitude":{ "description":"The revenue center longitude. Longitude must be between -180 and 180", "type":"string", "example":12.34 }, "floor":{ "description":"The floor of the building.", "type":"string", "example":"1st Floor" }, "kdsControllerId":{ "description":"The unique reference of the KDS Controller that controls the KDS Display Order Devices in this revenue center. Oracle recommends using no more than 15 KDS Display Order Devices on a single KDS Controller", "type":"integer", "example":2 }, "kdsControllerName":{ "description":"A group of string objects representing the name of the KDS controller in configured languages", "type":"object", "example":{ "en-US":"Controller", "de-DE":"Regler", "es-MX":"Controlador" } }, "isLDSActive":{ "description":"A flag indicating if LDS is activated for this revenue center.", "type":"boolean", "example":false }, "rvcTypes":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the revenue center types associated with the revenue center. If not specified, this will represent the default options associated with the revenue center", "type":"string", "example":"11111111111111111111111111111111" }, "rvcGroups":{ "description":"An object containing the descriptive options list associated with the revenue center groups associated with this revenue center", "type":"array", "items":{ "type":"object", "properties":{ "rvcGroupNum":{ "type":"integer", "description":"The object number of the revenue center group associated with the revenue center", "example":1 } } }, "example":{ "rvcGroupNum":1 } }, "dataExtensions":{ "description":"An array of extension data associated with the revenue center", "type":"array", "items":{ "type":"object", "properties":{ "columnName":{ "type":"string", "description":"The name of the extension data column", "example":"extension column 1" }, "value":{ "type":"string", "description":"The value associated with the extension data column", "example":"value 1" } } }, "example":{ "columnName":"extension column 1", "value":"value 1" } } } }, "RevenueCenterUpdate":{ "required":[ "hierUnitId", "name" ], "description":"Model for RevenueCenter Object", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the revenue center", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the revenue center configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "locHierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the revenue center", "type":"integer", "example":1 }, "ConsumerFacingName":{ "description":"A group of string objects representing the consumer facing name of the revenue center in the configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "phoneCountryCode":{ "description":"The phone number country code of the revenue center. It cannot be null when assigning a phone number to the property.", "type":"string", "example":"US" }, "phone":{ "type":"string", "description":"The phone number of the revenue center. If it is not null, the phoneCountryCode is required.", "example":"1234567890" }, "address1":{ "description":"The address line 1 for the revenue center.", "type":"string", "example":"Address Line 1" }, "address2":{ "description":"The address line 2 for the revenue center.", "type":"string", "example":"Address Line 2" }, "address3":{ "description":"The address line 3 for the revenue center.", "type":"string", "example":"Address Line 3" }, "city":{ "description":"The city for the revenue center.", "type":"string", "example":"City" }, "stateOrRegionCode":{ "description":"The state or region code for the revenue center. It cannot be null when stateOrRegion is not null.", "type":"string", "example":"NY" }, "stateOrRegion":{ "description":"The state or region for the revenue center. It cannot be null when stateOrRegionCode is not null.", "type":"string", "example":"New York" }, "zipOrPostalCode":{ "description":"The ZIP or postal code for the revenue center.", "type":"string", "example":"YXA123" }, "countryCode":{ "description":"The country code for the revenue center.", "type":"string", "example":"US" }, "latitude":{ "description":"The revenue center latitude. Latitude must be within range -90 to +90", "type":"string", "example":12.23 }, "longitude":{ "description":"The revenue center longitude. Longitude must be between -180 and 180", "type":"string", "example":12.34 }, "floor":{ "description":"The floor of the building.", "type":"string", "example":"1st Floor" }, "kdsControllerId":{ "description":"The unique reference of the KDS Controller that controls the KDS Display Order Devices in this revenue center. Oracle recommends using no more than 15 KDS Display Order Devices on a single KDS Controller", "type":"integer", "example":2 }, "kdsControllerName":{ "description":"A group of string objects representing the name of the KDS controller in configured languages", "type":"object", "example":{ "en-US":"Controller", "de-DE":"Regler", "es-MX":"Controlador" } }, "isLDSActive":{ "description":"A flag indicating if LDS is activated for this revenue center.", "type":"boolean", "example":false }, "rvcTypes":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the revenue center types associated with the revenue center. If not specified, this will represent the default options associated with the revenue center", "type":"string", "example":"11111111111111111111111111111111" }, "rvcGroups":{ "description":"An object containing the descriptive options list associated with the revenue center groups associated with this revenue center", "type":"array", "items":{ "type":"object", "properties":{ "rvcGroupNum":{ "type":"integer", "description":"The object number of the revenue center group associated with the revenue center", "example":1 } } }, "example":{ "rvcGroupNum":1 } }, "dataExtensions":{ "description":"An array of extension data associated with the revenue center", "type":"array", "items":{ "type":"object", "properties":{ "columnName":{ "type":"string", "description":"The name of the extension data column", "example":"extension column 1" }, "value":{ "type":"string", "description":"The value associated with the extension data column", "example":"value 1" } } }, "example":{ "columnName":"extension column 1", "value":"value 1" } } } }, "RevenueCenterGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Revenue Center objects of the organization.", "items":{ "$ref":"#/definitions/RevenueCenterGETv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "RevenueCenterGETv1":{ "description":"Model for RevenueCenter Object", "type":"object", "properties":{ "locHierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "locHierStrucId":{ "description":"Unique reference of the hierarchy structure of the property. Excluded by default.", "type":"integer", "example":1 }, "locObjNum":{ "description":"Object number of the property", "type":"integer", "example":1 }, "locName":{ "description":"A group of string objects representing the name of the location configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the revenue center", "type":"integer", "example":1 }, "hierStrucId":{ "description":"Unique reference of the hierarchy structure of the revenue center. Excluded by default.", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the revenue center", "type":"integer", "example":1 }, "rvcId":{ "description":"This field shows the Revenue Center ID, an uneditable field that is the database ID number. This field is provided as a reference so that configuration can be completed for interfaces and other applications that require Revenue Center IDs", "type":"integer", "example":1 }, "name":{ "description":"A group of string objects representing the name of the revenue center configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "consumerFacingName":{ "description":"A group of string objects representing the consumer facing name of the revenue center in the configured languages", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "phoneCountryCode":{ "description":"The phone number country code of the revenue center.", "type":"string", "example":"US" }, "phoneNumberPrefix":{ "description":"The phone number prefix of the revenue center.", "type":"integer", "example":1 }, "phone":{ "description":"The phone number of the revenue center", "type":"string", "example":1234567890 }, "address1":{ "description":"The address line 1 for the revenue center.", "type":"string", "example":"Address Line 1" }, "address2":{ "description":"The address line 2 for the revenue center.", "type":"string", "example":"Address Line 2" }, "address3":{ "description":"The address line 3 for the revenue center.", "type":"string", "example":"Address Line 3" }, "city":{ "description":"The city for the revenue center.", "type":"string", "example":"City" }, "stateOrRegionCode":{ "description":"The state or region code for the revenue center.", "type":"string", "example":"NY" }, "stateOrRegion":{ "description":"The state or region for the revenue center.", "type":"string", "example":"New York" }, "zipOrPostalCode":{ "description":"The ZIP or postal code for the revenue center.", "type":"string", "example":"YXA123" }, "countryCode":{ "description":"The country code for the revenue center.", "type":"string", "example":"US" }, "country":{ "description":"The country for the revenue center.", "type":"string", "example":"United States" }, "latitude":{ "description":"The revenue center latitude. Latitude must be within range -90 to +90", "type":"string", "example":12.23 }, "longitude":{ "description":"The revenue center longitude. Longitude must be between -180 and 180", "type":"string", "example":12.34 }, "floor":{ "description":"The floor of the building.", "type":"string", "example":"1st Floor" }, "kdsControllerId":{ "description":"The unique reference of the KDS Controller that controls the KDS Display Order Devices in this revenue center. Oracle recommends using no more than 15 KDS Display Order Devices on a single KDS Controller", "type":"integer", "example":2 }, "kdsControllerName":{ "description":"A group of string objects representing the name of the KDS controller in configured languages", "type":"object", "example":{ "en-US":"Controller", "de-DE":"Regler", "es-MX":"Controlador" } }, "isLDSActive":{ "description":"A flag indicating if LDS is activated for this revenue center.", "type":"boolean", "example":false }, "rvcTypes":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the revenue center types associated with the revenue center. If not specified, this will represent the default options associated with the revenue center", "type":"string", "example":"11111111111111111111111111111111" }, "rvcGroups":{ "description":"An object containing the descriptive options list associated with the revenue center groups associated with this revenue center", "type":"array", "items":{ "type":"object", "properties":{ "rvcGroupNum":{ "type":"integer", "description":"The object number of the revenue center group associated with the revenue center", "example":1 } } }, "example":{ "rvcGroupNum":1 } }, "dataExtensions":{ "description":"An array of extension data associated with the revenue center", "type":"array", "items":{ "type":"object", "properties":{ "columnName":{ "type":"string", "description":"The name of the extension data column", "example":"extension column 1" }, "value":{ "type":"string", "description":"The value associated with the extension data column", "example":"value 1" } } }, "example":{ "columnName":"extension column 1", "value":"value 1" } } } }, "RevenueCenterGETv2":{ "description":"Model for RevenueCenter Object", "type":"object", "properties":{ "locHierUnitId":{ "description":"Unique reference of the hierarchy unit of the property", "type":"integer", "example":1 }, "locHierStrucId":{ "description":"Unique reference of the hierarchy structure of the property. Excluded by default.", "type":"integer", "example":1 }, "locObjNum":{ "description":"Object number of the property", "type":"integer", "example":1 }, "hierUnitId":{ "description":"Unique reference of the hierarchy unit of the revenue center", "type":"integer", "example":1 }, "hierStrucId":{ "description":"Unique reference of the hierarchy structure of the revenue center. Excluded by default.", "type":"integer", "example":1 }, "objectNum":{ "description":"Object number of the revenue center", "type":"integer", "example":1 }, "rvcId":{ "description":"This field shows the Revenue Center ID, an uneditable field that is the database ID number. This field is provided as a reference so that configuration can be completed for interfaces and other applications that require Revenue Center IDs", "type":"integer", "example":1 }, "name":{ "description":"Revenue Center Name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "consumerFacingName":{ "description":"Consumer Facing Name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "phoneCountryCode":{ "description":"The phone number country code of the revenue center.", "type":"string", "example":"US" }, "phoneNumberPrefix":{ "description":"The phone number prefix of the revenue center.", "type":"integer", "example":1 }, "phone":{ "description":"The phone number of the revenue center", "type":"string", "example":1234567890 }, "address1":{ "description":"The address line 1 for the revenue center.", "type":"string", "example":"Address Line 1" }, "address2":{ "description":"The address line 2 for the revenue center.", "type":"string", "example":"Address Line 2" }, "address3":{ "description":"The address line 3 for the revenue center.", "type":"string", "example":"Address Line 3" }, "city":{ "description":"The city for the revenue center.", "type":"string", "example":"City" }, "stateOrRegionCode":{ "description":"The state or region code for the revenue center.", "type":"string", "example":"NY" }, "stateOrRegion":{ "description":"The state or region for the revenue center.", "type":"string", "example":"New York" }, "zipOrPostalCode":{ "description":"The ZIP or postal code for the revenue center.", "type":"string", "example":"YXA123" }, "countryCode":{ "description":"The country code for the revenue center.", "type":"string", "example":"US" }, "country":{ "description":"The country for the revenue center.", "type":"string", "example":"United States" }, "latitude":{ "description":"The revenue center latitude. Latitude must be within range -90 to +90", "type":"string", "example":12.23 }, "longitude":{ "description":"The revenue center longitude. Longitude must be between -180 and 180", "type":"string", "example":12.34 }, "floor":{ "description":"The floor of the building.", "type":"string", "example":"1st Floor" }, "kdsControllerId":{ "description":"The unique reference of the KDS Controller that controls the KDS Display Order Devices in this revenue center. Oracle recommends using no more than 15 KDS Display Order Devices on a single KDS Controller", "type":"integer", "example":2 }, "isLDSActive":{ "description":"A flag indicating if LDS is activated for this revenue center.", "type":"boolean", "example":false }, "rvcTypes":{ "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the revenue center types associated with the revenue center. If not specified, this will represent the default options associated with the revenue center", "type":"string", "example":"11111111111111111111111111111111" }, "rvcGroups":{ "description":"An object containing the descriptive options list associated with the revenue center groups associated with this revenue center", "type":"array", "items":{ "type":"object", "properties":{ "rvcGroupNum":{ "type":"integer", "description":"The object number of the revenue center group associated with the revenue center", "example":1 } } }, "example":{ "rvcGroupNum":1 } }, "dataExtensions":{ "description":"An array of extension data associated with the revenue center", "type":"array", "items":{ "type":"object", "properties":{ "columnName":{ "type":"string", "description":"The name of the extension data column", "example":"extension column 1" }, "value":{ "type":"string", "description":"The value associated with the extension data column", "example":"value 1" } } }, "example":{ "columnName":"extension column 1", "value":"value 1" } } } }, "ZoneGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Zone objects.", "items":{ "$ref":"#/definitions/Zonev1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "Zonev1":{ "description":"Model for a Zone", "type":"object", "properties":{ "hierUnitId":{ "description":"Hierarchy Unit Id of the Zone", "type":"integer", "example":1 }, "name":{ "description":"Zone Name", "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" } }, "hierStrucId":{ "description":"Hierarchy Structuture Id of the Zone. Excluded by default.", "type":"integer", "example":1 }, "parentHierUnitId":{ "description":"Hierarchy Unit Id of the Parent", "type":"integer", "example":1 }, "parentHierStrucId":{ "description":"Hierarchy Structuture Id of the Parent. Excluded by default.", "type":"integer", "example":1 }, "zoneType":{ "description":"Type of Zone", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 16 representing the status of Options", "type":"string", "example":"0001000000000000" }, "zoneOptionsExt":{ "$ref":"#/definitions/ZoneOptions" }, "emcOptionsExt":{ "$ref":"#/definitions/EMCOptions" } } }, "Zonev2":{ "description":"Model for a Zone", "type":"object", "properties":{ "hierUnitId":{ "description":"Hierarchy Unit Id of the Zone", "type":"integer", "example":1 }, "name":{ "description":"Zone Name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "hierStrucId":{ "description":"Hierarchy Structuture Id of the Zone. Excluded by default.", "type":"integer", "example":1 }, "parentHierUnitId":{ "description":"Hierarchy Unit Id of the Parent", "type":"integer", "example":1 }, "parentHierStrucId":{ "description":"Hierarchy Structuture Id of the Parent. Excluded by default.", "type":"integer", "example":1 }, "zoneType":{ "description":"Type of Zone", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 16 representing the status of Options", "type":"string", "example":"0001000000000000" }, "zoneOptionsExt":{ "$ref":"#/definitions/ZoneOptions" }, "emcOptionsExt":{ "$ref":"#/definitions/EMCOptions" } } }, "ZoneOptions":{ "description":"Details of Options", "type":"object", "properties":{ "EnforceUniquePropertiesWithinZone":{ "type":"boolean", "example":true }, "EnforceUniqueRVCsWithinZone":{ "type":"boolean", "example":true }, "restrictModulesInChildZones":{ "type":"boolean", "example":true }, "allRVCsfromSameLocation":{ "type":"boolean", "example":true }, "sortAlphabetically":{ "type":"boolean", "example":true } } }, "EMCOptions":{ "description":"Details of Selected EMC Modules", "type":"object", "properties":{ "enableAllModules":{ "type":"boolean", "example":true }, "enableAlphanumericKeyboard":{ "type":"boolean", "example":true }, "enableApplicationText":{ "type":"boolean", "example":true }, "enableAutoMenuLevels":{ "type":"boolean", "example":true }, "enableAutofireCheckOfflineHeader":{ "type":"boolean", "example":true }, "enableBarcodeFormatStatus":{ "type":"boolean", "example":true }, "enableBarcodes":{ "type":"boolean", "example":true }, "enableBrowser":{ "type":"boolean", "example":true }, "enableCanadianGST":{ "type":"boolean", "example":true }, "enableCanadianPST":{ "type":"boolean", "example":true }, "enableCanadianTaxTrailers":{ "type":"boolean", "example":true }, "enableCheckHeaderOrderTypeChannel":{ "type":"boolean", "example":true }, "enableCheckTrailerOrderTypeChannel":{ "type":"boolean", "example":true }, "enableCMAccount":{ "type":"boolean", "example":true }, "enableCMCashCountThreshold":{ "type":"boolean", "example":true }, "enableCMCashPullThreashold":{ "type":"boolean", "example":true }, "enableCMClass":{ "type":"boolean", "example":true }, "enableCMClassBehavior":{ "type":"boolean", "example":true }, "enableCMCountSheet":{ "type":"boolean", "example":true }, "enableCMPARLevel":{ "type":"boolean", "example":true }, "enableCMParameters":{ "type":"boolean", "example":true }, "enableCMReason":{ "type":"boolean", "example":true }, "enableCMReceptacle":{ "type":"boolean", "example":true }, "enableCMTemplate":{ "type":"boolean", "example":true }, "enableCMVendor":{ "type":"boolean", "example":true }, "enableCheckAlert":{ "type":"boolean", "example":true }, "enableCheckSummaryDescriptors":{ "type":"boolean", "example":true }, "enableComboMealGroups":{ "type":"boolean", "example":true }, "enableComboMeals":{ "type":"boolean", "example":true }, "enableComponents":{ "type":"boolean", "example":true }, "enableCondimentGroupNames":{ "type":"boolean", "example":true }, "enableCondimentSets":{ "type":"boolean", "example":true }, "enableContent":{ "type":"boolean", "example":true }, "enableControlParameters":{ "type":"boolean", "example":true }, "enableCreditCardHeader":{ "type":"boolean", "example":true }, "enableCreditCardTrailers":{ "type":"boolean", "example":true }, "enableCurrency":{ "type":"boolean", "example":true }, "enableCurrencyAvailability":{ "type":"boolean", "example":true }, "enableCurrencyConversion":{ "type":"boolean", "example":true }, "enableCurrencyParameters":{ "type":"boolean", "example":true }, "enableCustomReport":{ "type":"boolean", "example":true }, "enableCustomerReceiptHeaders":{ "type":"boolean", "example":true }, "enableDataExtensions":{ "type":"boolean", "example":true }, "enableDiningTableClass":{ "type":"boolean", "example":true }, "enableDiningTableStatusDefSet":{ "type":"boolean", "example":true }, "enableDiscountGroups":{ "type":"boolean", "example":true }, "enableDiscountItemizers":{ "type":"boolean", "example":true }, "enableDiscountSLUNames":{ "type":"boolean", "example":true }, "enableDiscounts":{ "type":"boolean", "example":true }, "enableEffectivityGroups":{ "type":"boolean", "example":true }, "enableExtentionApplication":{ "type":"boolean", "example":true }, "enableFormatParamters":{ "type":"boolean", "example":true }, "enableGiftCardProvider":{ "type":"boolean", "example":true }, "enableGuestCheckHeaders":{ "type":"boolean", "example":true }, "enableGuestCheckTrailers":{ "type":"boolean", "example":true }, "enableGuestInformationPrompts":{ "type":"boolean", "example":true }, "enableKDSBumpBars":{ "type":"boolean", "example":true }, "enableKDSHighlightSchemes":{ "type":"boolean", "example":true }, "enableKDSToolBars":{ "type":"boolean", "example":true }, "enableKDSDiningCourse":{ "type":"boolean", "example":true }, "enableLoanReasons":{ "type":"boolean", "example":true }, "enableLoyaltyConfig":{ "type":"boolean", "example":true }, "enableLoyaltyCardProvider":{ "type":"boolean", "example":true }, "enableLoyaltyDriver":{ "type":"boolean", "example":true }, "enableLoyaltyModule":{ "type":"boolean", "example":true }, "enableMenuItemClasses":{ "type":"boolean", "example":true }, "enableMenuItemDefinitions":{ "type":"boolean", "example":true }, "enableMenuItemGroups":{ "type":"boolean", "example":true }, "enableMenuItemMasterGroupSLUNames":{ "type":"boolean", "example":true }, "enableMenuItemMasterGroups":{ "type":"boolean", "example":true }, "enableMenuItemMasters":{ "type":"boolean", "example":true }, "enableMenuItemPrices":{ "type":"boolean", "example":true }, "enableMenuItemSLUNames":{ "type":"boolean", "example":true }, "enableMenuLevelSets":{ "type":"boolean", "example":true }, "enableNLUNames":{ "type":"boolean", "example":true }, "enableOperators":{ "type":"boolean", "example":true }, "enableOrderChannelParameters":{ "type":"boolean", "example":true }, "enableOrderTypeParameters":{ "type":"boolean", "example":true }, "enablePages":{ "type":"boolean", "example":true }, "enablePageAssignment":{ "type":"boolean", "example":true }, "enablePageTemplate":{ "type":"boolean", "example":true }, "enablePaymentDevice":{ "type":"boolean", "example":true }, "enablePaymentDriver":{ "type":"boolean", "example":true }, "enablePaymentReasons":{ "type":"boolean", "example":true }, "enablePayments":{ "type":"boolean", "example":true }, "enablePickupReasons":{ "type":"boolean", "example":true }, "enablePOSKeyboard":{ "type":"boolean", "example":true }, "enablePriceGroups":{ "type":"boolean", "example":true }, "enablePrintClasses":{ "type":"boolean", "example":true }, "enableProductionItem":{ "type":"boolean", "example":true }, "enablePropertyEmployeeRecords":{ "type":"boolean", "example":true }, "enableReportGroups":{ "type":"boolean", "example":true }, "enableReportHeaders":{ "type":"boolean", "example":true }, "enableReportTrailers":{ "type":"boolean", "example":true }, "enableReportParameters":{ "type":"boolean", "example":true }, "enableRoutingGroups":{ "type":"boolean", "example":true }, "enableReceiptHeaderOrderTypeChannel":{ "type":"boolean", "example":true }, "enableRVCTypeNames":{ "type":"boolean", "example":true }, "enableSalesItemizers":{ "type":"boolean", "example":true }, "enableSeatingSectionTemplate":{ "type":"boolean", "example":true }, "enableSection":{ "type":"boolean", "example":true }, "enableServiceAlert":{ "type":"boolean", "example":true }, "enableServiceChargeGroup":{ "type":"boolean", "example":true }, "enableServiceChargeItemizers":{ "type":"boolean", "example":true }, "enableServiceChargeSLUNames":{ "type":"boolean", "example":true }, "enableServiceCharges":{ "type":"boolean", "example":true }, "enableServiceTotalReasons":{ "type":"boolean", "example":true }, "enableStoredValueConfiguration":{ "type":"boolean", "example":true }, "enableStoredValueDriver":{ "type":"boolean", "example":true }, "enableStoredValueModule":{ "type":"boolean", "example":true }, "enableSystemTemplate":{ "type":"boolean", "example":true }, "enableTaskSchedules":{ "type":"boolean", "example":true }, "enableTaxClasses":{ "type":"boolean", "example":true }, "enableTaxParameters":{ "type":"boolean", "example":true }, "enableTaxRates":{ "type":"boolean", "example":true }, "enableTenderMedia":{ "type":"boolean", "example":true }, "enableTenderParameters":{ "type":"boolean", "example":true }, "enableTenderMediaSLUNames":{ "type":"boolean", "example":true }, "enableThemeAssignment":{ "type":"boolean", "example":true }, "enableTimeClockReasons":{ "type":"boolean", "example":true }, "enableTMSParameters":{ "type":"boolean", "example":true }, "enableTMSreasons":{ "type":"boolean", "example":true }, "enableTMSTableAttributes":{ "type":"boolean", "example":true }, "enableTrainingHeaders":{ "type":"boolean", "example":true }, "enableVoidReturnWasteReason":{ "type":"boolean", "example":true }, "enableWaitQuoteConfiguration":{ "type":"boolean", "example":true }, "enableWasteReceiptHeaders":{ "type":"boolean", "example":true }, "enableWasteReceiptTrailers":{ "type":"boolean", "example":true } } }, "MenuLevelEntryv1":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the menu level set" }, "index":{ "type":"integer", "example":1, "description":"Object number of the menu level entry" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "prefix":{ "type":"object", "description":"Prefix for Menu Level Entry", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "suffix":{ "type":"object", "description":"Suffix for Menu Level Entry", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated" }, "optionsExt":{ "$ref":"#/definitions/OptionsExt_MenuLevelEntry" } }, "description":"Model for a Menu Level Entry" }, "MenuLevelEntryGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Menu Level Entry objects of the organization.", "items":{ "$ref":"#/definitions/MenuLevelEntryv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "MenuLevelEntryv2":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "hierUnitObjNum":{ "type":"integer", "example":1, "description":"Object number of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the menu level set" }, "index":{ "type":"integer", "example":1, "description":"Object number of the menu level entry" }, "name":{ "type":"object", "description":"Menu Level Entry Name", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "prefix":{ "type":"object", "description":"Prefix for Menu Level Entry", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "suffix":{ "type":"object", "description":"Suffix for Menu Level Entry", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated" }, "optionsExt":{ "$ref":"#/definitions/OptionsExt_MenuLevelEntry" } }, "description":"Model for a Menu Level Entry" }, "MenuLevelEntryCUDRequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum", "index", "name" ], "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the menu level set" }, "index":{ "type":"integer", "example":1, "description":"Object number of the menu level entry" }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "prefix":{ "type":"object", "description":"Prefix for Menu Level Entry", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "suffix":{ "type":"object", "description":"Suffix for Menu Level Entry", "example":{ "en-US":"Family Group 1", "de-DE":"Familiengruppe 1", "es-MX":"Grupo Familiar 1" } }, "options":{ "type":"string", "example":"00000000", "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated" } }, "description":"Model for a Menu Level Entry CUD Request" }, "MenuLevelEntryResponse":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the menu level set" }, "index":{ "type":"integer", "example":1, "description":"Object number of the menu level entry" } }, "description":"Model for a Menu Level Entry Response" }, "OptionsExt_MenuLevelEntry":{ "type":"object", "properties":{ "default":{ "type":"boolean", "example":false, "description":"Select to mark this menu level as the default level for the Menu Level Set." }, "anonymous":{ "type":"boolean", "example":false, "description":"Select to mark this menu level as anonymous for the Menu Level Set." } }, "description":"An object containing the descriptive options list associated with the Menu Level Entry" }, "MenuLevelEntryGetRequestBody":{ "type":"object", "required":[ "objectNum" ], "properties":{ "offset":{ "type":"integer", "example":2, "description":"Starting resource record index. Not required if paging parameters are not supported" }, "limit":{ "type":"integer", "example":10, "description":"Number of results returned in this page. Not required if paging parameters are not supported." }, "orderBy":{ "type":"string", "example":"objectNum", "description":"Sorts the response by the specified field name and sort order." }, "searchCriteria":{ "type":"string", "example":"where equals(hierUnitId,1012)", "description":"Search criteria to filter results based on field value. In this case, results will be filtered based on 'hierUnitId' field with value as 1012." }, "include":{ "type":"string", "example":"locations" }, "includeAll":{ "type":"string", "example":"detailed", "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n" }, "languages":{ "type":"string", "example":"en-US, de-DE, es-MX", "description":"If specified, limits translated strings returned." }, "hierUnitId":{ "type":"integer", "example":1, "description":"Unique reference of the hierarchy unit" }, "objectNum":{ "type":"integer", "example":1, "description":"Object number of the menu level set" } } }, "ComboSideGroupItemsLite":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "example":2, "description":"Unique reference of the hierarchy unit where the side group item is located" }, "comboMealGroupId":{ "type":"integer", "example":1, "description":"Combo Meal Group Id" }, "itemObjNum":{ "type":"integer", "example":1, "description":"Object number of the menu item master associated with the combo group item" }, "quantity":{ "type":"integer", "example":1, "description":"The quantity of the item" }, "options":{ "type":"string", "example":"000000000000000000000000000000000000000000000000", "description":"A string value of 0s & 1s of length 48 representing the enablement or disablement of the options associated with the Combo Meal Group Item. If not specified, this will represent the default options associated with the Combo MealGroup Item" }, "optionsExt":{ "description":"An object containing the descriptive options list associated with the Combo Meal Group Item", "type":"object", "properties":{ "defaultWhenNoOrderTypeIsSelected":{ "type":"boolean", "example":false, "description":"Flag indicating to make this item the default for the Combo Group without a declared Order Type." }, "defaultForOrderType1":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 1 is active." }, "defaultForOrderType2":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 2 is active." }, "defaultForOrderType3":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 3 is active." }, "defaultForOrderType4":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 4 is active." }, "defaultForOrderType5":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 5 is active." }, "defaultForOrderType6":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 6 is active." }, "defaultForOrderType7":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 7 is active." }, "defaultForOrderType8":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 8 is active." }, "autofill":{ "type":"boolean", "example":false, "description":"A flag indicating to change the side item quantity to the number of remaining items needed to complete the side requirements when ordering one of the combo meals where more than one remaining item is required." }, "sendToComboParentsOrderDevices":{ "type":"boolean", "example":false, "description":"A flag indicating to also send the combo side menu item to the combo meal parent menu item's Order Devices" }, "defaultForOrderType9":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 9 is active." }, "defaultForOrderType10":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 10 is active." }, "defaultForOrderType11":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 11 is active." }, "defaultForOrderType12":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 12 is active." }, "defaultForOrderType13":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 13 is active." }, "defaultForOrderType14":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 14 is active." }, "defaultForOrderType15":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 15 is active." }, "defaultForOrderType16":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 16 is active." }, "defaultForOrderType17":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 17 is active." }, "defaultForOrderType18":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 18 is active." }, "defaultForOrderType19":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 19 is active." }, "defaultForOrderType20":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 20 is active." }, "defaultForOrderType21":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 21 is active." }, "defaultForOrderType22":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 22 is active." }, "defaultForOrderType23":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 23 is active." }, "defaultForOrderType24":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 24 is active." }, "defaultForOrderType25":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 25 is active." }, "defaultForOrderType26":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 26 is active." }, "defaultForOrderType27":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 27 is active." }, "defaultForOrderType28":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 28 is active." }, "defaultForOrderType29":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 29 is active." }, "defaultForOrderType30":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 30 is active." }, "defaultForOrderType31":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 31 is active." }, "defaultForOrderType32":{ "type":"boolean", "example":false, "description":"A flag indicating to make this item the default when Order Type 32 is active." } } }, "size1ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 1 function key (663)." }, "size2ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 2 function key (664)." }, "size3ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 3 function key (665)." }, "size4ItemObjNum":{ "type":"integer", "example":0, "description":"Object number of the menu item to substitute for the Primary Menu Item when using the Combo Size - Size 4 function key (666)." }, "size1MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 1. Valid range is between 1 and 8." }, "size2MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 2. Valid range is between 1 and 8." }, "size3MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 3. Valid range is between 1 and 8." }, "size4MenuLevelIndex":{ "type":"integer", "example":1, "description":"Menu Level index for using the Combo Size 4. Valid range is between 1 and 8." }, "effectivityGroupObjNum":{ "type":"integer", "example":1, "description":"Object number of the effectivity group" } }, "description":"Model for Combo Group Item Object" }, "NutrientSetNutrient":{ "description":"Nutrient record", "type":"object", "properties":{ "hierUnitId":{ "description":"Unique reference of the hierarchy unit. Only Enterprise hierarchy is allowed.", "type":"integer", "example":3599 }, "nutrientSetObjNum":{ "description":"Object number of the nutrient set.", "type":"integer", "example":50 }, "nutrientSetNutrientId":{ "description":"Unique Id of the nutrient.", "type":"integer", "example":101 }, "nutritionNameObjNum":{ "description":"Object number of the nutrition name.", "default":0, "type":"integer", "example":8 }, "unitOfMeasure":{ "description":"An integer representing the unit of measurement for quantity. Acceptable values range from 1 to 4 (both inclusive).
    Unit Of MeasurementDescription
    1 Calories
    2 KiloJoules
    3 Grams
    4 Milligrams
    ", "type":"integer", "minimum":1, "maximum":4, "default":1, "example":2 }, "quantity":{ "description":"quantity of the nutrient.", "default":0, "type":"integer", "example":10 } } }, "LocaleResponse":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object Number of Locale" } } }, "Locale":{ "type":"object", "required":[ "objectNum", "name", "decimalSeparator", "thousandsSeparator" ], "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the Locale" }, "name":{ "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" }, "description":"name of the Locale" }, "decimalSeparator":{ "type":"string", "example":",", "description":"Decimal Separator for the Locale. \n\nAcceptable values are : Dot \".\" and Comma \",\"\n" }, "thousandsSeparator":{ "type":"string", "example":".", "description":"Thousands Separator for the Locale\n\nAcceptable values are : Dot \".\" and Comma \",\"\n" } }, "description":"Model for Locale Object" }, "LocaleItemResponseBody":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the Locale" }, "name":{ "type":"object", "example":{ "en-US":"Enterprise", "de-DE":"Unternehmen", "es-MX":"Empresa" }, "description":"name of the Locale" }, "decimalSeparator":{ "type":"string", "example":",", "description":"Decimal Separator for the Locale" }, "thousandsSeparator":{ "type":"string", "example":".", "description":"Thousands Separator for the Locale" } }, "description":"Model for Locale Object" }, "Localesv2":{ "type":"object", "properties":{ "objectNum":{ "type":"integer", "example":1, "description":"Object Number of the Locale" }, "name":{ "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" }, "description":"name of the Locale" }, "decimalSeparator":{ "type":"string", "example":",", "description":"Decimal Separator for the Locale" }, "thousandsSeparator":{ "type":"string", "example":".", "description":"Thousands Separator for the Locale" } }, "description":"Model for Locale Object" }, "LocaleGetResponse":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Locale objects of the organization.", "items":{ "$ref":"#/definitions/LocaleItemResponseBody" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "LocaleDeleteResponse":{ "type":"object", "properties":{ "msg":{ "type":"string", "example":"1 record deleted" } } }, "BulkProcessingStatusResponse":{ "type":"object", "description":"A response body containing the status of the bulk request", "properties":{ "requestId":{ "type":"integer", "example":1012, "description":"The bulk processing request ID" }, "successRecordCount":{ "type":"integer", "example":5000, "description":"The count of successful records." }, "failedRecordCount":{ "type":"integer", "example":5000, "description":"The count of failed records." }, "message":{ "type":"string", "example":"Time taken to process the bulk request : 1012 is 2 seconds", "description":"A message giving details about the bulk request." }, "status":{ "type":"string", "example":"Completed", "description":"Bulk processing request ID status. Status can be one of the following :- Queued - To be processed, InProgress - Being processed, Completed - Processed successfully, CompletedWithErrors - Processing completed with some errors" }, "comments":{ "type":"string", "example":"Bulk Insert", "description":"The comments provided by the user while placing the bulk insert request." }, "response":{ "type":"array", "description":"The result for each object submitted in the bulk request", "items":{ "$ref":"#/definitions/BulkRecordsResponse" } } } }, "BulkRecordsResponse":{ "type":"object", "description":"A response body containing details for an object submitted in the bulk request.", "properties":{ "hierUnitId":{ "type":"integer", "example":88, "description":"Hierarchy reference where the object has been added." }, "objectNum":{ "type":"integer", "example":100, "description":"The object number" }, "recordStatus":{ "type":"string", "example":"Success", "description":"Status of the object submitted in the bulk request" } } }, "Zone2":{ "description":"Model for a Zone", "type":"object", "properties":{ "hierUnitId":{ "description":"Hierarchy Unit Id of the Zone", "type":"integer", "example":1 }, "name":{ "description":"Zone Name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } }, "hierStrucId":{ "description":"Hierarchy Structuture Id of the Zone. Excluded by default.", "type":"integer", "example":1 }, "parentHierUnitId":{ "description":"Hierarchy Unit Id of the Parent", "type":"integer", "example":1 }, "parentHierStrucId":{ "description":"Hierarchy Structuture Id of the Parent. Excluded by default.", "type":"integer", "example":1 }, "zoneType":{ "description":"Type of Zone", "type":"integer", "example":1 }, "options":{ "description":"A string value of 0s & 1s of length 16 representing the status of Options", "type":"string", "example":"0001000000000000" }, "optionsExt":{ "$ref":"#/definitions/ZoneOptions" }, "EMCModules":{ "description":"

    List of enabled EMC modules at the zone

    \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    Module NameValue
    AllModules 1
    AlphanumericKeyboard 2143
    ApplicationText 2138
    AutoMenuLevels 1150
    AutofireCheckOfflineHeader 2646
    BarcodeFormatStatus 1131
    Barcodes 2104
    Browser 2657
    CanadianGST 1146
    CanadianPST 1147
    CanadianTaxTrailers 2618
    CMAccount 6005
    CMCashCountThreshold 6011
    CMCashPullThreashold 6007
    CMClass 6003
    CMClassBehavior 6012
    CMCountSheet 6002
    CMPARLevel 6008
    CMParameters 6010
    CMReason 6009
    CMReceptacle 6004
    CMTemplate 6001
    CMVendor 6006
    CheckAlert 2643
    CheckSummaryDescriptors 2602
    ComboMealGroups 2123
    ComboMeals 2122
    Components 2158
    CondimentGroupNames 2627
    CondimentSets 2128
    Content 2126
    ControlParameters 1148
    CheckHeaderOrderTypeChannel 7110
    CheckTrailerOrderTypeChannel 7111
    CreditCardHeader 2616
    CreditCardTrailers 2617
    Currency 1113
    CurrencyAvailability 1144
    CurrencyConversion 1142
    CurrencyParameters 1145
    CustomReport 2137
    CustomerReceiptHeaders 2614
    DataExtensions 2129
    DiningTableClass 2140
    DiningTableStatusDefSet 2141
    DiscountGroups 2609
    DiscountItemizers 2624
    DiscountSLUNames 2629
    Discounts 1120
    EffectivityGroups 131
    ExtentionApplication 2139
    FormatParamters 1143
    GiftCardProvider 1175
    GuestCheckHeaders 2612
    GuestCheckTrailers 2613
    GuestInformationPrompts 2603
    KDSBumpBars 1129
    KDSHighlightSchemes 1137
    KDSToolBars 1130
    KDSDiningCourse 2641
    LoanReasons 2606
    LoyaltyConfig 1157
    LoyaltyCardProvider 1176
    LoyaltyDriver 1160
    LoyaltyModule 1159
    MenuItemClasses 2101
    MenuItemDefinitions 2102
    MenuItemGroups 1133
    MenuItemMasterGroupSLUNames 2652
    MenuItemMasterGroups 1138
    MenuItemMasters 1123
    MenuItemPrices 2103
    MenuItemSLUNames 2631
    MenuLevelSets 2127
    NLUNames 2623
    Operators 2100
    OrderChannelParameters 7107
    OrderTypeParameters 1141
    Pages 2124
    PageAssignment 2135
    PageTemplate 2125
    PaymentDevice 1164
    PaymentDriver 1161
    PaymentReasons 2605
    Payments 1155
    PickupReasons 2607
    POSKeyboard 2655
    PriceGroups 124
    PrintClasses 2146
    ProductionItem 2150
    PropertyEmployeeRecords 1101
    ReceiptHeaderOrderTypeChannel 7113
    ReportGroups 120
    ReportHeaders 7103
    ReportTrailers 7104
    ReportParameters 1149
    RoutingGroups 2639
    RVCTypeNames 2610
    SalesItemizers 2625
    SeatingSectionTemplate 2147
    Section 2148
    ServiceAlert 2642
    ServiceChargeGroup 7002
    ServiceChargeItemizers 2626
    ServiceChargeSLUNames 2633
    ServiceCharges 1121
    ServiceTotalReasons 2608
    StoredValueConfiguration 1158
    StoredValueDriver 1163
    StoredValueModule 1162
    SystemTemplate 2136
    TaskSchedules 133
    TaxClasses 1118
    TaxParameters 1139
    TaxRates 1117
    TenderMedia 1119
    TenderParameters 1140
    TenderMediaSLUNames 2635
    ThemeAssignment 2156
    TimeClockReasons 2621
    TMSParameters 2149
    TMSreasons 2644
    TMSTableAttributes 2155
    TrainingHeaders 2615
    VoidReturnWasteReason 2649
    WaitQuoteConfiguration 2645
    WasteReceiptHeaders 2647
    WasteReceiptTrailers 2648
    \n", "type":"array", "items":{ "type":"integer" }, "example":[ 1124, 1159 ] } } }, "EMCModule":{ "description":"EMC Module record", "type":"object", "properties":{ "hierStrucId":{ "description":"Unique reference of the hierarchy structure where the EMC Module is enabled.", "type":"integer", "example":3599 }, "EMCModule":{ "description":"

    Enabled EMC module at the corresponding hierarchy

    \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    Module NameValue
    AllModules 1
    AlphanumericKeyboard 2143
    ApplicationText 2138
    AutoMenuLevels 1150
    AutofireCheckOfflineHeader 2646
    BarcodeFormatStatus 1131
    Barcodes 2104
    Browser 2657
    CanadianGST 1146
    CanadianPST 1147
    CanadianTaxTrailers 2618
    CMAccount 6005
    CMCashCountThreshold 6011
    CMCashPullThreashold 6007
    CMClass 6003
    CMClassBehavior 6012
    CMCountSheet 6002
    CMPARLevel 6008
    CMParameters 6010
    CMReason 6009
    CMReceptacle 6004
    CMTemplate 6001
    CMVendor 6006
    CheckAlert 2643
    CheckSummaryDescriptors 2602
    ComboMealGroups 2123
    ComboMeals 2122
    Components 2158
    CondimentGroupNames 2627
    CondimentSets 2128
    Content 2126
    ControlParameters 1148
    CheckHeaderOrderTypeChannel 7110
    CheckTrailerOrderTypeChannel 7111
    CreditCardHeader 2616
    CreditCardTrailers 2617
    Currency 1113
    CurrencyAvailability 1144
    CurrencyConversion 1142
    CurrencyParameters 1145
    CustomReport 2137
    CustomerReceiptHeaders 2614
    DataExtensions 2129
    DiningTableClass 2140
    DiningTableStatusDefSet 2141
    DiscountGroups 2609
    DiscountItemizers 2624
    DiscountSLUNames 2629
    Discounts 1120
    EffectivityGroups 131
    ExtentionApplication 2139
    FormatParamters 1143
    GiftCardProvider 1175
    GuestCheckHeaders 2612
    GuestCheckTrailers 2613
    GuestInformationPrompts 2603
    KDSBumpBars 1129
    KDSHighlightSchemes 1137
    KDSToolBars 1130
    KDSDiningCourse 2641
    LoanReasons 2606
    LoyaltyConfig 1157
    LoyaltyCardProvider 1176
    LoyaltyDriver 1160
    LoyaltyModule 1159
    MenuItemClasses 2101
    MenuItemDefinitions 2102
    MenuItemGroups 1133
    MenuItemMasterGroupSLUNames 2652
    MenuItemMasterGroups 1138
    MenuItemMasters 1123
    MenuItemPrices 2103
    MenuItemSLUNames 2631
    MenuLevelSets 2127
    NLUNames 2623
    Operators 2100
    OrderChannelParameters 7107
    OrderTypeParameters 1141
    Pages 2124
    PageAssignment 2135
    PageTemplate 2125
    PaymentDevice 1164
    PaymentDriver 1161
    PaymentReasons 2605
    Payments 1155
    PickupReasons 2607
    POSKeyboard 2655
    PriceGroups 124
    PrintClasses 2146
    ProductionItem 2150
    PropertyEmployeeRecords 1101
    ReceiptHeaderOrderTypeChannel 7113
    ReportGroups 120
    ReportHeaders 7103
    ReportTrailers 7104
    ReportParameters 1149
    RoutingGroups 2639
    RVCTypeNames 2610
    SalesItemizers 2625
    SeatingSectionTemplate 2147
    Section 2148
    ServiceAlert 2642
    ServiceChargeGroup 7002
    ServiceChargeItemizers 2626
    ServiceChargeSLUNames 2633
    ServiceCharges 1121
    ServiceTotalReasons 2608
    StoredValueConfiguration 1158
    StoredValueDriver 1163
    StoredValueModule 1162
    SystemTemplate 2136
    TaskSchedules 133
    TaxClasses 1118
    TaxParameters 1139
    TaxRates 1117
    TenderMedia 1119
    TenderParameters 1140
    TenderMediaSLUNames 2635
    ThemeAssignment 2156
    TimeClockReasons 2621
    TMSParameters 2149
    TMSreaons 2644
    TMSTableAttributes 2155
    TrainingHeaders 2615
    VoidReturnWasteReaon 2649
    WaitQuoteConfiguration 2645
    WasteReceiptHeaders 2647
    WasteReceiptTrailers 2648
    \n", "type":"integer", "example":1124 } } }, "WorkstationClassMinimalBody":{ "type":"object", "properties":{ "hierUnitId":{ "type":"integer", "description":"Unique hierarchy unit value", "example":1 }, "objectNum":{ "description":"Object number of the Workstation class", "type":"integer", "example":1 } } }, "WorkstationClassGetResponsev1":{ "type":"object", "properties":{ "totalResults":{ "type":"integer", "example":100, "description":"Total number of rows (excluding the paging parameters)" }, "hasMore":{ "type":"boolean", "example":true, "description":"Flag indicating if there are more objects to fetch." }, "count":{ "type":"integer", "example":9, "description":"Current response record count." }, "items":{ "type":"array", "description":"Array of Workstation Class objects of the organization.", "items":{ "$ref":"#/definitions/WorkstationClassv1" } }, "offset":{ "type":"integer", "example":0, "description":"Starting resource record index" }, "limit":{ "type":"integer", "example":10, "description":"Server page size" } } }, "WorkstationClassv1":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value. The hierUnitId should be only of a location or the enterprise.", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Hierarchy unit object number", "type":"integer", "example":1 }, "hierUnitName":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } }, "objectNum":{ "description":"Object Number of the workstation class", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Hier Unit Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } } } }, "WorkstationClassv2":{ "type":"object", "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value. The hierUnitId should be only of a location or the enterprise.", "type":"integer", "example":1 }, "hierUnitObjNum":{ "description":"Hierarchy unit object number", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the workstation class", "type":"integer", "example":1 }, "name":{ "description":"Workstation Class Name", "type":"object", "example":{ "1":"Enterprise", "2":"Unternehmen", "3":"Empresa" } } } }, "WorkstationClassCUDRequestBody":{ "type":"object", "required":[ "hierUnitId", "objectNum", "name" ], "properties":{ "hierUnitId":{ "description":"Unique hierarchy unit value. The hierUnitId should be only of a location or the enterprise.", "type":"integer", "example":1 }, "objectNum":{ "description":"Object Number of the workstation class", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name", "example":{ "en-US":"Property", "de-DE":"Eigentum", "es-MX":"Propiedad" } } } }, "DiningTable":{ "description":"Dining Table record", "type":"object", "properties":{ "hierUnitId":{ "description":"Hier Unit Id of the RVC", "type":"integer", "example":7 }, "objectNum":{ "description":"Object Number of the Dining Table.", "type":"integer", "example":1 }, "name":{ "type":"object", "description":"Name of Dining Table.", "example":{ "1":"Entp", "2":"Untm", "3":"Emp" } }, "diningTableClassObjNum":{ "description":"Object Number of the Dining Table class.", "type":"integer", "example":243 } } } } }