Sustema

ENTITY developer reference

ICQuote

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.

Not a funds or capacity reservation. Reads are bounded; digest covers entire entity set, prices, targets, clocks and policies. Unqualified cost/time/rights makes production acceptance unavailable; synthetic examples remain labelled. The quoted funding_expiry_rule is immutable and covered by quote_digest. Explain that earlier-expiring credits cannot fund this window; quote creation reserves nothing and no future renewal or top-up is assumed. Acceptance is a current safe projection: accepted_order_id and acceptance_state are excluded from the immutable quote content digest. Once accepted, state remains accepted even after the acceptance window ends; expiry cannot create a new order. At most one durable order per (workspace_id, environment, quote_id), across all keys and clients. Readback of the original order still requires current authority; it never accepts new terms or restarts completed/cancelled work. Retention and expiry are governed by x-classification-retention; these subject-linked schemas cannot be returned after their class(a) cutoff. Independent current-purpose and financial projections do not extend them. Both uniqueness constraints are enforced atomically in the same order/reservation transaction: (workspace,environment,client_order_reference) and (workspace,environment,quote_id). First reject a reused client reference bound to a different quote/digest/semantic body as idempotency_conflict/409 (do_not_retry, no new effect). Otherwise an already consumed identical quote returns its original owned order, even under a different unused reference/key; it preserves the originally accepted client reference and binds no new alias. A changed digest/semantic body conflicts. A reference already bound to another order never overrides the quote check. active_order_conflict is reserved for a distinct compatible-target overlap that cannot safely be coalesced, not duplicate acceptance of the same quote. Retention tombstones cannot resurrect an expired order. Incremental recognition requires current lawful prior-acquisition access, a proved original unrefunded basis and its accepted eligibility window. Only current permitted source rights can contribute a prior basis or zero-price reuse; no sibling receipt/funding identity is disclosed.

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_id

Listed in this schema’s required array.

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

quote_digest

Listed in this schema’s required array.

Declared type
"string"
Reading definition for quote_digest
{
  "type": "string",
  "pattern": "^[a-f0-9]{64}$",
  "x-profile-maxLength": "string_characters_max"
}

workspace_id

Listed in this schema’s required array.

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

environment

Listed in this schema’s required array.

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

created_at

Listed in this schema’s required array.

Declared type
"string"
Declared format
"date-time"
Reading definition for created_at
{
  "type": "string",
  "format": "date-time",
  "x-profile-maxLength": "string_characters_max"
}

expires_at

Listed in this schema’s required array.

Declared type
"string"
Declared format
"date-time"
Reading definition for expires_at
{
  "type": "string",
  "format": "date-time",
  "x-profile-maxLength": "string_characters_max"
}

latest_completion_at

Listed in this schema’s required array.

Declared type
"string"
Declared format
"date-time"
Reading definition for latest_completion_at
{
  "type": "string",
  "format": "date-time",
  "x-profile-maxLength": "string_characters_max"
}

latest_accounting_at

Listed in this schema’s required array.

Original latest accounting deadline, including settlement margin and bounded by quote.created_at plus original maximum_order_seconds; never extended on replay.

Declared type
"string"
Declared format
"date-time"
Reading definition for latest_accounting_at
{
  "type": "string",
  "format": "date-time",
  "x-profile-maxLength": "string_characters_max",
  "description": "Original latest accounting deadline, including settlement margin and bounded by quote.created_at plus original maximum_order_seconds; never extended on replay."
}

