Mindbody · Schema

SalePayment

Implementation of the 'SalePayment' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name Type Description
Id integer A unique identifier for this payment.
Amount number The total amount of sales that were made on the sale date, including all payment methods that were used and taxes that were collected.
Method integer The method used to make this payment.
Type string The payment method type used for the client’s purchase.
Notes string Payment notes that are entered under the selected payment method in the Retail screen before completing the sale.
TransactionId integer The ID of transaction. Use this ID when calling the GET Transactions endpoint.
View JSON Schema on GitHub

JSON Schema

public-api-v6-sale-payment-schema.json Raw ↑ 
{
  "$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-payment-schema.json",
  "title": "SalePayment",
  "description": "Implementation of the 'SalePayment' model.",
  "type": "object",
  "properties": {
    "Id": {
      "type": "integer",
      "format": "int32",
      "description": "A unique identifier for this payment.",
      "example": 123456
    },
    "Amount": {
      "type": "number",
      "format": "double",
      "description": "The total amount of sales that were made on the sale date, including all payment methods that were used and taxes that were collected.",
      "example": 49.99
    },
    "Method": {
      "type": "integer",
      "format": "int32",
      "description": "The method used to make this payment.",
      "example": 1
    },
    "Type": {
      "type": "string",
      "description": "The payment method type used for the client\u2019s purchase.",
      "example": "example-value"
    },
    "Notes": {
      "type": "string",
      "description": "Payment notes that are entered under the selected payment method in the Retail screen before completing the sale.",
      "example": "Example note for Mindbody Public API."
    },
    "TransactionId": {
      "type": "integer",
      "format": "int32",
      "description": "The ID of transaction. Use this ID when calling the GET Transactions endpoint.",
      "example": 123456
    }
  }
}