Get Revenue Centers
post
/config/sim/v1/hierarchy/getRevenueCenters
Gets all the revenue centers for the specified organization
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
Objects included in the response.Example:
hierUnitId -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits the translated strings returned.Example:
en-US, es-ES, es-MX -
limit:
integer
If using paging, number of results returned in this page.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Revenue Centers.
Root Schema : RevenueCenterGetResponsev1
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Revenue Center objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Revenue Center objects of the organization.
Show Source
-
Array of:
object RevenueCenterGETv1
Model for RevenueCenter Object
Nested Schema : RevenueCenterGETv1
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
A group of string objects representing the consumer facing name of the revenue center in the configured languages
-
country:
string
The country for the revenue center.Example:
United States -
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 -
hierStrucId:
integer
Unique reference of the hierarchy structure of the revenue center. Excluded by default.Example:
1 -
hierUnitId:
integer
Unique reference of the hierarchy unit of the revenue centerExample:
1 -
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
A 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 -
locHierStrucId:
integer
Unique reference of the hierarchy structure of the property. Excluded by default.Example:
1 -
locHierUnitId:
integer
Unique reference of the hierarchy unit of the propertyExample:
1 -
locName:
object locName
A group of string objects representing the name of the location configured languages
-
locObjNum:
integer
Object number of the propertyExample:
1 -
longitude:
string
The revenue center longitude. Longitude must be between -180 and 180Example:
12.34 -
name:
object name
A group of string objects representing the name of the revenue center configured languages
-
objectNum:
integer
Object number of the revenue centerExample:
1 -
phone:
string
The phone number of the revenue centerExample:
1234567890 -
phoneCountryCode:
string
The phone number country code of the revenue center.Example:
US -
phoneNumberPrefix:
integer
The phone number prefix of the revenue center.Example:
1 -
rvcGroups:
array rvcGroups
An object containing the descriptive options list associated with the revenue center groups associated with this revenue center
-
rvcId:
integer
This field shows the Revenue Center ID, an uneditable field that is the database ID number. This field is provided as a reference so that configuration can be completed for interfaces and other applications that require Revenue Center IDsExample:
1 -
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.Example:
New York -
stateOrRegionCode:
string
The state or region code for the revenue center.Example:
NY -
zipOrPostalCode:
string
The ZIP or postal code for the revenue center.Example:
YXA123
Nested Schema : consumerFacingName
Type:
objectA 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:
objectA 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 : locName
Type:
objectA group of string objects representing the name of the location configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : name
Type:
objectA 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