Get total transactions
post
/bi/v1/{orgIdentifier}/getFiscalTotalData
Get all the Fiscal total transactions for a specified location that occurred for a specified 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:
objectRequest payload
Show Source
-
applicationName:
string
Title:
Application NameMaximum Length:128The name of the application which is accessing the API.First Available Version: 20.1.10
-
busDt(required):
string(date)
Title:
Business DateThe business date associated with the cash management detail -
include:
string
Title:
IncludeMaximum Length:2000List of objects to include in response -
locRef(required):
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
searchCriteria:
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 : fiscalTotalData
Type:
objectThe response body contains information about the fiscal totals for the specified location.
Show Source
-
busDt(required):
string(date)
Title:
Business DateBusiness Date -
locRef(required):
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
revenueCenters(required):
array Revenue Centers
Title:
Revenue CentersAn array of fiscal total data by reveneue centers
Nested Schema : Revenue Centers
Type:
arrayTitle:
Revenue CentersAn array of fiscal total data by reveneue centers
Show Source
-
Array of:
object fiscalTotalDataByRVC
The response body contains fiscal total data about a revenue center for the specified location.
Nested Schema : fiscalTotalDataByRVC
Type:
objectThe response body contains fiscal total data about a revenue center for the specified location.
Show Source
-
rvcNum(required):
integer
Title:
Revenue center numberMaximum Length:10Revenue Center number. This attribute will not be returned in the response if totalData is null -
totalData(required):
array Total Data
Title:
Total DataAn array of fiscal total data for a revenue center. This attribute will not be returned in the response if value is null
Nested Schema : Total Data
Type:
arrayTitle:
Total DataAn array of fiscal total data for a revenue center. This attribute will not be returned in the response if value is null
Show Source
-
Array of:
object fiscalTotalDataObj
The response body contains fiscal total data of a revenue center for the specified location.
Nested Schema : fiscalTotalDataObj
Type:
objectThe response body contains fiscal total data of a revenue center for the specified location.
Show Source
-
fcrBusDt(required):
string(date)
Title:
FCR Business DateDevice Business date, Country / Transaction specific value -
fcrInfo1(required):
string
Title:
Invoice Data Info 1Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrInfo10(required):
string
Title:
FCR Info 10Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrInfo11(required):
string
Title:
FCR Info 11Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrInfo12(required):
string
Title:
FCR Info 12Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrInfo13(required):
string
Title:
FCR Info 13Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrInfo14(required):
string
Title:
FCR Info 14Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrInfo15(required):
string
Title:
FCR Info 15Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrInfo16(required):
string
Title:
FCR Info 16Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrInfo2(required):
string
Title:
FCR Info 2Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrInfo3(required):
string
Title:
FCR Info 3Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrInfo4(required):
string
Title:
FCR Info 4Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrInfo5(required):
string
Title:
FCR Info 5Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrInfo6(required):
string
Title:
FCR Info 6Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrInfo7(required):
string
Title:
FCR Info 7Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrInfo8(required):
string
Title:
FCR Info 8Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrInfo9(required):
string
Title:
FCR Info 9Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrNum1(required):
string
Title:
FCR Number 1Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrNum2(required):
string
Title:
FCR Number 2Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
json:
object Country / Transaction specific fiscal data in Json
Title:
Country / Transaction specific fiscal data in JsonCountry / Transaction specific fiscal data represented in JSON format. This attribute will not be returned in the response if value is null.First Available Version: 20.1.12
-
wsNum(required):
integer
Title:
Workstation NumberMaximum Length:16Workstation Number. This attribute will not be returned in the response if value is null
Nested Schema : Country / Transaction specific fiscal data in Json
Type:
objectTitle:
Country / Transaction specific fiscal data in JsonCountry / Transaction specific fiscal data represented in JSON format. This attribute will not be returned in the response if value is null.
First Available Version: 20.1.12
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Examples
The following example shows how to view Fiscal Total Data 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/getFiscalTotalData
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": "2019-07-19",
"revenueCenters":[{
"rvcNum": 1372,
"totalData":[{
"wsNum": 23,
"fcrBusDt": "2019-07-19",
"fcrNum1": "Num1",
"fcrNum2": "Num2",
"fcrInfo1": "Info",
"fcrInfo2": "Info",
"fcrInfo3": "Info",
"fcrInfo4": "Info",
"fcrInfo5": "Info",
"fcrInfo6": "Info",
"fcrInfo7": "Info",
"fcrInfo8": "Info",
"fcrInfo9": "Info",
"fcrInfo10": "Info",
"fcrInfo11": "Info",
"fcrInfo12": "Info",
"fcrInfo13": "Info",
"fcrInfo14": "Info",
"fcrInfo15": "Info",
"fcrInfo16": "Info"
"json": "[{Country / Transaction specific fiscal data}]",
}]
}]
}