Business Intelligence API Guide

All REST Endpoints

Aggregations/Daily Aggregations

Daily Aggregations description.

Get combo item daily totals: Method: post
Path: /bi/v1/{orgIdentifier}/getComboItemDailyTotals
Get control daily totals: Method: post
Path: /bi/v1/{orgIdentifier}/getControlDailyTotals
Get discount daily totals: Method: post
Path: /bi/v1/{orgIdentifier}/getDiscountDailyTotals
Get employee daily totals: Method: post
Path: /bi/v1/{orgIdentifier}/getEmployeeDailyTotals
Get job code daily totals: Method: post
Path: /bi/v1/{orgIdentifier}/getJobCodeDailyTotals
Get menu item daily totals: Method: post
Path: /bi/v1/{orgIdentifier}/getMenuItemDailyTotals
Get operations daily totals: Method: post
Path: /bi/v1/{orgIdentifier}/getOperationsDailyTotals
Get order channel daily totals: Method: post
Path: /bi/v1/{orgIdentifier}/getOrderChannelDailyTotals
Get order type daily totals: Method: post
Path: /bi/v1/{orgIdentifier}/getOrderTypeDailyTotals
Get service charge daily totals: Method: post
Path: /bi/v1/{orgIdentifier}/getServiceChargeDailyTotals
Get tax daily totals: Method: post
Path: /bi/v1/{orgIdentifier}/getTaxDailyTotals
Get tender media daily totals: Method: post
Path: /bi/v1/{orgIdentifier}/getTenderMediaDailyTotals

Aggregations/Quarter Hour Aggregations

Quarter Hour Aggregations description.

Get combo item quarter hour totals: Method: post
Path: /bi/v1/{orgIdentifier}/getComboItemQuarterHourTotals
Get discount quarter hour totals: Method: post
Path: /bi/v1/{orgIdentifier}/getDiscountQuarterHourTotals
Get job code quarter hour totals: Method: post
Path: /bi/v1/{orgIdentifier}/getJobCodeQuarterHourTotals
Get menu item quarter hour totals: Method: post
Path: /bi/v1/{orgIdentifier}/getMenuItemQuarterHourTotals
Get operations quarter hour totals: Method: post
Path: /bi/v1/{orgIdentifier}/getOperationsQuarterHourTotals
Get order type quarter hour totals: Method: post
Path: /bi/v1/{orgIdentifier}/getOrderTypeQuarterHourTotals
Get service charge quarter hour totals: Method: post
Path: /bi/v1/{orgIdentifier}/getServiceChargeQuarterHourTotals
Get tender media quarter hour totals: Method: post
Path: /bi/v1/{orgIdentifier}/getTenderMediaQuarterHourTotals

Cash Management

Contains different operational totals w.r.t. Cash Management

Get details: Method: post
Path: /bi/v1/{orgIdentifier}/getCashManagementDetails

Fiscal Transactions

Fiscal transactions

Get invoice control data: Method: post
Path: /bi/v1/{orgIdentifier}/getFiscalInvoiceControlData
Get invoice transactions: Method: post
Path: /bi/v1/{orgIdentifier}/getFiscalInvoiceData
Get total transactions: Method: post
Path: /bi/v1/{orgIdentifier}/getFiscalTotalData

Kitchen Performance

Contains kitchen performance details

Get kitchen display system details: Method: post
Path: /bi/v1/{orgIdentifier}/getKDSDetails

Labor

Contains Labor details

Get time card details: Method: post
Path: /bi/v1/{orgIdentifier}/getTimeCardDetails

Payment Dimensions

Contains definitions of different Payment Dimensions

Get payment account holders: Method: post
Path: /bi/v1/{orgIdentifier}/getPaymentAccountHolderDimensions
Get payments account details: Method: post
Path: /bi/v1/{orgIdentifier}/getPaymentAccountDimensions

Payment Transactions

Contains definitions of different Payment Transactions

Get payment chargeback details: Method: post
Path: /bi/v1/{orgIdentifier}/getPaymentChargebacks
Get payment payout details: Method: post
Path: /bi/v1/{orgIdentifier}/getPaymentPayouts
Get payment settlement details: Method: post
Path: /bi/v1/{orgIdentifier}/getPaymentSettlements
Get payment transaction details: Method: post
Path: /bi/v1/{orgIdentifier}/getPaymentTransactions
Get payments payout summary: Method: post
Path: /bi/v1/{orgIdentifier}/getPaymentPayoutSummary

Point of Sale Dimensions

Contains definitions of different Point of Sale dimensions

Get cash management item: Method: post
Path: /bi/v1/{orgIdentifier}/getCashManagementItemDimensions
Get cashiers: Method: post
Path: /bi/v1/{orgIdentifier}/getCashierDimensions
Get discount dimensions: Method: post
Path: /bi/v1/{orgIdentifier}/getDiscountDimensions
Get Employee Dimensions: Method: post
Path: /bi/v1/{orgIdentifier}/getEmployeeDimensions
Get job codes: Method: post
Path: /bi/v1/{orgIdentifier}/getJobCodeDimensions
Get latest business date: Method: post
Path: /bi/v1/{orgIdentifier}/getLatestBusDt
Get location information: Method: post
Path: /bi/v1/{orgIdentifier}/getLocationDimensions
Get menu item prices: Method: post
Path: /bi/v1/{orgIdentifier}/getMenuItemPrices
Get menu items: Method: post
Path: /bi/v1/{orgIdentifier}/getMenuItemDimensions
Get order channels: Method: post
Path: /bi/v1/{orgIdentifier}/getOrderChannelDimensions
Get order types: Method: post
Path: /bi/v1/{orgIdentifier}/getOrderTypeDimensions
Get reason codes: Method: post
Path: /bi/v1/{orgIdentifier}/getReasonCodeDimensions
Get revenue centers: Method: post
Path: /bi/v1/{orgIdentifier}/getRevenueCenterDimensions
Get service charges: Method: post
Path: /bi/v1/{orgIdentifier}/getServiceChargeDimensions
Get taxes: Method: post
Path: /bi/v1/{orgIdentifier}/getTaxDimensions
Get tender media: Method: post
Path: /bi/v1/{orgIdentifier}/getTenderMediaDimensions

Transactions

Various transactions w.r.t. guest checks, non sale, point of sale journal logs, extensibility

Get guest check extensibility details: Method: post
Path: /bi/v1/{orgIdentifier}/getGuestCheckExtensibilityDetails
Get guest check line item extensibility details: Method: post
Path: /bi/v1/{orgIdentifier}/getGuestCheckLineItemExtDetails
Get guest checks: Method: post
Path: /bi/v1/{orgIdentifier}/getGuestChecks
Get non-sales transaction details: Method: post
Path: /bi/v1/{orgIdentifier}/getNonSalesTransactions
Get point of sale journal log details: Method: post
Path: /bi/v1/{orgIdentifier}/getPOSJournalLogDetails
Get point of sale waste details: Method: post
Path: /bi/v1/{orgIdentifier}/getPOSWasteDetails
Get SPI payment details: Method: post
Path: /bi/v1/{orgIdentifier}/getSPIPaymentDetails