Jump to

• Request
• Response
• Examples

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: string
  Unique identifier of the organization name

Body ()

The request body defines the details of the API request.

Root Schema : requestPayload

Type: object

Request payload

Show Source

• applicationName(optional): string
  Title: Application Name

  Maximum Length: 128

  The name of the application which is accessing the API.

  First Available Version: 20.1.10

• busDt: string(date)
  Title: Business Date

  The business date associated with the cash management detail
• include(optional): string
  Title: Include

  Maximum Length: 2000

  List of objects to include in response
• locRef: string
  Title: Location Reference

  Maximum Length: 99

  The location reference, this may be a store number or name depending on the organization
• searchCriteria(optional): string
  Title: Search Criteria

  Maximum Length: 2000

  Search criteria to filter results based on field value

{
    "description":"Request payload",
    "properties":{
        "locRef":{
            "type":"string",
            "description":"The location reference, this may be a store number or name depending on the organization",
            "title":"Location Reference",
            "maxLength":99
        },
        "busDt":{
            "type":"string",
            "description":"The business date associated with the cash management detail",
            "title":"Business Date",
            "format":"date"
        },
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value",
            "title":"Search Criteria",
            "maxLength":2000
        },
        "include":{
            "type":"string",
            "description":"List of objects to include in response",
            "title":"Include",
            "maxLength":2000
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application which is accessing the API. <p>First Available Version: 20.1.10</p>",
            "title":"Application Name",
            "maxLength":128
        }
    },
    "required":[
        "locRef",
        "busDt"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : fiscalTotalData

Type: object

The response body contains information about the fiscal totals for the specified location.

Show Source

• busDt: string(date)
  Title: Business Date

  Business Date
• locRef: string
  Title: Location Reference

  Maximum Length: 99

  The location reference, this may be a store number or name depending on the organization
• revenueCenters: array Revenue Centers
  Title: Revenue Centers

  An array of fiscal total data by reveneue centers

{
    "description":"The response body contains information about the fiscal totals for the specified location.",
    "properties":{
        "locRef":{
            "type":"string",
            "description":"The location reference, this may be a store number or name depending on the organization",
            "title":"Location Reference",
            "maxLength":99
        },
        "busDt":{
            "type":"string",
            "description":"Business Date",
            "title":"Business Date",
            "format":"date"
        },
        "revenueCenters":{
            "type":"array",
            "description":"An array of fiscal total data by reveneue centers",
            "title":"Revenue Centers",
            "items":{
                "$ref":"#/definitions/fiscalTotalDataByRVC"
            }
        }
    },
    "required":[
        "locRef",
        "busDt",
        "revenueCenters"
    ]
}

Nested Schema : Revenue Centers

Type: array

Title: Revenue Centers

An 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.

{
    "type":"array",
    "description":"An array of fiscal total data by reveneue centers",
    "title":"Revenue Centers",
    "items":{
        "$ref":"#/definitions/fiscalTotalDataByRVC"
    }
}

Nested Schema : fiscalTotalDataByRVC

Type: object

The response body contains fiscal total data about a revenue center for the specified location.

Show Source

• rvcNum: integer
  Title: Revenue center number

  Maximum Length: 99

  Revenue Center number. This attribute will not be returned in the response if totalData is null
• totalData: array Total Data
  Title: Total Data

  An array of fiscal total data for a revenue center. This attribute will not be returned in the response if value is null

{
    "description":"The response body contains fiscal total data about a revenue center for the specified location.",
    "properties":{
        "rvcNum":{
            "type":"integer",
            "description":"Revenue Center number. This attribute will not be returned in the response if totalData is null",
            "title":"Revenue center number",
            "maxLength":99
        },
        "totalData":{
            "type":"array",
            "description":"An array of fiscal total data for a revenue center. This attribute will not be returned in the response if value is null",
            "title":"Total Data",
            "items":{
                "$ref":"#/definitions/fiscalTotalDataObj"
            }
        }
    },
    "required":[
        "rvcNum",
        "totalData"
    ]
}

Nested Schema : Total Data

Type: array

Title: Total Data

An 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.

{
    "type":"array",
    "description":"An array of fiscal total data for a revenue center. This attribute will not be returned in the response if value is null",
    "title":"Total Data",
    "items":{
        "$ref":"#/definitions/fiscalTotalDataObj"
    }
}

Nested Schema : fiscalTotalDataObj

Type: object

The response body contains fiscal total data of a revenue center for the specified location.

Show Source

• fcrBusDt: string(date)
  Title: FCR Business Date

  Device Business date, Country / Transaction specific value
• fcrInfo1: string
  Title: Invoice Data Info 1

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• fcrInfo10: string
  Title: FCR Info 10

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• fcrInfo11: string
  Title: FCR Info 11

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• fcrInfo12: string
  Title: FCR Info 12

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• fcrInfo13: string
  Title: FCR Info 13

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• fcrInfo14: string
  Title: FCR Info 14

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• fcrInfo15: string
  Title: FCR Info 15

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• fcrInfo16: string
  Title: FCR Info 16

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• fcrInfo2: string
  Title: FCR Info 2

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• fcrInfo3: string
  Title: FCR Info 3

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• fcrInfo4: string
  Title: FCR Info 4

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• fcrInfo5: string
  Title: FCR Info 5

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• fcrInfo6: string
  Title: FCR Info 6

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• fcrInfo7: string
  Title: FCR Info 7

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• fcrInfo8: string
  Title: FCR Info 8

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• fcrInfo9: string
  Title: FCR Info 9

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• fcrNum1: string
  Title: FCR Number 1

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• fcrNum2: string
  Title: FCR Number 2

  Maximum Length: 100

  Country / Transaction specific value. This attribute will not be returned in the response if value is null
• json(optional): json object
  Title: Country / Transaction specific fiscal data in Json

  Country / 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: integer
  Title: Workstation Number

  Maximum Length: 16

  Workstation Number. This attribute will not be returned in the response if value is null

{
    "description":"The response body contains fiscal total data of a revenue center for the specified location.",
    "properties":{
        "wsNum":{
            "type":"integer",
            "description":"Workstation Number. This attribute will not be returned in the response if value is null",
            "title":"Workstation Number",
            "maxLength":16
        },
        "fcrBusDt":{
            "type":"string",
            "description":"Device Business date, Country / Transaction specific value",
            "title":"FCR Business Date",
            "format":"date"
        },
        "fcrNum1":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"FCR Number 1",
            "maxLength":100
        },
        "fcrNum2":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"FCR Number 2",
            "maxLength":100
        },
        "fcrInfo1":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"Invoice Data Info 1",
            "maxLength":100
        },
        "fcrInfo2":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"FCR Info 2",
            "maxLength":100
        },
        "fcrInfo3":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"FCR Info 3",
            "maxLength":100
        },
        "fcrInfo4":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"FCR Info 4",
            "maxLength":100
        },
        "fcrInfo5":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"FCR Info 5",
            "maxLength":100
        },
        "fcrInfo6":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"FCR Info 6",
            "maxLength":100
        },
        "fcrInfo7":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"FCR Info 7",
            "maxLength":100
        },
        "fcrInfo8":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"FCR Info 8",
            "maxLength":100
        },
        "fcrInfo9":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"FCR Info 9",
            "maxLength":100
        },
        "fcrInfo10":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"FCR Info 10",
            "maxLength":100
        },
        "fcrInfo11":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"FCR Info 11",
            "maxLength":100
        },
        "fcrInfo12":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"FCR Info 12",
            "maxLength":100
        },
        "fcrInfo13":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"FCR Info 13",
            "maxLength":100
        },
        "fcrInfo14":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"FCR Info 14",
            "maxLength":100
        },
        "fcrInfo15":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"FCR Info 15",
            "maxLength":100
        },
        "fcrInfo16":{
            "type":"string",
            "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null",
            "title":"FCR Info 16",
            "maxLength":100
        },
        "json":{
            "type":"json object",
            "description":"Country / Transaction specific fiscal data represented in JSON format. This attribute will not be returned in the response if value is null.<p>First Available Version: 20.1.12</p>",
            "title":"Country / Transaction specific fiscal data in Json"
        }
    },
    "required":[
        "fcrBusDt",
        "wsNum",
        "fcrNum1",
        "fcrNum2",
        "fcrInfo1",
        "fcrInfo2",
        "fcrInfo3",
        "fcrInfo4",
        "fcrInfo5",
        "fcrInfo6",
        "fcrInfo7",
        "fcrInfo8",
        "fcrInfo9",
        "fcrInfo10",
        "fcrInfo11",
        "fcrInfo12",
        "fcrInfo13",
        "fcrInfo14",
        "fcrInfo15",
        "fcrInfo16"
    ]
}

