statement

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bond/main/json-schema/bond-statement-schema.json",
  "title": "statement",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bond-accounts-openapi.yml#/components/schemas/statement",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "statement_id": {
          "type": "string"
        },
        "account_id": {
          "type": "string",
          "description": "uuid of account"
        },
        "statement_month": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": [
            "credit",
            "deposit"
          ]
        },
        "statement_start_date": {
          "type": "string"
        },
        "statement_end_date": {
          "type": "string"
        },
        "fees": {
          "type": "integer"
        },
        "transactions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "transaction_date": {
                "type": "string"
              },
              "settled_date": {
                "type": "string"
              },
              "amount": {
                "type": "integer"
              },
              "transaction_description": {
                "type": "string"
              },
              "transaction_type": {
                "type": "string",
                "enum": [
                  "Fee",
                  "Refund",
                  "Payment",
                  "Purchase",
                  "Interest"
                ]
              }
            },
            "required": [
              "transaction_date",
              "settled_date",
              "amount",
              "transaction_description",
              "transaction_type"
            ]
          }
        }
      },
      "required": [
        "statement_id",
        "statement_month",
        "type",
        "statement_start_date",
        "statement_end_date",
        "fees",
        "transactions"
      ]
    },
    {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "deposit": {
              "$ref": "#/$defs/account-deposit"
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "credit": {
              "$ref": "#/$defs/account-credit"
            }
          }
        }
      ]
    }
  ],
  "$defs": {
    "account-credit": {
      "type": "object",
      "title": "account-credit",
      "properties": {
        "credit_limit": {
          "type": "integer",
          "readOnly": true
        },
        "security_deposit_account_id": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": true
        }
      }
    },
    "account-deposit": {
      "title": "account-deposit",
      "x-stoplight": {
        "id": "qn18lhs28ly7m"
      },
      "type": "object"
    }
  }
}