Documentation
Documentation
https://developer.yodlee.com/resources/yodlee/yodlee-api-overview/docs/overview
GettingStarted
https://developer.yodlee.com/docs/getting-started
OpenAPI Specification
swagger: '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 DataExtracts API
version: 1.1.0
basePath: /
tags:
- name: DataExtracts
description: DataExtracts API
paths:
/dataExtracts/userData:
get:
summary: Get userData
deprecated: false
produces:
- application/json;charset=UTF-8
description: The get user data service is used to get a user's modified data for a particular period of time for accounts, transactions, holdings, and provider account information.<br>The time difference between fromDate and toDate fields cannot be more than 60 minutes.<br>By default, pagination is available for the transaction entity in this API. In the first response, the API will retrieve 500 transactions along with other data. The response header will provide a link to retrieve the next set of transactions.<br>In the response body of the first API response, totalTransactionsCount indicates the total number of transactions the API will retrieve for the user.<br>This service is only invoked with either admin access token or a cobrand session.<br/>Refer to <a href="https://developer.yodlee.com/resources/yodlee/data-extracts/docs/overview">dataExtracts</a> page for more information.<br><br><b>Note:</b><li>This service supports the localization feature and accepts locale as a header parameter.</li>
operationId: getDataExtractsUserData
responses:
200:
schema:
$ref: '#/definitions/DataExtractsUserDataResponse'
description: OK
400:
schema:
$ref: '#/definitions/YodleeError'
description: 'Y800 : Invalid value for eventName<br>Y821 : Data update event not supported<br>Y800 : Invalid value for fromDate.fromDate cannot be greater than current time<br>Y800 : Invalid value for toDate.toDate cannot be greater than current time<br>.Y800 : Invalid value for fromDate or toDate.fromDate and toDate cannot be older than 7 days<br>Y800 : Invalid value for fromDate.fromDate can not be greater than toDate<br>Y800 : Invalid value for loginName'
401:
description: Unauthorized
404:
description: Not Found
parameters:
- in: query
allowEmptyValue: false
name: fromDate
description: From DateTime (YYYY-MM-DDThh:mm:ssZ)
type: string
required: true
- in: query
allowEmptyValue: false
name: loginName
description: Login Name
type: string
required: true
- in: query
allowEmptyValue: false
name: toDate
description: To DateTime (YYYY-MM-DDThh:mm:ssZ)
type: string
required: true
tags:
- DataExtracts
/dataExtracts/events:
get:
summary: Get Events
deprecated: false
produces:
- application/json;charset=UTF-8
description: The get extracts events service is used to learn about occurrences of data extract related events. This service currently supports only the DATA_UPDATES event.<br>Passing the event name as DATA_UPDATES provides information about users for whom data has been modified in the system for the specified time range. To learn more, please refer to the <a href="https://developer.yodlee.com/resources/yodlee/data-extracts/docs/overview">Data Extracts</a> page.<br>You can retrieve data in increments of no more than 60 minutes over the period of the last 7 days from today's date.<br>This service is only invoked with either admin access token or a cobrand session.<br>
operationId: getDataExtractsEvents
responses:
200:
schema:
$ref: '#/definitions/DataExtractsEventResponse'
description: OK
400:
schema:
$ref: '#/definitions/YodleeError'
description: 'Y800 : Invalid value for fromDate.fromDate cannot be greater than current time<br>Y800 : Invalid value for toDate.toDate cannot be greater than current time<br>Y800 : Invalid value for fromDate or toDate.fromDate and toDate cannot be older than 7 days<br>Y800 : Invalid value for fromDate.fromDate cannot be greater than toDate.'
401:
description: Unauthorized
404:
description: Not Found
parameters:
- in: query
allowEmptyValue: false
name: eventName
description: Event Name
type: string
required: true
- in: query
allowEmptyValue: false
name: fromDate
description: From DateTime (YYYY-MM-DDThh:mm:ssZ)
type: string
required: true
- in: query
allowEmptyValue: false
name: toDate
description: To DateTime (YYYY-MM-DDThh:mm:ssZ)
type: string
required: true
tags:
- DataExtracts
definitions:
DataExtractsTransaction:
type: object
title: DataExtractsTransaction
properties:
date:
description: 'The value provided will be either postDate or transactionDate. postDate takes higher priority than transactionDate, except for the investment container as only transactionDate is available. The availability of postDate or transactionDate depends on the provider site.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
sourceId:
description: A unique ID that the provider site has assigned to the transaction. The source ID is only available for the pre-populated accounts.<br>Pre-populated accounts are the accounts that the FI customers shares with Yodlee, so that the user does not have to add or aggregate those accounts.
readOnly: true
type: string
symbol:
description: 'The symbol of the security being traded.<br><b>Note</b>: The settle date field applies only to trade-related transactions. <br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
cusipNumber:
description: 'The CUSIP (Committee on Uniform Securities Identification Procedures) identifies the financial instruments in the United States and Canada.<br><b><br><b>Note</b></b>: The CUSIP number field applies only to trade related transactions.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
sourceApcaNumber:
description: '6 Digit APCA number for the initiating institution. The field is fixed-width and padded with leading zeros if applicable. This field will be primarily be available for AU Open Banking sites, and for other regions/providers, the population will depend on the availability of data.<br><br><b>Applicable containers</b>: Bank,Card container<br>'
readOnly: true
type: string
highLevelCategoryId:
format: int64
description: 'The high level category assigned to the transaction. The supported values are provided by the GET transactions/categories. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: integer
memo:
description: 'Additional notes provided by the user for a particular transaction through application or API services. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
type:
description: 'The nature of the transaction, i.e., deposit, refund, payment, etc.<br><b>Note</b>: The transaction type field is available only for the United States, Canada, United Kingdom, New Zealand and India based provider sites. <br><br><b>Applicable containers</b>: bank,creditCard,investment<br>'
readOnly: true
type: string
intermediary:
description: 'The intermediary of the transaction.<br><br><b>Applicable containers</b>: bank,creditCard,investment,loan<br>'
readOnly: true
type: array
items:
type: string
frequency:
description: 'Frequency is set to MONTHLY if the Merchant type is BILLERS or SUBSCRIPTION.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
lastUpdated:
readOnly: true
type: string
price:
description: 'The price of the security for the transaction.<br><b>Note</b>: The price field applies only to the trade related transactions. <br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
$ref: '#/definitions/Money'
sourceMerchantCategoryCode:
description: 'The merchant category code for an outgoing payment to a merchant. This field will be primarily be available for AU Open Banking sites, and for other regions/providers, the population will depend on the availability of data.<br><br><b>Applicable containers</b>: Bank,Card,Loan container<br>'
readOnly: true
type: string
id:
format: int64
description: 'An unique identifier for the transaction. The combination of the id and account container are unique in the system. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: integer
checkNumber:
description: 'The checkNumber of the transaction.<br><br><b>Applicable containers</b>: bank<br>'
readOnly: true
type: string
transactionDateTime:
description: 'The timestamp the transaction happens in the account. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
typeAtSource:
description: 'The type of transaction. This field will be primarily be available for AU Open Banking sites, and for other regions/providers, the population will depend on the availability of data.<br><br><b>Applicable containers</b>: Bank,Card,Loan container<br>'
readOnly: true
type: string
valoren:
description: 'It is an identification number that is assigned to financial instruments such as stocks and bonds trading in Switzerland.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
isManual:
description: 'Indicates if the transaction is aggregated from the FI site or the consumer has manually created the transaction using the application or an API. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: boolean
sourceBillerName:
description: 'Name of the BPAY biller for the transaction (if available). This field will be primarily be available for AU Open Banking sites, and for other regions/providers, the population will depend on the availability of data.<br><br><b>Applicable containers</b>: Bank,Card container<br>'
readOnly: true
type: string
merchant:
description: 'The name of the merchant associated with the transaction.<br><b>Note</b>: The merchant name field is available only in the United States, Canada, United Kingdom, and India.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
$ref: '#/definitions/Merchant'
sedol:
description: 'SEDOL stands for Stock Exchange Daily Official List, a list of security identifiers used in the United Kingdom and Ireland for clearing purposes.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
categoryType:
description: 'The categoryType of the category assigned to the transaction. This is the type field of the transaction category resource. The supported values are provided by the GET transactions/categories.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
enum:
- TRANSFER
- DEFERRED_COMPENSATION
- UNCATEGORIZE
- INCOME
- EXPENSE
- LOAN
accountId:
format: int64
description: 'The account from which the transaction was made. This is basically the primary key of the account resource. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: integer
sourceType:
description: 'The source through which the transaction is added to the Yodlee system.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loann<br><b>Applicable Values:</b><br>'
readOnly: true
type: string
enum:
- AGGREGATED
- MANUAL
subType:
description: 'The transaction subtype field provides a detailed transaction type. For example, purchase is a transaction type and the transaction subtype field indicates if the purchase was made using a debit or credit card.<br><b>Note</b>: The transaction subtype field is available only in the United States, Canada, United Kingdom, New Zealand and India.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
enum:
- OVERDRAFT_CHARGE
- ONLINE_PURCHASE
- TAX_PAYMENT
- PAYMENT_BY_CHECK
- ATM_CASH_WITHDRAWAL
- SERVICE_CHARGE
- RETURNED_CHECK_CHARGE
- STOP_PAYMENT_CHARGE
- CONVENIENCE_FEE
- AUTO_LOAN
- HOME_LOAN_MORTGAGE
- RECURRING_SUBSCRIPTION_PAYMENT
- INTEREST
- PAYMENT
- PURCHASE
- REFUND
- TRANSFER
- FINANCE_CHARGE
- OTHER_CHARGES_FEES
- ANNUAL_FEE
- DEPOSIT
- DIRECT_DEPOSIT_SALARY
- INVESTMENT_INCOME_CASH
- SSA
- REWARDS
- TAX_REFUND
- CREDIT_CARD_PAYMENT
- INSURANCE_PAYMENT
- UTILITIES_PAYMENT
- CHILD_SUPPORT
- LOAN
- PERSONAL_LOAN
- STUDENT_LOAN
- REIMBURSEMENT
- BALANCE_TRANSFER
- OVERDRAFT_PROTECTION
- CREDIT
- NSF_FEES
holdingDescription:
description: 'For transactions involving securities, this captures the securities description.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
status:
description: 'The status of the transaction: pending or posted.<br><b>Note</b>: Most FI sites only display posted transactions. If the FI site displays transaction status, same will be aggregated. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br><b>Applicable Values</b><br>'
readOnly: true
type: string
enum:
- POSTED
- PENDING
- SCHEDULED
- FAILED
- CLEARED
detailCategoryId:
format: int64
description: 'The id of the detail category that is assigned to the transaction. This is a premium attribute which will be returned in the response only if the Detail Category feature is enabled. The supported values are provided by GET transactions/categories.<br><br><b>Applicable containers</b>: bank,creditCard<br>'
readOnly: true
type: integer
description:
description: 'Description details<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
$ref: '#/definitions/Description'
settleDate:
description: 'It is the date on which the transaction is finalized, that is, the date the ownership of the security is transferred to the buyer. The settlement date is usually few days after the transaction date.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
postDateTime:
description: 'The timestamp on which the transaction is posted to the account.<br><br><b>Applicable containers</b>: bank,creditCard,insurance,loan<br>'
readOnly: true
type: string
baseType:
description: 'Indicates if the transaction appears as a debit or a credit transaction in the account. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br><b>Applicable Values</b><br>'
readOnly: true
type: string
enum:
- CREDIT
- DEBIT
categorySource:
description: 'Indicates the source of the category, i.e., categories derived by the system or assigned/provided by the consumer. This is the source field of the transaction category resource. The supported values are provided by the GET transactions/categories.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br><b>Applicable Values</b><br>'
readOnly: true
type: string
enum:
- SYSTEM
- USER
principal:
description: 'The portion of the principal in the transaction amount. The transaction amount can be the amount due, payment amount, minimum amount, repayment, etc.<br><br><b>Applicable containers</b>: loan<br>'
readOnly: true
$ref: '#/definitions/Money'
sourceBillerCode:
description: 'BPAY Biller Code for the transaction (if available). This field will be primarily be available for AU Open Banking sites, and for other regions/providers, the population will depend on the availability of data.<br><br><b>Applicable containers</b>: Bank,Card container<br>'
readOnly: true
type: string
isDeleted:
description: 'Indicates if the transaction is marked as deleted.<b>Applicable containers</b>: All Containers<br><b>Aggregated / Manual</b>: Both <br><b>Endpoints</b>:<br><ul><li>GET dataExtracts/userData</li></ul>'
readOnly: true
type: boolean
interest:
description: 'The portion of interest in the transaction amount. The transaction amount can be the amount due, payment amount, minimum amount, repayment, etc.<br><br><b>Applicable containers</b>: loan<br>'
readOnly: true
$ref: '#/definitions/Money'
commission:
description: 'A commission or brokerage associated with a transaction.<br><br><br><b>Additional Details</b>:The commission only applies to trade-related transactions.<b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
$ref: '#/definitions/Money'
merchantType:
description: 'Indicates the merchantType of the transaction.e.g:-BILLERS,SUBSCRIPTION,BNPL,OTHERS <br><br><b>Applicable containers</b>: bank,creditCard,investment,loan<br>'
readOnly: true
type: string
amount:
description: 'The amount of the transaction as it appears at the FI site. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
$ref: '#/definitions/Money'
isPhysical:
description: 'Indicates if the transaction is happened online or in-store. <br><br><b>Applicable containers</b>: bank,creditCard,investment,loan<br>'
readOnly: true
type: boolean
quantity:
format: double
description: 'The quantity associated with the transaction.<br><b>Note</b>: The quantity field applies only to trade-related transactions.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: number
isRecurring:
description: 'If the transaction is done on a merchant with merchant type as BILLERS/SUBSCRIPTION, then such transactions are marked isRecurring to True or else it is marked as False.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
transactionDate:
description: 'The date the transaction happens in the account. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
createdDate:
readOnly: true
type: string
CONTAINER:
description: 'The account''s container.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br><b>Applicable Values</b><br>'
readOnly: true
type: string
enum:
- bank
- creditCard
- investment
- insurance
- loan
- reward
- bill
- realEstate
- otherAssets
- otherLiabilities
businessCategory:
description: 'business category details for the SMB customers.<br><br><b>Applicable containers</b>: Bank container<br>'
readOnly: true
$ref: '#/definitions/BusinessCategory'
postDate:
description: 'The date on which the transaction is posted to the account.<br><br><b>Applicable containers</b>: bank,creditCard,insurance,loan<br>'
readOnly: true
type: string
parentCategoryId:
format: int64
description: 'The parentCategoryId of the category assigned to the transaction.<br><b>Note</b>: This field will be provided in the response if the transaction is assigned to a user-created category. <br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: integer
category:
description: 'The name of the category assigned to the transaction. This is the category field of the transaction category resource. The supported values are provided by the GET transactions/categories.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
runningBalance:
description: 'The running balance in an account indicates the balance of the account after every transaction.<br><br><b>Applicable containers</b>: bank,creditCard,investment<br>'
readOnly: true
$ref: '#/definitions/Money'
categoryId:
format: int64
description: 'The id of the category assigned to the transaction. This is the id field of the transaction category resource. The supported values are provided by the GET transactions/categories.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: integer
isin:
description: 'International Securities Identification Number (ISIN) standard is used worldwide to identify specific securities.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
DataExtractsEventUserData:
type: object
title: DataExtractsEventUserData
properties:
links:
readOnly: true
type: array
items:
$ref: '#/definitions/DataExtractsEventLinks'
user:
readOnly: true
$ref: '#/definitions/DataExtractsUser'
DataExtractsUserDataResponse:
type: object
title: DataExtractsUserDataResponse
properties:
userData:
readOnly: true
type: array
items:
$ref: '#/definitions/DataExtractsUserData'
BusinessCategory:
type: object
title: BusinessCategory
properties:
categoryName:
description: 'The name of the category assigned to the transaction. This is the category field of the transaction category resource. The supported values are provided by the GET transactions/categories.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: string
categoryId:
format: int64
description: 'The id of the category assigned to the transaction. This is the id field of the transaction category resource. The supported values are provided by the GET transactions/categories.<br><br><b>Applicable containers</b>: bank,creditCard,investment,insurance,loan<br>'
readOnly: true
type: integer
DataExtractsEventResponse:
type: object
title: DataExtractsEventResponse
properties:
event:
readOnly: true
$ref: '#/definitions/DataExtractsEvent'
DataExtractsHolding:
type: object
title: DataExtractsHolding
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
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: '#/definitions/Money'
securityStyle:
description: 'Indicates the security style of holding identified through the security service.<br><br><b>Applicable containers</b>: investment, insurance<br>'
readOnly: true
type: string
vestedValue:
description: 'Indicates the estimated market value of the vested units.<br><b>Note</b>: FIs usually calculates the vested value as the market price vested quantity. The vested 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: '#/definitions/Money'
optionType:
description: 'The type of the option position (i.e., put or call).<br><b>Note</b>: The option type field is only applicable to options.<br><br><b>Applicable containers</b>: investment<br><b>Applicable Values</b><br>'
readOnly: true
type: string
enum:
- put
- call
- unknown
- other
lastUpdated:
description: 'The date when the information was last updated in the system.<br><br><b>Applicable containers</b>: investment, insurance<br>'
readOnly: true
type: string
matchStatus:
description: 'Indicates the security match status id of the investment option identified during security normalization.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
holdingType:
description: 'Type of holding<br><br><b>Applicable containers</b>: investment, insurance<br>'
readOnly: true
type: string
enum:
- stock
- mutualFund
- bond
- CD
- option
- moneyMarketFund
- other
- remic
- future
- commodity
- currency
- unitInvestmentTrust
- employeeStockOption
- insuranceAnnuity
- unknown
- preferredStock
- ETF
- warrants
- digitalAsset
maturityDate:
description: 'The stated maturity date of a bond or CD.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
price:
description: 'The current price of the security.<br><b>Note</b>: Only for bonds the price field indicates the normalized price and not the price aggregated from the site. 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
$ref: '#/definitions/Money'
term:
description: 'The fixed duration for which the bond or CD is issued.<br><b>Note</b>: The term field is only applicable to CD.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
contractQuantity:
format: double
description: 'The quantity of tradeable units in a contract.<br><b>Note</b>: The contract quantity field is only applicable to commodity and currency.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: number
id:
format: int64
description: 'Unique identifier for the security added in the system. This is the primary key of the holding resource.<br><br><b>Applicable containers</b>: investment, insurance<br>'
readOnly: true
type: integer
isShort:
description: 'Indicates that the holding is a short trading.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: boolean
value:
description: 'The total market value of the security. 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
$ref: '#/definitions/Money'
expirationDate:
description: 'The date on which an option, right or warrant expires.<br><b>Note</b>: The expiration date field is only applicable to options and employee stock options.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: string
interestRate:
format: double
description: 'The interest rate on a CD.<br><b>Note</b>: The interest rate field is only applicable to CD.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
type: number
quantity:
format: double
description: 'The quantity held for the holding.<br><b>Note</b>: Only for bonds the quantity field indicates the normalized quantity and not the quantity aggregated from the site. The quantity field is only applicable to restricted stock units/awards, performance units, currency, and commodity.<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: number
accruedInterest:
description: 'The accruedInterest of the holding.<br><br><b>Applicable containers</b>: investment<br>'
readOnly: true
$ref: '#/definitions/Money'
grantDate:
description: 'The date on which equity awards like ESOP, RSU, etc., are issued or granted.<br><b>Note</b>: The grant date 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: string
sedol:
description: 'The SEDOL (Stock Exchange Daily Official List) is a set of security identifiers used in the United Kingdom and Ireland for clearing purposes.<br><b>Note</b>: The SEDOL fi
# --- truncated at 32 KB (135 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yodlee/refs/heads/main/openapi/yodlee-dataextracts-api-openapi.yml