Sustema

ENTITY developer reference

ICQuoteEntity

Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.

This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.

This is the public candidate schema reading view. Read it with the operation that uses it; a representable field does not establish enabled coverage or entitlement.

Explicit price for every attainable qualifying subset, including none=0. Existing ownership and applicable incremental bundle credit are fixed in the quote digest; no provider attempt line is billable. All-owned or entirely unavailable lines have the sole empty qualifying subset at zero new units.

Declared type: "object"

Declared fields

This list shows only properties declared directly in this schema. Required labels refer only to this schema’s own required array. Referenced, composed and conditional rules can add constraints; a field not listed as required here is not guaranteed to be optional.

quote_line_id

Listed in this schema’s required array.

Declared type
"string"
Declared format
"uuid"
Reading definition for quote_line_id
{
  "type": "string",
  "format": "uuid",
  "x-profile-maxLength": "string_characters_max"
}

subject

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for subject
{
  "$ref": "#/components/schemas/SubjectRef"
}

client_references

Listed in this schema’s required array.

Declared type
"array"
Reading definition for client_references
{
  "type": "array",
  "items": {
    "type": "string",
    "minLength": 1,
    "maxLength": 120,
    "x-profile-maxLength": "string_characters_max"
  },
  "minItems": 1,
  "x-profile-maxItems": "quote_entities_max"
}

targets

Listed in this schema’s required array.

Declared type
"array"
Reading definition for targets
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ICQuoteTarget"
  },
  "minItems": 1,
  "maxItems": 2,
  "x-profile-maxItems": "collection_items_max"
}

outcome_prices

Listed in this schema’s required array.

Declared type
"array"
Reading definition for outcome_prices
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ICOutcomePrice"
  },
  "minItems": 1,
  "maxItems": 9,
  "x-profile-maxItems": "collection_items_max"
}

maximum_new_units

Listed in this schema’s required array.

Declared type
"string"
Reading definition for maximum_new_units
{
  "type": "string",
  "pattern": "^(0|[1-9][0-9]*)$",
  "maxLength": 30,
  "x-profile-maxLength": "string_characters_max"
}

recognised_prior_acquisitions

Listed in this schema’s required array.

Declared type
"array"
Reading definition for recognised_prior_acquisitions
{
  "type": "array",
  "items": {
    "type": "string",
    "format": "uuid",
    "x-profile-maxLength": "string_characters_max"
  },
  "minItems": 0,
  "maxItems": 2,
  "x-profile-maxItems": "collection_items_max"
}

Schema reading view

Read all retained constraints, including any allOf, oneOf, anyOf, conditional and additional-property constraints. The field list does not combine branches. Explicitly marked private-only omissions mean this view is not an executable substitute for the original schema or a released contract.

{
  "type": "object",
  "properties": {
    "quote_line_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "subject": {
      "$ref": "#/components/schemas/SubjectRef"
    },
    "client_references": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120,
        "x-profile-maxLength": "string_characters_max"
      },
      "minItems": 1,
      "x-profile-maxItems": "quote_entities_max"
    },
    "targets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ICQuoteTarget"
      },
      "minItems": 1,
      "maxItems": 2,
      "x-profile-maxItems": "collection_items_max"
    },
    "outcome_prices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ICOutcomePrice"
      },
      "minItems": 1,
      "maxItems": 9,
      "x-profile-maxItems": "collection_items_max"
    },
    "maximum_new_units": {
      "type": "string",
      "pattern": "^(0|[1-9][0-9]*)$",
      "maxLength": 30,
      "x-profile-maxLength": "string_characters_max"
    },
    "recognised_prior_acquisitions": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "x-profile-maxLength": "string_characters_max"
      },
      "minItems": 0,
      "maxItems": 2,
      "x-profile-maxItems": "collection_items_max"
    }
  },
  "required": [
    "quote_line_id",
    "subject",
    "client_references",
    "targets",
    "outcome_prices",
    "maximum_new_units",
    "recognised_prior_acquisitions"
  ],
  "additionalProperties": false,
  "description": "Explicit price for every attainable qualifying subset, including none=0. Existing ownership and applicable incremental bundle credit are fixed in the quote digest; no provider attempt line is billable. All-owned or entirely unavailable lines have the sole empty qualifying subset at zero new units."
}

Related schemas

All API operations