SettlementList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/chia-health/json-schema/chia-health-settlement-list-schema.json",
  "title": "SettlementList",
  "x-generated": "2026-11-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/chia-health-openapi.yml#/components/schemas/SettlementList",
  "type": "object",
  "additionalProperties": false,
  "allOf": [
    {
      "if": {
        "properties": {
          "livemode": {
            "const": true
          }
        },
        "required": [
          "livemode"
        ]
      },
      "then": {
        "properties": {
          "data": {
            "items": {
              "required": [
                "revision",
                "supersedes_id",
                "released_at"
              ],
              "properties": {
                "aggregate_activity": {
                  "oneOf": [
                    {
                      "$ref": "#/$defs/PrivacyThresholdedAggregateActivity"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  ],
  "oneOf": [
    {
      "properties": {
        "has_more": {
          "const": true
        },
        "next_cursor": {
          "type": "string",
          "pattern": "^cur_[A-Za-z0-9_-]{16,252}$"
        }
      }
    },
    {
      "properties": {
        "has_more": {
          "const": false
        },
        "next_cursor": {
          "type": "null"
        }
      }
    }
  ],
  "required": [
    "object",
    "data",
    "has_more",
    "next_cursor",
    "livemode"
  ],
  "properties": {
    "object": {
      "const": "list"
    },
    "data": {
      "type": "array",
      "maxItems": 25,
      "items": {
        "$ref": "#/$defs/SettlementSummary"
      }
    },
    "has_more": {
      "type": "boolean"
    },
    "next_cursor": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^cur_[A-Za-z0-9_-]{16,252}$"
    },
    "livemode": {
      "type": "boolean"
    }
  },
  "$defs": {
    "AggregateActivity": {
      "oneOf": [
        {
          "$ref": "#/$defs/LegacyAggregateActivity"
        },
        {
          "$ref": "#/$defs/PrivacyThresholdedAggregateActivity"
        }
      ]
    },
    "LegacyAggregateActivity": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "release_id",
        "period",
        "aggregate_initial_purchase_count",
        "as_of"
      ],
      "properties": {
        "release_id": {
          "type": "string",
          "pattern": "^act_[A-Za-z0-9]{8,64}$"
        },
        "period": {
          "$ref": "#/$defs/Period"
        },
        "aggregate_initial_purchase_count": {
          "type": "integer",
          "minimum": 1,
          "maximum": 9007199254740991
        },
        "as_of": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "Money": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "amount",
        "currency"
      ],
      "properties": {
        "amount": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "currency": {
          "const": "USD"
        }
      }
    },
    "NamedParty": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 180
        }
      }
    },
    "Period": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "start",
        "end",
        "timezone"
      ],
      "properties": {
        "start": {
          "type": "string",
          "format": "date"
        },
        "end": {
          "type": "string",
          "format": "date"
        },
        "timezone": {
          "const": "UTC"
        }
      }
    },
    "PrivacyThresholdedAggregateActivity": {
      "type": "object",
      "additionalProperties": false,
      "description": "Optional released aggregate only. An internal immutable privacy release must prove both the hard minimum group size of 10 and composition approval before a non-null count is projected; those proof fields remain private. Otherwise the count is null with below_minimum_group_size, or aggregate_activity is null.",
      "allOf": [
        {
          "if": {
            "properties": {
              "aggregate_initial_purchase_count": {
                "type": "null"
              }
            },
            "required": [
              "aggregate_initial_purchase_count"
            ]
          },
          "then": {
            "properties": {
              "suppression_reason": {
                "const": "below_minimum_group_size"
              }
            }
          },
          "else": {
            "properties": {
              "suppression_reason": {
                "type": "null"
              }
            }
          }
        }
      ],
      "required": [
        "release_id",
        "period",
        "aggregate_initial_purchase_count",
        "suppression_reason",
        "minimum_group_size",
        "as_of"
      ],
      "properties": {
        "release_id": {
          "type": "string",
          "pattern": "^act_[A-Za-z0-9]{8,64}$"
        },
        "period": {
          "$ref": "#/$defs/Period"
        },
        "aggregate_initial_purchase_count": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1,
          "maximum": 9007199254740991
        },
        "suppression_reason": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            null,
            "below_minimum_group_size"
          ]
        },
        "minimum_group_size": {
          "type": "integer",
          "minimum": 10,
          "maximum": 100,
          "description": "Finance-released threshold for this aggregate. The Partner API hard floor is 10; a partner-specific approval may require a larger value."
        },
        "as_of": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "ServiceFee": {
      "type": "object",
      "additionalProperties": false,
      "description": "Finance-authored statement values only. The API validates and projects this released record; it never calculates fee, due, paid, payable, or paid-at state from live data, configuration, events, or time.",
      "required": [
        "statement_id",
        "period",
        "status",
        "payer",
        "payee",
        "fixed_service_fee",
        "amount_paid",
        "amount_due_to_partner",
        "payable_on",
        "paid_at",
        "terms_version",
        "as_of"
      ],
      "properties": {
        "statement_id": {
          "type": "string",
          "pattern": "^fee_[A-Za-z0-9]{8,64}$"
        },
        "period": {
          "$ref": "#/$defs/Period"
        },
        "status": {
          "enum": [
            "finalized",
            "paid"
          ]
        },
        "payer": {
          "$ref": "#/$defs/NamedParty"
        },
        "payee": {
          "$ref": "#/$defs/NamedParty"
        },
        "fixed_service_fee": {
          "$ref": "#/$defs/Money"
        },
        "amount_paid": {
          "$ref": "#/$defs/Money"
        },
        "amount_due_to_partner": {
          "$ref": "#/$defs/Money"
        },
        "payable_on": {
          "type": [
            "string",
            "null"
          ],
          "format": "date"
        },
        "paid_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "terms_version": {
          "type": "string",
          "pattern": "^terms_[A-Za-z0-9]{8,64}$"
        },
        "as_of": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "SettlementSummary": {
      "type": "object",
      "additionalProperties": false,
      "description": "One closed settlement projection. Sandbox rows are synthetic 2.0-compatible fixtures. Every production row is a distinct immutable Finance release: id identifies that release, revision is the Finance-authored statement revision, supersedes_id links a correction to the immediately prior release, and released_at records the release decision. The public object contains no patient, order, payment-level, shipment, program, geography, event, or date-row data.",
      "allOf": [
        {
          "if": {
            "required": [
              "revision"
            ],
            "properties": {
              "revision": {
                "const": 1
              }
            }
          },
          "then": {
            "properties": {
              "supersedes_id": {
                "type": "null"
              }
            }
          },
          "else": {
            "properties": {
              "supersedes_id": {
                "type": "string",
                "pattern": "^set_[A-Za-z0-9]{8,64}$"
              }
            }
          }
        }
      ],
      "required": [
        "id",
        "object",
        "service_fee",
        "aggregate_activity"
      ],
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^set_[A-Za-z0-9]{8,64}$"
        },
        "object": {
          "const": "settlement_summary"
        },
        "revision": {
          "type": "integer",
          "minimum": 1,
          "maximum": 9007199254740991,
          "description": "Required in production. Finance-authored immutable revision number for this logical statement."
        },
        "supersedes_id": {
          "type": [
            "string",
            "null"
          ],
          "pattern": "^set_[A-Za-z0-9]{8,64}$",
          "description": "Required in production. Null for revision 1; otherwise the prior immutable release id corrected by this revision."
        },
        "released_at": {
          "type": "string",
          "format": "date-time",
          "description": "Required in production. Finance-authored release timestamp; never inferred from request or processing time."
        },
        "service_fee": {
          "$ref": "#/$defs/ServiceFee"
        },
        "aggregate_activity": {
          "oneOf": [
            {
              "$ref": "#/$defs/AggregateActivity"
            },
            {
              "type": "null"
            }
          ]
        }
      }
    }
  }
}