Sustema

ENTITY developer reference

ICOrder

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.

A durable order can be accepted with zero new debit when reusing acquisitions. Per-entity groups settle atomically once requested targets are terminal; other groups can complete earlier. Counts are no guarantee of complete industry coverage. Every visible order/operation field, revision, timestamp, count, accounting quantity, reason, error, cursor and notification is derived only from this owner's admitted actions/commitments, proved owned acquisitions/settlements and permitted published evidence. Persist the order public revision, timestamp and visible-content digest separately from private worker revisions. Hidden shared-job progress cannot advance them or make an expected_revision stale. Own accepted actions and changed permitted content atomically advance the public revision; identical replay/read does not. Item-page order_revision and cancellation expected_revision name this same owned revision. Current rights and the whole permitted publication history, including publication times, are part of the projection input. Cancellation linearises in the existing order/acquisition transaction against the owned public order revision. Preserve only acquisitions proved committed for this order before that cut-off; cancel every target not yet committed to it and release its unearned customer reservation. Merely prepared, running, coalesced or privately published worker output earns no customer fee. Fence later attachment/acquisition for the cancelled target. Reconcile genuinely uncertain pre-cut-off owned commits before declaring final money; provider costs alone are Sustema exposure and cannot manufacture a customer financial uncertainty. A late shared result may serve another entitled customer but cannot revive this cancelled target. This binds the cancellation policy: only acquisitions committed before the cancellation cut-off retain their original charge; it does not change tariffs/refunds or cancel another customer's 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. Cancellation of an already terminal completed/completed_partial/unfulfilled/cancelled order returns its unchanged owned terminal projection after current-authority and expected-public-revision checks; it adds no cancellation effect, debit or refund. Stale expected_revision uses stale_revision/412. Nonterminal cancellation retains the existing atomic cutoff/reconciliation rule. For a retired company binding, permitted recovery uses poll_same_order or do_not_retry. ICOrder has no status_path field: derive getClassificationOrder from its own order_id; an ICProblem carrying that recovery locator uses /v1/classification-orders/{owned_order_id}. Never direct the caller to a now-denied generic operation route. After authenticating current identity and exact permitted original ownership, compare original idempotency/client-reference/quote bindings and canonical payload before new-order financial-hold or funding checks. For an active company binding authorised to invoke createClassificationOrder, an identical consumed quote returns only its currently permitted original projection without another reservation, alias, or new effect; changed payload/reference conflicts. A retired-company createClassificationOrder invocation is denied even if its quote was consumed; discover its original obligation through the existing owned browser list/read instead. Retention and current access still apply before disclosure. A retired company cannot use createClassificationOrder for new acceptance or discovery. If its original API acknowledgement was lost, the verified original human can recover the existing order through the owned classification-order history in the signed-in console, or the original account case path. These require their own current original-party permissions; an API credential is not a browser/staff credential. Public getClassificationOrder reads an already-known order; no public list endpoint is promised or invented. During the qualified owned status-only suspension/retirement corridor, items_path=null and no result/item authority follows. Original order relation includes only its own committed delivery receipts, never the source receipt of reused data.

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.

order_id

Listed in this schema’s required array.

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

operation_id

Listed in this schema’s required array.

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

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

client_order_reference

Listed in this schema’s required array.

Declared type
"string"
Reading definition for client_order_reference
{
  "type": "string",
  "minLength": 1,
  "maxLength": 120,
  "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"
}

revision

Listed in this schema’s required array.

Owned public projection only; never shared worker state/revision/timing. See ICOrder description.

Declared type
"integer"
Reading definition for revision
{
  "type": "integer",
  "minimum": 1,
  "description": "Owned public projection only; never shared worker state/revision/timing. See ICOrder description."
}

state

Listed in this schema’s required array.

Owned public projection only; never shared worker state/revision/timing. See ICOrder description.

Declared type
"string"
Reading definition for state
{
  "type": "string",
  "enum": [
    "queued",
    "running",
    "completed",
    "completed_partial",
    "unfulfilled",
    "cancelled",
    "reconciling"
  ],
  "x-profile-maxLength": "string_characters_max",
  "description": "Owned public projection only; never shared worker state/revision/timing. See ICOrder description."
}

accepted_at

Listed in this schema’s required array.

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

updated_at

Listed in this schema’s required array.

Owned public projection only; never shared worker state/revision/timing. See ICOrder description.

