Envestnet · Schema

RuleClause

FinancialWealth ManagementOpen BankingAccount Aggregation

Properties

Name Type Description
field string Field for which the clause is created.


Valid Values:amount,descriptionApplicable containers: creditCard, investment, insurance, loan
userDefinedRuleId integer Unique identifier generated for every rule the user creates.

Applicable containers: creditCard, investment, insurance, loan
fieldValue string The value would be the amount value in case of amount based rule clause or the string value in case of description based rule clause.

Applicable containers: creditCard, investment, insur
operation string Operation for which the clause is created.

Applicable containers: creditCard, investment, insurance, loan
ruleClauseId integer Unique identifier generated for the rule clause.

Applicable containers: creditCard, investment, insurance, loan
View JSON Schema on GitHub

JSON Schema

envestnet-ruleclause-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RuleClause",
  "title": "RuleClause",
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "description": "Field for which the clause is created.<br><br><br><b>Valid Values</b>:amount,description<b>Applicable containers</b>: creditCard, investment, insurance, loan<br>",
      "readOnly": true,
      "enum": [
        "amount",
        "description"
      ]
    },
    "userDefinedRuleId": {
      "type": "integer",
      "description": "Unique identifier generated for every rule the user creates.<br><br><b>Applicable containers</b>: creditCard, investment, insurance, loan<br>",
      "format": "int64",
      "readOnly": true
    },
    "fieldValue": {
      "type": "string",
      "description": "The value would be the amount value in case of amount based rule clause or the string value in case of description based rule clause.<br><br><b>Applicable containers</b>: creditCard, investment, insurance, loan<br>",
      "readOnly": true
    },
    "operation": {
      "type": "string",
      "description": "Operation for which the clause is created.<br><br><b>Applicable containers</b>: creditCard, investment, insurance, loan<br>",
      "readOnly": true,
      "enum": [
        "numberEquals",
        "numberLessThan",
        "numberLessThanEquals",
        "numberGreaterThan",
        "numberGreaterThanEquals",
        "stringEquals",
        "stringContains"
      ]
    },
    "ruleClauseId": {
      "type": "integer",
      "description": "Unique identifier generated for the rule clause.<br><br><b>Applicable containers</b>: creditCard, investment, insurance, loan<br>",
      "format": "int64",
      "readOnly": true
    }
  }
}