Mindbody · Schema

CommissionPayrollPurchaseEvent

Implementation of the 'CommissionPayrollPurchaseEvent' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
StaffId	integer	The ID of the staff member who earned commissions.
SaleDateTime	string	The date and time when the sale occurred.
SaleId	integer	The sale’s ID.
SaleType	string	The Sales type. When this is "Purchase" indicates that this sale paid commission to a staff. When this is "Return"
ProductId	integer	The product ID of the item for which the staff earned commissions.
EarningsDetails	array	Contains information about which commissions the staff earned for this item.
Earnings	number	The total commissions earned by the staff for this item.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-schema/public-api-v6-commission-payroll-purchase-event-schema.json",
  "title": "CommissionPayrollPurchaseEvent",
  "description": "Implementation of the 'CommissionPayrollPurchaseEvent' model.",
  "type": "object",
  "properties": {
    "StaffId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the staff member who earned commissions.",
      "example": 123456
    },
    "SaleDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the sale occurred.",
      "example": "2026-05-28T14:30:00Z"
    },
    "SaleId": {
      "type": "integer",
      "format": "int32",
      "description": "The sale\u2019s ID.",
      "example": 123456
    },
    "SaleType": {
      "type": "string",
      "description": "The Sales type. When this is \"Purchase\" indicates that this sale paid commission to a staff. When this is \"Return\"",
      "example": "example-value"
    },
    "ProductId": {
      "type": "integer",
      "format": "int32",
      "description": "The product ID of the item for which the staff earned commissions.",
      "example": 123456
    },
    "EarningsDetails": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CommissionDetail"
      },
      "description": "Contains information about which commissions the staff earned for this item.",
      "example": [
        {}
      ]
    },
    "Earnings": {
      "type": "number",
      "format": "double",
      "description": "The total commissions earned by the staff for this item.",
      "example": 1.0
    }
  }
}