Get service charges
post
/bi/v1/{orgIdentifier}/getServiceChargeDimensions
Gets the service charges for a specified location.
Request
Path Parameters
-
orgIdentifier: string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : locRequestPayload
Type:
objectRequest payload with location reference
Show Source
-
applicationName(optional):
string
Title:
Application NameMaximum Length:128The name of the application which is accessing the API.First Available Version: 20.1.10
-
include(optional):
string
Title:
IncludeList of objects to include in response -
locRef:
string
Title:
Location ReferenceThe location reference, this may be a store number or name depending on the organization -
searchCriteria(optional):
string
Title:
Search CriteriaSearch criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : serviceChargeDimensions
Type:
objectThe response body contains information about the service charge dimensions for the specified locatio
Show Source
-
locRef:
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
serviceCharges:
array serviceCharges
An array of service charge dimensions
Nested Schema : serviceCharges
Type:
arrayAn array of service charge dimensions
Show Source
-
Array of:
object serviceCharge
The response body contains information about the service charge for the specified location.
Nested Schema : serviceCharge
Type:
objectThe response body contains information about the service charge for the specified location.
Show Source
-
category:
string
Title:
CategoryMaximum Length:99The category of the service charge. This attribute will not be returned in the response if value is null -
chrgTipsFlag:
boolean
Title:
Charged Tip FlagA flag indicating if the service charged is a charged tip. This attribute will not be returned in the response if value is false or null -
mstrName(optional):
string
Title:
Master NameMaximum Length:99The master Service charge name -
mstrNum(optional):
integer
Title:
Master NumberMaximum Length:16The master Service charge number -
name:
string
Title:
NameMaximum Length:99Service charge name -
num:
integer
Title:
NumberMaximum Length:16Service charge number -
posPercent:
number
Title:
POS PercentagePercentage of the service charge -
revFlag:
boolean
Title:
Revenue FlagA flag indicating if the service charge is revenue or non-revenue service charge. This attribute will not be returned in the response if value is true or null
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
Examples
The following example shows how to get the service charge dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H "Authorization: Bearer" -H "Content-Type:application/json" -d {"locRef":"1234"} https://baseurl/bi/v1/orgidentifier/getServiceChargeDimensions
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Date: Tue, 20 Oct 2020 21:24:33 GMT Transfer-Encoding: chunked Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"locRef": "1234",
"serviceCharges":[{
"num": 15253,
"name": "Charge Tip",
"mstrNum": 15253,
"mstrName": "Charge Tip",
"posPercent": 10.25,
"revFlag": true,
"chrgTipsFlag": true,
"category": "category"
}]
}