Envestnet · Schema

CategoryTrend

Category trend information, broken down by a specific frequency, for a specific date range.

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name	Type	Description
categoryId	string	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.
category	string	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.
debitTotal	object	The sum of all debit transactions associated with the category for the specific duration.
creditTotal	object	The sum of all credit transactions associated with the category for the specific duration.
netTotal	object	Net spending calculated as (debitTotal - creditTotal) associated with the category for the specific duration.
averageNetTotal	object	Average spending calculated as (netTotal)/(Number of Months) associated with the category for the specific duration.
link	object
detail	array	Breakdown of income/spending based on a predefined frequency - typically, monthly.
basicPeerDetail	array
categoryDerived	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CategoryTrend",
  "title": "CategoryTrend",
  "description": "Category trend information, broken down by a specific frequency, for a  specific date range.",
  "properties": {
    "categoryId": {
      "type": "string",
      "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.",
      "readOnly": true
    },
    "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.",
      "readOnly": true
    },
    "debitTotal": {
      "description": "The sum of all debit transactions associated with the category for the specific duration.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ],
      "readOnly": true
    },
    "creditTotal": {
      "description": "The sum of all credit transactions associated with the category for the specific duration.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ],
      "readOnly": true
    },
    "netTotal": {
      "description": "Net spending calculated as (debitTotal - creditTotal) associated with  the category for the specific duration.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ],
      "readOnly": true
    },
    "averageNetTotal": {
      "description": "Average spending calculated as (netTotal)/(Number of Months)  associated with the category for the specific duration.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ],
      "readOnly": true
    },
    "link": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Link"
        }
      ],
      "readOnly": true
    },
    "detail": {
      "type": "array",
      "description": "Breakdown of income/spending based on a predefined frequency - typically, monthly.",
      "items": {
        "$ref": "#/components/schemas/Detail"
      },
      "readOnly": true
    },
    "basicPeerDetail": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BasicPeerDetail"
      },
      "readOnly": true
    },
    "categoryDerived": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CategoryDerived"
      }
    }
  },
  "required": [
    "categoryId",
    "category"
  ]
}