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