Yodlee Derived API

openapi: 3.2.0
info:
  license:
    name: Yodlee Developer License
    url: https://developer.yodlee.com/terms/condition#_Services_1
  contact:
    email: developer@yodlee.com
  description: 'This file describes the Yodlee Platform APIs using the swagger notation. You can use this swagger file to generate client side SDKs to the Yodlee Platform APIs for many different programming languages. Yodlee API v1.1 - Overview</a>.<br><br>You will have to set the header before making the API call. The following headers apply to all the APIs:<ul><li>Authorization: This header holds the access token</li> <li> Api-Version: 1.1</li></ul><b>Note</b>: If there are any API-specific headers, they are mentioned explicitly in the respective API''s description.'
  termsOfService: https://developer.yodlee.com/terms/condition
  title: Yodlee Core APIs Account Token Derived API
  version: 1.1.0
servers:
- url: /
tags:
- name: Derived
  description: Derived API
paths:
  /derived/networth:
    get:
      summary: Get Networth Summary
      deprecated: false
      description: The get networth service is used to get the networth for the user.<br>If the include parameter value is passed as details then networth with historical balances is returned. <br>
      operationId: getNetworth
      responses:
        200:
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/DerivedNetworthResponse'
        400:
          description: 'Y800 : Invalid value for accountIds<br>Y800 : Invalid value for fromDate<br>Y800 : Invalid value for toDate<br>Y809 : Invalid date range<br>Y800 : Invalid value for interval<br>Y802 : Future date not allowed<br>Y814 : Exchange rate not available for currency<br>Y800 : Invalid value for container'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: query
        allowEmptyValue: false
        name: accountIds
        description: comma separated accountIds
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: container
        description: bank/creditCard/investment/insurance/loan/realEstate/otherAssets/otherLiabilities
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: fromDate
        description: from date for balance retrieval (YYYY-MM-DD)
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: include
        description: details
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: interval
        description: D-daily, W-weekly or M-monthly
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: skip
        description: skip (Min 0)
        required: false
        schema:
          type: integer
          format: int32
      - in: query
        allowEmptyValue: false
        name: toDate
        description: toDate for balance retrieval (YYYY-MM-DD)
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: top
        description: top (Max 500)
        required: false
        schema:
          type: integer
          format: int32
      tags:
      - Derived
  /derived/transactionSummary:
    get:
      summary: Get Transaction Summary
      deprecated: false
      description: The transaction summary service provides the summary values of transactions for the given date range by category type, high-level categories, or system-defined categories.<br><br>Yodlee has the transaction data stored for a day, month, year and week per category as per the availability of user's data. If the include parameter value is passed as details, then summary details will be returned depending on the interval passed-monthly is the default.<br><br><b>Notes:</b><ol> <li> Details can be requested for only one system-defined category<li>Passing categoryType is mandatory except when the groupBy value is CATEGORY_TYPE<li>Dates will not be respected for monthly, yearly, and weekly details<li>When monthly details are requested, only the fromDate and toDate month will be respected<li>When yearly details are requested, only the fromDate and toDate year will be respected<li>For weekly data points, details will be provided for every Sunday date available within the fromDate and toDate<li>This service supports the localization feature and accepts locale as a header parameter</li></ol>
      operationId: getTransactionSummary
      responses:
        200:
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/DerivedTransactionSummaryResponse'
        400:
          description: 'Y010 : Invalid session<br>Y800 : Invalid value for accountId<br>Y800 : Invalid value for groupBy<br>Y803 : groupBy required<br>Y803 : categoryType required<br>Y800 : Invalid value for categoryId<br>Y800 : Invalid value for fromDate<br>Y800 : Invalid value for toDate<br>Y800 : Invalid value for fromDate or toDate<br>Y814 : Exchange rate not available for currency<br>Y815 : Cannot apply filter on categoryId if groupBy value is CATEGORY_TYPE<br>Y816 : User-defined category details can only be requested for one system categoryId with groupBy=''CATEGORY''<br>Y824 : The maximum number of accountIds permitted is 100<br>Y824 : The maximum number of categoryIds permitted is 100<br>Y824 : The maximum number of categoryTypes permitted is 100'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: query
        allowEmptyValue: false
        name: accountId
        description: comma separated account Ids
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: categoryId
        description: comma separated categoryIds
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: categoryType
        description: LOAN, INCOME, EXPENSE, TRANSFER, UNCATEGORIZE or DEFERRED_COMPENSATION
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: fromDate
        description: YYYY-MM-DD format
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: groupBy
        description: CATEGORY_TYPE, HIGH_LEVEL_CATEGORY or CATEGORY
        required: true
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: include
        description: details
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: includeUserCategory
        description: TRUE/FALSE
        required: false
        schema:
          type: boolean
      - in: query
        allowEmptyValue: false
        name: interval
        description: D-daily, W-weekly, M-mothly or Y-yearly
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: toDate
        description: YYYY-MM-DD format
        required: false
        schema:
          type: string
      tags:
      - Derived
  /derived/holdingSummary:
    get:
      summary: Get Holding Summary
      deprecated: false
      description: The get holding summary service is used to get the summary of asset classifications for the user.<br>By default, accounts with status as ACTIVE and TO BE CLOSED will be considered.<br>If the include parameter value is passed as details then a summary with holdings and account information is returned.<br>
      operationId: getHoldingSummary
      responses:
        200:
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/DerivedHoldingSummaryResponse'
        400:
          description: 'Y800 : Invalid value for classificationType<br>Y814 : Exchange rate not available for currency<br>Y824 : The maximum number of accountIds permitted is 100<br>'
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/YodleeError'
        401:
          description: Unauthorized
        404:
          description: Not Found
      parameters:
      - in: query
        allowEmptyValue: false
        name: accountIds
        description: Comma separated accountIds
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: classificationType
        description: e.g. Country, Sector, etc.
        required: false
        schema:
          type: string
      - in: query
        allowEmptyValue: false
        name: include
        description: details
        required: false
        schema:
          type: string
      tags:
      - Derived
