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
Body ()
The request body defines the details of the API request.
Root Schema : POSWasteDetailsrequestPayload
Type: object
Request payload
Show Source
  • Title: Application Name
    Maximum Length: 128
    The name of the application which is accessing the API.

    First Available Version: 20.1.10

  • Title: Business Date
    Business date of the transaction
  • Title: Include
    Maximum Length: 2000
    List of objects to include in response
  • Title: Location Reference
    Maximum Length: 99
    The location reference, this may be a store number or name depending on the organization
  • Title: Search Criteria
    Maximum Length: 2000
    Search criteria to filter results based on field value
  • 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

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
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
Nested Schema : revenueCenters
Type: array
An array of point of sale waste details by reveneue centers
Show Source
Nested Schema : posWasteDetailsByRVC
Type: object
The response body contains point of sale waste details for a revenue center
Show Source
  • menuItems
    An array of point of sale waste details for a revenue center. This attribute will not be returned in the response if value is null
  • 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 : menuItems
Type: array
An array of point of sale waste details for a revenue center. This attribute will not be returned in the response if value is null
Show Source
Nested Schema : wasteDetail
Type: object
The response body contains the point of sale waste details associated with a revenue center
Show Source
  • Title: Quantity
    Quantity of the waste. This attribute will not be returned in the response if value is null
  • Title: Employee Number
    Maximum Length: 16
    Unique identifier of the employee who has entered the waste detail.
  • Title: Menu Item ID
    Maximum Length: 16
    The unique identifier of the menu item
  • 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
  • Title: Cost
    Preparation cost associated with the waste. This attribute will not be returned in the response if value is null
  • Title: Reason Code Number
    Maximum Length: 16
    The unique identifier reason code.
  • 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

  • Title: Transaction Date Time in UTC
    The date and time the point of sale waste was entered as a UTC time
  • Title: Amount
    Total amount of the waste. This attribute will not be returned in the response if value is null
  • Title: Weight
    Weight of the waste. This attribute will not be returned in the response if value is null

400 Response

Bad Request
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source

401 Response

Unauthorized
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source

403 Response

Service Unavailable
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source

404 Response

Resource Not Found
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source

Default Response

Unexpected Error
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source
Back to Top

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"
   }]
 }]
}
Back to Top