ENTITY developer reference
ICOrderAccounting
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.
initial=outstanding+gross_debited+released; net=gross_debited-credited; credits do not reopen the original reservation. Finance uses original funding allocations and separate adjustment grants where permitted; never add these included totals to usage twice. 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. credited_units is the sum of committed, authorised unit-credit ledger entries linked to this original order. A pending remedy decision or pending-policy/funding grant promise with no posted ledger credit contributes zero. A held, expired or revoked grant does not erase an already posted credit or turn it back into a debit; its currently available balance is separately zero. net_debited_units=gross_debited_units-committed credited_units; availability is never inferred from net or credited totals. Count each original ledger effect once, whether credited to original funding or its separately approved remedy funding; do not count the metadata grant twice.
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.
unit
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for unit
{
"type": "string",
"minLength": 1,
"maxLength": 80,
"x-profile-maxLength": "string_characters_max"
}unit_scale
Listed in this schema’s required array.
- Declared type
"integer"
Reading definition for unit_scale
{
"type": "integer",
"minimum": 1
}initial_reserved_units
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for initial_reserved_units
{
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
}outstanding_reserved_units
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for outstanding_reserved_units
{
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
}gross_debited_units
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for gross_debited_units
{
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
}released_units
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for released_units
{
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
}credited_units
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for credited_units
{
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
}net_debited_units
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for net_debited_units
{
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"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": {
"unit": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"x-profile-maxLength": "string_characters_max"
},
"unit_scale": {
"type": "integer",
"minimum": 1
},
"initial_reserved_units": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
},
"outstanding_reserved_units": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
},
"gross_debited_units": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
},
"released_units": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
},
"credited_units": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
},
"net_debited_units": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
}
},
"required": [
"unit",
"unit_scale",
"initial_reserved_units",
"outstanding_reserved_units",
"gross_debited_units",
"released_units",
"credited_units",
"net_debited_units"
],
"additionalProperties": false,
"description": "initial=outstanding+gross_debited+released; net=gross_debited-credited; credits do not reopen the original reservation. Finance uses original funding allocations and separate adjustment grants where permitted; never add these included totals to usage twice. 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. credited_units is the sum of committed, authorised unit-credit ledger entries linked to this original order. A pending remedy decision or pending-policy/funding grant promise with no posted ledger credit contributes zero. A held, expired or revoked grant does not erase an already posted credit or turn it back into a debit; its currently available balance is separately zero. net_debited_units=gross_debited_units-committed credited_units; availability is never inferred from net or credited totals. Count each original ledger effect once, whether credited to original funding or its separately approved remedy funding; do not count the metadata grant twice."
}