Get point of sale waste details
post
/bi/v1/{orgIdentifier}/getPOSWasteDetails
Get all the Point of Sale waste details 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 : POSWasteDetailsrequestPayload
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
Business date of the transaction -
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 -
transSinceUTC:
string(date-time)
Title:
Transaction Date Time in UTC
Report all POS waste transaction activity that has occurred since this UTC date and time for the specified business date. If this object is not included, return all POS Waste transactions for the specified business date.First Available Version: 20.3
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : posWasteDetails
Type:
object
The response body contains information about the point of sale waste details for the specified location and business date.
Show Source
-
busDt(required):
string(date)
Title:
Business Date
The business date associated with the point of sale waste detail -
curUTC:
string(date-time)
Title:
The current UTC date and time
The current UTC date and time when the request is made.First Available Version: 20.3
-
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 point of sale waste details by reveneue centers
Nested Schema : revenueCenters
Type:
array
An array of point of sale waste details by reveneue centers
Show Source
-
Array of:
object posWasteDetailsByRVC
The response body contains point of sale waste details for a revenue center
Nested Schema : posWasteDetailsByRVC
Type:
object
The response body contains point of sale waste details for a revenue center
Show Source
- menuItems(required): array menuItems
-
rvcNum(required):
integer
Title:
Revenue center number
Maximum Length:10
Revenue Center number. This attribute will not be returned in the response if logDetails is null
Nested Schema : wasteDetail
Type:
object
The response body contains the point of sale waste details associated with a revenue center
Show Source
-
cnt:
number
Title:
Quantity
Quantity of the waste. This attribute will not be returned in the response if value is null -
empNum(required):
integer
Title:
Employee Number
Maximum Length:16
Unique identifier of the employee who has entered the waste detail. -
miNum(required):
integer
Title:
Menu Item ID
Maximum Length:16
The unique identifier of the menu item -
prcLvl(required):
integer
Title:
Price Level
Maximum Length:16
Price level associated with the waste.This attribute will not be returned in the response if value is null -
prepCost:
number
Title:
Cost
Preparation cost associated with the waste. This attribute will not be returned in the response if value is null -
rsnCodeNum(required):
integer
Title:
Reason Code Number
Maximum Length:16
The unique identifier reason code. -
transLcl(required):
string(date-time)
Title:
Transaction Date Time Local
The date and time the point of sale waste was entered in the location's timezone.First Available Version: 20.1.9.6
-
transUTC(required):
string(date-time)
Title:
Transaction Date Time in UTC
The date and time the point of sale waste was entered as a UTC time -
ttl:
number
Title:
Amount
Total amount of the waste. This attribute will not be returned in the response if value is null -
weight(required):
number
Title:
Weight
Weight of the waste. This attribute will not be returned in the response if value is null
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
object
Exception 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
Exception 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
Exception 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
Exception 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
Exception 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 get the point of sale waste details for a specified location and 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/getPOSWasteDetails
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:
{ "curUTC": "2020-10-20T16:42:42", "locRef": "1234", "busDt": "2020-07-20", "revenueCenters": [{ "rvcNum": 1372, "menuItems": [{ "miNum": 123, "rsnCodeNum": 12, "empNum": 123, "qty": 2.23, "weight": 1.15, "amt": 12.56, "cost": 10.32, "prcLvl": 1, "transUTC": "2019-07-20T15:59:59", "transLcl": "2019-07-20T11:59:59" }] }] }