Upsert Revenue Center Parameters

post

/config/sim/v2/hierarchy/upsertRevenueCenterParameters

Updates the provided fields when the revenue center parameters exist.

Request

Supported Media Types
Header Parameters
Body ()
Request body for partially updating an existing Revenue Center Parameter.
Root Schema : schema
Type: object
Show Source
  • RevenueCenterParameter_addOrTransferRVCs
    An object representing the eight revenue centers from which checks can be transferred into this revenue center.
  • Object number of the employee whose totals are associated with Autofire checks when the check is fired.
    Example: 1
  • Minimum Length: 8
    Maximum Length: 8
    A 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
  • Object number of the workstation where Autofire checks are fired and printed.
    Example: 1
  • The amount of time (in minutes) that the specified Autofire workstation attempts to Autofire a check.
    Example: 1
  • Minimum Length: 24
    Maximum Length: 24
    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
  • Object number of the default Tender/Media for Autofire checks in the revenue center.
    Example: 1
  • Default Editing Popup Condiment Orderer Page for the revenue center.
    Example: 1
  • Default Ordering Popup Condiment Orderer Page for the revenue center.
    Example: 1
  • Minimum Value: 0
    Maximum Value: 8
    Object number of the default Main Level for this revenue center.
    Example: 1
  • Object number of the default Order Channel for this revenue center.
    Example: 1
  • Minimum Value: 0
    Maximum Value: 32
    Object number of the default Order Type for this revenue center.
    Example: 1
  • Minimum Value: 0
    Maximum Value: 8
    Object number of the default sub level for this revenue center
    Example: 1
  • Deposit Forfeit Return Item for the revenue center
    Example: 1
  • Default dining table status definitions to use in this revenue center.
    Example: 1
  • A flag indicating to prevent Cashier Financial Shifts from resetting with the start of each business day.
    Example: false
  • A flag indicating to prevent Employee Financial Shifts from resetting with the start of each business day.
    Example: true
  • A flag indicating to enable delivery platform integrations with Deliveroo.
    Example: false
  • 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
  • A flag indicating to enable delivery platform integration with Uber Eats.
    Example: true
  • Minimum Value: 0
    Maximum Value: 999
    End of Range Threshold for the Revenue Center Serial Number, as required for the Taiwanese tax structure.
    Example: 0
  • Handheld terminal option bit string.
    Example: 0000000000000000
  • Unique hierarchy unit value of the revenue center
    Example: 9442
  • RevenueCenterParameter_interfaces
    An object representing the eight revenue centers from which checks can be transferred into this revenue center.
  • Minimum Value: 1
    Maximum Value: 99999999
    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
    Example: 99999999
  • Minimum Value: 1
    Maximum Value: 366
    The maximum number of days (in the future) that Autofire checks can be scheduled. Valid values are 1 to 366, both inclusive.
    Example: 1
  • Minimum Value: 2
    Maximum Value: 99999
    Maximum 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
  • Minimum Value: 2
    Maximum Value: 99999
    Maximum 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
  • Minimum Value: 1
    Maximum Value: 99999999
    The lowest check number allowed for checks in the revenue center
    Example: 1
  • Minimum Value: 1
    Maximum Value: 99998
    Minimum 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
  • Minimum Value: 1
    Maximum Value: 99998
    Minimum 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
  • The number of guests required to trigger the automatic service charge for a transaction
    Example: 1
  • Minimum Length: 128
    Maximum Length: 128
    A 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
  • An amount to determine if the Below Threshold Print Class of a Tender/Media will be used.
    Example: 0
  • overridenSODTimes
    An array of overridden start of day times. Only existing calendar entries for the supplied days are updated.
  • Minimum Length: 16
    Maximum Length: 16
    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
  • Minimum Value: 30
    Maximum Value: 9999
    The purge order threshold in minutes for this revenue center. The value must be between 30 and 9999, or 0.
    Example: 30
  • The number of tables served by the revenue center.
    Example: 12
  • Taiwanese tax number prefix for the revenue center.
    Example: TW
  • RevenueCenterParameter_tmsInterfaceOptions
    An object containing the table management system interface options for the revenue center
Nested Schema : RevenueCenterParameter_addOrTransferRVCs
Type: object
An object representing the eight revenue centers from which checks can be transferred into this revenue center.
Show Source
  • Object number of the 1st revenue center from which checks can be transferred into this revenue center
    Example: 0
  • Object number of the 2nd revenue center from which checks can be transferred into this revenue center
    Example: 0
  • Object number of the 3rd revenue center from which checks can be transferred into this revenue center
    Example: 0
  • Object number of the 4th revenue center from which checks can be transferred into this revenue center
    Example: 0
  • Object number of the 5th revenue center from which checks can be transferred into this revenue center
    Example: 0
  • Object number of the 6th revenue center from which checks can be transferred into this revenue center
    Example: 0
  • Object number of the 7th revenue center from which checks can be transferred into this revenue center
    Example: 0
  • Object number of the 8th revenue center from which checks can be transferred into this revenue center
    Example: 0
Nested Schema : RevenueCenterParameter_interfaces
Type: object
An object representing the eight revenue centers from which checks can be transferred into this revenue center.
Show Source
Nested Schema : overridenSODTimes
Type: array
An array of overridden start of day times. Only existing calendar entries for the supplied days are updated.
Show Source
Nested Schema : RevenueCenterParameter_tmsInterfaceOptions
Type: object
An object containing the table management system interface options for the revenue center
Show Source
Nested Schema : RevenueCenterParameter_overridenSODTimes
Type: object
Show Source
Nested Schema : tmsLinkName
Type: object
TMS Link Name
Example:
{
    "en-US":"TMS",
    "de-DE":"TMS",
    "es-MX":"TMS"
}
Nested Schema : RevenueCenterParameters_tmsOptionsExt
Type: object
Show Source
Nested Schema : tmsUserWorkstationName
Type: object
TMS User Work Station Name
Example:
{
    "en-US":"Workstation",
    "de-DE":"Arbeitsplatz",
    "es-MX":"puesto de trabajo"
}
Back to Top

Response

Supported Media Types

200 Response

Revenue Center Parameters Updated.
Body ()
Root Schema : schema
Type: object
Show Source
Back to Top