Envestnet · Schema

HistoricalBalance

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name Type Description
date string Date for which the account balance was provided. This balance could be a carryforward, calculated or a scraped balance.
Additional Details:
Scraped: Balance shown in the provider s
isAsset boolean Indicates whether the balance is an asset or liability.

Aggregated / Manual: Both
Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
Endpoi
balance object
asOfDate string Date as of when the balance is last updated due to the auto account updates or user triggered updates. This balance will be carry forward for the days where there is no balance available in the system
dataSourceType string The source of balance information.

Aggregated / Manual: Both
Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
Endpoints:
  • GET a
View JSON Schema on GitHub

JSON Schema

envestnet-historicalbalance-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HistoricalBalance",
  "title": "HistoricalBalance",
  "type": "object",
  "properties": {
    "date": {
      "type": "string",
      "description": "Date for which the account balance was provided.  This balance could be a carryforward, calculated or a scraped balance.<br><b>Additional Details</b>:<br><b>Scraped</b>: Balance shown in the provider site. This balance gets stored in Yodlee system during system/user account updates.<br><b>CarryForward</b>: Balance carried forward from the scraped balance to the days for which the balance was not available in the system. Balance may not be available for all the days in the system due to MFA information required, error in the site, credential changes, etc.<br><b>calculated</b>: Balances that gets calculated for the days that are prior to the account added date.  <br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: bank, creditCard, investment, insurance, realEstate, loan<br><b>Endpoints</b>:<ul><li>GET accounts/historicalBalances</li><li>GET derived/networth</li></ul>",
      "readOnly": true
    },
    "isAsset": {
      "type": "boolean",
      "description": "Indicates whether the balance is an asset or liability.<br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: bank, creditCard, investment, insurance, realEstate, loan<br><b>Endpoints</b>:<ul><li>GET accounts/historicalBalances</li></ul>",
      "readOnly": true
    },
    "balance": {
      "$ref": "#/components/schemas/Money"
    },
    "asOfDate": {
      "type": "string",
      "description": "Date as of when the balance is last updated due to the auto account updates or user triggered updates. This balance will be carry forward for the days where there is no balance available in the system. <br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: bank, creditCard, investment, insurance, realEstate, loan<br><b>Endpoints</b>:<ul><li>GET accounts/historicalBalances</li></ul>",
      "readOnly": true
    },
    "dataSourceType": {
      "type": "string",
      "description": "The source of balance information.<br><br><b>Aggregated / Manual</b>: Both <br><b>Applicable containers</b>: bank, creditCard, investment, insurance, realEstate, loan<br><b>Endpoints</b>:<ul><li>GET accounts/historicalBalances</li></ul><b>Applicable Values</b><br>",
      "readOnly": true,
      "enum": [
        "S",
        "C",
        "CF"
      ]
    }
  }
}