Sustema

ENTITY developer reference

Receipt

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.

Permitted projection of an immutable commitment. The redacted accounting projection contains no subject/version, classification order or item references. Generic subject-bearing details expire no later than90days from original delivery, earlier on rights/deletion. A subject-free accounting receipt and nonreversible retry tombstone may remain for their separately qualified finite accounting period; no reverse index may recreate expired subject links. Current authority still controls reads. Financial identifiers/amounts are restricted accounting data, not a lookup history. Every receipt-to-order/item link, finance order/adjustment-request join, ICOperationResult and generic adjustment history uses the SAME order class(a) cutoff: earliest original delivery in that order +90days, or accepted_at +90days if none, intersected with earlier rights/deletion. Later-group delivery never extends the order join. A later receipt may retain its independently lawful own subject window while classification_order_id=null and classification_item_ids=[] from the earlier order cutoff. No reverse index reconstructs the removed join.

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.

receipt_id

Listed in this schema’s required array.

Declared type
"string"
Declared format
"uuid"
Reading definition for receipt_id
{
  "type": "string",
  "format": "uuid",
  "x-profile-maxLength": "string_characters_max"
}

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"
}

environment

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for environment
{
  "$ref": "#/components/schemas/Environment"
}

committed_at

Listed in this schema’s required array.

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

accepted_offer_id

Listed in this schema’s required array.

Declared type
"string"
Reading definition for accepted_offer_id
{
  "type": "string",
  "x-profile-maxLength": "string_characters_max"
}

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"
}

subject_versions

Listed in this schema’s required array.

Declared type
"array"
Reading definition for subject_versions
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/SubjectRef"
  },
  "x-profile-maxItems": "collection_items_max"
}

profile_revision

Listed in this schema’s required array.

Declared type
"string"
Reading definition for profile_revision
{
  "type": "string",
  "x-profile-maxLength": "string_characters_max"
}

policy_revision

Listed in this schema’s required array.

Declared type
"string"
Reading definition for policy_revision
{
  "type": "string",
  "x-profile-maxLength": "string_characters_max"
}

charged_units

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for charged_units
{
  "$ref": "#/components/schemas/Units"
}

unit

Listed in this schema’s required array.

Declared type
"string"
Reading definition for unit
{
  "type": "string",
  "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
}

settlement

Listed in this schema’s required array.

Original delivery settlement, including zero units. Later adjustments are separate ledger records and operation state; this receipt is immutable.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for settlement
{
  "const": "settled",
  "description": "Original delivery settlement, including zero units. Later adjustments are separate ledger records and operation state; this receipt is immutable."
}

result_available_until

Listed in this schema’s required array.

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

receipt_available_until

Listed in this schema’s required array.

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

delivery_meaning

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for delivery_meaning
{
  "const": "authorised_delivery_commit_not_client_receipt"
}

projection

Listed in this schema’s required array.

Declared type
"string"
Reading definition for projection
{
  "type": "string",
  "enum": [
    "full_permitted",
    "redacted"
  ],
  "x-profile-maxLength": "string_characters_max"
}

classification_order_id

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for classification_order_id
{
  "anyOf": [
    {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

classification_item_ids

Listed in this schema’s required array.

Declared type
"array"
Reading definition for classification_item_ids
{
  "type": "array",
  "items": {
    "type": "string",
    "format": "uuid",
    "x-profile-maxLength": "string_characters_max"
  },
  "minItems": 0,
  "x-profile-maxItems": "collection_items_max"
}

offer_binding

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for offer_binding
{
  "$ref": "#/components/schemas/OfferBinding"
}

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": {
    "receipt_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "operation_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "environment": {
      "$ref": "#/components/schemas/Environment"
    },
    "committed_at": {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    "accepted_offer_id": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "original_period_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "subject_versions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubjectRef"
      },
      "x-profile-maxItems": "collection_items_max"
    },
    "profile_revision": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "policy_revision": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "charged_units": {
      "$ref": "#/components/schemas/Units"
    },
    "unit": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "unit_scale": {
      "type": "integer",
      "minimum": 1
    },
    "settlement": {
      "const": "settled",
      "description": "Original delivery settlement, including zero units. Later adjustments are separate ledger records and operation state; this receipt is immutable."
    },
    "result_available_until": {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    "receipt_available_until": {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    "delivery_meaning": {
      "const": "authorised_delivery_commit_not_client_receipt"
    },
    "projection": {
      "type": "string",
      "enum": [
        "full_permitted",
        "redacted"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "classification_order_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "classification_item_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "x-profile-maxLength": "string_characters_max"
      },
      "minItems": 0,
      "x-profile-maxItems": "collection_items_max"
    },
    "offer_binding": {
      "$ref": "#/components/schemas/OfferBinding"
    }
  },
  "required": [
    "receipt_id",
    "operation_id",
    "environment",
    "committed_at",
    "accepted_offer_id",
    "original_period_id",
    "subject_versions",
    "profile_revision",
    "policy_revision",
    "charged_units",
    "unit",
    "unit_scale",
    "settlement",
    "result_available_until",
    "receipt_available_until",
    "delivery_meaning",
    "projection",
    "offer_binding",
    "classification_order_id",
    "classification_item_ids"
  ],
  "additionalProperties": false,
  "description": "Permitted projection of an immutable commitment. The redacted accounting projection contains no subject/version, classification order or item references. Generic subject-bearing details expire no later than90days from original delivery, earlier on rights/deletion. A subject-free accounting receipt and nonreversible retry tombstone may remain for their separately qualified finite accounting period; no reverse index may recreate expired subject links. Current authority still controls reads. Financial identifiers/amounts are restricted accounting data, not a lookup history. Every receipt-to-order/item link, finance order/adjustment-request join, ICOperationResult and generic adjustment history uses the SAME order class(a) cutoff: earliest original delivery in that order +90days, or accepted_at +90days if none, intersected with earlier rights/deletion. Later-group delivery never extends the order join. A later receipt may retain its independently lawful own subject window while classification_order_id=null and classification_item_ids=[] from the earlier order cutoff. No reverse index reconstructs the removed join.",
  "allOf": [
    {
      "if": {
        "properties": {
          "projection": {
            "const": "redacted"
          }
        },
        "required": [
          "projection"
        ]
      },
      "then": {
        "properties": {
          "subject_versions": {
            "maxItems": 0
          },
          "classification_order_id": {
            "type": "null"
          },
          "classification_item_ids": {
            "maxItems": 0
          }
        }
      }
    }
  ]
}

Related schemas

All API operations