DunningPolicy Data Type

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

Example

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