Add Revenue Centers
post
/config/sim/v1/hierarchy/revenueCenters
Add the revenue centers for the given location for the specified organization. After inserting the RVC, the corresponding RVC Parameter needs to be added manually.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string(string)
Detail that Identifies that who made the change
RevenueCenter object of the organization
Root Schema : RevenueCenterInsert
Type:
objectModel for RevenueCenter Object
Show Source
-
address1:
string
The address line 1 for the revenue center.Example:
Address Line 1 -
address2:
string
The address line 2 for the revenue center.Example:
Address Line 2 -
address3:
string
The address line 3 for the revenue center.Example:
Address Line 3 -
city:
string
The city for the revenue center.Example:
City -
ConsumerFacingName:
object ConsumerFacingName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the consumer facing name of the revenue center in the configured languages
-
countryCode:
string
The country code for the revenue center.Example:
US -
dataExtensions:
array dataExtensions
An array of extension data associated with the revenue center
-
floor:
string
The floor of the building.Example:
1st Floor -
isLDSActive:
boolean
A flag indicating if LDS is activated for this revenue center.Example:
false -
kdsControllerId:
integer
The unique reference of the KDS Controller that controls the KDS Display Order Devices in this revenue center. Oracle recommends using no more than 15 KDS Display Order Devices on a single KDS ControllerExample:
2 -
kdsControllerName:
object kdsControllerName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the KDS controller in configured languages
-
latitude:
string
The revenue center latitude. Latitude must be within range -90 to +90Example:
12.23 -
locHierUnitId(required):
integer
Unique reference of the hierarchy unit of the propertyExample:
1 -
longitude:
string
The revenue center longitude. Longitude must be between -180 and 180Example:
12.34 -
name(required):
object name
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the revenue center configured languages
-
objectNum(required):
integer
Object number of the revenue centerExample:
1 -
phone:
string
The phone number of the revenue center. If it is not null, the phoneCountryCode is required.Example:
1234567890 -
phoneCountryCode:
string
The phone number country code of the revenue center. It cannot be null when assigning a phone number to the property.Example:
US -
rvcGroups:
array rvcGroups
An object containing the descriptive options list associated with the revenue center groups associated with this revenue center
-
rvcTypes:
string
A string value of 0s & 1s of length 32 representing the enablement or disablement of the revenue center types associated with the revenue center. If not specified, this will represent the default options associated with the revenue centerExample:
11111111111111111111111111111111 -
stateOrRegion:
string
The state or region for the revenue center. It cannot be null when stateOrRegionCode is not null.Example:
New York -
stateOrRegionCode:
string
The state or region code for the revenue center. It cannot be null when stateOrRegion is not null.Example:
NY -
zipOrPostalCode:
string
The ZIP or postal code for the revenue center.Example:
YXA123
Nested Schema : ConsumerFacingName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the consumer facing name of the revenue center in the configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : dataExtensions
Type:
arrayAn array of extension data associated with the revenue center
Show Source
Example:
{
"columnName":"extension column 1",
"value":"value 1"
}Nested Schema : kdsControllerName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the KDS controller in configured languages
Example:
{
"en-US":"Controller",
"de-DE":"Regler",
"es-MX":"Controlador"
}Nested Schema : name
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the revenue center configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : rvcGroups
Type:
arrayAn object containing the descriptive options list associated with the revenue center groups associated with this revenue center
Show Source
Example:
{
"rvcGroupNum":"1"
}Nested Schema : items
Type:
Show Source
object-
columnName:
string
The name of the extension data columnExample:
extension column 1 -
value:
string
The value associated with the extension data columnExample:
value 1
Nested Schema : items
Type:
Show Source
object-
rvcGroupNum:
integer
The object number of the revenue center group associated with the revenue centerExample:
1
Response
Supported Media Types
- application/json
200 Response
Revenue Center object of a location
Root Schema : RevenueCenterResponse
Type:
Show Source
object-
hierUnitId(required):
integer
Example:
1 -
locHierUnitId(required):
integer
Example:
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