Upsert Enterprise Parameters

post

/config/sim/v2/setup/upsertEnterpriseParameters

Updates only the supplied Enterprise Parameters fields.

Request

Supported Media Types
Header Parameters
Body ()
Enterprise Parameters upsert request body
Root Schema : EnterpriseParametersUpsertRequest
Type: object
Enterprise Parameters upsert request body.
Show Source
  • Default date and time format used.
    Value TypeValue
    Default Valuenull
    Supported Valueyyyy-MM-dd HH:mm:ss.fff
    Supported Valueyyyy-MM-dd hh:mm:ss.fff tt
    Supported Valueyyyy-MM-dd
    Supported Valueyyyy/MM/dd HH:mm:ss.fff
    Supported Valueyyyy/MM/dd hh:mm:ss.fff tt
    Supported Valueyyyy/MM/dd
    Supported Valuedd-MM-yy HH:mm:ss.fff
    Supported Valuedd-MM-yy hh:mm:ss.fff tt
    Supported Valuedd-MM-yy
    Supported Valuedd/MM/yy HH:mm:ss.fff
    Supported Valuedd/MM/yy hh:mm:ss.fff tt
    Supported Valuedd/MM/yy
    Supported ValueMM-dd-yyyy HH:mm:ss.fff
    Supported ValueMM-dd-yyyy hh:mm:ss.fff tt
    Supported ValueMM-dd-yyyy
    Supported ValueMM/dd/yyyy HH:mm:ss.fff
    Supported ValueMM/dd/yyyy hh:mm:ss.fff tt
    Supported ValueMM/dd/yyyy
    Example: yyyy-MM-dd
  • disabledEMCModules

    Array of disabled modules in EMC.

    Module NameValue
    Allergen Names 2653
    Application Text 2138
    Autofire Check Offline Header 2646
    Barcode Format Sets 1131
    Barcodes 2104
    Canadian GST 1146
    Canadian PST 1147
    Canadian Tax Trailers 2618
    Cash Management Account 6005
    Cash Management Cash Count Threshold 6011
    Cash Management Cash Pull Threshold 6007
    Cash Management Class 6003
    Cash Management Class Behavior 6012
    Cash Management Count Sheet 6002
    Cash Management PAR Level 6008
    Cash Management Parameters 6010
    Cash Management Reason 6009
    Cash Management Receptacle 6004
    Cash Management Template 6001
    Cash Management Vendor 6006
    Cashiers 2116
    Check Alert 2643
    Check Headers - Default 2612
    Check Headers - Order Type/Channel 7110
    Check Summary Descriptors 2602
    Check Trailers - Default 2613
    Check Trailers - Order Type/Channel 7111
    Components 2158
    Condiment Group Names 2627
    Condiment Sets 2128
    Credit Card Headers 2616
    Credit Card Trailers 2617
    Currency 1113
    Currency Availability 1144
    Currency Conversions 1142
    Currency Parameters 1145
    Custom Browser 2657
    Dietary Labels 7102
    Discount Groups 2609
    Discount Itemizers 2624
    Discount SLU Names 2629
    Family Groups 1125
    Gift Card Provider 1175
    Guest Information Prompts 2603
    KDS Bump Bars 1129
    KDS Controllers 1127
    KDS Displays 1128
    KDS Highlight Schemes 1137
    KDS Status Bars 7112
    KDS Tool Bars 1130
    Kitchen Theme 1156
    Kitchen Theme Period 2151
    Languages 1115
    Loan Reasons 2606
    Locale 127
    Loyalty Card Provider 1176
    Major Groups 1124
    Menu Item Groups 1133
    Menu Item Master Group SLU Names 2652
    Menu Item Master Groups 1138
    Menu Item SLU Names 2631
    Menu Level Sets 2127
    NLU Names 2623
    Nutrition Names 2654
    Order Channel 7106
    Order Channel Parameters 7107
    Order Type Parameters 1141
    Order Types 2622
    Page Assignment 2135
    Pages 2124
    Payment Reasons 2605
    PC Autosequence Schedules 114
    PC Autosequences 113
    Pickup Reasons 2607
    POS Keyboard 2655
    Print Logos 116
    Production Item 2150
    Property Merchant Groups 1134
    Receipt Headers - Default 2614
    Receipt Headers - Order Type/Channel 7113
    Report Headers 7103
    Report Trailers 7104
    Reservation Periods 2153
    RVC Type Names 2610
    Sales Itemizers 2625
    Seating Section Template 2147
    Section 2148
    Service Alert 2642
    Service Charge Itemizers 2626
    Service Charge SLU Names 2633
    Service Total Reasons 2608
    Serving Periods 2112
    System Employees 506
    Tables 2111
    Tags 7100
    Tax Classes 1118
    Tax Parameters 1139
    Tax Rates 1117
    Tender/Media SLU Names 2635
    Theme Assignment 2156
    Time Periods 2113
    TMS Parameters 2149
    TMS Reasons 2644
    Training Headers 2615
    Void/Return/Waste Reason 2649
    Wait Quote Configuration 2645
    Waste Receipt Headers 2647
    Waste Receipt Trailers 2648
  • EnterpriseEmailConfiguration
    Enterprise email configuration
  • Unique reference of the hierarchy unit where Enterprise Parameters are configured.
    Example: 765
  • EnterpriseLicenseCountInfo
    License count information
  • A string value of 0s and 1s of length 128 representing the enablement or disablement of enterprise parameter options. The option bits that are not relevant,if set are ignored and kept disabled.
    Example: 00000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
  • EnterpriseLicenseCountInfo
    License count information
  • EnterpriseLicenseCountInfo
    License count information
