Balance

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/moneyhub/main/json-schema/moneyhub-balance-schema.json",
  "title": "Balance",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/moneyhub-accounts-api-openapi.yml#/components/schemas/Balance",
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "amount": {
      "properties": {
        "value": {
          "description": "The value of the balance in minor units of the currency, eg. pennies for GBP.",
          "type": "integer"
        },
        "majorUnits": {
          "description": "The major units of the value, based on the values currency, eg. pounds for GBP.",
          "type": "integer"
        },
        "minorUnits": {
          "description": "The minor units of the value, based on the values currency, eg. pennies for GBP.",
          "type": "integer"
        },
        "currency": {
          "description": "The currency of the balance taken from the account",
          "type": "string"
        }
      },
      "required": [
        "value",
        "currency"
      ],
      "type": "object"
    },
    "date": {
      "description": "The date of the balance",
      "format": "date",
      "type": "string"
    },
    "type": {
      "description": "The type of balance as returned by the banking provider. This field is only available for open banking connections. More information can be found [here](https://docs.moneyhubenterprise.com/docs/balance-types)",
      "type": "string",
      "enum": [
        "ClosingAvailable",
        "ClosingBooked",
        "ClosingCleared",
        "Expected",
        "ForwardAvailable",
        "Information",
        "InterimAvailable",
        "InterimBooked",
        "InterimCleared",
        "OpeningAvailable",
        "OpeningBooked",
        "OpeningCleared",
        "PreviouslyClosedBooked"
      ]
    }
  },
  "required": [
    "amount",
    "date"
  ]
}