openapi: 3.0.1 info: title: Envestnet Aggregation APIs Account Token DataExtracts API description: 'This file describes the Yodlee Aggregation product APIs using the swagger notation that you can use to build your financial application. You can generate the client SDK in Python, JavaScript, PHP, or any other languages according to your development needs. For more details about the APIs, refer to Yodlee API v1.1 - Overview.

You will have to set the header before making the API call. The following headers apply to all the APIs:Note: If there are any API-specific headers, they are mentioned explicitly in the respective API''s description.' termsOfService: https://developer.yodlee.com/terms/condition contact: email: developer@yodlee.com license: name: Yodlee Developer License url: https://developer.yodlee.com/terms/condition#_Services_1 version: 1.1.0 servers: - url: / tags: - name: DataExtracts description: DataExtracts API paths: /dataExtracts/userData: get: tags: - DataExtracts summary: Envestnet Get userData 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.
The time difference between fromDate and toDate fields cannot be more than 60 minutes.
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.
In the response body of the first API response, totalTransactionsCount indicates the total number of transactions the API will retrieve for the user.
This service is only invoked with either admin access token or a cobrand session.
Refer to dataExtracts page for more information.

Note:
  • This service supports the localization feature and accepts locale as a header parameter.
    • operationId: getDataExtractsUserData parameters: - name: fromDate in: query description: From DateTime (YYYY-MM-DDThh:mm:ssZ) required: true allowEmptyValue: false schema: type: string - name: loginName in: query description: Login Name required: true allowEmptyValue: false schema: type: string - name: toDate in: query description: To DateTime (YYYY-MM-DDThh:mm:ssZ) required: true allowEmptyValue: false schema: type: string responses: 200: description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/DataExtractsUserDataResponse' 400: description: 'Y800 : Invalid value for eventName
    Y821 : Data update event not supported
    Y800 : Invalid value for fromDate.fromDate cannot be greater than current time
    Y800 : Invalid value for toDate.toDate cannot be greater than current time
    .Y800 : Invalid value for fromDate or toDate.fromDate and toDate cannot be older than 7 days
    Y800 : Invalid value for fromDate.fromDate can not be greater than toDate
    Y800 : Invalid value for loginName' content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/YodleeError' 401: description: Unauthorized content: {} 404: description: Not Found content: {} deprecated: false /dataExtracts/events: get: tags: - DataExtracts summary: Envestnet Get Events 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.
    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 Data Extracts page.
    You can retrieve data in increments of no more than 60 minutes over the period of the last 7 days from today's date.
    This service is only invoked with either admin access token or a cobrand session.
    operationId: getDataExtractsEvents parameters: - name: eventName in: query description: Event Name required: true allowEmptyValue: false schema: type: string - name: fromDate in: query description: From DateTime (YYYY-MM-DDThh:mm:ssZ) required: true allowEmptyValue: false schema: type: string - name: toDate in: query description: To DateTime (YYYY-MM-DDThh:mm:ssZ) required: true allowEmptyValue: false schema: type: string responses: 200: description: OK content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/DataExtractsEventResponse' 400: description: 'Y800 : Invalid value for fromDate.fromDate cannot be greater than current time
    Y800 : Invalid value for toDate.toDate cannot be greater than current time
    Y800 : Invalid value for fromDate or toDate.fromDate and toDate cannot be older than 7 days
    Y800 : Invalid value for fromDate.fromDate cannot be greater than toDate.' content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/YodleeError' 401: description: Unauthorized content: {} 404: description: Not Found content: {} deprecated: false components: schemas: DataExtractsProviderAccount: title: DataExtractsProviderAccount type: object properties: destinationProviderAccountId: type: integer description: The providerAccountId that is retained as part of the many-to-one OAuth migration process.
    Endpoints: format: int64 readOnly: true oauthMigrationStatus: type: string description: Indicates the migration status of the provider account from screen-scraping provider to the Open Banking provider.

    Endpoints: readOnly: true enum: - IN_PROGRESS - TO_BE_MIGRATED - COMPLETED - MIGRATED isManual: type: boolean description: Indicates whether account is a manual or aggregated provider account.

    Endpoints: readOnly: true lastUpdated: type: string description: 'Indicate when the providerAccount is last updated successfully.

    Account Type: Aggregated
    Endpoints:' readOnly: true createdDate: type: string description: The date on when the provider account is created in the system.

    Endpoints: readOnly: true aggregationSource: type: string description: The source through which the providerAccount is added in the system.

    Endpoints:Applicable Values
    readOnly: true enum: - SYSTEM - USER isDeleted: type: boolean description: 'Indicates if the provider account is deleted from the system.Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    ' readOnly: true providerId: type: integer description: Unique identifier for the provider resource. This denotes the provider for which the provider account id is generated by the user.

    Endpoints: format: int64 readOnly: true requestId: type: string description: Unique id generated to indicate the request.

    Endpoints: readOnly: true sourceProviderAccountIds: type: array description: The providerAccountIds that are deleted and merged into the destinationProviderAccountId as part of the many-to-one OAuth migration process.
    Endpoints: readOnly: true items: type: integer format: int64 id: type: integer description: Unique identifier for the provider account resource. This is created during account addition.

    Endpoints: format: int64 readOnly: true authType: type: string description: The authentication type enabled at the provider site.

    Endpoints:Applicable Values
    readOnly: true enum: - OAUTH - CREDENTIALS - MFA_CREDENTIALS dataset: type: array description: Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents.

    Endpoints: readOnly: true items: $ref: '#/components/schemas/AccountDataset' status: type: string description: The status of last update attempted for the account.

    Endpoints:Applicable Values
    readOnly: true enum: - LOGIN_IN_PROGRESS - USER_INPUT_REQUIRED - IN_PROGRESS - PARTIAL_SUCCESS - SUCCESS - FAILED - MIGRATION_IN_PROGRESS - DATA_RETRIEVAL_FAILED DataExtractsUserData: title: DataExtractsUserData type: object properties: holding: type: array readOnly: true items: $ref: '#/components/schemas/DataExtractsHolding' totalTransactionsCount: type: integer format: int64 readOnly: true user: $ref: '#/components/schemas/DataExtractsUser' account: type: array readOnly: true items: $ref: '#/components/schemas/DataExtractsAccount' transaction: type: array readOnly: true items: $ref: '#/components/schemas/DataExtractsTransaction' providerAccount: type: array readOnly: true items: $ref: '#/components/schemas/DataExtractsProviderAccount' DataExtractsHolding: title: DataExtractsHolding type: object properties: symbol: type: string description: 'The symbol of the security.

    Applicable containers: investment
    ' readOnly: true exercisedQuantity: type: number description: 'The quantity of the employee stock options that are already exercised or bought by the employee.
    Note: 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.

    Applicable containers: investment
    ' format: double readOnly: true cusipNumber: type: string description: 'The CUSIP (Committee on Uniform Securities Identification Procedures) identifies most the financial instruments in the United States and Canada.

    Applicable containers: investment
    ' readOnly: true vestedQuantity: type: number description: 'The quantity of units or shares that are already vested on a vest date.
    Note: The vested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

    Applicable containers: investment
    ' format: double readOnly: true description: type: string description: 'The description (name) for the holding (E.g., Cisco Systems)
    For insurance container, the field is only applicable for insurance annuity and variable life insurance types.

    Applicable containers: investment, insurance
    ' readOnly: true unvestedValue: $ref: '#/components/schemas/Money' securityStyle: type: string description: 'Indicates the security style of holding identified through the security service.

    Applicable containers: investment, insurance
    ' readOnly: true vestedValue: $ref: '#/components/schemas/Money' optionType: type: string description: 'The type of the option position (i.e., put or call).
    Note: The option type field is only applicable to options.

    Applicable containers: investment
    Applicable Values
    ' readOnly: true enum: - put - call - unknown - other lastUpdated: type: string description: 'The date when the information was last updated in the system.

    Applicable containers: investment, insurance
    ' readOnly: true matchStatus: type: string description: 'Indicates the security match status id of the investment option identified during security normalization.

    Applicable containers: investment
    ' readOnly: true holdingType: type: string description: 'Type of holding

    Applicable containers: investment, insurance
    ' readOnly: true enum: - stock - mutualFund - bond - CD - option - moneyMarketFund - other - remic - future - commodity - currency - unitInvestmentTrust - employeeStockOption - insuranceAnnuity - unknown - preferredStock - ETF - warrants - digitalAsset maturityDate: type: string description: 'The stated maturity date of a bond or CD.

    Applicable containers: investment
    ' readOnly: true price: $ref: '#/components/schemas/Money' term: type: string description: 'The fixed duration for which the bond or CD is issued.
    Note: The term field is only applicable to CD.

    Applicable containers: investment
    ' readOnly: true contractQuantity: type: number description: 'The quantity of tradeable units in a contract.
    Note: The contract quantity field is only applicable to commodity and currency.

    Applicable containers: investment
    ' format: double readOnly: true id: type: integer description: 'Unique identifier for the security added in the system. This is the primary key of the holding resource.

    Applicable containers: investment, insurance
    ' format: int64 readOnly: true isShort: type: boolean description: 'Indicates that the holding is a short trading.

    Applicable containers: investment
    ' readOnly: true value: $ref: '#/components/schemas/Money' expirationDate: type: string description: 'The date on which an option, right or warrant expires.
    Note: The expiration date field is only applicable to options and employee stock options.

    Applicable containers: investment
    ' readOnly: true interestRate: type: number description: 'The interest rate on a CD.
    Note: The interest rate field is only applicable to CD.

    Applicable containers: investment
    ' format: double readOnly: true quantity: type: number description: 'The quantity held for the holding.
    Note: 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.
    For insurance container, the field is only applicable for insurance annuity and variable life insurance types.

    Applicable containers: investment, insurance
    ' format: double readOnly: true accruedInterest: $ref: '#/components/schemas/Money' grantDate: type: string description: 'The date on which equity awards like ESOP, RSU, etc., are issued or granted.
    Note: The grant date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

    Applicable containers: investment
    ' readOnly: true sedol: type: string description: 'The SEDOL (Stock Exchange Daily Official List) is a set of security identifiers used in the United Kingdom and Ireland for clearing purposes.
    Note: The SEDOL field is only applicable to the trade related transactions

    Applicable containers: investment
    ' readOnly: true vestedSharesExercisable: type: number description: 'The number of vested shares that can be exercised by the employee. It is usually equal to the vested quantity.
    Note: The vested shares exercisable field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

    Applicable containers: investment
    ' format: double readOnly: true spread: $ref: '#/components/schemas/Money' accountId: type: integer description: 'Unique identifier of the account to which the security is linked.

    Applicable containers: investment, insurance
    ' format: int64 readOnly: true enrichedDescription: type: string description: 'The enrichedDescription is the security description of the normalized holding

    Applicable containers: investment, insurance
    ' readOnly: true couponRate: type: number description: 'The stated interest rate for a bond.

    Applicable containers: investment
    ' format: double readOnly: true createdDate: type: string description: 'The date on which the holding is created in the Yodlee system.

    Applicable containers: investment, insurance
    ' readOnly: true accruedIncome: $ref: '#/components/schemas/Money' securityType: type: string description: 'Indicates the security type of holding identified through the security service.

    Applicable containers: investment, insurance
    ' readOnly: true providerAccountId: type: integer description: 'Unique identifier for the user''s association with the provider.

    Applicable containers: investment, insurance
    ' format: int64 readOnly: true unvestedQuantity: type: number description: 'Indicates the number of unvested quantity or units.
    Note: The unvested quantity field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

    Applicable containers: investment
    ' format: double readOnly: true costBasis: $ref: '#/components/schemas/Money' vestingDate: type: string description: 'The date on which a RSU, RSA, or an employee stock options become vested.
    Note: The vesting date field is only applicable to employee stock options, restricted stock units/awards, performance units, etc.

    Applicable containers: investment
    ' readOnly: true isin: type: string description: 'The ISIN (International Securities Identification Number) is used worldwide to identify specific securities. It is equivalent to CUSIP for international markets.

    Note: The ISIN field is only applicable to the trade related transactions

    Applicable containers: investment
    ' readOnly: true strikePrice: $ref: '#/components/schemas/Money' DataExtractsEvent: title: DataExtractsEvent type: object properties: data: $ref: '#/components/schemas/DataExtractsEventData' info: type: string readOnly: true YodleeError: title: YodleeError type: object properties: errorMessage: type: string description: The descriptive message that explains the error scenario. readOnly: true errorCode: type: string 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 referenceCode: type: string description: Unique Yodlee identifier used to troubleshoot issues at Yodlee's end. readOnly: true BankTransferCode: title: BankTransferCode type: object properties: id: type: string description: 'The FI''s branch identification number.Additional Details: The routing number of the bank account in the United States. For non-United States accounts, it is the IFSC code (India), BSB number (Australia), and sort code (United Kingdom).
    Account Type: Aggregated
    Applicable containers: bank, investment
    Endpoints:
    ' type: type: string description: 'The bank transfer code type varies depending on the region of the account origination.
    Account Type: Aggregated
    Applicable containers: bank, investment
    Endpoints:
    Applicable Values
    ' enum: - BSB - IFSC - ROUTING_NUMBER - SORT_CODE RewardBalance: title: RewardBalance type: object properties: expiryDate: type: string description: 'The date on which the balance expires.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true balanceToReward: type: string description: 'The balance required to qualify for a reward such as retaining membership, business reward, etc.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true balanceType: type: string description: 'The type of reward balance.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:Applicable Values
    ' readOnly: true enum: - EXPIRING_BALANCE - BALANCE_TO_LEVEL - BALANCE_TO_REWARD - BALANCE - TOTAL_BALANCE balance: type: number description: 'The actual reward balance.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:' format: double readOnly: true description: type: string description: 'The description for the reward balance as available at provider source.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true balanceToLevel: type: string description: 'The balance required to reach a reward level.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true units: type: string description: 'Unit of reward balance - miles, points, segments, dollars, credits.

    Account Type: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true AccountDataset: title: AccountDataset type: object properties: lastUpdated: type: string description: 'Indicate when the dataset is last updated successfully for the given provider account.

    Account Type: Aggregated
    Endpoints:' readOnly: true updateEligibility: type: string description: 'Indicate whether the dataset is eligible for update or not.

    Account Type: Aggregated
    Endpoints:Applicable Values
    ' readOnly: true enum: - ALLOW_UPDATE - ALLOW_UPDATE_WITH_CREDENTIALS - DISALLOW_UPDATE additionalStatus: type: string description: 'The status of last update attempted for the dataset.

    Account Type: Aggregated
    Endpoints:Applicable Values
    ' readOnly: true enum: - LOGIN_IN_PROGRESS - DATA_RETRIEVAL_IN_PROGRESS - ACCT_SUMMARY_RECEIVED - AVAILABLE_DATA_RETRIEVED - PARTIAL_DATA_RETRIEVED - DATA_RETRIEVAL_FAILED - DATA_NOT_AVAILABLE - ACCOUNT_LOCKED - ADDL_AUTHENTICATION_REQUIRED - BETA_SITE_DEV_IN_PROGRESS - CREDENTIALS_UPDATE_NEEDED - INCORRECT_CREDENTIALS - PROPERTY_VALUE_NOT_AVAILABLE - INVALID_ADDL_INFO_PROVIDED - REQUEST_TIME_OUT - SITE_BLOCKING_ERROR - UNEXPECTED_SITE_ERROR - SITE_NOT_SUPPORTED - SITE_UNAVAILABLE - TECH_ERROR - USER_ACTION_NEEDED_AT_SITE - SITE_SESSION_INVALIDATED - NEW_AUTHENTICATION_REQUIRED - DATASET_NOT_SUPPORTED - ENROLLMENT_REQUIRED_FOR_DATASET - CONSENT_REQUIRED - CONSENT_EXPIRED - CONSENT_REVOKED - INCORRECT_OAUTH_TOKEN - MIGRATION_IN_PROGRESS nextUpdateScheduled: type: string description: 'Indicates when the next attempt to update the dataset is scheduled.

    Account Type: Aggregated
    Endpoints:' readOnly: true name: type: string description: 'The name of the dataset requested from the provider site

    Account Type: Manual
    Endpoints:Applicable Values
    ' enum: - BASIC_AGG_DATA - ADVANCE_AGG_DATA - ACCT_PROFILE - DOCUMENT lastUpdateAttempt: type: string description: 'Indicate when the last attempt was performed to update the dataset for the given provider account

    Account Type: Aggregated
    Endpoints:' readOnly: true Description: title: Description type: object properties: security: type: string description: 'The description will provide the actual name of the security.

    Applicable containers: investment
    ' readOnly: true original: type: string description: 'Original transaction description as it appears at the FI site.

    Applicable containers: creditCard, insurance, loan
    ' readOnly: true simple: type: string description: 'The transaction description that appears at the FI site may not be self-explanatory, i.e., the source, purpose of the transaction may not be evident. Yodlee attempts to simplify and make the transaction meaningful to the consumer, and this simplified transaction description is provided in the simple description field.Note: The simple description field is available only in the United States, Canada, United Kingdom, and India.

    Applicable containers: creditCard, insurance, loan
    ' readOnly: true consumer: type: string description: The description of the transaction as defined by the consumer. The consumer can define or provide more details of the transaction in this field.

    Coordinates: title: Coordinates type: object properties: latitude: type: number description: 'Latitude of the merchant

    Applicable containers: bank,creditCard,loan
    ' format: double longitude: type: number description: 'Longitude of the merchant

    Applicable containers: bank,creditCard,loan
    ' format: double LoanPayoffDetails: title: LoanPayoffDetails type: object properties: payByDate: type: string description: 'The date by which the payoff amount should be paid.

    Account Type: Aggregated
    Applicable containers: loan
    Endpoints:' readOnly: true payoffAmount: $ref: '#/components/schemas/Money' outstandingBalance: $ref: '#/components/schemas/Money' DataExtractsUser: title: DataExtractsUser type: object properties: loginName: type: string readOnly: true DataExtractsUserDataResponse: title: DataExtractsUserDataResponse type: object properties: userData: type: array readOnly: true items: $ref: '#/components/schemas/DataExtractsUserData' DataExtractsAccount: title: DataExtractsAccount type: object properties: availableCash: $ref: '#/components/schemas/Money' includeInNetWorth: type: boolean description: 'Used to determine whether an account to be considered in the networth calculation.

    Aggregated / Manual: Aggregated
    Applicable containers: bank,creditCard,loan,investment,insurance,realEstate,otherAssets,otherLiabilities
    Endpoints:' readOnly: true moneyMarketBalance: $ref: '#/components/schemas/Money' enrollmentDate: type: string description: 'Date on which the user is enrolled on the rewards program.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true estimatedDate: type: string description: 'The date on which the home value was estimated.

    Aggregated / Manual: Manual
    Applicable containers: realEstate
    Endpoints:' readOnly: true memo: type: string description: 'The additional description or notes given by the user.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:' readOnly: true guarantor: type: string description: 'A nonprofit or state organization that works with lender, servicer, school, and the Department of Education to help successfully repay Federal Family Education Loan Program (FFELP) loans. If FFELP student loans default, the guarantor takes ownership of them.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:' readOnly: true interestPaidLastYear: $ref: '#/components/schemas/Money' lastUpdated: type: string description: 'The date time the account information was last retrieved from the provider site and updated in the Yodlee system.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:' readOnly: true balance: $ref: '#/components/schemas/Money' homeInsuranceType: type: string description: 'Type of home insurance, like -Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:Applicable Values
    ' readOnly: true enum: - HOME_OWNER - RENTAL - RENTER - UNKNOWN - OTHER id: type: integer description: 'The primary key of the account resource and the unique identifier for the account.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:' format: int64 readOnly: true cash: $ref: '#/components/schemas/Money' totalCreditLine: $ref: '#/components/schemas/Money' providerName: type: string description: 'Service provider or institution name where the account originates. This belongs to the provider resource.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:' readOnly: true valuationType: type: string description: 'The valuation type indicates whether the home value is calculated either manually or by Yodlee Partners.

    Aggregated / Manual: Manual
    Applicable containers: realEstate
    Endpoints:Applicable Values
    ' readOnly: true enum: - SYSTEM - MANUAL marginBalance: $ref: '#/components/schemas/Money' apr: type: number description: 'The annual percentage rate (APR) is the yearly rate of interest on the credit card account.
    Additional Details: The yearly percentage rate charged when a balance is held on a credit card. This rate of interest is applied every month on the outstanding credit card balance.
    Aggregated / Manual: Aggregated
    Applicable containers: creditCard
    Endpoints:
    ' format: double readOnly: true availableCredit: $ref: '#/components/schemas/Money' currentBalance: $ref: '#/components/schemas/Money' isManual: type: boolean description: 'Indicates if an account is aggregated from a site or it is a manual account i.e. account information manually provided by the user.
    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:' readOnly: true escrowBalance: $ref: '#/components/schemas/Money' nextLevel: type: string description: 'The eligible next level of the rewards program.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true classification: type: string description: 'The classification of the account such as personal, corporate, etc.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, creditCard, investment, reward, loan, insurance
    Endpoints:Applicable Values
    ' readOnly: true enum: - OTHER - PERSONAL - CORPORATE - SMALL_BUSINESS - TRUST - ADD_ON_CARD - VIRTUAL_CARD loanPayoffAmount: $ref: '#/components/schemas/Money' interestRateType: type: string description: 'The type of the interest rate, for example, fixed or variable.
    Applicable containers: loan
    Aggregated / Manual: Aggregated
    Endpoints:
    Applicable Values
    ' readOnly: true enum: - FIXED - VARIABLE - UNKNOWN - OTHER loanPayByDate: type: string description: 'The date by which the payoff amount should be paid.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:' readOnly: true faceAmount: $ref: '#/components/schemas/Money' policyFromDate: type: string description: 'The date the insurance policy began.
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    ' readOnly: true premiumPaymentTerm: type: string description: 'The number of years for which premium payments have to be made in a policy.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:' readOnly: true policyTerm: type: string description: 'The duration for which the policy is valid or in effect. For example, one year, five years, etc.
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    ' readOnly: true repaymentPlanType: type: string description: 'The type of repayment plan that the borrower prefers to repay the loan.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:Applicable Values:
    ' readOnly: true enum: - STANDARD - GRADUATED - EXTENDED - INCOME_BASED - INCOME_CONTINGENT - INCOME_SENSITIVE - PAY_AS_YOU_EARN - REVISED_PAY_AS_YOU_EARN aggregatedAccountType: type: string description: The type of account that is aggregated. readOnly: true availableBalance: $ref: '#/components/schemas/Money' accountStatus: type: string description: 'The status of the account that is updated by the consumer through an application or an API. Valid Values: AccountStatus
    Additional Details:
    ACTIVE: All the added manual and aggregated accounts status will be made "ACTIVE" by default.
    TO_BE_CLOSED: If the aggregated accounts are not found or closed in the data provider site, Yodlee system marks the status as TO_BE_CLOSED
    INACTIVE: Users can update the status as INACTIVE to stop updating and to stop considering the account in other services
    CLOSED: Users can update the status as CLOSED, if the account is closed with the provider.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:Applicable Values
    ' readOnly: true enum: - ACTIVE - INACTIVE - TO_BE_CLOSED - CLOSED - DELETED lifeInsuranceType: type: string description: 'Type of life insurance.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:Applicable Values
    ' readOnly: true enum: - OTHER - TERM_LIFE_INSURANCE - UNIVERSAL_LIFE_INSURANCE - WHOLE_LIFE_INSURANCE - VARIABLE_LIFE_INSURANCE - ULIP - ENDOWMENT premium: $ref: '#/components/schemas/Money' aggregationSource: type: string description: 'The source through which the account(s) are added in the system.
    Valid Values: SYSTEM, USER
    Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    Applicable Values
    ' readOnly: true enum: - SYSTEM - USER isDeleted: type: boolean description: 'Indicates if the account is marked as deleted.Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    ' readOnly: true overDraftLimit: $ref: '#/components/schemas/Money' nickname: type: string description: 'The nickname of the account as provided by the consumer to identify an account. The account nickname can be used instead of the account name.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:' readOnly: true term: type: string description: 'The tenure for which the CD account is valid or in case of loan, the number of years/months over which the loan amount has to be repaid.
    Additional Details:
    Bank: The Term field is only applicable for the account type CD.Loan: The period for which the loan agreement is in force. The period, before or at the end of which, the loan should either be repaid or renegotiated for another term.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, loan
    Endpoints:' readOnly: true interestRate: type: number description: '
    Bank: The interest rate offered by a FI to its depositors on a bank account.
    Loan: Interest rate applied on the loan.
    Additional Details:
    Note: The Interest Rate field is only applicable for the following account types: savings, checking, money market, and certificate of deposit.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, loan
    Endpoints:' format: double readOnly: true deathBenefit: $ref: '#/components/schemas/Money' address: $ref: '#/components/schemas/AccountAddress' cashValue: $ref: '#/components/schemas/Money' 401kLoan: $ref: '#/components/schemas/Money' homeValue: $ref: '#/components/schemas/Money' accountNumber: type: string description: 'The account number as it appears on the site. (The POST accounts service response return this field as number)
    Additional Details: Bank/ Loan/ Insurance/ Investment:
    The account number for the bank account as it appears at the site.
    Credit Card: The account number of the card account as it appears at the site,
    i.e., the card number.The account number can be full or partial based on how it is displayed in the account summary page of the site.In most cases, the site does not display the full account number in the account summary page and additional navigation is required to aggregate it.
    Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    ' readOnly: true createdDate: type: string description: 'The date on which the account is created in the Yodlee system.
    Additional Details: It is the date when the user links or aggregates the account(s) that are held with the provider to the Yodlee system.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:' readOnly: true interestPaidYTD: $ref: '#/components/schemas/Money' providerAccountId: type: integer description: 'The primary key of the provider account resource.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:' format: int64 readOnly: true isSelectedForAggregation: type: boolean description: 'Indicates if the account is selected by user for aggregation.
    Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    ' readOnly: true collateral: type: string description: 'Property or possession offered to support a loan that can be seized on a default.
    Applicable containers: loan
    Aggregated / Manual: Aggregated
    Endpoints:
    ' readOnly: true dataset: type: array description: 'Logical grouping of dataset attributes into datasets such as Basic Aggregation Data, Account Profile and Documents.

    Aggregated / Manual: Aggregated
    Applicable containers: All containers
    Endpoints:' readOnly: true items: $ref: '#/components/schemas/AccountDataset' runningBalance: $ref: '#/components/schemas/Money' sourceId: type: string description: 'A unique ID that the provider site has assigned to the account. The source ID is only available for the HELD accounts.

    Applicable containers: bank, creditCard, investment, insurance, loan, reward
    Endpoints:' readOnly: true dueDate: type: string description: 'The date on which the due amount has to be paid.
    Additional Details:
    Credit Card: The monthly date by when the minimum payment is due to be paid on the credit card account.
    Loan: The date on or before which the due amount should be paid.
    Note: The due date at the account-level can differ from the due date field at the statement-level, as the information in the aggregated card account data provides an up-to-date information to the consumer.

    Aggregated / Manual: Aggregated
    Applicable containers: creditCard, loan, insurance
    Endpoints:' readOnly: true frequency: type: string description: 'The frequency of the billing cycle of the account in case of card. The frequency in which premiums are paid in an insurance policy such as monthly, quarterly, and annually. The frequency in which due amounts are paid in a loan account.

    Aggregated / Manual: Both
    Applicable containers: creditCard, insurance, loan
    Endpoints:Applicable Values
    ' readOnly: true enum: - DAILY - ONE_TIME - WEEKLY - EVERY_2_WEEKS - SEMI_MONTHLY - MONTHLY - QUARTERLY - SEMI_ANNUALLY - ANNUALLY - EVERY_2_MONTHS - EBILL - FIRST_DAY_MONTHLY - LAST_DAY_MONTHLY - EVERY_4_WEEKS - UNKNOWN - OTHER maturityAmount: $ref: '#/components/schemas/Money' associatedProviderAccountId: type: array description: 'The providerAccountIds that share the account with the primary providerAccountId that was created when the user had added the account for the first time.
    Additional Details: This attribute is returned in the response only if the account deduplication feature is enabled and the same account is mapped to more than one provider account IDs indicating the account is owned by more than one user, for example, joint accounts.

    Aggregated / Manual: Aggregated
    Applicable containers: All Containers
    Endpoints:' readOnly: true items: type: integer format: int64 isAsset: type: boolean description: 'The account to be considered as an asset or liability.
    Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    ' readOnly: true principalBalance: $ref: '#/components/schemas/Money' totalCashLimit: $ref: '#/components/schemas/Money' maturityDate: type: string description: 'The date when a certificate of deposit (CD/FD) matures or the final payment date of a loan at which point the principal amount (including pending interest) is due to be paid.
    Additional Details: The date when a certificate of deposit (CD) matures, i.e., the money in the CD can be withdrawn without paying an early withdrawal penalty.The final payment date of a loan, i.e., the principal amount (including pending interest) is due to be paid.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, loan
    Endpoints:' readOnly: true minimumAmountDue: $ref: '#/components/schemas/Money' annualPercentageYield: type: number description: 'Annual percentage yield (APY) is a normalized representation of an interest rate, based on a compounding period of one year. APY generally refers to the rate paid to a depositor by a financial institution on an account.
    Applicable containers: bank
    Aggregated / Manual: Aggregated
    Endpoints:
    ' format: double readOnly: true accountType: type: string description: 'The type of account that is aggregated, i.e., savings, checking, credit card, charge, HELOC, etc. The account type is derived based on the attributes of the account.
    Valid Values:
    Aggregated Account Type
    bankcreditCardinvestment (SN 1.0)investment (SN 2.0)loaninsurancerealEstaterewardManual Account Type
    bankcreditloaninsuranceinvestment

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:' readOnly: true originationDate: type: string description: 'The date on which the loan is disbursed.

    Aggregated / Manual: Both
    Applicable containers: loan
    Endpoints:' readOnly: true totalVestedBalance: $ref: '#/components/schemas/Money' rewardBalance: type: array description: 'Information of different reward balances associated with the account.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true items: $ref: '#/components/schemas/RewardBalance' sourceAccountStatus: type: string description: 'Indicates the status of the loan account.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:Applicable Values:
    ' readOnly: true enum: - IN_REPAYMENT - DEFAULTED - IN_SCHOOL - IN_GRACE_PERIOD - DELINQUENCY - DEFERMENT - FORBEARANCE linkedAccountIds: type: array description: 'List of Loan accountId(s) to which the real-estate account is linked

    Aggregated / Manual: Both
    Applicable containers: realEstate
    Endpoints:' readOnly: true items: type: integer format: int64 derivedApr: type: number description: 'Derived APR will be an estimated purchase APR based on consumers credit card transactions and credit card purchase.
    Aggregated / Manual / Derived: Derived
    Applicable containers: creditCard
    Endpoints:
    ' format: double readOnly: true policyEffectiveDate: type: string description: 'The date on which the insurance policy coverage commences.
    Applicable containers: insurance
    Aggregated / Manual: Aggregated
    Endpoints:
    ' readOnly: true totalUnvestedBalance: $ref: '#/components/schemas/Money' annuityBalance: $ref: '#/components/schemas/Money' accountName: type: string description: 'The account name as it appears at the site.
    (The POST accounts service response return this field as name)
    Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    ' readOnly: true totalCreditLimit: $ref: '#/components/schemas/Money' policyStatus: type: string description: 'The status of the policy.
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    Applicable Values
    ' readOnly: true enum: - ACTIVE - IN_ACTIVE - OTHER shortBalance: $ref: '#/components/schemas/Money' lender: type: string description: 'The financial institution that provides the loan.

    Aggregated / Manual: Aggregated
    Applicable containers: loan
    Endpoints:' readOnly: true lastEmployeeContributionAmount: $ref: '#/components/schemas/Money' providerId: type: string description: 'Identifier of the provider site. The primary key of provider resource.

    Aggregated / Manual: Both
    Applicable containers: All containers
    Endpoints:' readOnly: true lastPaymentDate: type: string description: 'The date on which the payment for the previous or current billing cycle is done.
    Additional Details: If the payment is already done for the current billing cycle, then the field indicates the payment date of the current billing cycle. If payment is yet to be done for the current billing cycle, then the field indicates the date on which the payment was made for any of the previous billing cycles. The last payment date at the account-level can differ from the last payment date at the statement-level, as the information in the aggregated card account data provides an up-to-date information to the consumer.

    Aggregated / Manual: Aggregated
    Applicable containers: creditCard, loan, insurance
    Endpoints:' readOnly: true primaryRewardUnit: type: string description: 'Primary reward unit for this reward program. E.g. miles, points, etc.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true lastPaymentAmount: $ref: '#/components/schemas/Money' remainingBalance: $ref: '#/components/schemas/Money' userClassification: type: string description: 'Applicable containers: reward, bank, creditCard, investment, loan, insurance, realEstate, otherLiabilities
    Endpoints:
  • GET dataExtracts/userData
    • Applicable Values
    ' readOnly: true enum: - BUSINESS - PERSONAL bankTransferCode: type: array description: 'Bank and branch identification information.
    Aggregated / Manual: Aggregated
    Applicable containers: bank, investment, loan
    Endpoints:
    ' readOnly: true items: $ref: '#/components/schemas/BankTransferCode' expirationDate: type: string description: 'The date on which the insurance policy expires or matures.
    Additional Details: The due date at the account-level can differ from the due date field at the statement-level, as the information in the aggregated card account data provides an up-to-date information to the consumer.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:' readOnly: true coverage: type: array description: 'The coverage-related details of the account.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:' readOnly: true items: $ref: '#/components/schemas/Coverage' cashApr: type: number description: 'Annual percentage rate applied to cash withdrawals on the card.

    Account Type: Aggregated
    Applicable containers: creditCard
    Endpoints:' format: double oauthMigrationStatus: type: string description: Indicates the migration status of the account from screen-scraping provider to the Open Banking provider.

    Endpoints: readOnly: true enum: - IN_PROGRESS - TO_BE_MIGRATED - COMPLETED - MIGRATED displayedName: type: string description: 'The name or identification of the account owner, as it appears at the FI site.
    Note: The account holder name can be full or partial based on how it is displayed in the account summary page of the FI site. In most cases, the FI site does not display the full account holder name in the account summary page.

    Aggregated / Manual: Aggregated
    Applicable containers: bank, creditCard, investment, insurance, loan, reward
    Endpoints:' readOnly: true sourceProviderAccountId: type: integer description: The providerAccountId that is deleted and merged into the destinationProviderAccountId as part of the many-to-one OAuth migration process.
    Endpoints: format: int64 readOnly: true amountDue: $ref: '#/components/schemas/Money' currentLevel: type: string description: 'Current level of the reward program the user is associated with. E.g. Silver, Jade etc.

    Aggregated / Manual: Aggregated
    Applicable containers: reward
    Endpoints:' readOnly: true originalLoanAmount: $ref: '#/components/schemas/Money' policyToDate: type: string description: 'The date to which the policy exists.
    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:
    ' readOnly: true loanPayoffDetails: $ref: '#/components/schemas/LoanPayoffDetails' CONTAINER: type: string description: 'The type of service. E.g., Bank, Credit Card, Investment, Insurance, etc.

    Aggregated / Manual: Aggregated
    Applicable containers: All containers
    Endpoints:Applicable Values
    ' readOnly: true enum: - bank - creditCard - investment - insurance - loan - reward - bill - realEstate - otherAssets - otherLiabilities lastEmployeeContributionDate: type: string description: 'The date on which the last employee contribution was made to the 401k account.
    Note: The last employee contribution date field is derived from the transaction data and not aggregated from the FI site. The field is only applicable to the 401k account type.

    Aggregated / Manual: Aggregated
    Applicable containers: investment
    Endpoints:' readOnly: true lastPayment: $ref: '#/components/schemas/Money' recurringPayment: $ref: '#/components/schemas/Money' Money: title: Money type: object properties: amount: type: number description: Value of amount. format: double convertedAmount: type: number description: Value of the converted amount. format: double currency: type: string description: Currency should be a valid three-letter ISO Code. 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: type: string description: Currency should be a valid three-letter ISO Code. 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 DataExtractsEventResponse: title: DataExtractsEventResponse type: object properties: event: $ref: '#/components/schemas/DataExtractsEvent' DataExtractsEventData: title: DataExtractsEventData type: object properties: fromDate: type: string readOnly: true userData: type: array readOnly: true items: $ref: '#/components/schemas/DataExtractsEventUserData' userCount: type: integer format: int32 readOnly: true toDate: type: string readOnly: true DataExtractsEventUserData: title: DataExtractsEventUserData type: object properties: links: type: array readOnly: true items: $ref: '#/components/schemas/DataExtractsEventLinks' user: $ref: '#/components/schemas/DataExtractsUser' AccountAddress: title: AccountAddress type: object properties: zip: type: string description: Zip. country: type: string description: Country. address3: type: string description: Address Line 3. address2: type: string description: Address Line 2. city: type: string description: City. sourceType: type: string address1: type: string description: Address Line 1. street: type: string state: type: string description: State. type: type: string enum: - HOME - BUSINESS - POBOX - RETAIL - OFFICE - SMALL_BUSINESS - COMMUNICATION - PERMANENT - STATEMENT_ADDRESS - PAYMENT - PAYOFF - UNKNOWN CoverageAmount: title: CoverageAmount type: object properties: cover: $ref: '#/components/schemas/Money' unitType: type: string description: 'The type of coverage unit indicates if the coverage is for an individual or a family.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:Applicable Values:
    ' readOnly: true enum: - PER_FAMILY - PER_MEMBER type: type: string description: 'The type of coverage provided to an individual or an entity.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:Applicable Values:
    ' readOnly: true enum: - DEDUCTIBLE - OUT_OF_POCKET - ANNUAL_BENEFIT - MAX_BENEFIT - COVERAGE_AMOUNT - MONTHLY_BENEFIT - OTHER limitType: type: string description: 'The type of coverage limit indicates if the coverage is in-network or out-of-network.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:Applicable Values:
    ' readOnly: true enum: - IN_NETWORK - OUT_NETWORK met: $ref: '#/components/schemas/Money' DataExtractsTransaction: title: DataExtractsTransaction type: object properties: date: type: string 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.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ' readOnly: true sourceId: type: string description: A unique ID that the provider site has assigned to the transaction. The source ID is only available for the pre-populated accounts.
    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 symbol: type: string description: 'The symbol of the security being traded.
    Note: The settle date field applies only to trade-related transactions.

    Applicable containers: investment
    ' readOnly: true cusipNumber: type: string description: 'The CUSIP (Committee on Uniform Securities Identification Procedures) identifies the financial instruments in the United States and Canada.

    Note    : The CUSIP number field applies only to trade related transactions.

    Applicable containers: investment
    ' readOnly: true highLevelCategoryId: type: integer description: 'The high level category assigned to the transaction. The supported values are provided by the GET transactions/categories.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ' format: int64 readOnly: true detailCategoryId: type: integer description: 'The id of the detail category that is assigned to the transaction. The supported values are provided by GET transactions/categories.

    Applicable containers: bank,creditCard
    ' format: int64 readOnly: true description: $ref: '#/components/schemas/Description' memo: type: string description: 'Additional notes provided by the user for a particular transaction through application or API services.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ' readOnly: true settleDate: type: string 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.

    Applicable containers: investment
    ' readOnly: true type: type: string description: 'The nature of the transaction, i.e., deposit, refund, payment, etc.
    Note: The transaction type field is available only for the United States, Canada, United Kingdom, New Zealand and India based provider sites.

    Applicable containers: bank,creditCard,investment
    ' readOnly: true intermediary: type: array description: 'The intermediary of the transaction.

    Applicable containers: bank,creditCard,investment,loan
    ' readOnly: true items: type: string baseType: type: string description: 'Indicates if the transaction appears as a debit or a credit transaction in the account.

    Applicable containers: bank,creditCard,investment,insurance,loan
    Applicable Values
    ' readOnly: true enum: - CREDIT - DEBIT categorySource: type: string 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.

    Applicable containers: bank,creditCard,investment,insurance,loan
    Applicable Values
    ' readOnly: true enum: - SYSTEM - USER principal: $ref: '#/components/schemas/Money' lastUpdated: type: string readOnly: true isDeleted: type: boolean description: 'Indicates if the transaction is marked as deleted.Applicable containers: All Containers
    Aggregated / Manual: Both
    Endpoints:
    ' readOnly: true interest: $ref: '#/components/schemas/Money' price: $ref: '#/components/schemas/Money' commission: $ref: '#/components/schemas/Money' id: type: integer description: 'An unique identifier for the transaction. The combination of the id and account container are unique in the system.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ' format: int64 readOnly: true merchantType: type: string description: 'Indicates the merchantType of the transaction.e.g:-BILLERS,SUBSCRIPTION,OTHERS

    Applicable containers: bank,creditCard,investment,loan
    ' readOnly: true amount: $ref: '#/components/schemas/Money' checkNumber: type: string description: 'The checkNumber of the transaction.

    Applicable containers: bank
    ' readOnly: true isPhysical: type: boolean description: 'Indicates if the transaction is happened online or in-store.

    Applicable containers: bank,creditCard,investment,loan
    ' readOnly: true quantity: type: number description: 'The quantity associated with the transaction.
    Note: The quantity field applies only to trade-related transactions.

    Applicable containers: investment
    ' format: double readOnly: true valoren: type: string description: 'It is an identification number that is assigned to financial instruments such as stocks and bonds trading in Switzerland.

    Applicable containers: investment
    ' readOnly: true isManual: type: boolean 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.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ' readOnly: true merchant: $ref: '#/components/schemas/Merchant' sedol: type: string description: 'SEDOL stands for Stock Exchange Daily Official List, a list of security identifiers used in the United Kingdom and Ireland for clearing purposes.

    Applicable containers: investment
    ' readOnly: true transactionDate: type: string description: 'The date the transaction happens in the account.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ' readOnly: true categoryType: type: string 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.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ' readOnly: true enum: - TRANSFER - DEFERRED_COMPENSATION - UNCATEGORIZE - INCOME - EXPENSE accountId: type: integer description: 'The account from which the transaction was made. This is basically the primary key of the account resource.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ' format: int64 readOnly: true createdDate: type: string readOnly: true sourceType: type: string description: 'The source through which the transaction is added to the Yodlee system.

    Applicable containers: bank,creditCard,investment,insurance,loann
    Applicable Values:
    ' readOnly: true enum: - AGGREGATED - MANUAL CONTAINER: type: string description: 'The account''s container.

    Applicable containers: bank,creditCard,investment,insurance,loan
    Applicable Values
    ' readOnly: true enum: - bank - creditCard - investment - insurance - loan - reward - bill - realEstate - otherAssets - otherLiabilities postDate: type: string description: 'The date on which the transaction is posted to the account.

    Applicable containers: bank,creditCard,insurance,loan
    ' readOnly: true parentCategoryId: type: integer description: 'The parentCategoryId of the category assigned to the transaction.
    Note: This field will be provided in the response if the transaction is assigned to a user-created category.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ' format: int64 readOnly: true subType: type: string 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.
    Note: The transaction subtype field is available only in the United States, Canada, United Kingdom, New Zealand and India.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ' readOnly: true 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 category: type: string 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.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ' readOnly: true runningBalance: $ref: '#/components/schemas/Money' categoryId: type: integer 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.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ' format: int64 readOnly: true holdingDescription: type: string description: 'For transactions involving securities, this captures the securities description.

    Applicable containers: investment
    ' readOnly: true isin: type: string description: 'International Securities Identification Number (ISIN) standard is used worldwide to identify specific securities.

    Applicable containers: investment
    ' readOnly: true status: type: string description: 'The status of the transaction: pending or posted.
    Note: Most FI sites only display posted transactions. If the FI site displays transaction status, same will be aggregated.

    Applicable containers: bank,creditCard,investment,insurance,loan
    Applicable Values
    ' readOnly: true enum: - POSTED - PENDING - SCHEDULED - FAILED - CLEARED Merchant: title: Merchant type: object properties: website: type: string description: 'The website of the merchant.

    Applicable containers: bank,creditCard,investment,loan
    ' readOnly: true address: $ref: '#/components/schemas/AccountAddress' contact: $ref: '#/components/schemas/Contact' categoryLabel: type: array description: 'The business categories of the merchant.

    Applicable containers: bank,creditCard
    Applicable Values
    ' readOnly: true items: type: string coordinates: $ref: '#/components/schemas/Coordinates' name: type: string description: 'The name of the merchant.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ' readOnly: true id: type: string description: 'Identifier of the merchant.

    Applicable containers: bank,creditCard,investment,insurance,loan
    ' readOnly: true source: type: string description: 'The source through which merchant information is retrieved.

    Applicable containers: bank,creditCard,investment,insurance,loan
    Applicable Values
    ' readOnly: true enum: - YODLEE - FACTUAL logoURL: type: string description: 'The logoURL of the merchant.

    Applicable containers: bank,creditCard,investment,loan
    ' readOnly: true Coverage: title: Coverage type: object properties: amount: type: array description: 'The coverage amount-related details.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:' readOnly: true items: $ref: '#/components/schemas/CoverageAmount' planType: type: string description: 'The plan type for an insurance provided to an individual or an entity.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance
    Endpoints:Applicable Values:
    ' readOnly: true enum: - PPO - HMO - UNKNOWN endDate: type: string description: 'The date on which the coverage for the account ends or expires.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:' readOnly: true type: type: string description: 'The type of coverage provided to an individual or an entity.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:Applicable Values:
    ' readOnly: true enum: - VISION - DENTAL - MEDICAL - HEALTH - DEATH_COVER - TOTAL_PERMANENT_DISABILITY - ACCIDENTAL_DEATH_COVER - INCOME_PROTECTION - DEATH_TOTAL_PERMANENT_DISABILITY - OTHER startDate: type: string description: 'The date on which the coverage for the account starts.

    Aggregated / Manual: Aggregated
    Applicable containers: insurance,investment
    Endpoints:' readOnly: true DataExtractsEventLinks: title: DataExtractsEventLinks type: object properties: methodType: type: string readOnly: true rel: type: string readOnly: true href: type: string readOnly: true Contact: title: Contact type: object properties: phone: type: string description: 'Phone number of the merchant

    Applicable containers: bank,creditCard,investment,loan
    ' email: type: string description: 'Email Id of the merchant

    Applicable containers: bank,creditCard,investment,loan
    '