Get invoice transactions
post
/bi/v1/{orgIdentifier}/getFiscalInvoiceData
Get all the Fiscal invoice 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 : fiscalInvoiceData
Type:
objectThe response body contains information about the fiscal invoice 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 invoice data by reveneue centers
Nested Schema : Revenue Centers
Type:
arrayTitle:
Revenue CentersAn array of fiscal invoice data by reveneue centers
Show Source
-
Array of:
object fiscalInvoiceDataByRVC
The response body contains fiscal invoice data about a revenue center for the specified location.
Nested Schema : fiscalInvoiceDataByRVC
Type:
objectThe response body contains fiscal invoice data about a revenue center for the specified location.
Show Source
-
invoiceData(required):
array Invoice Data
Title:
Invoice DataAn array of fiscal invoice data for a revenue center. This attribute will not be returned in the response if value is null -
rvcNum(required):
integer
Title:
Revenue center numberMaximum Length:10Revenue Center number. This attribute will not be returned in the response if invoiceData is null
Nested Schema : Invoice Data
Type:
arrayTitle:
Invoice DataAn array of fiscal invoice data for a revenue center. This attribute will not be returned in the response if value is null
Show Source
-
Array of:
object fiscalInvoiceDataObj
The response body contains fiscal invoice data of a revenue center for the specified location.
Nested Schema : fiscalInvoiceDataObj
Type:
objectThe response body contains fiscal invoice data of a revenue center for the specified location.
Show Source
-
checkNum(required):
integer
Title:
Check NumberMaximum Length:10Optional Check number -
customerDataNum(required):
string
Title:
Customer Data NumberMaximum Length:20The unque reference of customer data. This attribute will not be returned in the response if value is null.First Available Version: 20.1.10
-
dataType(required):
string
Title:
Data TypeMaximum Length:10Country / Transaction specific value. This attribute will not be returned in the response if value is null -
deviceIdentifier(required):
string
Title:
Device IdentifierMaximum Length:50Country / Transaction specific value. This attribute will not be returned in the response if value is null -
documentType(required):
string
Title:
Dociment TypeMaximum Length:10Country / Transaction specific value. This attribute will not be returned in the response if value is null -
extraDate1(required):
string(date-time)
Title:
Extra Date 1Country / Transaction specific value. This attribute will not be returned in the response if value is null -
extraDate2(required):
string(date-time)
Title:
Extra Date 2Country / Transaction specific value. This attribute will not be returned in the response if value is null -
extraDate3(required):
string(date-time)
Title:
Extra Date 3Country / Transaction specific value. This attribute will not be returned in the response if value is null -
extraDate4(required):
string(date-time)
Title:
Extra Date 4Country / Transaction specific value. This attribute will not be returned in the response if value is null -
extraDate5(required):
string(date-time)
Title:
Extra Date 5Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrBusinessDate:
string(date)
Title:
FCR Business DateDevice Business date, Country / Transaction specific value -
fcrIdentifier(required):
integer
Title:
FCR IdentifierMaximum Length:10Country / Transaction specific value. This attribute will not be returned in the response if value is null -
fcrInvNum(required):
string
Title:
FCR Invoice NumberMaximum Length:50Country / Transaction specific value -
fiscalKey(required):
string
Title:
Fiscal KeyMaximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
guestCheckId(required):
integer
Title:
Guest Check IDMaximum Length:16The unique identifier of the guest check -
invDataInfo1(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 -
invDataInfo10(required):
string
Title:
Invoice Data Info 10Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invDataInfo11(required):
string
Title:
Invoice Data Info 11Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invDataInfo12(required):
string
Title:
Invoice Data Info 12Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invDataInfo13(required):
string
Title:
Invoice Data Info 13Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invDataInfo14(required):
string
Title:
Invoice Data Info 14Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invDataInfo15(required):
string
Title:
Invoice Data Info 15Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invDataInfo16(required):
string
Title:
Invoice Data Info 16Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invDataInfo2(required):
string
Title:
Invoice Data Info 2Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invDataInfo3(required):
string
Title:
Invoice Data Info 3Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invDataInfo4(required):
string
Title:
Invoice Data Info 4Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invDataInfo5(required):
string
Title:
Invoice Data Info 5Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invDataInfo6(required):
string
Title:
Invoice Data Info 6Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invDataInfo7(required):
string
Title:
Invoice Data Info 7Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invDataInfo8(required):
string
Title:
Invoice Data Info 8Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invDataInfo9(required):
string
Title:
Invoice Data Info 9Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invoiceStatus(required):
integer
Title:
Invoice StatusMaximum Length:3Country / Transaction specific value -
invoiceType(required):
integer
Title:
Invoice TypeMaximum Length:3Country / Transaction specific value -
json:
json object
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
-
opnBusDt(required):
string(date)
Title:
Open Business DateOptional business date the guest check was opened. -
storeIdentifier(required):
integer
Title:
Store IdentifierMaximum Length:10Country / Transaction specific value. This attribute will not be returned in the response if value is null -
subTotal1(required):
number
Title:
Subtotal 1Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
subTotal10(required):
number
Title:
Subtotal 10Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
subTotal11(required):
number
Title:
Subtotal 11Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
subTotal12(required):
number
Title:
Subtotal 12Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
subTotal13(required):
number
Title:
Subtotal 13Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
subTotal14(required):
number
Title:
Subtotal 14Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
subTotal2(required):
number
Title:
Subtotal 2Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
subTotal3(required):
number
Title:
Subtotal 3Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
subTotal4(required):
number
Title:
Subtotal 4Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
subTotal5(required):
number
Title:
Subtotal 5Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
subTotal6(required):
number
Title:
Subtotal 6Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
subTotal7(required):
number
Title:
Subtotal 7Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
subTotal8(required):
number
Title:
Subtotal 8Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
subTotal9(required):
number
Title:
Subtotal 9Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
sysDocIdentifier(required):
number
Title:
System Document IdentifierCountry / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
taxTotal1(required):
number
Title:
Tax Total 1Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
taxTotal10(required):
number
Title:
Tax Total 10Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
taxTotal11(required):
number
Title:
Tax Total 11Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
taxTotal12(required):
number
Title:
Tax Total 12Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
taxTotal13(required):
number
Title:
Tax Total 13Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
taxTotal14(required):
number
Title:
Tax Total 14Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
taxTotal15(required):
number
Title:
Tax Total 15Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
taxTotal16(required):
number
Title:
Tax Total 16Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
taxTotal2(required):
number
Title:
Tax Total 2Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
taxTotal3(required):
number
Title:
Tax Total 3Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
taxTotal4(required):
number
Title:
Tax Total 4Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
taxTotal5(required):
number
Title:
Tax Total 5Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
taxTotal6(required):
number
Title:
Tax Total 6Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
taxTotal7(required):
number
Title:
Tax Total 7Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
taxTotal8(required):
number
Title:
Tax Total 8Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
taxTotal9(required):
number
Title:
Tax Total 9Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null -
wsNum(required):
integer
Title:
Workstation NumberMaximum Length:16Workstation Number. 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:
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:
objectError 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:
objectError 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:
objectError 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:
objectError 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 Invoice 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/getFiscalInvoiceData
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,
"invoiceData":[{
"wsNum": 23,
"fcrInvNum": "INV01",
"customerDataNum": "CUST123",
"opnBusDt": "2019-07-19",
"checkNum": 414798,
"guestCheckId": 123,
"invoiceType": 1,
"invoiceStatus": 1,
"fcrBusinessDt": "2019-07-19",
"subTotal1": 1234.56,
"subTotal2": 1234.56,
"subTotal3": 1234.56,
"subTotal4": 1234.56,
"subTotal5": 1234.56,
"subTotal6": 1234.56,
"subTotal7": 1234.56,
"subTotal8": 1234.56,
"subTotal9": 1234.56,
"subTotal10": 1234.56,
"subTotal11": 1234.56,
"subTotal12": 1234.56,
"subTotal13": 1234.56,
"subTotal14": 1234.56,
"taxTotal1": 1234.56,
"taxTotal2": 1234.56,
"taxTotal3": 1234.56,
"taxTotal4": 1234.56,
"taxTotal5": 1234.56,
"taxTotal6": 1234.56,
"taxTotal7": 1234.56,
"taxTotal8": 1234.56,
"taxTotal9": 1234.56,
"taxTotal10": 1234.56,
"taxTotal11": 1234.56,
"taxTotal12": 1234.56,
"taxTotal13": 1234.56,
"taxTotal14": 1234.56,
"taxTotal15": 1234.56,
"taxTotal16": 1234.56,
"invDataInfo1": "Inv Info",
"invDataInfo2": "Inv Info",
"invDataInfo3": "Inv Info",
"invDataInfo4": "Inv Info",
"invDataInfo5": "Inv Info",
"invDataInfo6": "Inv Info",
"invDataInfo7": "Inv Info",
"invDataInfo8": "Inv Info",
"invDataInfo9": "Inv Info",
"invDataInfo10": "Inv Info",
"invDataInfo11": "Inv Info",
"invDataInfo12": "Inv Info",
"invDataInfo13": "Inv Info",
"invDataInfo14": "Inv Info",
"invDataInfo15": "Inv Info",
"invDataInfo16": "Inv Info",
"fcrIdentifier": 987,
"storeIdentifier": 654,
"deviceIdentifier": "ID01",
"documentType": "D01",
"dataType": "T01",
"sysDocIdentifier": 1234.56,
"fiscalKey": "KEY01",
"json": "[{Country / Transaction specific fiscal data}]",
"extraDate1": "2019-07-01T13:00:00",
"extraDate2": "2019-07-01T13:00:00",
"extraDate3": "2019-07-01T13:00:00",
"extraDate4": "2019-07-01T13:00:00",
"extraDate5": "2019-07-01T13:00:00"
}]
}]
}