Upsert Revenue Center Parameters
post
/config/sim/v2/hierarchy/upsertRevenueCenterParameters
Updates the provided fields when the revenue center parameters exist.
Request
Supported Media Types
- multipart/form-data
- application/json
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
Request body for partially updating an existing Revenue Center Parameter.
Root Schema : schema
Type:
Show Source
object-
addOrTransferRVCs:
object RevenueCenterParameter_addOrTransferRVCs
An object representing the eight revenue centers from which checks can be transferred into this revenue center.
-
autoFireEmpObjNum:
integer
Object number of the employee whose totals are associated with Autofire checks when the check is fired.Example:
1 -
autoFireOptions:
string
Minimum Length:
8Maximum Length:8A string value of 0s & 1s of length 8 representing the enablement or disablement of the autofire options associated with the revenue center parameter. If supplied, its third bit also sets bit 49 of options, using the existing options string when options is omitted.Example:00000000 -
autoFireWSNum:
integer
Object number of the workstation where Autofire checks are fired and printed.Example:
1 -
backAutoFireDelayInMinutes:
integer
The amount of time (in minutes) that the specified Autofire workstation attempts to Autofire a check.Example:
1 -
creditCardOptions:
string
Minimum Length:
24Maximum Length:24A string value of 0s & 1s of length 24 representing the enablement or disablement of the credit card options associated with the revenue center parameter.Example:000000000000000000000000 -
defaultAutoFireTenderMediaNum:
integer
Object number of the default Tender/Media for Autofire checks in the revenue center.Example:
1 -
defaultCondimentEditingPopup:
integer
Default Editing Popup Condiment Orderer Page for the revenue center.Example:
1 -
defaultCondimentOrderingPopup:
integer
Default Ordering Popup Condiment Orderer Page for the revenue center.Example:
1 -
defaultMainLvlIndex:
integer
Minimum Value:
0Maximum Value:8Object number of the default Main Level for this revenue center.Example:1 -
defaultOrderChannelObjNum:
integer
Object number of the default Order Channel for this revenue center.Example:
1 -
defaultOrderTypeObjNum:
integer
Minimum Value:
0Maximum Value:32Object number of the default Order Type for this revenue center.Example:1 -
defaultSubLevelIndex:
integer
Minimum Value:
0Maximum Value:8Object number of the default sub level for this revenue centerExample:1 -
depositForfeitReturnMIObjNum:
integer
Deposit Forfeit Return Item for the revenue centerExample:
1 -
diningTableStatusSet:
integer
Default dining table status definitions to use in this revenue center.Example:
1 -
dontResetCashierFinancialShiftsWithSOD:
boolean
A flag indicating to prevent Cashier Financial Shifts from resetting with the start of each business day.Example:
false -
dontResetEmpFinancialShiftsWithSOD:
boolean
A flag indicating to prevent Employee Financial Shifts from resetting with the start of each business day.Example:
true -
enableDeliverooIntegration:
boolean
A flag indicating to enable delivery platform integrations with Deliveroo.Example:
false -
enableOverridePropertySODtimes:
boolean
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. If omitted, the existing override state is preserved. True creates calendar entries if none exist; false removes the revenue center calendar entries.Example:
true -
enableUberEatsIntegration:
boolean
A flag indicating to enable delivery platform integration with Uber Eats.Example:
true -
endOfRangeThreshold:
integer
Minimum Value:
0Maximum Value:999End of Range Threshold for the Revenue Center Serial Number, as required for the Taiwanese tax structure.Example:0 -
HHTOPTIONBITS:
string
Handheld terminal option bit string.Example:
0000000000000000 -
hierUnitId(required):
integer
Unique hierarchy unit value of the revenue centerExample:
9442 -
interfaces:
object RevenueCenterParameter_interfaces
An object representing the eight revenue centers from which checks can be transferred into this revenue center.
-
maxGuestCheckNum:
integer
Minimum Value:
1Maximum Value:99999999The 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 fieldExample:99999999 -
maximumDays:
integer
Minimum Value:
1Maximum Value:366The maximum number of days (in the future) that Autofire checks can be scheduled. Valid values are 1 to 366, both inclusive.Example:1 -
maxRVCSerialNumber1:
integer
Minimum Value:
2Maximum Value:99999Maximum serial number 1 for the revenue center. Valid values are 2 to 99999, both inclusive. It must be greater than or equal to minRVCSerialNumber1.Example:99999 -
maxRVCSerialNumber2:
integer
Minimum Value:
2Maximum Value:99999Maximum serial number 2 for the revenue center. Valid values are 2 to 99999, both inclusive. It must be greater than or equal to minRVCSerialNumber2.Example:99999 -
minGuestCheckNum:
integer
Minimum Value:
1Maximum Value:99999999The lowest check number allowed for checks in the revenue centerExample:1 -
minRVCSerialNumber1:
integer
Minimum Value:
1Maximum Value:99998Minimum serial number 1 for the revenue center. Valid values are 1 to 99998, both inclusive. It must be less than or equal to maxRVCSerialNumber1.Example:1 -
minRVCSerialNumber2:
integer
Minimum Value:
1Maximum Value:99998Minimum serial number 2 for the revenue center. Valid values are 1 to 99998, both inclusive. It must be less than or equal to maxRVCSerialNumber2.Example:1 -
numGuestsBeforeAutoSVC:
integer
The number of guests required to trigger the automatic service charge for a transactionExample:
1 -
options:
string
Minimum Length:
128Maximum Length:128A string value of 0s & 1s of length 128 representing the enablement or disablement of the options associated with the revenue center parameter. If omitted, the existing string is used. Supplied Boolean flags override bits 23, 24, 45 and 46 (counting from 1). Supplied autoFireOptions also updates bit 49.Example:00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 -
orderRoutingThresholdAmount:
number
An amount to determine if the Below Threshold Print Class of a Tender/Media will be used.Example:
0 -
overridenSODTimes:
array overridenSODTimes
An array of overridden start of day times. Only existing calendar entries for the supplied days are updated.
-
postingOptions:
string
Minimum Length:
16Maximum Length:16A string value of 0s & 1s of length 16 representing the enablement or disablement of the posting options associated with the revenue center parameter.Example:0000000000000000 -
purgeOrderThresholdInMinutes:
integer
Minimum Value:
30Maximum Value:9999The purge order threshold in minutes for this revenue center. The value must be between 30 and 9999, or 0.Example:30 -
tableCount:
integer
The number of tables served by the revenue center.Example:
12 -
taxNumberPrefix:
string
Taiwanese tax number prefix for the revenue center.Example:
TW -
tmsInterfaceOptions:
object RevenueCenterParameter_tmsInterfaceOptions
An object containing the table management system interface options for the revenue center
Nested Schema : RevenueCenterParameter_addOrTransferRVCs
Type:
objectAn object representing the eight revenue centers from which checks can be transferred into this revenue center.
Show Source
-
rvc1ObjNum:
integer
Object number of the 1st revenue center from which checks can be transferred into this revenue centerExample:
0 -
rvc2ObjNum:
integer
Object number of the 2nd revenue center from which checks can be transferred into this revenue centerExample:
0 -
rvc3ObjNum:
integer
Object number of the 3rd revenue center from which checks can be transferred into this revenue centerExample:
0 -
rvc4ObjNum:
integer
Object number of the 4th revenue center from which checks can be transferred into this revenue centerExample:
0 -
rvc5ObjNum:
integer
Object number of the 5th revenue center from which checks can be transferred into this revenue centerExample:
0 -
rvc6ObjNum:
integer
Object number of the 6th revenue center from which checks can be transferred into this revenue centerExample:
0 -
rvc7ObjNum:
integer
Object number of the 7th revenue center from which checks can be transferred into this revenue centerExample:
0 -
rvc8ObjNum:
integer
Object number of the 8th revenue center from which checks can be transferred into this revenue centerExample:
0
Nested Schema : RevenueCenterParameter_interfaces
Type:
objectAn object representing the eight revenue centers from which checks can be transferred into this revenue center.
Show Source
-
interface10ObjNum:
integer
Object number of the 10th interface associated with the revenue centerExample:
0 -
interface11ObjNum:
integer
Object number of the 11th interface associated with the revenue centerExample:
0 -
interface12ObjNum:
integer
Object number of the 12th interface associated with the revenue centerExample:
0 -
interface13ObjNum:
integer
Object number of the 13th interface associated with the revenue centerExample:
0 -
interface14ObjNum:
integer
Object number of the 14th interface associated with the revenue centerExample:
0 -
interface15ObjNum:
integer
Object number of the 15th interface associated with the revenue centerExample:
0 -
interface16ObjNum:
integer
Object number of the 16th interface associated with the revenue centerExample:
0 -
interface1ObjNum:
integer
Object number of the 1st interface associated with the revenue center.Example:
0 -
interface2ObjNum:
integer
Object number of the 2nd interface associated with the revenue center.Example:
0 -
interface3ObjNum:
integer
Object number of the 3rd interface associated with the revenue centerExample:
0 -
interface4ObjNum:
integer
Object number of the 4th interface associated with the revenue centerExample:
0 -
interface5ObjNum:
integer
Object number of the 5th interface associated with the revenue centerExample:
0 -
interface6ObjNum:
integer
Object number of the 6th interface associated with the revenue centerExample:
0 -
interface7ObjNum:
integer
Object number of the 7th interface associated with the revenue centerExample:
0 -
interface8ObjNum:
integer
Object number of the 8th interface associated with the revenue centerExample:
0 -
interface9ObjNum:
integer
Object number of the 9th interface associated with the revenue centerExample:
0
Nested Schema : overridenSODTimes
Type:
arrayAn array of overridden start of day times. Only existing calendar entries for the supplied days are updated.
Show Source
Nested Schema : RevenueCenterParameter_tmsInterfaceOptions
Type:
objectAn object containing the table management system interface options for the revenue center
Show Source
-
tmsLinkName:
object tmsLinkName
TMS Link Name
-
tmsLinkNum:
integer
Object number of the Table Management System (from the Enterprise Interface file) that accepts postings from this revenue center.Example:
0 -
tmsOperatorName:
string
The name of the workstation operator to assign for checks that are opened by the TMS before being picked up by a server.Example:
Operator 1 -
tmsOperatorObjNum:
integer
Object number of the workstation operator to assign for checks that are opened by the TMS before being picked up by a server.Example:
0 -
tmsOptions:
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the TMS options associated with the revenue center parameter.Example:
00000000 -
tmsOptionsExt:
object RevenueCenterParameters_tmsOptionsExt
-
tmsUserWorkstationName:
object tmsUserWorkstationName
TMS User Work Station Name
-
tmsUserWorkstationObjNum:
integer
Object number of the workstation to assign for checks that are opened by the TMS.Example:
0
Nested Schema : RevenueCenterParameter_overridenSODTimes
Type:
Show Source
object-
dayOfWeek:
integer
An integer representing day of the week.Example:
1 -
runManually:
boolean
A flag indicating to manually run the start of day for this business date.Example:
false -
sodTime:
string
The start of day time for the day.Example:
00:00
Nested Schema : tmsLinkName
Type:
objectTMS Link Name
Example:
{
"en-US":"TMS",
"de-DE":"TMS",
"es-MX":"TMS"
}Nested Schema : RevenueCenterParameters_tmsOptionsExt
Type:
Show Source
object-
enableCRMTMSInterface:
boolean
A flag indicating to enable CRM/TMS interface options, the enhanced features for the CRM/TMS Interface.Example:
false -
resendTMSMessagesWithoutPrompting:
boolean
A flag indicating to retry sending failed TMS messages without user intervention.Example:
false -
sendCheckStatusMessagesToTMS:
boolean
A flag indicating to automatically send check status messages to TMS.Example:
false -
sendClosedCheckDetailToCRMTMS:
boolean
A flag indicating to send closed check detail data to the CRM/TMS interface.Example:
false -
sendClosedCheckTotalToCRMTMS:
boolean
A flag indicating to send closed check totals to the CRM/TMS interface.Example:
false -
sendCourseTimingDateToCRMTMS:
boolean
A flag indicating to send course timing data to the CRM/TMS interface.Example:
false -
sendGuestCountUpdatesToTMS:
boolean
A flag indicating to send guest count update messages to TMS when the guest count changes.Example:
false
Nested Schema : tmsUserWorkstationName
Type:
objectTMS User Work Station Name
Example:
{
"en-US":"Workstation",
"de-DE":"Arbeitsplatz",
"es-MX":"puesto de trabajo"
}Response
Supported Media Types
- application/json
200 Response
Revenue Center Parameters Updated.
Root Schema : schema
Type:
Show Source
object-
hierUnitId:
integer
Unique hierarchy unit value of the revenue center.Example:
9442