Get invoice control data
post
/bi/v1/{orgIdentifier}/getFiscalInvoiceControlData
Get all the Fiscal invoice control data 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 : fiscalControlData
Type:
objectThe response body contains information about the fiscal invoice control data 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 control data by reveneue centers
Nested Schema : Revenue Centers
Type:
arrayTitle:
Revenue CentersAn array of fiscal invoice control data by reveneue centers
Show Source
-
Array of:
object fiscalControlDataByRVC
The response body contains fiscal invoice control data about a revenue center for the specified location.
Nested Schema : fiscalControlDataByRVC
Type:
objectThe response body contains fiscal invoice control data about a revenue center for the specified location.
Show Source
-
invoiceControlData(required):
array Control Data
Title:
Control DataAn array of fiscal control 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 invoiceControlData is null
Nested Schema : Control Data
Type:
arrayTitle:
Control DataAn array of fiscal control data for a revenue center. This attribute will not be returned in the response if value is null
Show Source
-
Array of:
object fiscalInvoiceControlData
The response body contains fiscal inovice control data of a revenue center for the specified location.
Nested Schema : fiscalInvoiceControlData
Type:
objectThe response body contains fiscal inovice control data of a revenue center for the specified location.
Show Source
-
currInvNum(required):
integer
Title:
Current Invoice NumberMaximum Length:19Country / Transaction specific value of the current invoice number -
endInvNum(required):
integer
Title:
End Invoice NumberMaximum Length:19Country / Transaction specific value of the end invoice number -
invcontrolInfo1(required):
string
Title:
Invoice Control Info 1Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invcontrolInfo10(required):
string
Title:
Invoice Control Info 10Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invcontrolInfo11(required):
string
Title:
Invoice Control Info 11Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invcontrolInfo12(required):
string
Title:
Invoice Control Info 12Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invcontrolInfo2(required):
string
Title:
Invoice Control Info 2Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invcontrolInfo3(required):
string
Title:
Invoice Control Info 3Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invcontrolInfo4(required):
string
Title:
Invoice Control Info 4Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invcontrolInfo5(required):
string
Title:
Invoice Control Info 5Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invcontrolInfo6(required):
string
Title:
Invoice Control Info 6Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invcontrolInfo7(required):
string
Title:
Invoice Control Info 7Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invcontrolInfo8(required):
string
Title:
Invoice Control Info 8Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invcontrolInfo9(required):
string
Title:
Invoice Control Info 9Maximum Length:100Country / Transaction specific value. This attribute will not be returned in the response if value is null -
invoiceType(required):
integer
Title:
Invoice TypeMaximum Length:3Country / Transaction specific value of the Invoice Type -
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
-
lockedBy(required):
integer
Title:
Locked ByMaximum Length:5Country / Transaction specific value of the id of the locked by -
resolutionDt(required):
string(date)
Title:
Resolution DateDevice Business date, Country / Transaction specific value of the resolution date -
series(required):
string
Title:
SeriesMaximum Length:3Country / Transaction specific value of the series. This attribute will not be returned in the response if value is null -
startInvNum(required):
integer
Title:
Start Invoice NumberMaximum Length:19Country / Transaction specific value of the start invoice number -
status(required):
integer
Title:
StatusMaximum Length:3Country / Transaction specific value of the status -
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 Control 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/getFiscalInvoiceControlData
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-20",
"revenueCenters":[{
"rvcNum": 1372,
"invoiceControlData":[{
"wsNum": 23,
"invoiceType": 1,
"series": "S01",
"startInvNum": 1,
"endInvNum": 99999999,
"status": 0,
"currInvNum": 8877,
"lockedBy": 0,
"resolutionDt": "2019-07-01",
"invcontrolInfo1": "Control Info",
"invcontrolInfo2": "Control Info",
"invcontrolInfo3": "Control Info",
"invcontrolInfo4": "Control Info",
"invcontrolInfo5": "Control Info",
"invcontrolInfo6": "Control Info",
"invcontrolInfo7": "Control Info",
"invcontrolInfo8": "Control Info",
"invcontrolInfo9": "Control Info",
"invcontrolInfo10": "Control Info",
"invcontrolInfo11": "Control Info",
"invcontrolInfo12": "Control Info"
"invcontrolInfo12": "Control Info"
"json": "[{Country / Transaction specific fiscal data}]",
}]
}]
}