estimated_ready_from

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for estimated_ready_from
{
  "anyOf": [
    {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

estimated_ready_until

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for estimated_ready_until
{
  "anyOf": [
    {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

estimate_basis

Listed in this schema’s required array.

Route estimates use measured public route/aggregate service capacity and this owned commitment, never private subject-specific queues or other tenants' jobs.

Declared type
"string"
Reading definition for estimate_basis
{
  "type": "string",
  "enum": [
    "measured_route_and_queue",
    "not_qualified"
  ],
  "description": "Route estimates use measured public route/aggregate service capacity and this owned commitment, never private subject-specific queues or other tenants' jobs.",
  "x-profile-maxLength": "string_characters_max"
}

offer

Listed in this schema’s required array.

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

tariff_revision

Listed in this schema’s required array.

Declared type
"string"
Reading definition for tariff_revision
{
  "type": "string",
  "minLength": 1,
  "maxLength": 200,
  "x-profile-maxLength": "string_characters_max"
}

unit

Listed in this schema’s required array.

Declared type
"string"
Reading definition for unit
{
  "type": "string",
  "minLength": 1,
  "maxLength": 80,
  "x-profile-maxLength": "string_characters_max"
}

unit_scale

Listed in this schema’s required array.

Declared type
"integer"
Reading definition for unit_scale
{
  "type": "integer",
  "minimum": 1
}

credit_policy_revision

Listed in this schema’s required array.

Declared type
"string"
Reading definition for credit_policy_revision
{
  "type": "string",
  "minLength": 1,
  "maxLength": 200,
  "x-profile-maxLength": "string_characters_max"
}

requested_rows

Listed in this schema’s required array.

Declared type
"integer"
Reading definition for requested_rows
{
  "type": "integer",
  "minimum": 1,
  "maximum": 1000
}

distinct_entities

Listed in this schema’s required array.

Declared type
"integer"
Reading definition for distinct_entities
{
  "type": "integer",
  "minimum": 1,
  "maximum": 1000
}

lines

Listed in this schema’s required array.

Declared type
"array"
Reading definition for lines
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ICQuoteEntity"
  },
  "minItems": 1,
  "x-profile-maxItems": "quote_entities_max",
  "maxItems": 1000
}

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"
}

rights_and_lifecycle_digest

Listed in this schema’s required array.

Also binds every proved recognised-prior acquisition pricing_revision, original unrefunded-unit basis and current bounded window. Recheck at acceptance; changed basis gives existing quote_stale with null operation/status references. Accepted order price remains frozen.

Declared type
"string"
Reading definition for rights_and_lifecycle_digest
{
  "type": "string",
  "pattern": "^[a-f0-9]{64}$",
  "x-profile-maxLength": "string_characters_max",
  "description": "Also binds every proved recognised-prior acquisition pricing_revision, original unrefunded-unit basis and current bounded window. Recheck at acceptance; changed basis gives existing quote_stale with null operation/status references. Accepted order price remains frozen."
}

research_mode

Listed in this schema’s required array.

Declared type
"string"
Reading definition for research_mode
{
  "type": "string",
  "enum": [
    "existing_only",
    "held_or_known_site",
    "bounded_discovery"
  ],
  "x-profile-maxLength": "string_characters_max"
}

acceptance_state

Listed in this schema’s required array.

Declared type
"string"
Reading definition for acceptance_state
{
  "type": "string",
  "enum": [
    "acceptable",
    "unavailable",
    "expired",
    "replaced",
    "accepted"
  ],
  "x-profile-maxLength": "string_characters_max"
}

unavailability_reasons

Listed in this schema’s required array.

Declared type
"array"
Reading definition for unavailability_reasons
{
  "type": "array",
  "items": {
    "type": "string",
    "minLength": 1,
    "maxLength": 100,
    "x-profile-maxLength": "string_characters_max"
  },
  "minItems": 0,
  "maxItems": 16,
  "x-profile-maxItems": "collection_items_max"
}

funding_expiry_rule

Listed in this schema’s required array.

Exclude grants whose original expiry is at or before latest_accounting_at, then allocate earliest-expiring otherwise eligible grants with funding ID tie break. Preserve original expiry, scope and paid-service constraints.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for funding_expiry_rule
{
  "const": "duration_eligible_then_earliest_expiry",
  "description": "Exclude grants whose original expiry is at or before latest_accounting_at, then allocate earliest-expiring otherwise eligible grants with funding ID tie break. Preserve original expiry, scope and paid-service constraints."
}

offer_binding

Listed in this schema’s required array.

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

purpose

Listed in this schema’s required array.

Declared type
"string"
Reading definition for purpose
{
  "type": "string",
  "enum": [
    "acquisition",
    "refresh"
  ],
  "x-profile-maxLength": "string_characters_max"
}

accepted_order_id

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for accepted_order_id
{
  "anyOf": [
    {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

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_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "quote_digest": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$",
      "x-profile-maxLength": "string_characters_max"
    },
    "workspace_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "environment": {
      "$ref": "#/components/schemas/Environment"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    "latest_completion_at": {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    "latest_accounting_at": {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max",
      "description": "Original latest accounting deadline, including settlement margin and bounded by quote.created_at plus original maximum_order_seconds; never extended on replay."
    },
    "estimated_ready_from": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "estimated_ready_until": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "estimate_basis": {
      "type": "string",
      "enum": [
        "measured_route_and_queue",
        "not_qualified"
      ],
      "description": "Route estimates use measured public route/aggregate service capacity and this owned commitment, never private subject-specific queues or other tenants' jobs.",
      "x-profile-maxLength": "string_characters_max"
    },
    "offer": {
      "$ref": "#/components/schemas/ICVersionRef"
    },
    "tariff_revision": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "x-profile-maxLength": "string_characters_max"
    },
    "unit": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "x-profile-maxLength": "string_characters_max"
    },
    "unit_scale": {
      "type": "integer",
      "minimum": 1
    },
    "credit_policy_revision": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "x-profile-maxLength": "string_characters_max"
    },
    "requested_rows": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    },
    "distinct_entities": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    },
    "lines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ICQuoteEntity"
      },
      "minItems": 1,
      "x-profile-maxItems": "quote_entities_max",
      "maxItems": 1000
    },
    "maximum_new_units": {
      "type": "string",
      "pattern": "^(0|[1-9][0-9]*)$",
      "maxLength": 30,
      "x-profile-maxLength": "string_characters_max"
    },
    "rights_and_lifecycle_digest": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$",
      "x-profile-maxLength": "string_characters_max",
      "description": "Also binds every proved recognised-prior acquisition pricing_revision, original unrefunded-unit basis and current bounded window. Recheck at acceptance; changed basis gives existing quote_stale with null operation/status references. Accepted order price remains frozen."
    },
    "research_mode": {
      "type": "string",
      "enum": [
        "existing_only",
        "held_or_known_site",
        "bounded_discovery"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "acceptance_state": {
      "type": "string",
      "enum": [
        "acceptable",
        "unavailable",
        "expired",
        "replaced",
        "accepted"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "unavailability_reasons": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100,
        "x-profile-maxLength": "string_characters_max"
      },
      "minItems": 0,
      "maxItems": 16,
      "x-profile-maxItems": "collection_items_max"
    },
    "funding_expiry_rule": {
      "const": "duration_eligible_then_earliest_expiry",
      "description": "Exclude grants whose original expiry is at or before latest_accounting_at, then allocate earliest-expiring otherwise eligible grants with funding ID tie break. Preserve original expiry, scope and paid-service constraints."
    },
    "offer_binding": {
      "$ref": "#/components/schemas/OfferBinding"
    },
    "purpose": {
      "type": "string",
      "enum": [
        "acquisition",
        "refresh"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "accepted_order_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "quote_id",
    "quote_digest",
    "workspace_id",
    "environment",
    "created_at",
    "expires_at",
    "latest_completion_at",
    "latest_accounting_at",
    "estimated_ready_from",
    "estimated_ready_until",
    "estimate_basis",
    "offer",
    "tariff_revision",
    "unit",
    "unit_scale",
    "credit_policy_revision",
    "requested_rows",
    "distinct_entities",
    "lines",
    "maximum_new_units",
    "rights_and_lifecycle_digest",
    "research_mode",
    "acceptance_state",
    "unavailability_reasons",
    "funding_expiry_rule",
    "offer_binding",
    "purpose",
    "accepted_order_id"
  ],
  "additionalProperties": false,
  "description": "Not a funds or capacity reservation. Reads are bounded; digest covers entire entity set, prices, targets, clocks and policies. Unqualified cost/time/rights makes production acceptance unavailable; synthetic examples remain labelled. The quoted funding_expiry_rule is immutable and covered by quote_digest. Explain that earlier-expiring credits cannot fund this window; quote creation reserves nothing and no future renewal or top-up is assumed. Acceptance is a current safe projection: accepted_order_id and acceptance_state are excluded from the immutable quote content digest. Once accepted, state remains accepted even after the acceptance window ends; expiry cannot create a new order. At most one durable order per (workspace_id, environment, quote_id), across all keys and clients. Readback of the original order still requires current authority; it never accepts new terms or restarts completed/cancelled work. Retention and expiry are governed by x-classification-retention; these subject-linked schemas cannot be returned after their class(a) cutoff. Independent current-purpose and financial projections do not extend them. Both uniqueness constraints are enforced atomically in the same order/reservation transaction: (workspace,environment,client_order_reference) and (workspace,environment,quote_id). First reject a reused client reference bound to a different quote/digest/semantic body as idempotency_conflict/409 (do_not_retry, no new effect). Otherwise an already consumed identical quote returns its original owned order, even under a different unused reference/key; it preserves the originally accepted client reference and binds no new alias. A changed digest/semantic body conflicts. A reference already bound to another order never overrides the quote check. active_order_conflict is reserved for a distinct compatible-target overlap that cannot safely be coalesced, not duplicate acceptance of the same quote. Retention tombstones cannot resurrect an expired order. Incremental recognition requires current lawful prior-acquisition access, a proved original unrefunded basis and its accepted eligibility window. Only current permitted source rights can contribute a prior basis or zero-price reuse; no sibling receipt/funding identity is disclosed.",
  "allOf": [
    {
      "if": {
        "properties": {
          "purpose": {
            "const": "refresh"
          }
        },
        "required": [
          "purpose"
        ]
      },
      "then": {
        "properties": {
          "lines": {
            "items": {
              "properties": {
                "outcome_prices": {
                  "items": {
                    "required": [
                      "assessment_outcomes"
                    ],
                    "properties": {
                      "assessment_outcomes": {
                        "items": {
                          "properties": {
                            "outcome": {
                              "enum": [
                                "changed",
                                "unchanged"
                              ]
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "targets": {
                  "items": {
                    "properties": {
                      "assessment_plan": {
                        "properties": {
                          "purpose": {
                            "const": "refresh"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "acceptance_state": {
            "const": "accepted"
          }
        },
        "required": [
          "acceptance_state"
        ]
      },
      "then": {
        "properties": {
          "accepted_order_id": {
            "type": "string",
            "format": "uuid",
            "x-profile-maxLength": "string_characters_max"
          }
        }
      },
      "else": {
        "properties": {
          "accepted_order_id": {
            "type": "null"
          }
        }
      }
    },
    {
      "if": {
        "required": [
          "purpose"
        ],
        "properties": {
          "purpose": {
            "const": "acquisition"
          }
        }
      },
      "then": {
        "properties": {
          "lines": {
            "items": {
              "properties": {
                "outcome_prices": {
                  "items": {
                    "properties": {
                      "assessment_outcomes": {
                        "items": {
                          "properties": {
                            "outcome": {
                              "const": "initial"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "targets": {
                  "items": {
                    "properties": {
                      "assessment_plan": {
                        "properties": {
                          "purpose": {
                            "const": "acquisition"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "acceptance_state": {
            "enum": [
              "acceptable",
              "accepted"
            ]
          }
        },
        "required": [
          "acceptance_state"
        ]
      },
      "then": {
        "properties": {
          "unavailability_reasons": {
            "maxItems": 0
          }
        }
      },
      "else": {
        "properties": {
          "unavailability_reasons": {
            "minItems": 1
          }
        }
      }
    }
  ]
}

Related schemas

All API operations