Get non-sales transaction details
post
/bi/v1/{orgIdentifier}/getNonSalesTransactions
Gets all the non-sales transaction for a specified location that occurred for a specified business date or for a specified business date and also after a specified calendar date and time
Request
Path Parameters
-
orgIdentifier: string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : nonSlsRequestPayload
Type:
objectRequest payload for non-sales transactions
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 DateBusiness date associated with the non sales transaction. -
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 -
transSinceUTC(optional):
string(date-time)
Title:
Transaction Date Time in UTCReport all non-sales transaction activity that has occurred since this UTC date and time for the specified business date.If this object is not included, return all non-sales transaction activity for the specified business date.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : nonSlsTransactionDetails
Type:
objectThe response body contains information about the non sales transactions for the specified location and business date.
Show Source
-
busDt:
string(date)
Title:
Business DateBusiness date or reopen closed check closed business date. -
curUTC(optional):
string(date-time)
Title:
Current Date Time in UTCThe current UTC date and time when the request is made -
locRef:
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
nonSalesTransactions:
array Non-Sales Transactions
Title:
Non-Sales TransactionsAn array of non sales transactions
Nested Schema : Non-Sales Transactions
Type:
arrayTitle:
Non-Sales TransactionsAn array of non sales transactions
Show Source
-
Array of:
object nonSalesTransaction
The response body contains information about the non sales transactions for the specified location and business date.
Nested Schema : nonSalesTransaction
Type:
objectThe response body contains information about the non sales transactions for the specified location and business date.
Show Source
-
chkNum:
integer
Title:
Check NumberMaximum Length:16Unique identifier of the guest check associated with this transaction. This attribute will not be returned in the response if value is null -
empNum:
integer
Title:
Employee NumberMaximum Length:16Unique identifier of the employee who has entered the log -
guestCheckId:
integer
Title:
Guest Check IDMaximum Length:16Unique Id of the guest check where the non-sale transaction was recorded.This attribute will not be returned in the response if value is null -
refInfo:
string
Title:
Reference InformationMaximum Length:32Open entry reference information. This attribute will not be returned in the response if value is null -
rsnCodeNum:
integer
Title:
Reason Code NumberMaximum Length:16Unique identifier of the reason code. This attribute will not be returned in the response if value is null -
rvcNum:
integer
Title:
Revenue center numberMaximum Length:99Revenue Center number -
tmedNum:
integer
Title:
Tender Media NumberMaximum Length:16For types 3 and 4 this is the tender/media number. For other types this object is absent. This attribute will not be returned in the response if type of transaction is not equal 3 or 4 -
transLcl:
string(date-time)
Title:
Transaction Date Time LocalThe date and time this transaction was entered in location's timezone.First Available Version: 20.1.9.6
-
transType:
integer
Title:
Transaction typeMaximum Length:3The type of the transaction.The following are the different transaction types that could be returned:
1 = Training
2 = No Sale
3 = Paid In
4 = Paid Out
5 = Cancel -
transUTC:
string(date-time)
Title:
Transaction Date Time in UTCThe UTC date and time this transaction was entered. -
value:
number
Title:
ValueThe value of the non-sales transaction. -
wsNum:
integer
Title:
Workstation NumberMaximum Length:16Unique identifier of the workstation
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 non-sales transaction details for a specified location and business date after a given date time 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","transSinceUTC":"2020-10-20T16:00:00"} https://baseurl/bi/v1/orgidentifier/getNonSalesTransactions
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-20T17:59:59",
"locRef": "1234",
"busDt": "2019-10-20",
"nonSalesTransactions":[{
"transUTC": "2020-10-20T16:16:10",
"transLcl": "2020-10-20T12:16:10",
"transType": 4,
"tmedNum": 3691,
"chkNum": 414798,
"empNum": 6128,
"wsNum": 354,
"value": 1234.56,
"refInfo": "This is an example",
"rsnCodeNum": 2632,
"guestCheckId": 1234,
"rvcNum": 123
}]
}