Envestnet · Schema

BudgetDetail

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name Type Description
creditTotal object credit total for the budget.
debitTotal object debit total for the budget.
incomeBudget object Set a budget for the overall income budget.
remaingIncomeBudget object Set a budget for the remaining expense budget.
expenseBudget object Set a budget for the overall expense budget.
remaingExpenseBudget object Set a budget for the remaining expense budget.
typeName string TypeName identifies the merchant name.
typeId number TypeId identifies the category or detailcategory id.'
remainingIncomeBudgetPercent number 'percentage of remaining Income budget'
remaininExpenseBudgetPercent number 'percentage of remaining Expense budget'
View JSON Schema on GitHub

JSON Schema

envestnet-budgetdetail-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BudgetDetail",
  "title": "BudgetDetail",
  "properties": {
    "creditTotal": {
      "description": "credit total for the budget.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ]
    },
    "debitTotal": {
      "description": "debit total for the budget.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ]
    },
    "incomeBudget": {
      "description": "Set a budget for the overall income budget.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ]
    },
    "remaingIncomeBudget": {
      "description": "Set a budget for the remaining expense budget.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ]
    },
    "expenseBudget": {
      "description": "Set a budget for the overall expense budget.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ]
    },
    "remaingExpenseBudget": {
      "description": "Set a budget for the remaining expense budget.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Money"
        }
      ]
    },
    "typeName": {
      "type": "string",
      "description": "TypeName identifies the merchant name."
    },
    "typeId": {
      "type": "number",
      "description": "TypeId identifies the category or detailcategory id.'"
    },
    "remainingIncomeBudgetPercent": {
      "type": "number",
      "description": "'percentage of remaining Income budget'"
    },
    "remaininExpenseBudgetPercent": {
      "type": "number",
      "description": "'percentage of remaining Expense budget'"
    }
  }
}