Flipdish · Schema

RevenueDetail

Sales information

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
OnlineSalesAmount number Online sales amount
OnlineSalesTax number Online sales tax
OnlineSalesIncludingTax number Online sales amount plus online sales tax
OnlineSalesFeesBaseAmount number Online sales base amount to calculate fees
CashSalesAmount number Cash sales amount
CashSalesTax number Cash sales tax
CashSalesIncludingTax number Cash sales amount plus online sales tax
CashSalesFeesBaseAmount number Online sales base amount to calculate fees
TotalSalesIncludingTax number Total Sales (online and cash) including tax
OnlineSalesDeliveryCharges number Delivery charges on online sales
OnlineSalesTips number Tips for online sales
TotalOnlineRevenue number Online sales plus online delivery charges and tips
OnlineSalesServiceCharges number Service charge on online sales
View JSON Schema on GitHub

JSON Schema

payments-revenue-detail-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/payments-revenue-detail-schema.json",
  "title": "RevenueDetail",
  "description": "Sales information",
  "type": "object",
  "properties": {
    "OnlineSalesAmount": {
      "format": "double",
      "description": "Online sales amount",
      "type": "number",
      "example": 12.5
    },
    "OnlineSalesTax": {
      "format": "double",
      "description": "Online sales tax",
      "type": "number",
      "example": 1.0
    },
    "OnlineSalesIncludingTax": {
      "format": "double",
      "description": "Online sales amount plus online sales tax",
      "type": "number",
      "example": 1.0
    },
    "OnlineSalesFeesBaseAmount": {
      "format": "double",
      "description": "Online sales base amount to calculate fees",
      "type": "number",
      "example": 12.5
    },
    "CashSalesAmount": {
      "format": "double",
      "description": "Cash sales amount",
      "type": "number",
      "example": 12.5
    },
    "CashSalesTax": {
      "format": "double",
      "description": "Cash sales tax",
      "type": "number",
      "example": 1.0
    },
    "CashSalesIncludingTax": {
      "format": "double",
      "description": "Cash sales amount plus online sales tax",
      "type": "number",
      "example": 1.0
    },
    "CashSalesFeesBaseAmount": {
      "format": "double",
      "description": "Online sales base amount to calculate fees",
      "type": "number",
      "example": 12.5
    },
    "TotalSalesIncludingTax": {
      "format": "double",
      "description": "Total Sales (online and cash) including tax",
      "type": "number",
      "example": 12.5
    },
    "OnlineSalesDeliveryCharges": {
      "format": "double",
      "description": "Delivery charges on online sales",
      "type": "number",
      "example": 1.0
    },
    "OnlineSalesTips": {
      "format": "double",
      "description": "Tips for online sales",
      "type": "number",
      "example": 1.0
    },
    "TotalOnlineRevenue": {
      "format": "double",
      "description": "Online sales plus online delivery charges and tips",
      "type": "number",
      "example": 12.5
    },
    "OnlineSalesServiceCharges": {
      "format": "double",
      "description": "Service charge on online sales",
      "type": "number",
      "example": 1.0
    }
  }
}