components:
  schemas:
    DerivedHoldingsLinks:
      type: object
      title: DerivedHoldingsLinks
      properties:
        holdings:
          readOnly: true
          type: string
    DerivedNetworth:
      type: object
      title: DerivedNetworth
      properties:
        date:
          description: 'The date as of when the networth information is provided.<br><br><b>Applicable containers</b>: bank, creditcard, investment, insurance, realEstate, loan<br>'
          readOnly: true
          type: string
        liability:
          description: 'The liability amount that the user owes.<br><br><b>Applicable containers</b>: bank, creditcard, investment, insurance, realEstate, loan<br>'
          readOnly: true
          $ref: '#/components/schemas/Money'
        historicalBalances:
          description: 'Balances of the accounts over the period of time.<br><br><b>Applicable containers</b>: bank, creditcard, investment, insurance, realEstate, loan<br>'
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/DerivedNetworthHistoricalBalance'
        networth:
          description: 'Networth of the user.<br><br><b>Applicable containers</b>: bank, creditcard, investment, insurance, realEstate, loan<br>'
          readOnly: true
          $ref: '#/components/schemas/Money'
        asset:
          description: 'The asset value that the user owns.<br><br><b>Applicable containers</b>: bank, creditcard, investment, insurance, realEstate, loan<br>'
          readOnly: true
          $ref: '#/components/schemas/Money'
    DerivedNetworthResponse:
      type: object
      title: DerivedNetworthResponse
      properties:
        networth:
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/DerivedNetworth'
    Money:
      type: object
      title: Money
      properties:
        amount:
          format: double
          description: Value of amount.
          type: number
        convertedAmount:
          format: double
          description: Value of the converted amount.
          type: number
        currency:
          description: Currency should be a valid three-letter ISO Code.
          type: string
          enum:
          - USD
          - AUD
          - BRL
          - CAD
          - EUR
          - GBP
          - HKD
          - IDR
          - INR
          - JPY
          - NZD
          - SGD
          - ZAR
          - CNY
          - VND
          - MYR
          - CHF
          - AED
          - AFA
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AWG
          - AZM
          - BAM
          - BBD
          - BDT
          - BGL
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BSD
          - BTN
          - BWP
          - BYR
          - BZD
          - CDF
          - CLP
          - COP
          - CRC
          - CUP
          - CVE
          - CYP
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EEK
          - EGP
          - ERN
          - ETB
          - FJD
          - FKP
          - GEL
          - GGP
          - GHC
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HNL
          - HRK
          - HTG
          - HUF
          - ILS
          - IMP
          - IQD
          - IRR
          - ISK
          - JEP
          - JMD
          - JOD
          - KES
          - KGS
          - KHR
          - KMF
          - KPW
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LTL
          - LVL
          - LYD
          - MAD
          - MDL
          - MGF
          - MKD
          - MMK
          - MNT
          - MOP
          - MRO
          - MTL
          - MUR
          - MVR
          - MWK
          - MXN
          - MZM
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - ROL
          - RUR
          - RWF
          - SAR
          - SBD
          - SCR
          - SDD
          - SEK
          - SHP
          - SIT
          - SKK
          - SLL
          - SOS
          - SPL
          - SRG
          - STD
          - SVC
          - SYP
          - SZL
          - THB
          - TJR
          - TMM
          - TND
          - TOP
          - TRL
          - TTD
          - TVD
          - TWD
          - TZS
          - UAH
          - UGX
          - UYU
          - UZS
          - VEB
          - VUV
          - WST
          - XAF
          - XAG
          - XAU
          - XCD
          - XDR
          - XOF
          - XPD
          - XPF
          - XPT
          - YER
          - YUM
          - ZMK
          - ZWD
          - ADP
          - ATS
          - BEF
          - BUK
          - CSD
          - CSK
          - DDM
          - DEM
          - ECS
          - ESP
          - FIM
          - GRD
          - GWP
          - IEP
          - ITL
          - LUF
          - MLF
          - NLG
          - PTE
          - SUR
          - TPE
          - UAK
          - XBA
          - XBB
          - XBC
          - XBD
          - XEU
          - XFO
          - XFU
          - XGF
          - XMK
          - XRM
          - XTS
          - YDD
          - YUD
          - ZRN
          - TJS
          - RON
          - BGN
          - BTC
          - XBT
          - CNH
          - RUB
          - TRY
          - GHS
          - TMT
          - ZMW
          - VEF
          - SSP
          - ALK
        convertedCurrency:
          description: Currency should be a valid three-letter ISO Code.
          type: string
          enum:
          - USD
          - AUD
          - BRL
          - CAD
          - EUR
          - GBP
          - HKD
          - IDR
          - INR
          - JPY
          - NZD
          - SGD
          - ZAR
          - CNY
          - VND
          - MYR
          - CHF
          - AED
          - AFA
          - ALL
          - AMD
          - ANG
          - AOA
          - ARS
          - AWG
          - AZM
          - BAM
          - BBD
          - BDT
          - BGL
          - BHD
          - BIF
          - BMD
          - BND
          - BOB
          - BSD
          - BTN
          - BWP
          - BYR
          - BZD
          - CDF
          - CLP
          - COP
          - CRC
          - CUP
          - CVE
          - CYP
          - CZK
          - DJF
          - DKK
          - DOP
          - DZD
          - EEK
          - EGP
          - ERN
          - ETB
          - FJD
          - FKP
          - GEL
          - GGP
          - GHC
          - GIP
          - GMD
          - GNF
          - GTQ
          - GYD
          - HNL
          - HRK
          - HTG
          - HUF
          - ILS
          - IMP
          - IQD
          - IRR
          - ISK
          - JEP
          - JMD
          - JOD
          - KES
          - KGS
          - KHR
          - KMF
          - KPW
          - KRW
          - KWD
          - KYD
          - KZT
          - LAK
          - LBP
          - LKR
          - LRD
          - LSL
          - LTL
          - LVL
          - LYD
          - MAD
          - MDL
          - MGF
          - MKD
          - MMK
          - MNT
          - MOP
          - MRO
          - MTL
          - MUR
          - MVR
          - MWK
          - MXN
          - MZM
          - NAD
          - NGN
          - NIO
          - NOK
          - NPR
          - OMR
          - PAB
          - PEN
          - PGK
          - PHP
          - PKR
          - PLN
          - PYG
          - QAR
          - ROL
          - RUR
          - RWF
          - SAR
          - SBD
          - SCR
          - SDD
          - SEK
          - SHP
          - SIT
          - SKK
          - SLL
          - SOS
          - SPL
          - SRG
          - STD
          - SVC
          - SYP
          - SZL
          - THB
          - TJR
          - TMM
          - TND
          - TOP
          - TRL
          - TTD
          - TVD
          - TWD
          - TZS
          - UAH
          - UGX
          - UYU
          - UZS
          - VEB
          - VUV
          - WST
          - XAF
          - XAG
          - XAU
          - XCD
          - XDR
          - XOF
          - XPD
          - XPF
          - XPT
          - YER
          - YUM
          - ZMK
          - ZWD
          - ADP
          - ATS
          - BEF
          - BUK
          - CSD
          - CSK
          - DDM
          - DEM
          - ECS
          - ESP
          - FIM
          - GRD
          - GWP
          - IEP
          - ITL
          - LUF
          - MLF
          - NLG
          - PTE
          - SUR
          - TPE
          - UAK
          - XBA
          - XBB
          - XBC
          - XBD
          - XEU
          - XFO
          - XFU
          - XGF
          - XMK
          - XRM
          - XTS
          - YDD
          - YUD
          - ZRN
          - TJS
          - RON
          - BGN
          - BTC
          - XBT
          - CNH
          - RUB
          - TRY
          - GHS
          - TMT
          - ZMW
          - VEF
          - SSP
          - ALK
    DerivedHoldingsAccount:
      type: object
      title: DerivedHoldingsAccount
      properties:
        id:
          format: int64
          description: 'The primary key of the account resource and the unique identifier for the account.<br>Required Feature Enablement: Asset classification feature.<br><br><b>Applicable containers</b>: investment, insurance<br>'
          readOnly: true
          type: integer
        value:
          description: 'The investment accounts cash balance.<br>Required Feature Enablement: Asset classification feature.<br><br><b>Applicable containers</b>: investment, insurance<br>'
          readOnly: true
          $ref: '#/components/schemas/Money'
    DerivedCategorySummary:
      type: object
      title: DerivedCategorySummary
      properties:
        creditTotal:
          description: 'The total of credit transactions for the category.<br><br><b>Applicable containers</b>: creditCard, bank, investment<br>'
          readOnly: true
          $ref: '#/components/schemas/Money'
        details:
          description: 'Credit and debit summary per date.<br><br><b>Applicable containers</b>: creditCard, bank, investment<br>'
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/DerivedCategorySummaryDetails'
        links:
          description: 'Link of the API services that corresponds to the value derivation.<br><br><b>Applicable containers</b>: creditCard, bank, investment<br>'
          readOnly: true
          $ref: '#/components/schemas/DerivedTransactionsLinks'
        categoryName:
          description: 'The name of the category.<br><br><b>Applicable containers</b>: creditCard, bank, investment<br>'
          readOnly: true
          type: string
        categoryId:
          format: int64
          description: 'Id of the category. This information is provided by transactions/categories service.<br><br><b>Applicable containers</b>: creditCard, bank, investment<br>'
          readOnly: true
          type: integer
        debitTotal:
          description: 'The total of debit transactions for the category.<br><br><b>Applicable containers</b>: creditCard, bank, investment<br>'
          readOnly: true
          $ref: '#/components/schemas/Money'
    DerivedHoldingSummaryResponse:
      type: object
      title: DerivedHoldingSummaryResponse
      properties:
        holdingSummary:
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/DerivedHoldingsSummary'
        link:
          readOnly: true
          $ref: '#/components/schemas/DerivedHoldingsLinks'
    DerivedTransactionSummaryResponse:
      type: object
      title: DerivedTransactionSummaryResponse
      properties:
        links:
          readOnly: true
          $ref: '#/components/schemas/DerivedTransactionsLinks'
        transactionSummary:
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/DerivedTransactionsSummary'
    DerivedTransactionsSummary:
      type: object
      title: DerivedTransactionsSummary
      properties:
        categoryType:
          description: 'Type of categories provided by transactions/categories service.<br><br><b>Applicable containers</b>: creditCard, bank, investment<br><b>Applicable Values</b><br>'
          readOnly: true
          type: string
          enum:
          - TRANSFER
          - DEFERRED_COMPENSATION
          - UNCATEGORIZE
          - INCOME
          - EXPENSE
          - LOAN
        categorySummary:
          description: 'Summary of transaction amouts at category level.<br><br><b>Applicable containers</b>: creditCard, bank, investment<br>'
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/DerivedCategorySummary'
        creditTotal:
          description: 'The total of credit transactions for the category type.<br><br><b>Applicable containers</b>: creditCard, bank, investment<br>'
          readOnly: true
          $ref: '#/components/schemas/Money'
        links:
          description: 'Link of the API services that corresponds to the value derivation.<br><br><b>Applicable containers</b>: creditCard, bank, investment<br>'
          readOnly: true
          $ref: '#/components/schemas/DerivedTransactionsLinks'
        debitTotal:
          description: 'The total of debit transactions for the category type.<br><br><b>Applicable containers</b>: creditCard, bank, investment<br>'
          readOnly: true
          $ref: '#/components/schemas/Money'
    DerivedCategorySummaryDetails:
      type: object
      title: DerivedCategorySummaryDetails
      properties:
        date:
          description: 'Date on which the credit and debit transactions had occured.<br><br><b>Applicable containers</b>: creditCard, bank, investment<br>'
          readOnly: true
          type: string
        creditTotal:
          description: 'Total of credit transaction amounts that had occured on the date.<br><br><b>Applicable containers</b>: creditCard, bank, investment<br>'
          readOnly: true
          $ref: '#/components/schemas/Money'
        debitTotal:
          description: 'Total of debit transaction amounts that had occured on the date.<br><br><b>Applicable containers</b>: creditCard, bank, investment<br>'
          readOnly: true
          $ref: '#/components/schemas/Money'
    DerivedNetworthHistoricalBalance:
      type: object
      title: DerivedNetworthHistoricalBalance
      properties:
        date:
          description: '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.<br><br><b>Account Type</b>: Aggregated and Manual<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
          type: string
        accountId:
          format: int64
          readOnly: true
          type: integer
        isAsset:
          description: 'Indicates whether the balance is an asset or liability.<br><br><b>Account Type</b>: Aggregated and Manual<br><b>Applicable containers</b>: bank, creditCard, investment, insurance, realEstate, loan<br><b>Endpoints</b>:<ul><li>GET accounts/historicalBalances</li></ul>'
          readOnly: true
          type: boolean
        balance:
          description: 'Balance amount of the account.<br><br><b>Account Type</b>: Aggregated and Manual<br><b>Applicable containers</b>: bank, creditCard, investment, insurance, realEstate, loan<br><b>Endpoints</b>:<ul><li>GET accounts/historicalBalances</li></ul>'
          readOnly: true
          $ref: '#/components/schemas/Money'
        asOfDate:
          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>Account Type</b>: Aggregated and Manual<br><b>Applicable containers</b>: bank, creditCard, investment, insurance, realEstate, loan<br><b>Endpoints</b>:<ul><li>GET accounts/historicalBalances</li></ul>'
          readOnly: true
          type: string
        dataSourceType:
          description: 'The source of balance information.<br><br><b>Account Type</b>: Aggregated and Manual<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
          type: string
          enum:
          - S
          - C
          - CF
    DerivedTransactionsLinks:
      type: object
      title: DerivedTransactionsLinks
      properties:
        transactions:
          description: 'Link of the transaction API service that corresponds to the value derivation.<br><br><b>Applicable containers</b>: creditCard, bank, investment<br>'
          readOnly: true
          type: string
    DerivedHoldingsSummary:
      type: object
      title: DerivedHoldingsSummary
      properties:
        holding:
          description: 'Securities that belong to the asset classification type and contributed to the summary value.<br><b>Required Feature Enablement</b>: Asset classification feature.<br><br><b>Applicable containers</b>: investment, insurance<br>'
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/DerivedHolding'
        classificationType:
          description: 'The classification type of the security. The supported asset classification type and the values are provided in the /holdings/assetClassificationList.<br><b>Required Feature Enablement</b>: Asset classification feature.<br><br><b>Applicable containers</b>: investment, insurance<br>'
          readOnly: true
          type: string
        classificationValue:
          description: 'The classification value that corresponds to the classification type of the holding. The supported asset classification type and the values are provided in the /holdings/assetClassificationList.<br><b>Required Feature Enablement</b>: Asset classification feature.<br><br><b>Applicable containers</b>: investment, insurance<br>'
          readOnly: true
          type: string
        value:
          description: 'Summary value of the securities.<br><b>Required Feature Enablement</b>: Asset classification feature.<br><br><b>Applicable containers</b>: investment, insurance<br>'
          readOnly: true
          $ref: '#/components/schemas/Money'
        account:
          description: 'Accounts that contribute to the classification. <br><b>Required Feature Enablement</b>: Asset classification feature.<br><br><b>Applicable containers</b>: investment, insurance<br>'
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/DerivedHoldingsAccount'
    YodleeError:
      type: object
      title: YodleeError
      properties:
        errorMessage:
          description: The descriptive message that explains the error scenario.
          readOnly: true
          type: string
        errorCode:
          description: The error code follows the format YNNN. The error codes do not change. New error codes may be added as we introduce new features and enhance functionalities.
          readOnly: true
          type: string
        referenceCode:
          description: Unique Yodlee identifier used to troubleshoot issues at Yodlee's end.
          readOnly: true
          type: string
    DerivedHolding:
      type: object
      title: DerivedHolding
      properties:
        symbol:
          description: 'The symbol of the security.<br><br><b>Applicable containers</b>: investment<br>'
          readOnly: true
          type: string
        exercisedQuantity:
          format: double
          description: 'The quantity of the employee stock options that are already exercised or bought by the employee.<br><b>Note</b>: Once the employee stock options is exercised, they are either converted to cash value or equity positions depending on the FI. The exercised quantity field is only applicable to employee stock options.<br><br><b>Applicable containers</b>: investment<br>'
          readOnly: true
          type: number
        cusipNumber:
          description: 'The CUSIP (Committee on Uniform Securities Identification Procedures) identifies most the financial instruments in the United States and Canada.<br><br><b>Applicable containers</b>: investment<br>'
          readOnly: true
          type: string
        assetClassification:
          description: 'Asset classification applied to the holding. <br><br><b>Applicable containers</b>: investment<br>'
          readOnly: true
          $ref: '#/components/schemas/AssetClassification'
        vestedQuantity:
          format: double
          description: 'The quantity of units or shares that are already vested on a vest date.<br><b>Note</b>: The vested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.<br><br><b>Applicable containers</b>: investment<br>'
          readOnly: true
          type: number
        description:
          description: 'The description (name) for the holding (E.g., Cisco Systems)<br>For insurance container, the field is only applicable for insurance annuity and variable life insurance types. <br><br><b>Applicable containers</b>: investment, insurance<br>'
          readOnly: true
          type: string
        unvestedValue:
          description: 'Indicates the estimated market value of the unvested units.<br><b>Note</b>: FIs usually calculates the unvested value as the market price unvested quantity. The unvested value field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.<br><br><b>Applicable containers</b>: investment<br>'
          readOnly: true
          $ref: '#/components/schemas/Money'
        securityStyle:
          description: 'Indicates the security style 

# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yodlee/refs/heads/main/openapi/yodlee-derived-api-openapi.yml