Get Control Parameters
post
/config/sim/v2/setup/getControlParameters
Gets Control Parameters
Request
Supported Media Types
- multipart/form-data
- application/json
The input body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, guestCountConfirmationThreshold, openCheckAgeThreshold -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details. detailed Forces the response to include all fields including option string details. Example:detailed -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order. Allowed fields are all public fields.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria. Allowed fields are all public fields.Example:
where equals(hierUnitId, 3599)
Response
Supported Media Types
- application/json
200 Response
A collection of Control Parameters.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
10 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Control Parameters objects.
-
limit:
integer
Server page size.Example:
10 -
offset:
integer
Starting resource record index.Example:
0 -
totalResults:
integer
Total number of rows.Example:
100
Nested Schema : items
Type:
arrayArray of Control Parameters objects.
Show Source
-
Array of:
object ControlParameters
Control Parameters record.
Nested Schema : ControlParameters
Type:
objectControl Parameters record.
Show Source
-
automaticOperatorPopupInterval:
integer
Automatic operator popup interval, stored in seconds.Example:
300 -
checksPrintedBeforeAuthorization:
integer
Minimum Value:
0Maximum Value:99Number of checks printed before authorization.Example:3 -
daysToAdjustClosedChecks:
integer
Minimum Value:
0Maximum Value:7Number of days to adjust closed checks.Example:2 -
daysToReopenOrReprintClosedChecks:
integer
Minimum Value:
0Maximum Value:7Number of days to reopen or reprint closed checks from a previous business day.Example:2 -
guestCountConfirmationThreshold:
integer
Minimum Value:
0Maximum Value:999Confirm number of guests threshold. Enter 0 to disable the prompt.Example:10 -
hierUnitId:
integer
Unique hierarchy unit value for the target hierarchy node.Example:
3599 -
itemsOnHoldWarningThreshold:
integer
Minimum Value:
0Maximum Value:999Items on hold warning threshold, stored in seconds.Example:600 -
openCheckAgeThreshold:
integer
Minimum Value:
0Maximum Value:5Open check age threshold in days.Example:1 -
options:
string
Minimum Length:
96Maximum Length:96Raw control-options bit string of length 96.Example:000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000 -
optionsExt:
object ControlParametersOptionsExt
Read Only:
trueRead-only helper object derived from options. Bit positions are 1-based. Bits 49 gates bits 50-61; bit 54 requires one of bits 50, 51, or 52; bit 61 requires one of bits 56, 57, or 58; bit 65 requires bit 36. -
reportsDefaultView:
string
Minimum Length:
96Maximum Length:96Raw default-view bit string of length 96. A value of true means Revenue Center view; false means Property view.Example:000000100000010000000000000000000000000000100000000000000000000000100000000000000000000000000000 -
reportsDefaultViewExt:
object ControlParametersReportsDefaultViewExt
Read Only:
trueRead-only helper object derived from reportsDefaultView. Bit position equals report id. True means Revenue Center view; false means Property view.
Nested Schema : ControlParametersOptionsExt
Type:
objectRead Only:
trueRead-only helper object derived from options. Bit positions are 1-based. Bits 49 gates bits 50-61; bit 54 requires one of bits 50, 51, or 52; bit 61 requires one of bits 56, 57, or 58; bit 65 requires bit 36.
Show Source
-
allowOnlyOneGroupPerTable:
boolean
Option bit 25. Allow Only One Group per Table.
-
allowOpenOfCashDrawerOnServiceCharge:
boolean
Option bit 65. Allow open of Cash Drawer on Service Charge. Requires option bit 36.
-
allowOriginalV2xPageDesigner:
boolean
Option bit 48. Allow Original v2.x Page Designer.
-
allowPickupOrCreationOfUnassignedChecks:
boolean
Option bit 39. Allow Pickup or Creation of Unassigned Checks.
-
allowPriceOverridesAndModificationsToPreviousRoundItems:
boolean
Option bit 43. Allow Price Overrides and Modifications to Previous-Round Items.
-
allowPrintCustomerReceiptAfterNonPrintingTenderOrMedia:
boolean
Option bit 40. Allow Print Customer Receipt after non-printing Tender or Media.
-
allowServiceTotalOfClosedChecks:
boolean
Option bit 31. Allow Service Total of Closed Checks.
-
allowVoidOfDiscountInCurrentServiceRoundOnly:
boolean
Option bit 20. Allow Void of Discount in Current Service Round Only.
-
allowVoidOfServiceChargeInCurrentServiceRoundOnly:
boolean
Option bit 21. Allow Void of Service Charge in Current Service Round Only.
-
allowVoidOfTenderOrMediaInCurrentServiceRoundOnly:
boolean
Option bit 22. Allow Void of Tender or Media in Current Service Round Only.
-
alwaysOpenCashDrawerIfChangeDue:
boolean
Option bit 42. Always Open Cash Drawer if Change Due.
-
applyUpdateWhenSignedOut:
boolean
Option bit 64. Apply Update When Signed Out.
-
beginCheckKeyConfirmationNotRequired:
boolean
Option bit 3. Begin Check Key Confirmation Not Required.
-
cashierTotalsDeclarationRequiredWithTenderOrMediaAndTipsPaid:
boolean
Option bit 17. Cashier Totals Declaration Required with Tender or Media and Tips Paid.
-
confirmationRequiredForRevenueCenterChangeWithSignInRevenueCenterIndex:
boolean
Option bit 46. Confirmation Required for Revenue Center Change with Sign In Revenue Center Index.
-
confirmationRequiredForTouchVoids:
boolean
Option bit 6. Confirmation Required for Touch-Voids.
-
convertWeightToSystemUnitOfMeasure:
boolean
Option bit 13. Convert Weight to System Unit of Measure.
-
disableOpenChecksFromPreviousBusinessDaysNotificationOnPosClientScreens:
boolean
Option bit 77. Disable the open checks from previous business days notification on POS client screens.
-
disableSynchronizationPrompt:
boolean
Option bit 70. Disable Synchronization Prompt.
-
displaySummaryTotalsOnlyAfterOrderTypeDeclared:
boolean
Option bit 8. Display Summary Totals Only After Order Type Declared.
-
doNotOpenDrawerIfSubtotalIsZero:
boolean
Option bit 36. Do Not Open Drawer if Subtotal is 0.00. Required by option bit 65.
-
doNotPromptForGuestCountWhenProratingPmsItemizers:
boolean
Option bit 2. Do Not Prompt for Guest Count When Prorating PMS Itemizers.
-
doNotRequirePinOrPatternLockOnAndroidClientsToRunSimphonyClient:
boolean
Option bit 80. Do not require PIN or Pattern lock on Android clients to run the Simphony client.
-
employeeIdRequiredWithNoSaleKey:
boolean
Option bit 33. Employee ID Required With No Sale Key.
-
enableCharityDonationsSupport:
boolean
Option bit 75. Enable Charity Donations Support.
-
enableHoldAndFireFinalTenderNotification:
boolean
Option bit 66. Enable Hold and Fire Final Tender Notification.
-
enableShiftTracking:
boolean
Option bit 49. Enable Shift Tracking.
-
enableSurchargeAddedToPaymentCardTenderByPaymentServiceProvider:
boolean
Option bit 76. Enable a Surcharge to be added to a payment card tender by payment service provider.
-
enableUnusedCreditCardAuthorizationReleaseAlert:
boolean
Option bit 73. Enable unused Credit Card authorization release alert.
-
incrementCashierShiftWhenChangingJob:
boolean
Option bit 52. Increment Cashier Shift when Changing Job.
-
incrementCashierShiftWhenChangingRevenueCenter:
boolean
Option bit 53. Increment Cashier Shift when Changing Revenue Center.
-
incrementCashierShiftWhenClockingIn:
boolean
Option bit 51. Increment Cashier Shift when Clocking In.
-
incrementCashierShiftWhenClockingOut:
boolean
Option bit 50. Increment Cashier Shift when Clocking Out.
-
incrementEmployeeShiftWhenChangingJob:
boolean
Option bit 58. Increment Employee Shift when Changing Job.
-
incrementEmployeeShiftWhenChangingRevenueCenter:
boolean
Option bit 59. Increment Employee Shift when Changing Revenue Center.
-
incrementEmployeeShiftWhenClockingIn:
boolean
Option bit 57. Increment Employee Shift when Clocking In.
-
incrementEmployeeShiftWhenClockingOut:
boolean
Option bit 56. Increment Employee Shift when Clocking Out.
-
noConfirmationRequiredWhenCreatingComboMealsFromExistingItems:
boolean
Option bit 12. No Confirmation Required when Creating Combo Meals from Existing Items.
-
onlyNonSalesTransactionsOutputToJournal:
boolean
Option bit 28. Only Non-Sales Transactions Output to Journal.
-
openCashDrawerWhenVoidingClosedCheck:
boolean
Option bit 74. Open Cash Drawer when voiding closed check.
-
openDrawerOnlyIfBalanceDueIsZero:
boolean
Option bit 23. Open Drawer Only if Balance Due is 0.00.
-
permitRequiredCondimentsToBeEnteredOutOfOrder:
boolean
Option bit 44. Permit Required Condiments To Be Entered Out Of Order.
-
pickupCheckKeyConfirmationNotRequired:
boolean
Option bit 4. Pickup Check Key Confirmation Not Required.
-
printVoucherWhenEmployeeDiscountOrEmployeeTenderIsUsed:
boolean
Option bit 34. Print Voucher When Employee Discount or Employee Tender is Used.
-
promptBeforeIncrementingCashierShift:
boolean
Option bit 54. Prompt before incrementing Cashier Shift. Requires one of option bits 50, 51, or 52.
-
promptBeforeIncrementingEmployeeShift:
boolean
Option bit 61. Prompt before incrementing Employee Shift. Requires one of option bits 56, 57, or 58.
-
promptForGuestCountWhenSplitCheck:
boolean
Option bit 9. Prompt for Guest Count when Split Check.
-
promptForNumberOfGuestsOnOriginalCheckWhenSplit:
boolean
Option bit 63. Prompt for Number of Guests on original check when split.
-
promptForNumberOfGuestsWhenPostingTheFinalTender:
boolean
Option bit 62. Prompt for Number of Guests when posting the final Tender.
-
promptForVoidReasonCode:
boolean
Option bit 10. Prompt for Void Reason Code.
-
promptOnDemandOperatorsToPrintSplitChecks:
boolean
Option bit 1. Prompt On-Demand Operators to Print Split Checks.
-
promptToIncrementCashierShiftAfterShiftReport:
boolean
Option bit 55. Prompt to Increment Cashier Shift after Shift Report.
-
promptToIncrementEmployeeShiftAfterShiftReport:
boolean
Option bit 60. Prompt to Increment Employee Shift after Shift Report.
-
requireCashierTotalsToBeginTransaction:
boolean
Option bit 18. Require Cashier Totals to Begin Transaction.
-
requireEventAssociationForEveryGuestCheckWhenEventFeatureIsEnabled:
boolean
Option bit 67. Association of an Event to every Guest Check is mandatory where Event feature is enabled.
-
requireFinalizationOfCheckAfterPartialTender:
boolean
Option bit 19. Require Finalization of Check after Partial Tender.
-
requireReasonOnNoSale:
boolean
Option bit 68. Require Reason on No Sale.
-
requireReferenceEntryWithPriceOverride:
boolean
Option bit 35. Require Reference Entry With Price Override.
-
showAllDefinitionsForOutOfMenuItemInEditMenuItemAvailability:
boolean
Option bit 79. Show All Definitions for Out of Menu Item in Edit Menu Item Availability.
-
storeReferenceEntriesInPlainText:
boolean
Option bit 45. Store Reference Entries In Plain Text.
-
treatErrorCorrectsAsVoids:
boolean
Option bit 24. Treat Error Corrects as Voids.
-
validationRequiredForMenuItemAndServiceChargeVoids:
boolean
Option bit 26. Validation Required for Menu Item and Service Charge Voids.
-
validationRequiredForMenuItemReturns:
boolean
Option bit 27. Validation Required for Menu Item Returns.
Nested Schema : ControlParametersReportsDefaultViewExt
Type:
objectRead Only:
trueRead-only helper object derived from reportsDefaultView. Bit position equals report id. True means Revenue Center view; false means Property view.
Show Source
-
cashierFinancial:
boolean
Report id 14. Cashier Financial.
-
cashManagementPettyCash:
boolean
Report id 58. Cash Management Petty Cash.
-
cashManagementServerBanking:
boolean
Report id 59. Cash Management Server Banking.
-
checkJournal:
boolean
Report id 37. Check Journal.
-
clockInStatus:
boolean
Report id 27. Clock-in Status.
-
employeeClosedCheck:
boolean
Report id 9. Employee Closed Check.
-
employeeFinancial:
boolean
Report id 7. Employee Financial.
-
employeeFinancialV2:
boolean
Report id 38. Employee Financial V2.
-
employeeFinancialVat:
boolean
Report id 41. Employee Financial VAT.
-
employeeJournal:
boolean
Report id 36. Employee Journal.
-
employeeOpenCheck:
boolean
Report id 8. Employee Open Check.
-
employeeTip:
boolean
Report id 10. Employee Tip.
-
familyGroupSales:
boolean
Report id 16. Family Group Sales.
-
gmsEmployeeSectionAssignmentReport:
boolean
Report id 44. GMS Employee Section Assignment Report.
-
heldItemSummary:
boolean
Report id 61. Held Item Summary.
-
jobCodeLabor:
boolean
Report id 29. Job Code Labor.
-
laborAvailability:
boolean
Report id 28. Labor Availability.
-
majorGroupSales:
boolean
Report id 15. Major Group Sales.
- menuItemSales: boolean
- menuItemSummary: boolean
-
offlineCashierFinancial:
boolean
Report id 33. Offline Cashier Financial.
-
offlineEmployeeFinancial:
boolean
Report id 32. Offline Employee Financial.
-
offlineEmployeeOpenCheck:
boolean
Report id 35. Offline Employee Open Check.
-
posWasteDetailSummary:
boolean
Report id 65. POS Waste Detail Summary.
-
posWasteEmployeeSummary:
boolean
Report id 62. POS Waste Employee Summary.
-
posWasteMenuItemSummary:
boolean
Report id 63. POS Waste Menu Item Summary.
-
posWasteReasonSummary:
boolean
Report id 64. POS Waste Reason Summary.
-
revenueCenterLock:
boolean
Report id 67. Revenue Center Lock.
-
taxSummary:
boolean
Report id 43. Tax Summary.
-
workstationLock:
boolean
Report id 66. Workstation Lock.