DunningPolicy Data Type

Implemented Interfaces
Serializable
Properties
name data type description
auditable Auditable
includeDueInvoicesInThreshold boolean
minBalanceTrigger number
totalDunningLevels number
isDefaultPolicy boolean
policyPriority number
id number
includePayReminder boolean
determineLevelBy DunningDetermineLevelBy
disabled boolean
notified boolean
policyName string
interestForDelaySequence number
attachInvoicesToEmails boolean
isActivePolicy boolean
auditableFields array of AuditableFieldHistory
active boolean
policyDescription string
historized boolean
version number
dunningPolicyRules array of DunningPolicyRule
minBalanceTriggerCurrency Currency
transient boolean
dunningLevels array of DunningPolicyLevel

Example

{
  "auditable" : {
    "created" : 12345,
    "lastUser" : "...",
    "creator" : "...",
    "updater" : "...",
    "updated" : 12345,
    "lastModified" : 12345
  },
  "includeDueInvoicesInThreshold" : true,
  "minBalanceTrigger" : 12345.0,
  "totalDunningLevels" : 12345,
  "isDefaultPolicy" : true,
  "policyPriority" : 12345,
  "id" : 12345,
  "includePayReminder" : true,
  "determineLevelBy" : "DAYS_OVERDUE",
  "disabled" : true,
  "notified" : true,
  "policyName" : "...",
  "interestForDelaySequence" : 12345,
  "attachInvoicesToEmails" : true,
  "isActivePolicy" : true,
  "auditableFields" : [ {
    "fieldName" : "...",
    "notfiable" : true,
    "historable" : true,
    "auditType" : "OTHER",
    "currentState" : { },
    "previousState" : { },
    "notified" : true,
    "historized" : true
  }, {
    "fieldName" : "...",
    "notfiable" : true,
    "historable" : true,
    "auditType" : "RENEWAL",
    "currentState" : { },
    "previousState" : { },
    "notified" : true,
    "historized" : true
  } ],
  "active" : true,
  "policyDescription" : "...",
  "historized" : true,
  "version" : 12345,
  "dunningPolicyRules" : [ {
    "dunningPolicy" : {
      "auditable" : { },
      "includeDueInvoicesInThreshold" : true,
      "minBalanceTrigger" : 12345.0,
      "totalDunningLevels" : 12345,
      "isDefaultPolicy" : true,
      "policyPriority" : 12345,
      "id" : 12345,
      "includePayReminder" : true,
      "determineLevelBy" : "DAYS_OVERDUE_OR_BALANCE_THRESHOLD",
      "disabled" : true,
      "notified" : true,
      "policyName" : "...",
      "interestForDelaySequence" : 12345,
      "attachInvoicesToEmails" : true,
      "isActivePolicy" : true,
      "auditableFields" : [ { }, { } ],
      "active" : true,
      "policyDescription" : "...",
      "historized" : true,
      "version" : 12345,
      "dunningPolicyRules" : [ { }, { } ],
      "minBalanceTriggerCurrency" : { },
      "transient" : true,
      "dunningLevels" : [ { }, { } ]
    },
    "id" : 12345,
    "ruleJoint" : "...",
    "dunningPolicyRuleLines" : [ {
      "policyConditionOperator" : "...",
      "auditableFields" : [ { }, { } ],
      "dunningPolicyRule" : { },
      "historized" : true,
      "auditable" : { },
      "policyConditionTarget" : "...",
      "notified" : true,
      "version" : 12345,
      "ruleLineJoint" : "...",
      "id" : 12345,
      "transient" : true,
      "policyConditionTargetValue" : "..."
    }, {
      "policyConditionOperator" : "...",
      "auditableFields" : [ { }, { } ],
      "dunningPolicyRule" : { },
      "historized" : true,
      "auditable" : { },
      "policyConditionTarget" : "...",
      "notified" : true,
      "version" : 12345,
      "ruleLineJoint" : "...",
      "id" : 12345,
      "transient" : true,
      "policyConditionTargetValue" : "..."
    } ],
    "version" : 12345,
    "auditable" : {
      "created" : 12345,
      "lastUser" : "...",
      "creator" : "...",
      "updater" : "...",
      "updated" : 12345,
      "lastModified" : 12345
    },
    "auditableFields" : [ {
      "fieldName" : "...",
      "notfiable" : true,
      "historable" : true,
      "auditType" : "RENEWAL",
      "currentState" : { },
      "previousState" : { },
      "notified" : true,
      "historized" : true
    }, {
      "fieldName" : "...",
      "notfiable" : true,
      "historable" : true,
      "auditType" : "RENEWAL",
      "currentState" : { },
      "previousState" : { },
      "notified" : true,
      "historized" : true
    } ],
    "notified" : true,
    "historized" : true,
    "transient" : true
  }, {
    "dunningPolicy" : {
      "auditable" : { },
      "includeDueInvoicesInThreshold" : true,
      "minBalanceTrigger" : 12345.0,
      "totalDunningLevels" : 12345,
      "isDefaultPolicy" : true,
      "policyPriority" : 12345,
      "id" : 12345,
      "includePayReminder" : true,
      "determineLevelBy" : "DAYS_OVERDUE",
      "disabled" : true,
      "notified" : true,
      "policyName" : "...",
      "interestForDelaySequence" : 12345,
      "attachInvoicesToEmails" : true,
      "isActivePolicy" : true,
      "auditableFields" : [ { }, { } ],
      "active" : true,
      "policyDescription" : "...",
      "historized" : true,
      "version" : 12345,
      "dunningPolicyRules" : [ { }, { } ],
      "minBalanceTriggerCurrency" : { },
      "transient" : true,
      "dunningLevels" : [ { }, { } ]
    },
    "id" : 12345,
    "ruleJoint" : "...",
    "dunningPolicyRuleLines" : [ {
      "policyConditionOperator" : "...",
      "auditableFields" : [ { }, { } ],
      "dunningPolicyRule" : { },
      "historized" : true,
      "auditable" : { },
      "policyConditionTarget" : "...",
      "notified" : true,
      "version" : 12345,
      "ruleLineJoint" : "...",
      "id" : 12345,
      "transient" : true,
      "policyConditionTargetValue" : "..."
    }, {
      "policyConditionOperator" : "...",
      "auditableFields" : [ { }, { } ],
      "dunningPolicyRule" : { },
      "historized" : true,
      "auditable" : { },
      "policyConditionTarget" : "...",
      "notified" : true,
      "version" : 12345,
      "ruleLineJoint" : "...",
      "id" : 12345,
      "transient" : true,
      "policyConditionTargetValue" : "..."
    } ],
    "version" : 12345,
    "auditable" : {
      "created" : 12345,
      "lastUser" : "...",
      "creator" : "...",
      "updater" : "...",
      "updated" : 12345,
      "lastModified" : 12345
    },
    "auditableFields" : [ {
      "fieldName" : "...",
      "notfiable" : true,
      "historable" : true,
      "auditType" : "RENEWAL",
      "currentState" : { },
      "previousState" : { },
      "notified" : true,
      "historized" : true
    }, {
      "fieldName" : "...",
      "notfiable" : true,
      "historable" : true,
      "auditType" : "OTHER",
      "currentState" : { },
      "previousState" : { },
      "notified" : true,
      "historized" : true
    } ],
    "notified" : true,
    "historized" : true,
    "transient" : true
  } ],
  "minBalanceTriggerCurrency" : {
    "descriptionEn" : "...",
    "transient" : true,
    "auditableFields" : [ {
      "fieldName" : "...",
      "notfiable" : true,
      "historable" : true,
      "auditType" : "STATUS",
      "currentState" : { },
      "previousState" : { },
      "notified" : true,
      "historized" : true
    }, {
      "fieldName" : "...",
      "notfiable" : true,
      "historable" : true,
      "auditType" : "RENEWAL",
      "currentState" : { },
      "previousState" : { },
      "notified" : true,
      "historized" : true
    } ],
    "description" : "...",
    "historized" : true,
    "version" : 12345,
    "currencyCode" : "...",
    "descriptionI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "systemCurrency" : true,
    "symbol" : "...",
    "auditable" : {
      "created" : 12345,
      "lastUser" : "...",
      "creator" : "...",
      "updater" : "...",
      "updated" : 12345,
      "lastModified" : 12345
    },
    "id" : 12345,
    "notified" : true
  },
  "transient" : true,
  "dunningLevels" : [ {
    "id" : 12345,
    "auditableFields" : [ {
      "fieldName" : "...",
      "notfiable" : true,
      "historable" : true,
      "auditType" : "OTHER",
      "currentState" : { },
      "previousState" : { },
      "notified" : true,
      "historized" : true
    }, {
      "fieldName" : "...",
      "notfiable" : true,
      "historable" : true,
      "auditType" : "OTHER",
      "currentState" : { },
      "previousState" : { },
      "notified" : true,
      "historized" : true
    } ],
    "collectionPlanStatus" : {
      "id" : 12345,
      "historized" : true,
      "transient" : true,
      "dunningSettings" : { },
      "notified" : true,
      "auditable" : { },
      "auditableFields" : [ { }, { } ],
      "colorCode" : "...",
      "status" : "FAILED",
      "version" : 12345,
      "description" : "..."
    },
    "sequence" : 12345,
    "notified" : true,
    "dunningPolicy" : {
      "auditable" : { },
      "includeDueInvoicesInThreshold" : true,
      "minBalanceTrigger" : 12345.0,
      "totalDunningLevels" : 12345,
      "isDefaultPolicy" : true,
      "policyPriority" : 12345,
      "id" : 12345,
      "includePayReminder" : true,
      "determineLevelBy" : "DAYS_OVERDUE_OR_BALANCE_THRESHOLD",
      "disabled" : true,
      "notified" : true,
      "policyName" : "...",
      "interestForDelaySequence" : 12345,
      "attachInvoicesToEmails" : true,
      "isActivePolicy" : true,
      "auditableFields" : [ { }, { } ],
      "active" : true,
      "policyDescription" : "...",
      "historized" : true,
      "version" : 12345,
      "dunningPolicyRules" : [ { }, { } ],
      "minBalanceTriggerCurrency" : { },
      "transient" : true,
      "dunningLevels" : [ { }, { } ]
    },
    "auditable" : {
      "created" : 12345,
      "lastUser" : "...",
      "creator" : "...",
      "updater" : "...",
      "updated" : 12345,
      "lastModified" : 12345
    },
    "dunningLevel" : {
      "endOfDunningLevel" : true,
      "historized" : true,
      "referenceDescription" : "...",
      "id" : 12345,
      "description" : "...",
      "appendGeneratedCode" : true,
      "parentEntity" : { },
      "codeChanged" : true,
      "softDecline" : true,
      "auditable" : { },
      "dunningActions" : [ { }, { } ],
      "transient" : true,
      "chargeValue" : 12345.0,
      "relatedPolicies" : [ { }, { } ],
      "code" : "...",
      "minBalance" : 12345.0,
      "active" : true,
      "chargeCurrency" : { },
      "reminder" : true,
      "chargeType" : "PERCENTAGE",
      "auditableFields" : [ { }, { } ],
      "descriptionAndCode" : "...",
      "parentEntityType" : { },
      "descriptionOrCode" : "...",
      "version" : 12345,
      "notified" : true,
      "daysOverdue" : 12345,
      "minBalanceCurrency" : { },
      "referenceCode" : "..."
    },
    "transient" : true,
    "historized" : true,
    "version" : 12345
  }, {
    "id" : 12345,
    "auditableFields" : [ {
      "fieldName" : "...",
      "notfiable" : true,
      "historable" : true,
      "auditType" : "STATUS",
      "currentState" : { },
      "previousState" : { },
      "notified" : true,
      "historized" : true
    }, {
      "fieldName" : "...",
      "notfiable" : true,
      "historable" : true,
      "auditType" : "STATUS",
      "currentState" : { },
      "previousState" : { },
      "notified" : true,
      "historized" : true
    } ],
    "collectionPlanStatus" : {
      "id" : 12345,
      "historized" : true,
      "transient" : true,
      "dunningSettings" : { },
      "notified" : true,
      "auditable" : { },
      "auditableFields" : [ { }, { } ],
      "colorCode" : "...",
      "status" : "STOPPED",
      "version" : 12345,
      "description" : "..."
    },
    "sequence" : 12345,
    "notified" : true,
    "dunningPolicy" : {
      "auditable" : { },
      "includeDueInvoicesInThreshold" : true,
      "minBalanceTrigger" : 12345.0,
      "totalDunningLevels" : 12345,
      "isDefaultPolicy" : true,
      "policyPriority" : 12345,
      "id" : 12345,
      "includePayReminder" : true,
      "determineLevelBy" : "DAYS_OVERDUE",
      "disabled" : true,
      "notified" : true,
      "policyName" : "...",
      "interestForDelaySequence" : 12345,
      "attachInvoicesToEmails" : true,
      "isActivePolicy" : true,
      "auditableFields" : [ { }, { } ],
      "active" : true,
      "policyDescription" : "...",
      "historized" : true,
      "version" : 12345,
      "dunningPolicyRules" : [ { }, { } ],
      "minBalanceTriggerCurrency" : { },
      "transient" : true,
      "dunningLevels" : [ { }, { } ]
    },
    "auditable" : {
      "created" : 12345,
      "lastUser" : "...",
      "creator" : "...",
      "updater" : "...",
      "updated" : 12345,
      "lastModified" : 12345
    },
    "dunningLevel" : {
      "endOfDunningLevel" : true,
      "historized" : true,
      "referenceDescription" : "...",
      "id" : 12345,
      "description" : "...",
      "appendGeneratedCode" : true,
      "parentEntity" : { },
      "codeChanged" : true,
      "softDecline" : true,
      "auditable" : { },
      "dunningActions" : [ { }, { } ],
      "transient" : true,
      "chargeValue" : 12345.0,
      "relatedPolicies" : [ { }, { } ],
      "code" : "...",
      "minBalance" : 12345.0,
      "active" : true,
      "chargeCurrency" : { },
      "reminder" : true,
      "chargeType" : "FLAT_AMOUNT",
      "auditableFields" : [ { }, { } ],
      "descriptionAndCode" : "...",
      "parentEntityType" : { },
      "descriptionOrCode" : "...",
      "version" : 12345,
      "notified" : true,
      "daysOverdue" : 12345,
      "minBalanceCurrency" : { },
      "referenceCode" : "..."
    },
    "transient" : true,
    "historized" : true,
    "version" : 12345
  } ]
}