Envestnet · Schema

CategoryTypeDerived

provides values derived at "categoryType" level.

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name Type Description
categoryType string 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.
totalSpending object The total amount spent by the user in the defined dateRange and categoryType.
dateRange object The date range considered to compute the values.
link object
View JSON Schema on GitHub

JSON Schema

envestnet-categorytypederived-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CategoryTypeDerived",
  "title": "CategoryTypeDerived",
  "description": "provides values derived at \"categoryType\" level.",
  "properties": {
    "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.",
      "readOnly": true
    },
    "totalSpending": {
      "description": "The total amount spent by the user in the defined dateRange and categoryType.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ],
      "readOnly": true
    },
    "dateRange": {
      "description": "The date range considered to compute the values.",
      "items": {
        "$ref": "#/components/schemas/DateRange"
      },
      "readOnly": true
    },
    "link": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Link"
        }
      ],
      "readOnly": true
    }
  }
}