Update Revenue Center Parameters
post
/config/sim/v2/hierarchy/updateRevenueCenterParameters
Updates the parameter of the specified revenue center of the given location. If revenue center parameter is not found is not found, it creates a new revenue center parameter.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
Request body
Root Schema : RevenueCenterParameterCUDRequestBody
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:
0 -
autoFireOptions:
string
A string value of 0s & 1s of length 24 representing the enablement or disablement of the autofire options associated with the revenue center parameter.Example:
000000000000000000000000 -
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
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.Example:
000000000000000000000000 -
currentBusinessDate:
string
A string representing the current business date at the revenue centerExample:
01/03/2022 -
defaultAutoFireTenderMediaNum:
integer
Object number of the default Tender/Media for Autofire checks in the revenue center.Example:
0 -
defaultCondimentEditingPopup:
integer
Default Editing Popup Condiment Orderer Page for the revenue center.Example:
0 -
defaultCondimentOrderingPopup:
integer
Default Ordering Popup Condiment Orderer Page for the revenue center.Example:
1 -
defaultMainLvlIndex:
integer
Object 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
Object number of the default Order Type for this revenue center.Example:
1 -
defaultSubLevelIndex:
integer
Object number of the default sub level for this revenue centerExample:
1 -
depositForfeitReturnMIObjNum:
integer
Deposit Forfeit Return Item for the revenue centerExample:
0 -
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:
false -
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.Example:
false -
enableUberEatsIntegration:
boolean
A flag indicating to enable delivery platform integration with Uber Eats.Example:
false -
endOfRangeThreshold:
integer
End of Range Threshold for the Revenue Center Serial Number, as required for the Taiwanese tax structure.Example:
0 -
hierUnitId(required):
integer
Unique hierarchy unit value of the revenue centerExample:
1 -
interfaces:
object RevenueCenterParameter_interfaces
An object representing the eight revenue centers from which checks can be transferred into this revenue center.
-
locHierUnitId:
integer
Unique reference of the hierarchy unit of the propertyExample:
1 -
locObjNum:
integer
Object number of the locationExample:
1 -
maxGuestCheckNum:
integer
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 fieldExample:
99999999 -
maximumDays:
integer
The maximum number of days (in the future) that Autofire checks can be scheduled.Example:
1 -
maxRVCSerialNumber1:
integer
Maximum serial number 1 for the revenue centerExample:
99999 -
maxRVCSerialNumber2:
integer
Maximum serial number 2 for the revenue centerExample:
99999 -
minGuestCheckNum:
integer
The lowest check number allowed for checks in the revenue centerExample:
1 -
minRVCSerialNumber1:
integer
Minimum serial number 1 for the revenue center.Example:
1 -
minRVCSerialNumber2:
integer
Minimum serial number 2 for the revenue centerExample:
1 -
numGuestsBeforeAutoSVC:
integer
The number of guests required to trigger the automatic service charge for a transactionExample:
1 -
objectNum:
integer
Object number of the revenue centerExample:
1 -
options:
string
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 parameterExample:
000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 -
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.
-
postingOptions:
string
A 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
The purge order threshold in minutes for this revenue center. The minimum valid value is 30.Example:
30 -
startedAt:
string
A string representing the date and time the current business date started at the revenue centerExample:
01/03/2022 03:00:00 AM -
tableCount:
integer
The number of tables served by the revenue center.Example:
1 -
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.
Show Source
Nested Schema : RevenueCenterParameter_tmsInterfaceOptions
Type:
objectAn object containing the table management system interface options for the revenue center
Show Source
-
tmsLinkName:
object TranslatedString_tmsLinkName
A string that contains translations of tmsLinkName into multiple languages
-
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 TranslatedString_tmsUserWorkstationName
A string that contains translations of tmsUserWorkstationName into multiple languages
-
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 : TranslatedString_tmsLinkName
Type:
objectA string that contains translations of tmsLinkName into multiple languages
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 : TranslatedString_tmsUserWorkstationName
Type:
objectA string that contains translations of tmsUserWorkstationName into multiple languages
Example:
{
"en-US":"Workstation",
"de-DE":"Arbeitsplatz",
"es-MX":"puesto de trabajo"
}Response
Supported Media Types
- application/json
200 Response
A response body for Revenue Center Parameter
Root Schema : RevenueCenterParameterResponse
Type:
Show Source
object-
hierUnitId(required):
integer
unique HierUnitId of the RVCExample:
1
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html