Sustema

ENTITY developer reference

ICUsage

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.

Included breakdown of existing original-lot wallet totals, not extra allowance. Order-level progress/adjustments provide detailed records. No supplier costs, company names or new payment authority.

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.

as_of

Listed in this schema’s required array.

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

reserved_units_included_in_wallet

Listed in this schema’s required array.

Declared type
"string"
Reading definition for reserved_units_included_in_wallet
{
  "type": "string",
  "pattern": "^(0|[1-9][0-9]*)$",
  "maxLength": 30,
  "x-profile-maxLength": "string_characters_max"
}

gross_debited_units_included_in_wallet

Listed in this schema’s required array.

Declared type
"string"
Reading definition for gross_debited_units_included_in_wallet
{
  "type": "string",
  "pattern": "^(0|[1-9][0-9]*)$",
  "maxLength": 30,
  "x-profile-maxLength": "string_characters_max"
}

credited_units_included_in_wallet

Listed in this schema’s required array.

Declared type
"string"
Reading definition for credited_units_included_in_wallet
{
  "type": "string",
  "pattern": "^(0|[1-9][0-9]*)$",
  "maxLength": 30,
  "x-profile-maxLength": "string_characters_max"
}

open_orders

Listed in this schema’s required array.

Declared type
"integer"
Reading definition for open_orders
{
  "type": "integer",
  "minimum": 0
}

order_history_path

Listed in this schema’s required array.

Declared type
"string"
Reading definition for order_history_path
{
  "type": "string",
  "minLength": 1,
  "maxLength": 240,
  "x-profile-maxLength": "string_characters_max",
  "x-documentation-scope": "Private console route pattern withheld. The original source constraint is unchanged. This is a structured console order-history locator. Validate the full path against the matching qualified console binding’s exact allowlisted order-history template and bind its workspace ID to the original known workspace before navigation. An unknown workspace, unknown template or mismatch prevents navigation. Reject arbitrary URLs and query, fragment or encoding tricks. This reading view withholds the private template and is insufficient to implement that validator: use the matching separately released console binding, never guess the route. This field names order history, not a support case. The path grants no authority; its destination independently checks current ownership and permissions."
}

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": {
    "as_of": {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    "reserved_units_included_in_wallet": {
      "type": "string",
      "pattern": "^(0|[1-9][0-9]*)$",
      "maxLength": 30,
      "x-profile-maxLength": "string_characters_max"
    },
    "gross_debited_units_included_in_wallet": {
      "type": "string",
      "pattern": "^(0|[1-9][0-9]*)$",
      "maxLength": 30,
      "x-profile-maxLength": "string_characters_max"
    },
    "credited_units_included_in_wallet": {
      "type": "string",
      "pattern": "^(0|[1-9][0-9]*)$",
      "maxLength": 30,
      "x-profile-maxLength": "string_characters_max"
    },
    "open_orders": {
      "type": "integer",
      "minimum": 0
    },
    "order_history_path": {
      "type": "string",
      "minLength": 1,
      "maxLength": 240,
      "x-profile-maxLength": "string_characters_max",
      "x-documentation-scope": "Private console route pattern withheld. The original source constraint is unchanged. This is a structured console order-history locator. Validate the full path against the matching qualified console binding’s exact allowlisted order-history template and bind its workspace ID to the original known workspace before navigation. An unknown workspace, unknown template or mismatch prevents navigation. Reject arbitrary URLs and query, fragment or encoding tricks. This reading view withholds the private template and is insufficient to implement that validator: use the matching separately released console binding, never guess the route. This field names order history, not a support case. The path grants no authority; its destination independently checks current ownership and permissions."
    }
  },
  "required": [
    "as_of",
    "reserved_units_included_in_wallet",
    "gross_debited_units_included_in_wallet",
    "credited_units_included_in_wallet",
    "open_orders",
    "order_history_path"
  ],
  "additionalProperties": false,
  "description": "Included breakdown of existing original-lot wallet totals, not extra allowance. Order-level progress/adjustments provide detailed records. No supplier costs, company names or new payment authority."
}

All API operations