Envestnet · Schema

Attribute

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name	Type	Description
container	array	Containers for which the attributes are supported. Endpoints: GET providers GET providers/{providerId}
fromDate	string	Applicable only to EBILLS and STATEMENTS attributes of DOCUMENT dataset. Endpoints: POST providerAccounts PUT providerAccounts
toFinYear	string	Applicable only to TAX attribute of DOCUMENT dataset. Endpoints: POST providerAccounts PUT providerAccounts
fromFinYear	string	Applicable only to TAX attribute of DOCUMENT dataset. Endpoints: POST providerAccounts PUT providerAccounts
containerAttributes	object
toDate	string	Applicable only to EBILLS and STATEMENTS attributes of DOCUMENT dataset. Endpoints: POST providerAccounts PUT providerAccounts
name	string	Attributes that are supported for a dataset. Endpoints: GET providers GET providers/{providerId}

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Attribute",
  "title": "Attribute",
  "type": "object",
  "properties": {
    "container": {
      "type": "array",
      "description": "Containers for which the attributes are supported.<br><br><b>Endpoints</b>:<ul><li>GET providers</li><li>GET providers/{providerId}</li></ul>",
      "items": {
        "type": "string",
        "enum": [
          "bank",
          "creditCard",
          "investment",
          "insurance",
          "loan",
          "reward",
          "bill",
          "realEstate",
          "otherAssets",
          "otherLiabilities"
        ]
      }
    },
    "fromDate": {
      "type": "string",
      "description": "Applicable only to EBILLS and STATEMENTS attributes of DOCUMENT dataset.<br><br><b>Endpoints</b>:<ul><li>POST providerAccounts</li><li>PUT providerAccounts</li></ul>",
      "readOnly": true
    },
    "toFinYear": {
      "type": "string",
      "description": "Applicable only to TAX attribute of DOCUMENT dataset.<br><br><b>Endpoints</b>:<ul><li>POST providerAccounts</li><li>PUT providerAccounts</li></ul>",
      "readOnly": true
    },
    "fromFinYear": {
      "type": "string",
      "description": "Applicable only to TAX attribute of DOCUMENT dataset.<br><br><b>Endpoints</b>:<ul><li>POST providerAccounts</li><li>PUT providerAccounts</li></ul>",
      "readOnly": true
    },
    "containerAttributes": {
      "$ref": "#/components/schemas/ContainerAttributes"
    },
    "toDate": {
      "type": "string",
      "description": "Applicable only to EBILLS and STATEMENTS attributes of DOCUMENT dataset.<br><br><b>Endpoints</b>:<ul><li>POST providerAccounts</li><li>PUT providerAccounts</li></ul>",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "Attributes that are supported for a dataset.<br><br><b>Endpoints</b>:<ul><li>GET providers</li><li>GET providers/{providerId}</li></ul>",
      "enum": [
        "BASIC_ACCOUNT_INFO",
        "TRANSACTIONS",
        "STATEMENTS",
        "HOLDINGS",
        "ACCOUNT_DETAILS",
        "TAX",
        "EBILLS",
        "FULL_ACCT_NUMBER",
        "BANK_TRANSFER_CODE",
        "HOLDER_NAME",
        "HOLDER_DETAILS",
        "PAYMENT_PROFILE",
        "PAYMENT_DETAILS",
        "INTEREST_DETAILS",
        "COVERAGE"
      ]
    }
  }
}