Sustema

ENTITY developer reference

ICAdjustmentRequest

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.

Authenticated claim linked to an owned order. No new spend or work balance required; no unconditional refund and no automatic URL fetching at intake. Evidence URLs require normal safe-source qualification if later fetched. Only HTTPS evidence references; render as untrusted text and apply safe destination rules. Intake never fetches URLs.

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.

order_id

Listed in this schema’s required array.

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

item_id

Listed in this schema’s required array.

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

acquisition_id

Listed in this schema’s required array.

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

reason

Listed in this schema’s required array.

Declared type
"string"
Reading definition for reason
{
  "type": "string",
  "enum": [
    "duplicate_debit",
    "no_qualifying_result",
    "undelivered_result",
    "wrong_subject_or_scope",
    "evidence_error"
  ],
  "x-profile-maxLength": "string_characters_max"
}

explanation

Listed in this schema’s required array.

Declared type
"string"
Reading definition for explanation
{
  "type": "string",
  "minLength": 1,
  "maxLength": 1000,
  "x-profile-maxLength": "string_characters_max"
}

evidence_url

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for evidence_url
{
  "anyOf": [
    {
      "type": "string",
      "format": "uri",
      "x-profile-maxLength": "string_characters_max",
      "pattern": "^https://",
      "maxLength": 2000
    },
    {
      "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": {
    "order_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "item_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "acquisition_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "reason": {
      "type": "string",
      "enum": [
        "duplicate_debit",
        "no_qualifying_result",
        "undelivered_result",
        "wrong_subject_or_scope",
        "evidence_error"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "explanation": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1000,
      "x-profile-maxLength": "string_characters_max"
    },
    "evidence_url": {
      "anyOf": [
        {
          "type": "string",
          "format": "uri",
          "x-profile-maxLength": "string_characters_max",
          "pattern": "^https://",
          "maxLength": 2000
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "order_id",
    "item_id",
    "acquisition_id",
    "reason",
    "explanation",
    "evidence_url"
  ],
  "additionalProperties": false,
  "description": "Authenticated claim linked to an owned order. No new spend or work balance required; no unconditional refund and no automatic URL fetching at intake. Evidence URLs require normal safe-source qualification if later fetched. Only HTTPS evidence references; render as untrusted text and apply safe destination rules. Intake never fetches URLs."
}

All API operations