Flipdish · Schema

UserMonthlyCommission

User Monthly Commission

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
UserId integer The unique identifier of the user.
MonthStart string The start date of the month for which the commission is calculated.
CommissionAmount number The total commission amount for the user in the specified month.
Currency string The currency in which the commission is paid.
IsoCurrency string The ISO currency code for the commission currency.
View JSON Schema on GitHub

JSON Schema

customers-user-monthly-commission-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/customers-user-monthly-commission-schema.json",
  "title": "UserMonthlyCommission",
  "description": "User Monthly Commission",
  "type": "object",
  "properties": {
    "UserId": {
      "format": "int32",
      "description": "The unique identifier of the user.",
      "type": "integer",
      "example": 500123
    },
    "MonthStart": {
      "format": "date-time",
      "description": "The start date of the month for which the commission is calculated.",
      "type": "string",
      "example": "2026-06-02T12:00:00Z"
    },
    "CommissionAmount": {
      "format": "double",
      "description": "The total commission amount for the user in the specified month.",
      "type": "number",
      "example": 12.5
    },
    "Currency": {
      "description": "The currency in which the commission is paid.",
      "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"
    },
    "IsoCurrency": {
      "description": "The ISO currency code for the commission currency.",
      "type": "string",
      "example": "EUR"
    }
  }
}