Flipdish · Schema

PayoutOrder

Holds the information for an order related to a payout

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
OrderId integer The id of the order
PayoutId integer The id of the payout the order is related to
OrderDate string The date the order was placed
OrderType string Order type (online or cash)
OrderCurrency string Order currency
Sales number Order sales amount
SalesTax number Order sales tax amount
DeliveryCharges number Order delivery charges
Tips number Order tips amount
Voucher number Order voucher amount
FlatFeeExcludingVat number Order flat fee amount excluding VAT
FlatFeeExcludingVAT number Order flat fee amount excluding VAT
FlatFeeIncludingVat number Order flat fee amount including VAT
PercentageFeeExcludingVat number Order percentage fee excluding VAT
PercentageFeeExcludingVAT number Order percentage fee excluding VAT
Vat number Order VAT amount
TotalFees number Total order fees amount
CashFeeChargedToCustomer number Cash fee charged to customer
NetSales number Order net sales amount
StoreId integer Store id
ServiceChargeAmount number Order ServiceChargeAmount amount
ServiceChargePercentage number Order ServiceChargePercentage amount
View JSON Schema on GitHub

JSON Schema

payments-payout-order-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-payout-order-schema.json",
  "title": "PayoutOrder",
  "description": "Holds the information for an order related to a payout",
  "type": "object",
  "properties": {
    "OrderId": {
      "format": "int32",
      "description": "The id of the order",
      "type": "integer",
      "example": 500123
    },
    "PayoutId": {
      "format": "int32",
      "description": "The id of the payout the order is related to",
      "type": "integer",
      "example": 500123
    },
    "OrderDate": {
      "format": "date-time",
      "description": "The date the order was placed",
      "type": "string",
      "example": "2026-06-02T12:00:00Z"
    },
    "OrderType": {
      "description": "Order type (online or cash)",
      "enum": [
        "Cash",
        "Online"
      ],
      "type": "string",
      "example": "Cash"
    },
    "OrderCurrency": {
      "description": "Order currency",
      "enum": [
        "EUR",
        "USD",
        "GBP",
        "CAD",
        "AUD",
        "DJF",
        "ZAR",
        "ETB",
        "AED",
        "BHD",
        "DZD",
        "EGP",
        "IQD",
        "JOD",
        "KWD",
        "LBP",
        "LYD",
        "MAD",
        "OMR",
        "QAR",
        "SAR",
        "SYP",
        "TND",
        "YER",
        "CLP",
        "INR",
        "AZN",
        "RUB",
        "BYN",
        "BGN",
        "NGN",
        "BDT",
        "CNY",
        "BAM",
        "CZK",
        "DKK",
        "CHF",
        "MVR",
        "BTN",
        "XCD",
        "BZD",
        "HKD",
        "IDR",
        "JMD",
        "MYR",
        "NZD",
        "PHP",
        "SGD",
        "TTD",
        "XDR",
        "ARS",
        "BOB",
        "COP",
        "CRC",
        "CUP",
        "DOP",
        "GTQ",
        "HNL",
        "MXN",
        "NIO",
        "PAB",
        "PEN",
        "PYG",
        "UYU",
        "VEF",
        "IRR",
        "XOF",
        "CDF",
        "XAF",
        "HTG",
        "ILS",
        "HRK",
        "HUF",
        "AMD",
        "ISK",
        "JPY",
        "GEL",
        "KZT",
        "KHR",
        "KRW",
        "KGS",
        "LAK",
        "MKD",
        "MNT",
        "BND",
        "MMK",
        "NOK",
        "NPR",
        "PKR",
        "PLN",
        "AFN",
        "BRL",
        "MDL",
        "RON",
        "RWF",
        "SEK",
        "LKR",
        "SOS",
        "ALL",
        "RSD",
        "KES",
        "TJS",
        "THB",
        "ERN",
        "TMT",
        "BWP",
        "TRY",
        "UAH",
        "UZS",
        "VND",
        "MOP",
        "TWD",
        "BMD"
      ],
      "type": "string",
      "example": "EUR"
    },
    "Sales": {
      "format": "double",
      "description": "Order sales amount",
      "type": "number",
      "example": 1.0
    },
    "SalesTax": {
      "format": "double",
      "description": "Order sales tax amount",
      "type": "number",
      "example": 1.0
    },
    "DeliveryCharges": {
      "format": "double",
      "description": "Order delivery charges",
      "type": "number",
      "example": 1.0
    },
    "Tips": {
      "format": "double",
      "description": "Order tips amount",
      "type": "number",
      "example": 1.0
    },
    "Voucher": {
      "format": "double",
      "description": "Order voucher amount",
      "type": "number",
      "example": 1.0
    },
    "FlatFeeExcludingVat": {
      "format": "double",
      "description": "Order flat fee amount excluding VAT",
      "type": "number",
      "example": 12.5
    },
    "FlatFeeExcludingVAT": {
      "format": "double",
      "description": "Order flat fee amount excluding VAT",
      "type": "number",
      "example": 12.5
    },
    "FlatFeeIncludingVat": {
      "format": "double",
      "description": "Order flat fee amount including VAT",
      "type": "number",
      "example": 12.5
    },
    "PercentageFeeExcludingVat": {
      "format": "double",
      "description": "Order percentage fee excluding VAT",
      "type": "number",
      "example": 12.5
    },
    "PercentageFeeExcludingVAT": {
      "format": "double",
      "description": "Order percentage fee excluding VAT",
      "type": "number",
      "example": 12.5
    },
    "Vat": {
      "format": "double",
      "description": "Order VAT amount",
      "type": "number",
      "example": 1.0
    },
    "TotalFees": {
      "format": "double",
      "description": "Total order fees amount",
      "type": "number",
      "example": 12.5
    },
    "CashFeeChargedToCustomer": {
      "format": "double",
      "description": "Cash fee charged to customer",
      "type": "number",
      "example": 12.5
    },
    "NetSales": {
      "format": "double",
      "description": "Order net sales amount",
      "type": "number",
      "example": 1.0
    },
    "StoreId": {
      "format": "int32",
      "description": "Store id",
      "type": "integer",
      "example": 500123
    },
    "ServiceChargeAmount": {
      "format": "double",
      "description": "Order ServiceChargeAmount amount",
      "type": "number",
      "example": 12.5
    },
    "ServiceChargePercentage": {
      "format": "double",
      "description": "Order ServiceChargePercentage amount",
      "type": "number",
      "example": 1.0
    }
  }
}