Order Line

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/dassault/json-schema/order_line.json",
  "title": "Order Line",
  "type": "object",
  "description": "Details of License Charge Condition.\nThis object is also interchangably called as Line Item.\n",
  "properties": {
    "sequenceNumber": {
      "type": "integer",
      "description": "The sequence number used to identify the line item.\nIt is an integer autogenerated by system, between 1 and 999.\n",
      "minimum": 1,
      "maximum": 999,
      "example": 1
    },
    "lineGroup": {
      "type": "string",
      "description": "Unique identifier of license charge condition. This is used to group together the Installed Base sub-lines.\n",
      "maxLength": 15,
      "example": "SBL0001234567"
    },
    "onlineInstanceSeatId": {
      "$ref": "#/components/schemas/online_instance_seat_id"
    },
    "orderType": {
      "$ref": "#/components/schemas/order_type"
    },
    "usageScope": {
      "type": "string",
      "description": "Defines the geographical or territorial scope in which the product can be used,\nas specified in the associated agreement details. This may refer to a region (e.g., GEO)\nor a specific country.\n",
      "maxLength": 80,
      "example": "GEO EMEA"
    },
    "promotion": {
      "type": "object",
      "description": "Promotion information.\nThis object contains information about the promotion applied to the order.\nThe promotion object contains information about the promotion, including its name, ID, and combination of one or more products.\n",
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier of the promotion.\nThe ID is a 15-character string that starts with \"PAO\" followed by a sequence of numbers.\nThe numbers are generated by the system and are used to identify the promotion.\nThe ID is unique within the instance and is used to track and manage the promotion.\n",
          "maxLength": 10,
          "example": "PAO0000111"
        },
        "name": {
          "type": "string",
          "description": "Name of the promotion.\nThe name is a human-readable description of the promotion.\nThe name is used to identify the promotion and to display it to the user.\n",
          "maxLength": 100,
          "example": "3DEXPERIENCE for small and medium business"
        },
        "combination": {
          "type": "string",
          "description": "The human-readable name of the combination that represents specific grouping of products.\nThe combination is usually one or more products from one or multiple portfolios.\nA combination can be thought of as a \"bundle\" of products that are sold together, or as a \"package\" of products that are related in some way.\n",
          "maxLength": 100,
          "example": "Collaborative Design & Engineering Learning @Home"
        }
      }
    },
    "waiver": {
      "type": "object",
      "description": "Waiver information for the license charge.\nIt can be either of `duration` or `endDate`.\n",
      "properties": {
        "duration": {
          "type": "integer",
          "description": "The number of months the order is eligible for free or discount.\nThe duration is usually a number of months.\n",
          "example": 1
        },
        "endDate": {
          "type": "string",
          "description": "The date untill which the order is eligible for free or discount.\n\nFormat: ISO 8601 (e.g., `2025-05-30`)\n",
          "format": "date",
          "example": "2025-05-30"
        }
      },
      "oneOf": [
        {
          "required": [
            "duration"
          ]
        },
        {
          "required": [
            "endDate"
          ]
        }
      ]
    },
    "licenseChargeBreakdown": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/order_sub_line"
      }
    }
  }
}