VirtualAccountCommissionDetails

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/slash/main/json-schema/slash-virtual-account-commission-details-schema.json",
  "title": "VirtualAccountCommissionDetails",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/slash-virtual-account-api-openapi.yml#/components/schemas/VirtualAccountCommissionDetails",
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "flatFee"
          ],
          "description": "The type of the commission rule. A type of flat_fee will take a flat fee from the virtual account and transfer it to the primary account\nwith the frequency of the collection defined as monthly or yearly.\n"
        },
        "amount": {
          "$ref": "#/$defs/Money",
          "description": "The amount of money to be diverted from the virtual account if the type of rule is flat_fee.",
          "x-entrypoint": {
            "virtualPath": "schemas/Money",
            "sourcePath": "schemas/Money.yaml",
            "title": "Money",
            "origin": "./src/publicApi"
          }
        },
        "frequency": {
          "type": "string",
          "enum": [
            "monthly",
            "yearly"
          ],
          "description": "The frequency from the start date that the rule will be applied. E.g. a start date of November 26, 2024 with a frequency of \"monthly\"\nwill have the rule applied on December 26, 2024. If the frequency was \"yearly\", the rule would be applied again on November 26, 2025.\n"
        },
        "startDate": {
          "type": "string",
          "format": "date-time",
          "description": "The date that the rule will begin to take effect."
        }
      },
      "required": [
        "type",
        "frequency",
        "amount"
      ]
    },
    {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "takeRate"
          ],
          "description": "The type of the commission rule. A type of take_rate will take a percent of the virtual account's funds and divert them to\nthe primary account.\n"
        },
        "takeRate": {
          "type": "number",
          "description": "The percentage of funds to divert from the virtual account to the primary account."
        }
      },
      "required": [
        "type",
        "takeRate"
      ]
    }
  ],
  "x-entrypoint": {
    "virtualPath": "schemas/VirtualAccountCommissionDetails",
    "sourcePath": "schemas/VirtualAccountCommissionDetails.yaml",
    "title": "VirtualAccountCommissionDetails",
    "origin": "./src/publicApi"
  },
  "$defs": {
    "Money": {
      "type": "object",
      "description": "Represents a monetary value",
      "properties": {
        "amountCents": {
          "type": "integer",
          "description": "The amount in cents"
        }
      },
      "required": [
        "amountCents"
      ],
      "x-entrypoint": {
        "virtualPath": "schemas/Money",
        "sourcePath": "schemas/Money.yaml",
        "title": "Money",
        "origin": "./src/publicApi"
      },
      "title": "Money"
    }
  }
}