Get account

{
  "type": "object",
  "properties": {
    "created_at": {
      "type": "string",
      "description": "When the account was created."
    },
    "currency_code": {
      "type": "string",
      "description": "The currency code for the account."
    },
    "current_balance": {
      "type": "number",
      "description": "The current balance of the account."
    },
    "current_balance_date": {
      "type": "string",
      "description": "The date of the current balance."
    },
    "current_balance_exchange_rate": {
      "type": "number",
      "description": "The exchange rate between the account's currency and the user's base currency, when different. If the currencies are the same, null is returned."
    },
    "current_balance_in_base_currency": {
      "type": "number",
      "description": "The current balance of the account in the user's base currency."
    },
    "id": {
      "type": "integer",
      "description": "The unique identifier of the account."
    },
    "is_net_worth": {
      "type": "boolean",
      "description": "Whether the account is a net worth asset."
    },
    "primary_scenario": {
      "type": "object",
      "properties": {
        "achieve_date": {
          "type": "string",
          "description": "For goals, the date that they should be achieved by."
        },
        "closing_balance": {
          "type": "number",
          "description": "The closing balance of the scenario."
        },
        "closing_balance_date": {
          "type": "string",
          "description": "The date of the closing balance."
        },
        "created_at": {
          "type": "string",
          "description": "When the scenario was created."
        },
        "current_balance": {
          "type": "number",
          "description": "The current balance of the scenario."
        },
        "current_balance_date": {
          "type": "string",
          "description": "The date of the current balance."
        },
        "current_balance_exchange_rate": {
          "type": "number",
          "description": "The exchange rate between the scenario's currency and the user's base currency, when different. If the currencies are the same, null is returned."
        },
        "current_balance_in_base_currency": {
          "type": "number",
          "description": "The current balance of the scenario in the user's base currency."
        },
        "description": {
          "type": "string",
          "description": "A short description of what the scenario is modelling."
        },
        "id": {
          "type": "integer",
          "description": "The unique identifier of the scenario."
        },
        "interest_rate": {
          "type": "number",
          "description": "The amount of interest to apply to the balance. Will apply periodically depending on what `interest_rate_repeat_id` is set to."
        },
        "interest_rate_repeat_id": {
          "type": "integer",
          "description": "A number representing how often the interest should be applied. 0 is used for no interest, 2 is weekly, 3 is fortnightly, 4 is monthly, 5 is yearly and 7 for quarterly."
        },
        "maximum-value": {
          "type": "number"
        },
        "minimum-value": {
          "type": "number"
        },
        "safe_balance": {
          "type": "number",
          "description": "The current safe balance in the user's base currency, if safe balance is activated on the account associated with the scenario. If safe balance is not activated, then null is returned."
        },
        "safe_balance_in_base_currency": {
          "type": "number",
          "description": "The current safe balance in the user's base currency, if safe balance is activated on the account associated with the scenario. If safe balance is not available, then null is returned."
        },
        "starting_balance": {
          "type": "number",
          "description": "The starting balance of the scenario."
        },
        "starting_balance_date": {
          "type": "string",
          "description": "The date of the starting balance."
        },
        "title": {
          "type": "string",
          "description": "The title of the scenario."
        },
        "type": {
          "type": "string",
          "description": "The type of the scenario.",
          "enum": [
            "no-interest",
            "savings",
            "debt"
          ]
        },
        "updated_at": {
          "type": "string",
          "description": "When the scenario was last updated."
        }
      }
    },
    "primary_transaction_account": {
      "type": "object",
      "properties": {
        "created_at": {
          "type": "string"
        },
        "currency_code": {
          "type": "string",
          "description": "The currency that the account is in. This is determined by the account that the transaction account belongs to."
        },
        "current_balance": {
          "type": "number"
        },
        "current_balance_date": {
          "type": "string"
        },
        "current_balance_exchange_rate": {
          "type": "number",
          "description": "The exchange rate between the transaction account's currency and the user's base currency, when different. If the currencies are the same, null is returned."
        },
        "current_balance_in_base_currency": {
          "type": "number",
          "description": "The current balance of the transaction account in the user's base currency."
        },
        "id": {
          "type": "integer"
        },
        "institution": {
          "type": "object",
          "properties": {
            "created_at": {
              "type": "string",
              "description": "When the institution was created."
            },
            "currency_code": {
              "type": "string",
              "description": "The currency code of the institution."
            },
            "id": {
              "type": "integer",
              "description": "The unique identifier of the institution."
            },
            "title": {
              "type": "string",
              "description": "The title of the institution."
            },
            "updated_at": {
              "type": "string",
              "description": "When the institution was last updated."
            }
          }
        },
        "name": {
          "type": "string"
        },
        "number": {
          "type": "string"
        },
        "safe_balance": {
          "type": "number",
          "description": "The current safe balance, if safe balance is activated and available for the transaction account. If safe balance is not available, then null is returned."
        },
        "safe_balance_in_base_currency": {
          "type": "number",
          "description": "The current safe balance in the user's base currency, if safe balance is activated and available for the transaction account. If safe balance is not available, then null is returned."
        },
        "starting_balance": {
          "type": "number"
        },
        "starting_balance_date": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "description": "The type of the transaction account.",
          "enum": [
            "bank",
            "credits",
            "cash",
            "stocks",
            "mortgage",
            "loans",
            "vehicle",
            "property",
            "insurance",
            "other_asset",
            "other_liability"
          ]
        },
        "updated_at": {
          "type": "string"
        }
      }
    },
    "safe_balance": {
      "type": "number",
      "description": "The current safe balance, if safe balance is activated on the account. If safe balance is not activated, then null is returned."
    },
    "safe_balance_in_base_currency": {
      "type": "number",
      "description": "The current safe balance in the user's base currency, if safe balance is activated on the account. If safe balance is not activated, then null is returned."
    },
    "scenarios": {
      "type": "array",
      "description": "All scenarios that compose the account, including the primary.",
      "items": {
        "type": "object",
        "properties": {
          "achieve_date": {
            "type": "string",
            "description": "For goals, the date that they should be achieved by."
          },
          "closing_balance": {
            "type": "number",
            "description": "The closing balance of the scenario."
          },
          "closing_balance_date": {
            "type": "string",
            "description": "The date of the closing balance."
          },
          "created_at": {
            "type": "string",
            "description": "When the scenario was created."
          },
          "current_balance": {
            "type": "number",
            "description": "The current balance of the scenario."
          },
          "current_balance_date": {
            "type": "string",
            "description": "The date of the current balance."
          },
          "current_balance_exchange_rate": {
            "type": "number",
            "description": "The exchange rate between the scenario's currency and the user's base currency, when different. If the currencies are the same, null is returned."
          },
          "current_balance_in_base_currency": {
            "type": "number",
            "description": "The current balance of the scenario in the user's base currency."
          },
          "description": {
            "type": "string",
            "description": "A short description of what the scenario is modelling."
          },
          "id": {
            "type": "integer",
            "description": "The unique identifier of the scenario."
          },
          "interest_rate": {
            "type": "number",
            "description": "The amount of interest to apply to the balance. Will apply periodically depending on what `interest_rate_repeat_id` is set to."
          },
          "interest_rate_repeat_id": {
            "type": "integer",
            "description": "A number representing how often the interest should be applied. 0 is used for no interest, 2 is weekly, 3 is fortnightly, 4 is monthly, 5 is yearly and 7 for quarterly."
          },
          "maximum-value": {
            "type": "number"
          },
          "minimum-value": {
            "type": "number"
          },
          "safe_balance": {
            "type": "number",
            "description": "The current safe balance in the user's base currency, if safe balance is activated on the account associated with the scenario. If safe balance is not activated, then null is returned."
          },
          "safe_balance_in_base_currency": {
            "type": "number",
            "description": "The current safe balance in the user's base currency, if safe balance is activated on the account associated with the scenario. If safe balance is not available, then null is returned."
          },
          "starting_balance": {
            "type": "number",
            "description": "The starting balance of the scenario."
          },
          "starting_balance_date": {
            "type": "string",
            "description": "The date of the starting balance."
          },
          "title": {
            "type": "string",
            "description": "The title of the scenario."
          },
          "type": {
            "type": "string",
            "description": "The type of the scenario.",
            "enum": [
              "no-interest",
              "savings",
              "debt"
            ]
          },
          "updated_at": {
            "type": "string",
            "description": "When the scenario was last updated."
          }
        }
      }
    },
    "title": {
      "type": "string",
      "description": "The title of the account."
    },
    "transaction_accounts": {
      "type": "array",
      "description": "All transaction accounts that compose the account, including the primary.",
      "items": {
        "type": "object",
        "properties": {
          "created_at": {
            "type": "string"
          },
          "currency_code": {
            "type": "string",
            "description": "The currency that the account is in. This is determined by the account that the transaction account belongs to."
          },
          "current_balance": {
            "type": "number"
          },
          "current_balance_date": {
            "type": "string"
          },
          "current_balance_exchange_rate": {
            "type": "number",
            "description": "The exchange rate between the transaction account's currency and the user's base currency, when different. If the currencies are the same, null is returned."
          },
          "current_balance_in_base_currency": {
            "type": "number",
            "description": "The current balance of the transaction account in the user's base currency."
          },
          "id": {
            "type": "integer"
          },
          "institution": {
            "type": "object",
            "properties": {
              "created_at": {
                "type": "string",
                "description": "When the institution was created."
              },
              "currency_code": {
                "type": "string",
                "description": "The currency code of the institution."
              },
              "id": {
                "type": "integer",
                "description": "The unique identifier of the institution."
              },
              "title": {
                "type": "string",
                "description": "The title of the institution."
              },
              "updated_at": {
                "type": "string",
                "description": "When the institution was last updated."
              }
            }
          },
          "name": {
            "type": "string"
          },
          "number": {
            "type": "string"
          },
          "safe_balance": {
            "type": "number",
            "description": "The current safe balance, if safe balance is activated and available for the transaction account. If safe balance is not available, then null is returned."
          },
          "safe_balance_in_base_currency": {
            "type": "number",
            "description": "The current safe balance in the user's base currency, if safe balance is activated and available for the transaction account. If safe balance is not available, then null is returned."
          },
          "starting_balance": {
            "type": "number"
          },
          "starting_balance_date": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "description": "The type of the transaction account.",
            "enum": [
              "bank",
              "credits",
              "cash",
              "stocks",
              "mortgage",
              "loans",
              "vehicle",
              "property",
              "insurance",
              "other_asset",
              "other_liability"
            ]
          },
          "updated_at": {
            "type": "string"
          }
        }
      }
    },
    "type": {
      "type": "string",
      "description": "The type of the account.",
      "enum": [
        "bank",
        "credits",
        "cash",
        "stocks",
        "mortgage",
        "loans",
        "vehicle",
        "property",
        "insurance",
        "other_asset",
        "other_liability"
      ]
    },
    "updated_at": {
      "type": "string",
      "description": "When the account was last updated."
    }
  }
}