Sustema

ENTITY developer reference

OfferBinding

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.

Immutable resolved business-offer and policy pins. Paid funded execution requires agreement and original funded credit-period IDs. A sponsored/free execution requires its actual sponsored period but has null paid agreement/revision; it still binds the accepted free offer and source rights. Catalogue and pre-agreement quotes may have null agreement/period. Top-up/upgrade funding retains the original base credit-period identity and its separate funding/lot identities; renewal never rebinds an admitted reservation. On an operation/order/receipt, funded_period_id is its immutable admission accounting period, equal to original_period_id where projected. Each underlying funding allocation separately retains the grant/lot and its own originating period and terms. A mixed-lot operation does not imply that every lot was funded by the service agreement or in its admission period.

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.

offer_id

Listed in this schema’s required array.

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

offer_version

Listed in this schema’s required array.

Declared type
"integer"
Reading definition for offer_version
{
  "type": "integer",
  "minimum": 1
}

offer_sha256

Listed in this schema’s required array.

Declared type
"string"
Reading definition for offer_sha256
{
  "type": "string",
  "pattern": "^[a-f0-9]{64}$",
  "x-profile-maxLength": "string_characters_max"
}

policy_pins

Listed in this schema’s required array.

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

agreement_id

Listed in this schema’s required array.

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

agreement_revision

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for agreement_revision
{
  "anyOf": [
    {
      "type": "integer",
      "minimum": 1
    },
    {
      "type": "null"
    }
  ]
}

funded_period_id

Listed in this schema’s required array.

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

selection_evidence_id

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for selection_evidence_id
{
  "anyOf": [
    {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "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",
  "additionalProperties": false,
  "properties": {
    "offer_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "offer_version": {
      "type": "integer",
      "minimum": 1
    },
    "offer_sha256": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$",
      "x-profile-maxLength": "string_characters_max"
    },
    "policy_pins": {
      "$ref": "#/components/schemas/OfferPolicyPins"
    },
    "agreement_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "agreement_revision": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 1
        },
        {
          "type": "null"
        }
      ]
    },
    "funded_period_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "selection_evidence_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "offer_id",
    "offer_version",
    "offer_sha256",
    "policy_pins",
    "agreement_id",
    "agreement_revision",
    "funded_period_id",
    "selection_evidence_id"
  ],
  "description": "Immutable resolved business-offer and policy pins. Paid funded execution requires agreement and original funded credit-period IDs. A sponsored/free execution requires its actual sponsored period but has null paid agreement/revision; it still binds the accepted free offer and source rights. Catalogue and pre-agreement quotes may have null agreement/period. Top-up/upgrade funding retains the original base credit-period identity and its separate funding/lot identities; renewal never rebinds an admitted reservation. On an operation/order/receipt, funded_period_id is its immutable admission accounting period, equal to original_period_id where projected. Each underlying funding allocation separately retains the grant/lot and its own originating period and terms. A mixed-lot operation does not imply that every lot was funded by the service agreement or in its admission period."
}

Related schemas

All API operations