Get service charge daily totals
post
/bi/v1/{orgIdentifier}/getServiceChargeDailyTotals
Get the service charge daily totals for a specified location and business date.
Request
Path Parameters
-
orgIdentifier(required): string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : requestPayload
Type:
object
Request payload
Show Source
-
applicationName:
string
Title:
Application Name
Maximum Length:128
The name of the application which is accessing the API.First Available Version: 20.1.10
-
busDt(required):
string(date)
Title:
Business Date
The business date associated with the cash management detail -
include:
string
Title:
Include
Maximum Length:2000
List of objects to include in response -
locRef(required):
string
Title:
Location Reference
Maximum Length:99
The location reference, this may be a store number or name depending on the organization -
searchCriteria:
string
Title:
Search Criteria
Maximum Length:2000
Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : svcDailyTotals
Type:
object
The response body contains information about the daily totals of service charges for the specified location and business date.
Show Source
-
busDt(required):
string(date)
Title:
Business Date
Business date -
locRef(required):
string
Title:
Location Reference
Maximum Length:99
The location reference, this may be a store number or name depending on the organization -
revenueCenters(required):
array revenueCenters
An array of service charge daily totals by revenue centers
Nested Schema : revenueCenters
Type:
array
An array of service charge daily totals by revenue centers
Show Source
-
Array of:
object svcDailyTotalsByRVC
The response body contains daily totals of service charges applied at a revenue center for the specified location and business date.
Nested Schema : svcDailyTotalsByRVC
Type:
object
The response body contains daily totals of service charges applied at a revenue center for the specified location and business date.
Show Source
-
rvcNum(required):
integer
Title:
Revenue Center Number
Maximum Length:10
Revenue Center number. This attribute will not be returned in the response if serviceCharges is null -
serviceCharges(required):
array serviceCharges
An array of daily totals of service charges for a revenue center. This attribute will not be returned in the response if value is null
Nested Schema : serviceCharges
Type:
array
An array of daily totals of service charges for a revenue center. This attribute will not be returned in the response if value is null
Show Source
-
Array of:
object svcDailyTotal
The response body contains daily totals of service charges for a revenue center for the specified location and business date.
Nested Schema : svcDailyTotal
Type:
object
The response body contains daily totals of service charges for a revenue center for the specified location and business date.
Show Source
-
cnt(required):
integer
Title:
Service Charge Count
Maximum Length:16
Total number of times the service charge was applied -
svcNum(required):
integer
Title:
Service Charge Number
Maximum Length:16
Unique identifier of the service charge -
ttl(required):
number
Title:
Service Charge Total
Total value of service charges
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
detail:
string
Title:
Error description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle error code
Oracle error code -
status:
integer
Title:
Status
HTTP response code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
detail:
string
Title:
Error description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle error code
Oracle error code -
status:
integer
Title:
Status
HTTP response code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
detail:
string
Title:
Error description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle error code
Oracle error code -
status:
integer
Title:
Status
HTTP response code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
detail:
string
Title:
Error description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle error code
Oracle error code -
status:
integer
Title:
Status
HTTP response code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
detail:
string
Title:
Error description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle error code
Oracle error code -
status:
integer
Title:
Status
HTTP response code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
Examples
The following example shows how to view all the service charge daily totals for a specified location & business date 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","busDt":"2020-10-20"} https://baseurl/bi/v1/orgidentifier/getServiceChargeDailyTotals
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", "busDt": "2020-07-20", "revenueCenters":[{ "rvcNum": 1372, "serviceCharges":[{ "svcNum": 12345, "ttl": 1234.56, "cnt": 123 }] }] }