Declared type
"string"
Declared format
"date-time"
Reading definition for updated_at
{
  "type": "string",
  "format": "date-time",
  "x-profile-maxLength": "string_characters_max",
  "description": "Owned public projection only; never shared worker state/revision/timing. See ICOrder description."
}

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.

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

funding_valid_until

Listed in this schema’s required array.

Earliest original expiry of funding actually allocated at acceptance; null only when no new funding was reserved. Positive reservations require latest_accounting_at strictly before this expiry. The order retains the accepted quote funding rule.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for funding_valid_until
{
  "anyOf": [
    {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ],
  "description": "Earliest original expiry of funding actually allocated at acceptance; null only when no new funding was reserved. Positive reservations require latest_accounting_at strictly before this expiry. The order retains the accepted quote funding rule."
}

counts

Listed in this schema’s required array.

Owned public projection only; never shared worker state/revision/timing. See ICOrder description.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for counts
{
  "$ref": "#/components/schemas/ICOrderCounts",
  "description": "Owned public projection only; never shared worker state/revision/timing. See ICOrder description."
}

accounting

Listed in this schema’s required array.

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

receipt_ids

Listed in this schema’s required array.

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

items_path

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for items_path
{
  "anyOf": [
    {
      "type": "string",
      "minLength": 1,
      "maxLength": 240,
      "x-profile-maxLength": "string_characters_max",
      "pattern": "^/v1/classification-orders/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}/items$"
    },
    {
      "type": "null"
    }
  ]
}

cancellation_requested

Listed in this schema’s required array.

Declared type
"boolean"
Reading definition for cancellation_requested
{
  "type": "boolean"
}

retry_action

Listed in this schema’s required array.

Declared type
"string"
Reading definition for retry_action
{
  "type": "string",
  "enum": [
    "poll_same_order",
    "read_results",
    "do_not_retry",
    "read_original_operation"
  ],
  "x-profile-maxLength": "string_characters_max"
}

reason_codes

Listed in this schema’s required array.

Declared type
"array"
Reading definition for reason_codes
{
  "type": "array",
  "items": {
    "type": "string",
    "minLength": 1,
    "maxLength": 100,
    "x-profile-maxLength": "string_characters_max",
    "not": {
      "const": "financial_hold"
    }
  },
  "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"
}

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": {
    "order_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "operation_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "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"
    },
    "client_order_reference": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "x-profile-maxLength": "string_characters_max"
    },
    "workspace_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "environment": {
      "$ref": "#/components/schemas/Environment"
    },
    "revision": {
      "type": "integer",
      "minimum": 1,
      "description": "Owned public projection only; never shared worker state/revision/timing. See ICOrder description."
    },
    "state": {
      "type": "string",
      "enum": [
        "queued",
        "running",
        "completed",
        "completed_partial",
        "unfulfilled",
        "cancelled",
        "reconciling"
      ],
      "x-profile-maxLength": "string_characters_max",
      "description": "Owned public projection only; never shared worker state/revision/timing. See ICOrder description."
    },
    "accepted_at": {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max",
      "description": "Owned public projection only; never shared worker state/revision/timing. See ICOrder description."
    },
    "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"
    },
    "funding_valid_until": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ],
      "description": "Earliest original expiry of funding actually allocated at acceptance; null only when no new funding was reserved. Positive reservations require latest_accounting_at strictly before this expiry. The order retains the accepted quote funding rule."
    },
    "counts": {
      "$ref": "#/components/schemas/ICOrderCounts",
      "description": "Owned public projection only; never shared worker state/revision/timing. See ICOrder description."
    },
    "accounting": {
      "$ref": "#/components/schemas/ICOrderAccounting"
    },
    "receipt_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "x-profile-maxLength": "string_characters_max"
      },
      "minItems": 0,
      "x-profile-maxItems": "quote_entities_max"
    },
    "items_path": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 240,
          "x-profile-maxLength": "string_characters_max",
          "pattern": "^/v1/classification-orders/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}/items$"
        },
        {
          "type": "null"
        }
      ]
    },
    "cancellation_requested": {
      "type": "boolean"
    },
    "retry_action": {
      "type": "string",
      "enum": [
        "poll_same_order",
        "read_results",
        "do_not_retry",
        "read_original_operation"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "reason_codes": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100,
        "x-profile-maxLength": "string_characters_max",
        "not": {
          "const": "financial_hold"
        }
      },
      "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"
    }
  },
  "required": [
    "order_id",
    "operation_id",
    "quote_id",
    "quote_digest",
    "client_order_reference",
    "workspace_id",
    "environment",
    "revision",
    "state",
    "accepted_at",
    "updated_at",
    "latest_completion_at",
    "latest_accounting_at",
    "funding_valid_until",
    "counts",
    "accounting",
    "receipt_ids",
    "items_path",
    "cancellation_requested",
    "retry_action",
    "reason_codes",
    "funding_expiry_rule",
    "offer_binding",
    "purpose"
  ],
  "additionalProperties": false,
  "description": "A durable order can be accepted with zero new debit when reusing acquisitions. Per-entity groups settle atomically once requested targets are terminal; other groups can complete earlier. Counts are no guarantee of complete industry coverage. Every visible order/operation field, revision, timestamp, count, accounting quantity, reason, error, cursor and notification is derived only from this owner's admitted actions/commitments, proved owned acquisitions/settlements and permitted published evidence. Persist the order public revision, timestamp and visible-content digest separately from private worker revisions. Hidden shared-job progress cannot advance them or make an expected_revision stale. Own accepted actions and changed permitted content atomically advance the public revision; identical replay/read does not. Item-page order_revision and cancellation expected_revision name this same owned revision. Current rights and the whole permitted publication history, including publication times, are part of the projection input. Cancellation linearises in the existing order/acquisition transaction against the owned public order revision. Preserve only acquisitions proved committed for this order before that cut-off; cancel every target not yet committed to it and release its unearned customer reservation. Merely prepared, running, coalesced or privately published worker output earns no customer fee. Fence later attachment/acquisition for the cancelled target. Reconcile genuinely uncertain pre-cut-off owned commits before declaring final money; provider costs alone are Sustema exposure and cannot manufacture a customer financial uncertainty. A late shared result may serve another entitled customer but cannot revive this cancelled target. This binds the cancellation policy: only acquisitions committed before the cancellation cut-off retain their original charge; it does not change tariffs/refunds or cancel another customer's 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. Cancellation of an already terminal completed/completed_partial/unfulfilled/cancelled order returns its unchanged owned terminal projection after current-authority and expected-public-revision checks; it adds no cancellation effect, debit or refund. Stale expected_revision uses stale_revision/412. Nonterminal cancellation retains the existing atomic cutoff/reconciliation rule. For a retired company binding, permitted recovery uses poll_same_order or do_not_retry. ICOrder has no status_path field: derive getClassificationOrder from its own order_id; an ICProblem carrying that recovery locator uses /v1/classification-orders/{owned_order_id}. Never direct the caller to a now-denied generic operation route. After authenticating current identity and exact permitted original ownership, compare original idempotency/client-reference/quote bindings and canonical payload before new-order financial-hold or funding checks. For an active company binding authorised to invoke createClassificationOrder, an identical consumed quote returns only its currently permitted original projection without another reservation, alias, or new effect; changed payload/reference conflicts. A retired-company createClassificationOrder invocation is denied even if its quote was consumed; discover its original obligation through the existing owned browser list/read instead. Retention and current access still apply before disclosure. A retired company cannot use createClassificationOrder for new acceptance or discovery. If its original API acknowledgement was lost, the verified original human can recover the existing order through the owned classification-order history in the signed-in console, or the original account case path. These require their own current original-party permissions; an API credential is not a browser/staff credential. Public getClassificationOrder reads an already-known order; no public list endpoint is promised or invented. During the qualified owned status-only suspension/retirement corridor, items_path=null and no result/item authority follows. Original order relation includes only its own committed delivery receipts, never the source receipt of reused data.",
  "allOf": [
    {
      "if": {
        "properties": {
          "reason_codes": {
            "contains": {
              "const": "company_authority_retired"
            }
          }
        },
        "required": [
          "reason_codes"
        ]
      },
      "then": {
        "properties": {
          "retry_action": {
            "enum": [
              "poll_same_order",
              "do_not_retry"
            ]
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "reason_codes": {
            "contains": {
              "const": "company_authority_retired"
            }
          }
        },
        "required": [
          "reason_codes"
        ]
      },
      "then": {
        "properties": {
          "items_path": {
            "type": "null"
          }
        }
      }
    }
  ]
}

Related schemas

All API operations