API Response Documentation

Root Properties

• openCheckCount: The total number of open checks.
  
• variablePriceItemsCount: The total number of items with variable pricing.
  
• hourly: An array of objects, where each object contains hourly sales and operational data. Each object includes:
  • paidoutCount: The number of paid outs during the specified hour.
    
  • refundCount: The number of refunds processed during the specified hour.
    
  • giftCardAmount: The total value of gift cards sold during the specified hour.
    
  • discountCount: The number of discounts applied during the specified hour.
    
  • discountAmount: The total value of discounts applied during the specified hour.
    
  • giftCardCount: The total number of gift cards sold during the specified hour.
    
  • variablePriceItemsSales: Total sales value of items with variable prices.
    
  • hour: The hour (in 24-hour format) for which the data is recorded.
    
  • laborMinutes: Total labor minutes worked during the specified hour.
    
  • itemsOrderedCount: The number of items ordered during the specified hour.
    
  • paidoutAmount: Total value of paid outs during the specified hour.
    
  • returnItemCount: The number of returned items during the specified hour.
    
  • closedCheckNetCash: Total cash value of closed checks for the hour.
    
  • refundAmount: Total refund amount processed during the specified hour.
    
  • closedAverageCheckTotal: Average value of closed checks during the specified hour.
    
  • returnItemAmount: Total value of returned items during the specified hour.
    
  • netSales: The net sales for the hour.
    
  • voidedItemCount: The total number of voided items during the specified hour.
    
  • laborPercentage: The percentage of labor cost relative to sales.
    
  • itemsOrderTotal: The total value of items ordered.
    
  • reopenedCheckCount: The number of checks reopened during the specified hour.
    
  • voidedItemTotal: Total value of voided items during the specified hour.
    
  • newCheckCount: The number of new checks created during the specified hour.
    
  • laborCost: The total cost of labor during the specified hour.
    
  • newCheckGuestCount: The total number of guests on new checks during the specified hour.
    
  • closedCheckCount: The number of closed checks during the specified hour.
    
• gratuityCount: Total count of gratuities processed.
  
• firstCheckAt: Timestamp for when the first check was opened.
  
• discountCount: Total count of discounts applied.
  
• guestCount: The total number of guests served.
  
• giftCardCount: Total number of gift cards sold.
  
• advanceAmount: The total amount of advance payments.
  
• tipsPaidOut: The total amount of tips paid out to employees.
  
• voidCount: The total count of voided transactions.
  
• outOfStockItemsCount: The total number of items out of stock.
  
• voidAmount: The total value of voided transactions.
  
• laborSalaryCost: The total salary cost for labor.
  
• paidoutAmount: The total amount paid out.
  
• firstClockInAt: Timestamp of the first employee clocking in.
  
• giftCardAmount: The total value of gift cards sold.
  
• averageGuest: The average amount spent per guest.
  
• depositAmount: The total amount deposited.
  
• kitchenPerformance: An array of performance metrics related to kitchen operations (empty in this case).
  
• tipsRetained: The total amount of tips retained by the business.
  
• employees: An array of objects, where each object contains information about an employee:
  • total: Total sales made by the employee.
    
  • cost: Labor cost associated with the employee.
    
  • discountCount: Number of discounts applied by the employee.
    
  • name: Employee's name.
    
  • count: The count of transactions or items processed by the employee.
    
  • id: The unique identifier for the employee.
    
  • type: The role or type of the employee (e.g., employee).
    
  • tips: The total amount of tips earned by the employee.
    
• grossCash: Total cash sales.
  
• averageKitchenBumpDurationSeconds: Average time (in seconds) for kitchen orders to be completed (bumped).
  
• averageCheck: The average check total.
  
• tenders: An array of objects, where each object contains information about payment tenders:
  • name: The name of the payment tender (e.g., Credit, Cash).
    
  • count: The total number of transactions processed using this tender.
    
  • total: The total value of transactions processed using this tender.
    
  • id: The unique identifier for the payment tender.
    
  • type: The type of tender (e.g., paymentTender).
    
  • tips: The total amount of tips associated with this tender.
    
• taxInclusiveTotal: Total sales amount including tax.
  
• lastTransactionAt: Timestamp of the last transaction.
  
• paidoutCount: The total count of paid outs.
  
• grossSalesTotal: The total gross sales.
  
• trackingItemsCount: Total count of items being tracked (for stock management).
  
• refundAmount: The total amount refunded.
  
• outOfStockItemIds: An array of IDs for items that are out of stock.
  
• returnItemCount: The total count of returned items.
  
• depositCount: The number of deposits made.
  
• countdownItemIds: An array of IDs for items that are on countdown.
  
• gratuityTotal: Total amount of gratuities.
  
• laborCost: Total cost of labor.
  
• menuItems: An array of objects, where each object contains information about menu items:
  • total: Total sales for the item.
    
  • discountTotal: Total value of discounts applied to the item.
    
  • voidTotal: Total value of voided sales for the item.
    
  • discountCount: Number of discounts applied to the item.
    
  • name: The name of the menu item.
    
  • count: The number of items sold.
    
  • id: The unique identifier for the menu item.
    
  • type: The type of item (e.g., menuItem).
    
  • voidCount: The number of voided transactions for the item.
    
• firstClockInEmployeeId: The ID of the employee who clocked in first.
  
• venueId: The unique identifier for the venue.
  
• reopenedCheckCount: The number of reopened checks.
  
• checkCount: The total number of checks.
  
• laborPercentage: The percentage of labor cost relative to total sales.
  
• checkOpenAverageSeconds: The average time (in seconds) that checks remain open.
  
• countdownItemsCount: The total count of countdown items.
  
• netCash: The total net cash balance.
  
• jobs: An array of objects, where each object contains information about job roles:
  • total: Total sales made by the role.
    
  • cost: Labor cost associated with the role.
    
  • discountCount: Number of discounts applied by this role.
    
  • name: The name of the job role (e.g., Kitchen, Server).
    
  • count: The count of transactions or items processed by the role.
    
  • id: The unique identifier for the job role.
    
  • type: The type of role (e.g., job).
    
  • tips: The total amount of tips earned by this role.
    
• variablePriceItemsSales: Total sales value of items with variable pricing.
  
• businessDate: The business date for the data.
  
• taxExclusiveTotal: The total sales amount excluding tax.
  
• refundCount: The total number of refunds.
  
• missingBeverageCount: The count of missing beverage items.
  
• discountAmount: Total discount amount applied.
  
• tipFee: The total tip fee, if applicable.
  
• taxTotal: The total tax amount.
  
• salesCategories: An array of objects representing different sales categories, each containing:
  • total: Total sales amount for the category.
    
  • discountTotal: Total discount amount applied to the category.
    
  • voidTotal: Total value of voided transactions for the category.
    
  • discountCount: Total number of discounts applied to the category.
    
  • name: The name of the sales category (e.g., Food, Wine).
    
  • count: The total number of items sold in the category.
    
  • id: The unique identifier for the sales category.
    
  • type: The type of sales category (e.g., salesCategory).
    
  • voidCount: The total number of voided transactions in the category.
    
• netSales: Total net sales.
  
• returnItemAmount: The total value of returned items.