Get Balances Response

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/thisisbud/main/json-schema/thisisbud-get-balances-response-schema.json",
  "title": "Get Balances Response",
  "x-generated": "2026-10-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/thisisbud-openapi-openapi.yml#/components/schemas/GetBalancesResponse",
  "type": "object",
  "required": [
    "operation_id"
  ],
  "properties": {
    "operation_id": {
      "$ref": "#/$defs/OperationId"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "balances"
        ],
        "properties": {
          "account_id": {
            "type": "string",
            "description": "Identifier of the accounts from which the balances have been calculated"
          },
          "balances": {
            "type": "array",
            "items": {
              "$ref": "#/$defs/BalanceOverTimeDataPoint"
            }
          }
        }
      }
    },
    "metadata": {
      "type": "object",
      "properties": {
        "accounts": {
          "description": "This is a hashmap representing account_ids and metadata about the results returned from the balances endpoint",
          "additionalProperties": {
            "description": "Hashmap of an account_id returned from the balances endpoint",
            "allOf": [
              {
                "$ref": "#/$defs/BudDateRangeMetadata"
              },
              {
                "type": "object",
                "properties": {
                  "balance_count": {
                    "type": "number",
                    "description": "The number of balances returned for the account"
                  }
                }
              },
              {
                "type": "object",
                "properties": {
                  "min_balance": {
                    "description": "The minimum balance in the returned period",
                    "$ref": "#/$defs/BudAmount"
                  }
                }
              },
              {
                "type": "object",
                "properties": {
                  "max_balance": {
                    "description": "The maximum balance in the returned period",
                    "$ref": "#/$defs/BudAmount"
                  }
                }
              },
              {
                "type": "object",
                "properties": {
                  "last_updated_at": {
                    "type": "string",
                    "format": "date-time",
                    "description": "The date and time the account's balance data was last updated, taken as the newer of the\naccount's balance date and the calculation date of the newest transaction used in the\nbalances-over-time calculation, in the format [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339).\n\nExamples:\n  - `2023-03-17T23:59:59Z`\n"
                  }
                }
              }
            ]
          }
        },
        "parameters": {
          "title": "The parameters used to calculated balances",
          "allOf": [
            {
              "$ref": "#/$defs/BudDateRangeMetadata"
            },
            {
              "type": "object",
              "properties": {
                "granularity": {
                  "type": "string",
                  "description": "The granularity that the balances have been retrieved for.\n\nCurrently supported values include (but are not necessarily limited to):\n  - `daily`\n  - `weekly`\n  - `biweekly`\n  - `monthly`\n  - `quarterly`\n  - `six_monthly`\n  - `annually`\n"
                }
              }
            }
          ]
        }
      }
    }
  },
  "$defs": {
    "BalanceAmount": {
      "title": "Balance amount",
      "description": "A representation of both the amount and the credit/debit indicator",
      "required": [
        "amount",
        "type",
        "credit_debit_indicator"
      ],
      "properties": {
        "amount": {
          "$ref": "#/$defs/BudAmount"
        },
        "type": {
          "type": "string",
          "description": "The type for the given balance.\n\nCurrently supported values include (but are not necessarily limited to):\n  - `closing_available`\n  - `closing_booked`\n  - `closing_cleared`\n  - `expected`\n  - `forward_available`\n  - `information`\n  - `interim_available`\n  - `interim_booked`\n  - `interim_cleared`\n  - `opening_available`\n  - `opening_booked`\n  - `opening_cleared`\n  - `previously_closed_booked`\n"
        },
        "credit_debit_indicator": {
          "type": "string",
          "description": "Indication as to whether the balance is in credit or debit",
          "enum": [
            "credit",
            "debit"
          ]
        }
      }
    },
    "BalanceOverTimeDataPoint": {
      "title": "Balance Over Time Data-Point",
      "description": "A single record of the balance at the end of the given date.",
      "type": "object",
      "required": [
        "date",
        "booked"
      ],
      "properties": {
        "date": {
          "type": "string",
          "description": "The date of the given balance in the format [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339).\n\nExamples:\n  - `2023-03-17T23:59:59Z`\n  - `2023-03-17T23:59:59-08:00`\n"
        },
        "booked": {
          "description": "The current balance of the account",
          "$ref": "#/$defs/BalanceAmount"
        },
        "pending": {
          "description": "The balance of the account if all pending transactions have settled. This field is only present if the pending balance is different than the booked balance.",
          "$ref": "#/$defs/BalanceAmount"
        }
      }
    },
    "BudAmount": {
      "title": "Standard Bud Amount",
      "type": "object",
      "description": "The monetary amount.",
      "required": [
        "value",
        "currency"
      ],
      "properties": {
        "value": {
          "$ref": "#/$defs/BudMonetaryValue"
        },
        "currency": {
          "$ref": "#/$defs/BudCurrency"
        }
      }
    },
    "BudCurrency": {
      "title": "Currency",
      "description": "The three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) of the monetary amount.\n\nExample: `GBP`\n",
      "type": "string"
    },
    "BudDateRangeMetadata": {
      "title": "Metadata",
      "type": "object",
      "required": [
        "from",
        "to"
      ],
      "properties": {
        "from": {
          "type": "string",
          "description": "The date from when results were retrieved in the format [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339).\nThis is either populated with the default value used when retrieving the results, or the user specified parameter.\n\nExamples:\n  - `2023-01-17T17:29:51Z`\n  - `2023-01-17T17:29:51-08:00`\n"
        },
        "to": {
          "type": "string",
          "description": "The date up to when results were retrieved in the format [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339).\nThis is either populated with the default value used when retrieving the results, or the user specified parameter.\n\nExamples:\n  - `2023-03-17T17:29:51Z`\n  - `2023-03-17T17:29:51-08:00`\n"
        }
      }
    },
    "BudMonetaryValue": {
      "title": "Monetary Value",
      "description": "The value of the monetary amount. The value is formatted with the number of decimal places for the respective currency. \n\nExample: `10.98`\n",
      "type": "string"
    },
    "OperationId": {
      "title": "Operation Id Field",
      "type": "string",
      "description": "A unique identifier/reference associated with a given endpoint/operation"
    }
  }
}