Sustema

ENTITY developer reference

LegacyOperationResult

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.

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": [
    "not_started",
    "reserved",
    "settled",
    "released",
    "uncertain",
    "adjusted"
  ],
  "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

Not listed in this schema’s required array.

Declared type
"null"
Reading definition for classification_order_id
{
  "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": {
    "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": [
        "not_started",
        "reserved",
        "settled",
        "released",
        "uncertain",
        "adjusted"
      ],
      "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": "null"
    }
  },
  "required": [
    "operation_id",
    "state",
    "financial_state",
    "receipt_id",
    "original_period_id",
    "reserved_units",
    "settled_units",
    "result_replay_available",
    "replay_status",
    "retry_action",
    "updated_at"
  ],
  "additionalProperties": false,
  "allOf": [
    {
      "if": {
        "properties": {
          "state": {
            "const": "accepted"
          }
        },
        "required": [
          "state"
        ]
      },
      "then": {
        "properties": {
          "financial_state": {
            "type": "string",
            "enum": [
              "reserved"
            ],
            "x-profile-maxLength": "string_characters_max"
          },
          "replay_status": {
            "type": "string",
            "enum": [
              "pending"
            ],
            "x-profile-maxLength": "string_characters_max"
          },
          "receipt_id": {
            "type": "null"
          },
          "settled_units": {
            "type": "null"
          },
          "result_replay_available": {
            "const": false
          },
          "retry_action": {
            "const": "poll_status"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "state": {
            "const": "running"
          }
        },
        "required": [
          "state"
        ]
      },
      "then": {
        "properties": {
          "financial_state": {
            "type": "string",
            "enum": [
              "reserved"
            ],
            "x-profile-maxLength": "string_characters_max"
          },
          "replay_status": {
            "type": "string",
            "enum": [
              "pending"
            ],
            "x-profile-maxLength": "string_characters_max"
          },
          "receipt_id": {
            "type": "null"
          },
          "settled_units": {
            "type": "null"
          },
          "result_replay_available": {
            "const": false
          },
          "retry_action": {
            "const": "poll_status"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "state": {
            "const": "reconciling"
          }
        },
        "required": [
          "state"
        ]
      },
      "then": {
        "properties": {
          "financial_state": {
            "type": "string",
            "enum": [
              "reserved",
              "uncertain"
            ],
            "x-profile-maxLength": "string_characters_max"
          },
          "replay_status": {
            "type": "string",
            "enum": [
              "pending"
            ],
            "x-profile-maxLength": "string_characters_max"
          },
          "receipt_id": {
            "type": "null"
          },
          "settled_units": {
            "type": "null"
          },
          "result_replay_available": {
            "const": false
          },
          "retry_action": {
            "const": "poll_status"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "state": {
            "const": "committed"
          }
        },
        "required": [
          "state"
        ]
      },
      "then": {
        "properties": {
          "financial_state": {
            "type": "string",
            "enum": [
              "settled",
              "adjusted"
            ],
            "x-profile-maxLength": "string_characters_max"
          },
          "replay_status": {
            "type": "string",
            "enum": [
              "available",
              "restricted",
              "invalidated",
              "expired"
            ],
            "x-profile-maxLength": "string_characters_max"
          },
          "receipt_id": {
            "type": "string",
            "format": "uuid",
            "x-profile-maxLength": "string_characters_max"
          },
          "settled_units": {
            "$ref": "#/components/schemas/Units"
          },
          "reserved_units": {
            "const": "0"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "state": {
            "const": "failed"
          }
        },
        "required": [
          "state"
        ]
      },
      "then": {
        "properties": {
          "financial_state": {
            "type": "string",
            "enum": [
              "released",
              "not_started"
            ],
            "x-profile-maxLength": "string_characters_max"
          },
          "replay_status": {
            "type": "string",
            "enum": [
              "expired"
            ],
            "x-profile-maxLength": "string_characters_max"
          },
          "receipt_id": {
            "type": "null"
          },
          "settled_units": {
            "type": "null"
          },
          "result_replay_available": {
            "const": false
          },
          "reserved_units": {
            "const": "0"
          },
          "retry_action": {
            "type": "string",
            "enum": [
              "new_operation_permitted",
              "do_not_retry"
            ],
            "x-profile-maxLength": "string_characters_max"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "state": {
            "const": "expired"
          }
        },
        "required": [
          "state"
        ]
      },
      "then": {
        "properties": {
          "financial_state": {
            "type": "string",
            "enum": [
              "released",
              "not_started"
            ],
            "x-profile-maxLength": "string_characters_max"
          },
          "replay_status": {
            "type": "string",
            "enum": [
              "expired"
            ],
            "x-profile-maxLength": "string_characters_max"
          },
          "receipt_id": {
            "type": "null"
          },
          "settled_units": {
            "type": "null"
          },
          "result_replay_available": {
            "const": false
          },
          "reserved_units": {
            "const": "0"
          },
          "retry_action": {
            "const": "do_not_retry"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "replay_status": {
            "const": "available"
          }
        },
        "required": [
          "replay_status"
        ]
      },
      "then": {
        "properties": {
          "result_replay_available": {
            "const": true
          },
          "state": {
            "const": "committed"
          },
          "retry_action": {
            "const": "replay_original_request"
          }
        }
      },
      "else": {
        "properties": {
          "result_replay_available": {
            "const": false
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "state": {
            "const": "committed"
          },
          "replay_status": {
            "enum": [
              "restricted",
              "invalidated",
              "expired"
            ]
          }
        },
        "required": [
          "state",
          "replay_status"
        ]
      },
      "then": {
        "properties": {
          "retry_action": {
            "const": "do_not_retry"
          }
        }
      }
    }
  ]
}

Related schemas

All API operations