{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/yapily/main/json-schema/yapily-account-balance-schema.json",
  "title": "Yapily AccountBalance",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Specifies the type of the stated account balance.",
      "enum": [
        "CLOSING_AVAILABLE",
        "CLOSING_BOOKED",
        "CLOSING_CLEARED",
        "EXPECTED",
        "FORWARD_AVAILABLE",
        "INFORMATION",
        "INTERIM_AVAILABLE",
        "INTERIM_BOOKED",
        "INTERIM_CLEARED",
        "OPENING_AVAILABLE",
        "OPENING_BOOKED",
        "OPENING_CLEARED",
        "PREVIOUSLY_CLOSED_BOOKED",
        "AUTHORISED",
        "OTHER",
        "UNKNOWN"
      ]
    },
    "dateTime": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time of the reported balance."
    },
    "balanceAmount": {
      "title": "Amount Details",
      "required": [
        "amount",
        "currency"
      ],
      "type": "object",
      "properties": {
        "amount": {
          "title": "Amount",
          "type": "number",
          "description": "__Mandatory__. The monetary value",
          "example": 10
        },
        "currency": {
          "title": "Currency",
          "type": "string",
          "description": "__Mandatory__. The [ISO 4217](https://www.xe.com/iso4217.php) currency code",
          "example": "GBP"
        }
      },
      "description": "__Mandatory__. Monetary Amount."
    },
    "creditLineIncluded": {
      "type": "boolean",
      "description": "__Optional__. Indicates whether any credit lines are included in the balance."
    },
    "creditLines": {
      "type": "array",
      "description": "__Optional__. Specifies the type of balance.",
      "items": {
        "type": "object",
        "description": "__Mandatory__. Details whether the account has access to a credit line from an `Institution`.",
        "properties": {
          "type": {
            "type": "string",
            "description": "__Mandatory__. The type of credit that has been provided.",
            "enum": [
              "AVAILABLE",
              "CREDIT",
              "EMERGENCY",
              "PRE_AGREED",
              "TEMPORARY",
              "OTHER",
              "UNKNOWN"
            ]
          },
          "creditLineAmount": {
            "title": "Amount Details",
            "required": [
              "amount",
              "currency"
            ],
            "type": "object",
            "properties": {
              "amount": {
                "title": "Amount",
                "type": "number",
                "description": "__Mandatory__. The monetary value",
                "example": 10
              },
              "currency": {
                "title": "Currency",
                "type": "string",
                "description": "__Mandatory__. The [ISO 4217](https://www.xe.com/iso4217.php) currency code",
                "example": "GBP"
              }
            },
            "description": "__Mandatory__. Monetary Amount."
          }
        }
      }
    }
  }
}