ENTITY developer reference
ICOrderItem
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.
No code or source excerpt before successful acquisition. Gate rating is the weakest delivered classification rating, never a replacement aggregate score. Unassessed/pending uses not_assessed. A non-qualifying item cannot have a debit or new acquisition. A retired/split or otherwise no-longer-resolved quoted subject before settlement uses the existing unavailable state with failure_reasons containing identity_unresolved, unsatisfied terminal fulfilment, no new acquisition or debit, and release of its unearned reservation. Never silently retarget to a successor. Previously committed unrelated groups retain their immutable outcome. A requote is explicit, subject to original cadence lineage and current rights. Availability, estimates, progress, publication state and visible revisions use this customer's acquisitions/admitted commitment and currently lawful public corpus/capacity facts only. Private jobs, another tenant's evidence or unpublished shared completion cannot change the view. Coalescing preserves a distinct owned progress projection and may not expose shared job IDs/timing; it does not create another charged acquisition. Reuse/publication requires separately qualified sharing rights. 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. A newly hold-fenced uncommitted target uses state unavailable, failure_reasons [] (the internal financial cause is withheld), zero debit, null acquisition and terminal FulfilmentDisposition(information_outcome restricted_or_unavailable,satisfaction unsatisfied,publication withheld); release the unearned original reservation. Prior confirmed commits reconcile as their original outcomes. 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. financial_hold is an internal financial/admission cause and is not emitted in public data failure_reasons, reason_codes, detail or notifications. The hold-fenced uncommitted item still returns unavailable with zero debit/credit, null acquisition/receipt/result version and terminal restricted_or_unavailable/withheld/unsatisfied, but failure_reasons=[]; existing financial/account access alone may expose the exact cause. No new permission for data-only principals is assumed. At projection choose one dominant safe outcome: company-authority retirement first, then opaque rights/financial restriction, then identity_unresolved, then other permitted classification failures. Do not combine identity_unresolved with a restriction/retirement outcome that has a different terminal meaning. Prior proved commits retain their actual original settlement.
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.
item_id
Listed in this schema’s required array.
- Declared type
"string"- Declared format
"uuid"
Reading definition for item_id
{
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
}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"
}entity_group_id
Listed in this schema’s required array.
- Declared type
"string"- Declared format
"uuid"
Reading definition for entity_group_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"
}target
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for target
{
"$ref": "#/components/schemas/ICTarget"
}state
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for state
{
"type": "string",
"enum": [
"queued",
"preparing",
"qualifying",
"newly_acquired",
"already_acquired",
"not_qualified",
"unavailable",
"failed",
"cancelled"
],
"x-profile-maxLength": "string_characters_max"
}gate_rating
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for gate_rating
{
"$ref": "#/components/schemas/SEIPercentageScore"
}failure_reasons
Listed in this schema’s required array.
- Declared type
"array"
Reading definition for failure_reasons
{
"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"
}acquisition_id
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for acquisition_id
{
"anyOf": [
{
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}debit_units
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for debit_units
{
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
}credit_adjustment_units
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for credit_adjustment_units
{
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
}receipt_id
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for receipt_id
{
"anyOf": [
{
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}result_version
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for result_version
{
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 200,
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}updated_at
Listed in this schema’s required array.
- Declared type
"string"- Declared format
"date-time"
Reading definition for updated_at
{
"type": "string",
"format": "date-time",
"x-profile-maxLength": "string_characters_max"
}fulfilment
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for fulfilment
{
"$ref": "#/components/schemas/FulfilmentDisposition"
}assessment_id
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for assessment_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": {
"item_id": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
"order_id": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
"entity_group_id": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
"subject": {
"$ref": "#/components/schemas/SubjectRef"
},
"target": {
"$ref": "#/components/schemas/ICTarget"
},
"state": {
"type": "string",
"enum": [
"queued",
"preparing",
"qualifying",
"newly_acquired",
"already_acquired",
"not_qualified",
"unavailable",
"failed",
"cancelled"
],
"x-profile-maxLength": "string_characters_max"
},
"gate_rating": {
"$ref": "#/components/schemas/SEIPercentageScore"
},
"failure_reasons": {
"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"
},
"acquisition_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"debit_units": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
},
"credit_adjustment_units": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
},
"receipt_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"result_version": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 200,
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"updated_at": {
"type": "string",
"format": "date-time",
"x-profile-maxLength": "string_characters_max"
},
"fulfilment": {
"$ref": "#/components/schemas/FulfilmentDisposition"
},
"assessment_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}
},
"required": [
"item_id",
"order_id",
"entity_group_id",
"subject",
"target",
"state",
"gate_rating",
"failure_reasons",
"acquisition_id",
"debit_units",
"credit_adjustment_units",
"receipt_id",
"result_version",
"updated_at",
"fulfilment",
"assessment_id"
],
"additionalProperties": false,
"description": "No code or source excerpt before successful acquisition. Gate rating is the weakest delivered classification rating, never a replacement aggregate score. Unassessed/pending uses not_assessed. A non-qualifying item cannot have a debit or new acquisition. A retired/split or otherwise no-longer-resolved quoted subject before settlement uses the existing unavailable state with failure_reasons containing identity_unresolved, unsatisfied terminal fulfilment, no new acquisition or debit, and release of its unearned reservation. Never silently retarget to a successor. Previously committed unrelated groups retain their immutable outcome. A requote is explicit, subject to original cadence lineage and current rights. Availability, estimates, progress, publication state and visible revisions use this customer's acquisitions/admitted commitment and currently lawful public corpus/capacity facts only. Private jobs, another tenant's evidence or unpublished shared completion cannot change the view. Coalescing preserves a distinct owned progress projection and may not expose shared job IDs/timing; it does not create another charged acquisition. Reuse/publication requires separately qualified sharing rights. 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. A newly hold-fenced uncommitted target uses state unavailable, failure_reasons [] (the internal financial cause is withheld), zero debit, null acquisition and terminal FulfilmentDisposition(information_outcome restricted_or_unavailable,satisfaction unsatisfied,publication withheld); release the unearned original reservation. Prior confirmed commits reconcile as their original outcomes. 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. financial_hold is an internal financial/admission cause and is not emitted in public data failure_reasons, reason_codes, detail or notifications. The hold-fenced uncommitted item still returns unavailable with zero debit/credit, null acquisition/receipt/result version and terminal restricted_or_unavailable/withheld/unsatisfied, but failure_reasons=[]; existing financial/account access alone may expose the exact cause. No new permission for data-only principals is assumed. At projection choose one dominant safe outcome: company-authority retirement first, then opaque rights/financial restriction, then identity_unresolved, then other permitted classification failures. Do not combine identity_unresolved with a restriction/retirement outcome that has a different terminal meaning. Prior proved commits retain their actual original settlement.",
"allOf": [
{
"if": {
"properties": {
"state": {
"enum": [
"newly_acquired",
"already_acquired"
]
}
},
"required": [
"state"
]
},
"then": {
"properties": {
"acquisition_id": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
"result_version": {
"type": "string",
"minLength": 1,
"x-profile-maxLength": "string_characters_max"
},
"receipt_id": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
}
}
},
"else": {
"properties": {
"acquisition_id": {
"type": "null"
},
"result_version": {
"type": "null"
},
"receipt_id": {
"type": "null"
},
"debit_units": {
"const": "0"
},
"credit_adjustment_units": {
"const": "0"
}
}
}
},
{
"if": {
"properties": {
"state": {
"const": "already_acquired"
}
},
"required": [
"state"
]
},
"then": {
"properties": {
"debit_units": {
"const": "0"
},
"credit_adjustment_units": {
"const": "0"
}
}
}
},
{
"if": {
"properties": {
"state": {
"type": "string",
"enum": [
"newly_acquired",
"already_acquired"
],
"x-profile-maxLength": "string_characters_max"
}
},
"required": [
"state"
]
},
"then": {
"properties": {
"assessment_id": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
"fulfilment": {
"properties": {
"satisfaction": {
"const": "satisfied"
},
"information_outcome": {
"const": "satisfied"
},
"terminal": {
"const": true
}
}
}
}
},
"else": {
"if": {
"properties": {
"state": {
"type": "string",
"enum": [
"queued",
"preparing",
"qualifying"
],
"x-profile-maxLength": "string_characters_max"
}
},
"required": [
"state"
]
},
"then": {
"properties": {
"fulfilment": {
"properties": {
"satisfaction": {
"const": "pending"
},
"terminal": {
"const": false
}
}
}
}
},
"else": {
"properties": {
"fulfilment": {
"properties": {
"satisfaction": {
"const": "unsatisfied"
},
"terminal": {
"const": true
}
}
}
}
}
}
},
{
"if": {
"properties": {
"failure_reasons": {
"contains": {
"const": "identity_unresolved"
}
}
},
"required": [
"failure_reasons"
]
},
"then": {
"properties": {
"state": {
"const": "unavailable"
},
"debit_units": {
"const": "0"
},
"acquisition_id": {
"type": "null"
},
"receipt_id": {
"type": "null"
},
"fulfilment": {
"properties": {
"satisfaction": {
"const": "unsatisfied"
},
"terminal": {
"const": true
}
}
}
}
}
},
{
"if": {
"properties": {
"failure_reasons": {
"contains": {
"const": "company_authority_retired"
}
}
},
"required": [
"failure_reasons"
]
},
"then": {
"properties": {
"state": {
"const": "unavailable"
},
"debit_units": {
"const": "0"
},
"acquisition_id": {
"type": "null"
},
"receipt_id": {
"type": "null"
},
"fulfilment": {
"properties": {
"information_outcome": {
"const": "restricted_or_unavailable"
},
"publication": {
"const": "withheld"
},
"satisfaction": {
"const": "unsatisfied"
},
"terminal": {
"const": true
}
}
}
}
}
},
{
"if": {
"properties": {
"failure_reasons": {
"contains": {
"const": "identity_unresolved"
}
}
},
"required": [
"failure_reasons"
]
},
"then": {
"properties": {
"state": {
"const": "unavailable"
},
"debit_units": {
"const": "0"
},
"acquisition_id": {
"type": "null"
},
"receipt_id": {
"type": "null"
},
"fulfilment": {
"properties": {
"information_outcome": {
"const": "identity_unresolved"
},
"publication": {
"const": "withheld"
},
"satisfaction": {
"const": "unsatisfied"
},
"terminal": {
"const": true
}
}
}
}
}
},
{
"if": {
"properties": {
"state": {
"const": "unavailable"
},
"failure_reasons": {
"maxItems": 0
}
},
"required": [
"state",
"failure_reasons"
]
},
"then": {
"properties": {
"debit_units": {
"const": "0"
},
"credit_adjustment_units": {
"const": "0"
},
"acquisition_id": {
"type": "null"
},
"receipt_id": {
"type": "null"
},
"result_version": {
"type": "null"
},
"fulfilment": {
"properties": {
"information_outcome": {
"const": "restricted_or_unavailable"
},
"publication": {
"const": "withheld"
},
"satisfaction": {
"const": "unsatisfied"
},
"terminal": {
"const": true
}
}
}
}
}
},
{
"not": {
"properties": {
"failure_reasons": {
"allOf": [
{
"contains": {
"const": "identity_unresolved"
}
},
{
"contains": {
"const": "company_authority_retired"
}
}
]
}
},
"required": [
"failure_reasons"
]
}
}
]
}