Get point of sale journal log details
post
/bi/v1/{orgIdentifier}/getPOSJournalLogDetails
Get all the Point of Sale Journal Log details for a specified location and business date.
Request
Path Parameters
-
orgIdentifier: string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : requestPayload
Type:
objectRequest payload
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
-
busDt:
string(date)
Title:
Business DateThe business date associated with the cash management detail -
include(optional):
string
Title:
IncludeMaximum Length:2000List of objects to include in response -
locRef:
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
searchCriteria(optional):
string
Title:
Search CriteriaMaximum Length:2000Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : posJournalLogDetails
Type:
objectThe response body contains information about the point of sale journal log details for the specified location and business date.
Show Source
-
busDt:
string(date)
Title:
Business DateThe business date associated with the point of sale journal log -
locRef:
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
revenueCenters:
array revenueCenters
An array of point of sale journal log details by reveneue centers
Nested Schema : revenueCenters
Type:
arrayAn array of point of sale journal log details by reveneue centers
Show Source
-
Array of:
object posJournalLogDetailsByRVC
The response body contains point of sale journal log details for a revenue center
Nested Schema : posJournalLogDetailsByRVC
Type:
objectThe response body contains point of sale journal log details for a revenue center
Show Source
-
logDetails:
array logDetails
An array of point of sale journal log details for a revenue center. This attribute will not be returned in the response if value is null
-
rvcNum:
integer
Title:
Revenue center numberMaximum Length:99Revenue Center number. This attribute will not be returned in the response if logDetails is null
Nested Schema : logDetails
Type:
arrayAn array of point of sale journal log details for a revenue center. This attribute will not be returned in the response if value is null
Show Source
-
Array of:
object logDetails
The response body contains the point of sale journal log details associated with a revenue center
Nested Schema : logDetails
Type:
objectThe response body contains the point of sale journal log details associated with a revenue center
Show Source
-
empNum:
integer
Title:
Employee NumberMaximum Length:16Unique identifier of the employee who has entered the log. This attribute will not be returned in the response if value is null -
guestCheckId:
integer
Title:
Guest Check IDMaximum Length:16The unique identifier of the guest check -
journalTxt:
string
Title:
Journal textMaximum Length:99Journal text of the log. This attribute will not be returned in the response if value is null -
transId:
integer
Title:
Transaction IDMaximum Length:16Unique identifier of the transaction log. This attribute will not be returned in the response if value is null -
transLcl(optional):
string(date-time)
Title:
Transaction Date Time LocalThe date and time the POS journal log was entered in location's timezone.First Available Version: 20.1.9.6
-
transUTC:
string(date-time)
Title:
Transaction Date Time in UTCThe date and time the POS journal log was entered as a UTC time -
type:
integer
Title:
TypeMaximum Length:16The type of the log -
wsNum:
integer
Title:
Workstation NumberMaximum Length:16Unique identifier of the workstation. This attribute will not be returned in the response if value is 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 point of sale journal log 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/getPOSJournalLogDetails
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-10-20",
"revenueCenters":[{
"rvcNum": 1372,
"logDetails":[{
"guestCheckId": 123,
"type": 1,
"transId": 1,
"transUTC": "2019-10-20T15:59:59",
"transLcl": "2019-10-20T11:59:59",
"journalTxt": "Journal Text",
"wsNum": 123,
"empNum": 1234
}]
}]
}