Derived - Networth Resource
This page refers to Yodlee API v1.0. The latest API version's data model documentation is available here.
Entity: networth
| Attribute Name | Container | Type | Description |
|---|---|---|---|
| date | bank creditCard investment insurance realEstate loan |
date | The date as of when the networth information is provided. |
| asset | bank creditCard investment insurance realEstate loan |
money | The asset value that the user owns. |
| liability | bank creditCard investment insurance realEstate loan |
money | The liability amount that the user owes. |
| networth | bank creditCard investment insurance realEstate loan |
money | Networth of the user. |
| historicalBalances | bank creditCard investment insurance realEstate loan |
entity[] | Balances of the accounts over the period of time. |
Entity: historicalBalances
| Attribute Name | Container | Type | Aggregated/Manual | Description | Endpoints |
|---|---|---|---|---|---|
| date | bank creditCard investment insurance realEstate loan |
date | Both | 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 site. This balance gets stored in Yodlee system during system/user account updates. carryForward : 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. calculated: Balances that gets calculated for the days that are prior to the account added date. |
GET accounts/historicalBalances GET derived/networth |
| asOfDate | bank creditCard investment insurance realEstate loan |
date | Both | 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. | GET accounts/historicalBalances |
| balance | bank creditCard investment insurance realEstate loan |
money | Both | Balance amount of the account. | GET accounts/historicalBalances |
| isAsset | bank creditCard investment insurance realEstate loan |
boolean | Both | Indicates whether the balance is an asset or liability. | GET accounts/historicalBalances |
| dataSourceType | bank creditCard investment insurance realEstate loan |
string | Both | The source of balance information.
Valid Values: Balances Data Source Type
|
GET accounts/historicalBalances |
Enums: Balances Data Source Type
| DataSourceType | Description |
|---|---|
| S | Scraped balance from the provider site. |
| C | Calculated balance by the system. |
| CF | Last available balance that was carry forwarded for the days when account was not updated. |