400 Response

Bad Request

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail(optional): string
  Title: Error description

  The description of the error
• o:errorCode: integer
  Title: Oracle error code

  Oracle error code
• status(optional): integer
  Title: Status

  HTTP response code
• title: string
  Title: Title

  High level description of the error
• type: string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle error code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP response code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

401 Response

Unauthorized

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail(optional): string
  Title: Error description

  The description of the error
• o:errorCode: integer
  Title: Oracle error code

  Oracle error code
• status(optional): integer
  Title: Status

  HTTP response code
• title: string
  Title: Title

  High level description of the error
• type: string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle error code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP response code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

403 Response

Service Unavailable

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail(optional): string
  Title: Error description

  The description of the error
• o:errorCode: integer
  Title: Oracle error code

  Oracle error code
• status(optional): integer
  Title: Status

  HTTP response code
• title: string
  Title: Title

  High level description of the error
• type: string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle error code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP response code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

404 Response

Resource Not Found

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail(optional): string
  Title: Error description

  The description of the error
• o:errorCode: integer
  Title: Oracle error code

  Oracle error code
• status(optional): integer
  Title: Status

  HTTP response code
• title: string
  Title: Title

  High level description of the error
• type: string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle error code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP response code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

Default Response

Unexpected Error

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail(optional): string
  Title: Error description

  The description of the error
• o:errorCode: integer
  Title: Oracle error code

  Oracle error code
• status(optional): integer
  Title: Status

  HTTP response code
• title: string
  Title: Title

  High level description of the error
• type: string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle error code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP response code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

Back to Top

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}]",
  }]
 }]
}

Back to Top