Flipdish · Schema

ServiceCharge

Store Service Charge

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
StoreId integer Store identifier
PercentageValue number The Default Service Charge Value
Enabled boolean Enable Service Charge for store true(on) / false(off)
IsOptional boolean Sets the service charge to be optional
DisplayWithProcessingFee boolean Display service charge together with processing fee
IncludesVouchers boolean If true, will include voucher value in calculation i.e 10E order with 1E service charge and 5E voucher would have service charge at 0.5E
View JSON Schema on GitHub

JSON Schema

stores-service-charge-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/stores-service-charge-schema.json",
  "title": "ServiceCharge",
  "description": "Store Service Charge",
  "type": "object",
  "properties": {
    "StoreId": {
      "format": "int32",
      "description": "Store identifier",
      "type": "integer",
      "example": 500123
    },
    "PercentageValue": {
      "format": "double",
      "description": "The Default Service Charge Value",
      "type": "number",
      "example": 1.0
    },
    "Enabled": {
      "description": "Enable Service Charge for store true(on) / false(off)",
      "type": "boolean",
      "example": true
    },
    "IsOptional": {
      "description": "Sets the service charge to be optional",
      "type": "boolean",
      "example": true
    },
    "DisplayWithProcessingFee": {
      "description": "Display service charge together with processing fee",
      "type": "boolean",
      "example": true
    },
    "IncludesVouchers": {
      "description": "If true, will include voucher value in calculation \r\ni.e 10E order with 1E service charge and 5E voucher would have service charge at 0.5E",
      "type": "boolean",
      "example": true
    }
  }
}