Nested Schema : disabledEMCModules
Type: array

Array of disabled modules in EMC.

Module NameValue
Allergen Names 2653
Application Text 2138
Autofire Check Offline Header 2646
Barcode Format Sets 1131
Barcodes 2104
Canadian GST 1146
Canadian PST 1147
Canadian Tax Trailers 2618
Cash Management Account 6005
Cash Management Cash Count Threshold 6011
Cash Management Cash Pull Threshold 6007
Cash Management Class 6003
Cash Management Class Behavior 6012
Cash Management Count Sheet 6002
Cash Management PAR Level 6008
Cash Management Parameters 6010
Cash Management Reason 6009
Cash Management Receptacle 6004
Cash Management Template 6001
Cash Management Vendor 6006
Cashiers 2116
Check Alert 2643
Check Headers - Default 2612
Check Headers - Order Type/Channel 7110
Check Summary Descriptors 2602
Check Trailers - Default 2613
Check Trailers - Order Type/Channel 7111
Components 2158
Condiment Group Names 2627
Condiment Sets 2128
Credit Card Headers 2616
Credit Card Trailers 2617
Currency 1113
Currency Availability 1144
Currency Conversions 1142
Currency Parameters 1145
Custom Browser 2657
Dietary Labels 7102
Discount Groups 2609
Discount Itemizers 2624
Discount SLU Names 2629
Family Groups 1125
Gift Card Provider 1175
Guest Information Prompts 2603
KDS Bump Bars 1129
KDS Controllers 1127
KDS Displays 1128
KDS Highlight Schemes 1137
KDS Status Bars 7112
KDS Tool Bars 1130
Kitchen Theme 1156
Kitchen Theme Period 2151
Languages 1115
Loan Reasons 2606
Locale 127
Loyalty Card Provider 1176
Major Groups 1124
Menu Item Groups 1133
Menu Item Master Group SLU Names 2652
Menu Item Master Groups 1138
Menu Item SLU Names 2631
Menu Level Sets 2127
NLU Names 2623
Nutrition Names 2654
Order Channel 7106
Order Channel Parameters 7107
Order Type Parameters 1141
Order Types 2622
Page Assignment 2135
Pages 2124
Payment Reasons 2605
PC Autosequence Schedules 114
PC Autosequences 113
Pickup Reasons 2607
POS Keyboard 2655
Print Logos 116
Production Item 2150
Property Merchant Groups 1134
Receipt Headers - Default 2614
Receipt Headers - Order Type/Channel 7113
Report Headers 7103
Report Trailers 7104
Reservation Periods 2153
RVC Type Names 2610
Sales Itemizers 2625
Seating Section Template 2147
Section 2148
Service Alert 2642
Service Charge Itemizers 2626
Service Charge SLU Names 2633
Service Total Reasons 2608
Serving Periods 2112
System Employees 506
Tables 2111
Tags 7100
Tax Classes 1118
Tax Parameters 1139
Tax Rates 1117
Tender/Media SLU Names 2635
Theme Assignment 2156
Time Periods 2113
TMS Parameters 2149
TMS Reasons 2644
Training Headers 2615
Void/Return/Waste Reason 2649
Wait Quote Configuration 2645
Waste Receipt Headers 2647
Waste Receipt Trailers 2648
Show Source
Example:
[
    2138,
    2653
]
Nested Schema : EnterpriseEmailConfiguration
Type: object
Enterprise email configuration
Show Source
Nested Schema : EnterpriseLicenseCountInfo
Type: object
License count information
Show Source
Nested Schema : EnterpriseSMTPServer
Type: object
SMTP server details
Show Source
Nested Schema : EnterpriseEmailFormatting
Type: object
Email formatting details
Show Source
Back to Top

Response

Supported Media Types

200 Response

Enterprise Parameters Updated.
Body ()
Root Schema : EnterpriseParametersUpsertResponse
Type: object
Show Source
  • Unique reference of the hierarchy unit where Enterprise Parameters are configured.
    Example: 765
Back to Top