{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/dassault/json-schema/order_sub_line.json",
  "title": "Order Sub Line",
  "type": "object",
  "description": "Details of License Charge Breakdown.\nIt is also interchangably called as Sub-Line Item.\n",
  "properties": {
    "sequenceNumber": {
      "type": "integer",
      "description": "The sequence number used to identify the license charge breakdown item.\nIt is an integer autogenerated by system, between 1 and 999.\n",
      "minimum": 1,
      "maximum": 999,
      "example": 1
    },
    "installedBaseNumber": {
      "$ref": "#/components/schemas/installed_base_number"
    },
    "subOrderType": {
      "$ref": "#/components/schemas/sub_order_type"
    },
    "revenueType": {
      "$ref": "#/components/schemas/order_revenue_type"
    },
    "portfolio": {
      "type": "string",
      "description": "The portfolio to which the product being ordered belongs.\nThis field identifies the specific product family or category to which the ordered product belongs.\nFor example, a product might belong to a portfolio such as \"CATIA\", \"ENOVIA\", or \"SIMULIA\".\n",
      "maxLength": 50,
      "example": "CATIA"
    },
    "release": {
      "type": "string",
      "description": "The name of the product release being ordered.\nThis field identifies the specific version of the product to which the ordered product belongs.\nFor example, a product might belong to a release such as \"3DEXPERIENCE R2025x\", \"SOLIDWORKS 2025\", or \"V5-6R2025\".\n",
      "maxLength": 50,
      "example": "3DEXPERIENCE R2025x"
    },
    "product": {
      "type": "object",
      "description": "This field identifies the specific product that is being ordered.\n",
      "properties": {
        "trigram": {
          "type": "string",
          "description": "The trigram code for the product being ordered.\n",
          "maxLength": 10,
          "example": "XYZ"
        },
        "type": {
          "$ref": "#/components/schemas/product_type"
        },
        "number": {
          "type": "string",
          "description": "The product number.\n",
          "maxLength": 20,
          "example": "1AB-XYZ"
        },
        "name": {
          "type": "string",
          "description": "The name of the product.\nThis field specifies the title or label of the product.\n",
          "maxLength": 200,
          "example": "Generic Product Standard with Cloud Services"
        },
        "dsOffering": {
          "$ref": "#/components/schemas/ds_offering"
        }
      }
    },
    "quantity": {
      "type": "integer",
      "description": "The quantity of the product being ordered.\n",
      "minimum": 1,
      "example": 2
    },
    "unitListPrice": {
      "type": "number",
      "format": "float",
      "description": "The price listed by the Finance Department for the product being ordered.\n\nThis field represents the standard price of a single unit of the product, as approved by the Finance Department.\n",
      "example": 1000
    },
    "totalListPrice": {
      "type": "number",
      "format": "float",
      "description": "The total price of the product licenses, calculated by multiplying the `Unit List Price` and the `Quantity`.\n\nThis field represents the total cost of the product licenses, taking into account the number of units purchased.\n",
      "example": 2000
    },
    "billToNetAmount": {
      "type": "number",
      "format": "float",
      "description": "The actual amount payable by the Bill To Site for the selected product.\n\nThis field represents the total cost of the product or service, including any applicable taxes, fees, or discounts.\n",
      "example": 1930
    },
    "billToAnnualAmount": {
      "type": "number",
      "format": "float",
      "description": "The total amount payable by the Bill To Site for the full year.\n\nThis field represents the annual cost of the product or service, taking into account any usage periods that are not a full year.\n\nNote that there may be a difference between `Bill To Net Amount` and `Bill To Annual Amount` when the product is not purchased for a full year of usage.\n",
      "example": 1930
    },
    "billToDiscountPercentage": {
      "type": "number",
      "format": "float",
      "description": "The discount percentage applicable to the `Total List Price`.\n\nThis field represents the percentage reduction in the total list price, as a decimal value (e.g. 3.5 represents 3.5%).\n",
      "example": 3.5
    },
    "billToMarginPercentage": {
      "type": "number",
      "format": "float",
      "description": "The percentage difference between the discount price offered by Dassault Syst\u00e8mes and the Partner Bill To Site.\n\nThis field represents the margin earned by the Partner Bill To Site, calculated as a percentage of the discount price.\n\nNote: This field is pre-filled according to the percentage value set inside the Distributor Discount Model section of the GVA Agreement.\n\nAdditionally, note that this field is related to `Bill to Discount Percentage`, which represents the percentage reduction in the `Total List Price`.\n",
      "example": 1.5
    },
    "maximumCustomerNetAmount": {
      "type": "number",
      "format": "float",
      "description": "The actual amount payable by the Final Customer Site for the selected product.\n\nThis field represents the maximum net amount that the Final Customer Site is responsible for paying, taking into account any applicable discounts or fees.\n",
      "example": 1958.95
    },
    "maximumCustomerAnnualAmount": {
      "type": "number",
      "format": "float",
      "description": "The total amount payable by the Final Customer Site for the full year.\n\nThis field represents the annual cost of the product or service, taking into account any usage periods that are not a full year.\n\nNote that there may be a difference between `Maximum Customer Net Amount` and `Maximum Customer Annual Amount` when the product is not purchased for a full year of usage.\n",
      "example": 1958.95
    },
    "minimumCustomerDiscountPercentage": {
      "type": "number",
      "format": "float",
      "description": "The minimum discount percentage that the Partner Bill To Site offers to the Final Customer for the selected product.\n\nThis field represents the lowest percentage discount that the Partner Bill To Site is willing to offer to the Final Customer, as a decimal value (e.g. 0.5 represents 0.5%).\n",
      "example": 0.5
    },
    "startDate": {
      "type": "string",
      "description": "The start date of the product or service, in ISO 8601 format (YYYY-MM-DD).\n",
      "format": "date",
      "example": "2025-06-01"
    },
    "endDate": {
      "type": "string",
      "description": "The end date of the product or service, in ISO 8601 format (YYYY-MM-DD).\n",
      "example": "2026-05-31"
    },
    "duration": {
      "type": "integer",
      "description": "The duration for which the product or service is intended to be used.\n\nThe unit of duration depends on the `Revenue Type`:\n\n- If `Revenue Type` is ALC (Annual License Charge), then the duration is measured in years. For example, a duration of 2 represents 2 years.\n- If `Revenue Type` is QLC (Quarterly License Charge), then the duration is measured in quarters. For example, a duration of 2 represents 2 quarters.\n",
      "example": 2
    },
    "calculatedStartDate": {
      "type": "string",
      "description": "This field is automatically calculated by the system. Format: ISO 8601 format (YYYY-MM-DD).\n\nIt is based on one of the following dates:\n\n- The user-entered `Start Date`\n- The `CRAD (Customer Requested Arrival Date)`\n- The `Finance Approved` date of the order\n",
      "format": "date",
      "example": "2025-06-01"
    },
    "calculatedEndDate": {
      "type": "string",
      "description": "This field is automatically calculated by the system. Format: ISO 8601 format (YYYY-MM-DD).\n\nIt is based on one of the following values:\n\n- `First Year Co-Terminus`: The end date of the first year of the contract.\n- End date of the Duration calculated from 'calculatedStartDate' or entered by the user\n",
      "format": "date",
      "example": "2026-06-31"
    },
    "yearNumber": {
      "type": "integer",
      "description": "This field represents the product usage `Year Number` for multi-year orders.\n\nIt is used to identify the specific year of a multi-year contract.\n",
      "example": 1
    },
    "coupon": {
      "type": "object",
      "description": "Details of the discount coupon applied to the final price.\n",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the discount coupon.\n",
          "maxLength": 40,
          "example": "10% off on Installation Fee"
        },
        "discountPercentage": {
          "type": "number",
          "format": "float",
          "description": "The discount percentage that will be applied to final price.\n",
          "example": 10
        }
      }
    },
    "inflation": {
      "type": "object",
      "description": "Details about the inflation rate applied to the price of the product.\nThe inflation occurs when it is the case of product renewals.\n",
      "properties": {
        "date": {
          "type": "string",
          "description": "The date since when the inflation rate is applicable.\nThis date should be in the format `YYYY-MM-DD`.\n",
          "format": "date",
          "example": "2025-07-01"
        },
        "ratio": {
          "type": "number",
          "format": "float",
          "description": "The multiplication factor applied to the price.\nFor example, a ratio of `1.04` indicates a 4% price increase applied.\n",
          "example": 1.04
        },
        "exception": {
          "type": "string",
          "description": "Any exception applied while calculating the inflated amount.\n",
          "enum": [
            "Capping To Price List",
            "No Price Increase",
            "No Cap. Lower than Price List"
          ],
          "example": "Capping To Price List"
        }
      }
    }
  }
}