ENTITY developer reference
ICOperationResult
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.
Classification order projection supports partial group settlement while legacy operations retain their original state rules. Reserved units are outstanding only; settled units are original gross debits, not net of adjustments; detailed reconciliation is on ICOrder.accounting. Terminal orders with any committed group, including partial success or cancellation after one delivered group, project state committed; failed/expired means no group settled. A terminal zero-debit unfulfilled order is released. receipt_id may be null for multi-receipt orders; the complete bounded classification_receipt_ids owns that projection. A per-group receipt is immutable. Financial uncertainty blocks claims of terminal completion; proven prior group debits remain visible while the remaining group is reconciling. Schema constraints do not prove ledger conservation. 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. 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.
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.
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"
}state
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for state
{
"type": "string",
"enum": [
"accepted",
"running",
"reconciling",
"committed",
"failed",
"expired"
],
"x-profile-maxLength": "string_characters_max"
}financial_state
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for financial_state
{
"type": "string",
"enum": [
"reserved",
"partially_settled",
"settled",
"released",
"uncertain",
"adjusted",
"not_started"
],
"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"
}
]
}original_period_id
Listed in this schema’s required array.
- Declared type
"string"- Declared format
"uuid"
Reading definition for original_period_id
{
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
}reserved_units
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for reserved_units
{
"$ref": "#/components/schemas/Units"
}settled_units
Listed in this schema’s required array.
Original settlement, unchanged by append-only adjustments. Period aggregate adjustments are exposed through authorised usage; original receipt retains the original amount.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for settled_units
{
"anyOf": [
{
"$ref": "#/components/schemas/Units"
},
{
"type": "null"
}
],
"description": "Original settlement, unchanged by append-only adjustments. Period aggregate adjustments are exposed through authorised usage; original receipt retains the original amount."
}result_replay_available
Listed in this schema’s required array.
- Declared type
"boolean"
Reading definition for result_replay_available
{
"type": "boolean"
}replay_status
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for replay_status
{
"type": "string",
"enum": [
"available",
"pending",
"expired",
"restricted",
"invalidated"
],
"x-profile-maxLength": "string_characters_max"
}retry_action
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for retry_action
{
"type": "string",
"enum": [
"poll_status",
"replay_original_request",
"new_operation_permitted",
"do_not_retry"
],
"x-profile-maxLength": "string_characters_max"
}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"
}classification_order_id
Listed in this schema’s required array.
- Declared type
"string"- Declared format
"uuid"
Reading definition for classification_order_id
{
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
}classification_receipt_ids
Listed in this schema’s required array.
- Declared type
"array"
Reading definition for classification_receipt_ids
{
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
"x-profile-maxItems": "quote_entities_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": {
"operation_id": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
"state": {
"type": "string",
"enum": [
"accepted",
"running",
"reconciling",
"committed",
"failed",
"expired"
],
"x-profile-maxLength": "string_characters_max"
},
"financial_state": {
"type": "string",
"enum": [
"reserved",
"partially_settled",
"settled",
"released",
"uncertain",
"adjusted",
"not_started"
],
"x-profile-maxLength": "string_characters_max"
},
"receipt_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"original_period_id": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
"reserved_units": {
"$ref": "#/components/schemas/Units"
},
"settled_units": {
"anyOf": [
{
"$ref": "#/components/schemas/Units"
},
{
"type": "null"
}
],
"description": "Original settlement, unchanged by append-only adjustments. Period aggregate adjustments are exposed through authorised usage; original receipt retains the original amount."
},
"result_replay_available": {
"type": "boolean"
},
"replay_status": {
"type": "string",
"enum": [
"available",
"pending",
"expired",
"restricted",
"invalidated"
],
"x-profile-maxLength": "string_characters_max"
},
"retry_action": {
"type": "string",
"enum": [
"poll_status",
"replay_original_request",
"new_operation_permitted",
"do_not_retry"
],
"x-profile-maxLength": "string_characters_max"
},
"updated_at": {
"type": "string",
"format": "date-time",
"x-profile-maxLength": "string_characters_max"
},
"classification_order_id": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
"classification_receipt_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
"x-profile-maxItems": "quote_entities_max"
}
},
"required": [
"operation_id",
"state",
"financial_state",
"receipt_id",
"original_period_id",
"reserved_units",
"settled_units",
"result_replay_available",
"replay_status",
"retry_action",
"updated_at",
"classification_order_id",
"classification_receipt_ids"
],
"additionalProperties": false,
"description": "Classification order projection supports partial group settlement while legacy operations retain their original state rules. Reserved units are outstanding only; settled units are original gross debits, not net of adjustments; detailed reconciliation is on ICOrder.accounting. Terminal orders with any committed group, including partial success or cancellation after one delivered group, project state committed; failed/expired means no group settled. A terminal zero-debit unfulfilled order is released. receipt_id may be null for multi-receipt orders; the complete bounded classification_receipt_ids owns that projection. A per-group receipt is immutable. Financial uncertainty blocks claims of terminal completion; proven prior group debits remain visible while the remaining group is reconciling. Schema constraints do not prove ledger conservation. 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. 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.",
"allOf": [
{
"if": {
"properties": {
"state": {
"enum": [
"accepted",
"running"
]
}
},
"required": [
"state"
]
},
"then": {
"properties": {
"financial_state": {
"enum": [
"reserved",
"partially_settled",
"settled"
]
},
"replay_status": {
"const": "pending"
},
"result_replay_available": {
"const": false
},
"retry_action": {
"const": "poll_status"
}
}
}
},
{
"if": {
"properties": {
"state": {
"const": "reconciling"
}
},
"required": [
"state"
]
},
"then": {
"properties": {
"financial_state": {
"enum": [
"reserved",
"partially_settled",
"uncertain"
]
},
"replay_status": {
"const": "pending"
},
"result_replay_available": {
"const": false
},
"retry_action": {
"const": "poll_status"
}
}
}
},
{
"if": {
"properties": {
"state": {
"const": "committed"
}
},
"required": [
"state"
]
},
"then": {
"properties": {
"financial_state": {
"enum": [
"settled",
"released",
"adjusted"
]
},
"reserved_units": {
"const": "0"
},
"settled_units": {
"$ref": "#/components/schemas/Units"
}
}
}
},
{
"if": {
"properties": {
"state": {
"enum": [
"failed",
"expired"
]
}
},
"required": [
"state"
]
},
"then": {
"properties": {
"financial_state": {
"enum": [
"released",
"not_started"
]
},
"reserved_units": {
"const": "0"
},
"settled_units": {
"enum": [
null,
"0"
]
},
"classification_receipt_ids": {
"maxItems": 0
},
"receipt_id": {
"type": "null"
},
"result_replay_available": {
"const": false
},
"replay_status": {
"const": "expired"
}
}
}
},
{
"if": {
"properties": {
"financial_state": {
"const": "not_started"
}
},
"required": [
"financial_state"
]
},
"then": {
"properties": {
"reserved_units": {
"const": "0"
},
"settled_units": {
"enum": [
null,
"0"
]
},
"classification_receipt_ids": {
"maxItems": 0
}
}
}
},
{
"if": {
"properties": {
"replay_status": {
"const": "available"
}
},
"required": [
"replay_status"
]
},
"then": {
"properties": {
"state": {
"const": "committed"
},
"result_replay_available": {
"const": true
},
"retry_action": {
"const": "replay_original_request"
}
}
},
"else": {
"properties": {
"result_replay_available": {
"const": false
}
}
}
}
]
}