Mindbody · Schema

Sale

Implementation of the 'Sale' model. Contains the Sale details.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
Id	integer	The sale ID.
SaleDate	string	The date the item was sold.
SaleTime	string	The time the item was sold.
SaleDateTime	string	The date and time the item was sold.
OriginalSaleDateTime	string	The date and time the item was sold originally.
SalesRepId	integer	The sales representative ID
ClientId	string	The ID of the client who made the purchase.
RecipientClientId	integer	Recipient Client Id
PurchasedItems	array	Contains the `PurchasedItem` objects that describe the purchased items.
LocationId	integer	The ID of the location where the sale takes place.
Payments	array	Contains the `SalePayment` objects that describe the payments that contributed to this sale.

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-sale-schema.json",
  "title": "Sale",
  "description": "Implementation of the 'Sale' model. Contains the Sale details.",
  "type": "object",
  "properties": {
    "Id": {
      "type": "integer",
      "format": "int32",
      "description": "The sale ID.",
      "example": 123456
    },
    "SaleDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date the item was sold.",
      "example": "2026-05-28T14:30:00Z"
    },
    "SaleTime": {
      "type": "string",
      "description": "The time the item was sold.",
      "example": "example-value"
    },
    "SaleDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the item was sold.",
      "example": "2026-05-28T14:30:00Z"
    },
    "OriginalSaleDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the item was sold originally.",
      "example": "2026-05-28T14:30:00Z"
    },
    "SalesRepId": {
      "type": "integer",
      "format": "int32",
      "description": "The sales representative ID",
      "example": 123456
    },
    "ClientId": {
      "type": "string",
      "description": "The ID of the client who made the purchase.",
      "example": "example-value"
    },
    "RecipientClientId": {
      "type": "integer",
      "format": "int32",
      "description": "Recipient Client Id",
      "example": 123456
    },
    "PurchasedItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PurchasedItem"
      },
      "description": "Contains the `PurchasedItem` objects that describe the purchased items.",
      "example": [
        {}
      ]
    },
    "LocationId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of the location where the sale takes place.",
      "example": 123456
    },
    "Payments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SalePayment"
      },
      "description": "Contains the `SalePayment` objects that describe the payments that contributed to this sale.",
      "example": [
        {}
      ]
    }
  }
}