| name | data type | constraints | description |
|---|---|---|---|
| active | boolean | ||
| chargeCurrency | Currency | ||
| chargeValue | number | ||
| referenceCode | string | ||
| historized | boolean | ||
| code | string | required, max size: 255, min size: 1 | |
| transient | boolean | ||
| codeChanged | boolean | ||
| parentEntity | BusinessEntity | ||
| description | string | max size: 255, min size: 0 | |
| reminder | boolean | ||
| auditable | Auditable | ||
| dunningActions | array of DunningAction | ||
| parentEntityType | object | ||
| array of DunningPolicyLevel | |||
| version | number | ||
| referenceDescription | string | ||
| notified | boolean | ||
| daysOverdue | number | ||
| chargeType | DunningLevelChargeTypeEnum | ||
| endOfDunningLevel | boolean | ||
| appendGeneratedCode | boolean | ||
| minBalanceCurrency | Currency | ||
| softDecline | boolean | ||
| minBalance | number | ||
| auditableFields | array of AuditableFieldHistory | ||
| id | number | ||
| descriptionOrCode | string | ||
| descriptionAndCode | string |
Example
{
"active" : true,
"chargeCurrency" : {
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastModified" : 12345,
"updater" : "...",
"updated" : 12345,
"lastUser" : "..."
},
"transient" : true,
"auditableFields" : [ {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "RENEWAL",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
}, {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "STATUS",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
} ],
"version" : 12345,
"id" : 12345,
"notified" : true,
"description" : "...",
"systemCurrency" : true,
"symbol" : "...",
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"historized" : true,
"descriptionEn" : "...",
"currencyCode" : "..."
},
"chargeValue" : 12345.0,
"referenceCode" : "...",
"historized" : true,
"code" : "...",
"transient" : true,
"codeChanged" : true,
"parentEntity" : {
"code" : "...",
"appendGeneratedCode" : true,
"auditableFields" : [ {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "STATUS",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
}, {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "RENEWAL",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
} ],
"notified" : true,
"parentEntity" : { },
"referenceDescription" : "...",
"id" : 12345,
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastModified" : 12345,
"updater" : "...",
"updated" : 12345,
"lastUser" : "..."
},
"codeChanged" : true,
"transient" : true,
"referenceCode" : "...",
"descriptionOrCode" : "...",
"historized" : true,
"version" : 12345,
"parentEntityType" : { },
"description" : "...",
"descriptionAndCode" : "..."
},
"description" : "...",
"reminder" : true,
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastModified" : 12345,
"updater" : "...",
"updated" : 12345,
"lastUser" : "..."
},
"dunningActions" : [ {
"code" : "...",
"assignedTo" : {
"id" : 12345,
"notified" : true,
"agentEmailItem" : "...",
"auditable" : { },
"historized" : true,
"agentLastNameItem" : "...",
"collectionAgency" : "...",
"auditableFields" : [ { }, { } ],
"version" : 12345,
"transient" : true,
"external" : true,
"dunningSettings" : { },
"agentFirstNameItem" : "..."
},
"id" : 12345,
"parentEntityType" : { },
"version" : 12345,
"transient" : true,
"attachOverdueInvoices" : true,
"activeAction" : true,
"appendGeneratedCode" : true,
"actionChannel" : "CERTIFIED_LETTER",
"scriptInstance" : {
"scriptInstanceCategory" : { },
"sourcingRoles" : [ "...", "..." ],
"parentEntity" : { },
"descriptionOrCode" : "...",
"historized" : true,
"codeChanged" : true,
"id" : 12345,
"executionRoles" : [ "...", "..." ],
"appendGeneratedCode" : true,
"description" : "...",
"transient" : true,
"code" : "...",
"auditable" : { },
"active" : true,
"parentEntityType" : { },
"auditableFields" : [ { }, { } ],
"notified" : true,
"disabled" : true,
"script" : "...",
"sourceTypeEnum" : "JAVA",
"referenceDescription" : "...",
"version" : 12345,
"referenceCode" : "...",
"reuse" : true,
"descriptionAndCode" : "...",
"scriptErrors" : [ { }, { } ],
"error" : true
},
"referenceCode" : "...",
"actionMode" : "MANUAL",
"notified" : true,
"actionNotificationTemplate" : {
"id" : 12345,
"referenceDescription" : "...",
"type" : "DUNNING",
"parentEntity" : { },
"appendGeneratedCode" : true,
"tagStartDelimiter" : "...",
"descriptionOrCode" : "...",
"auditable" : { },
"descriptionAndCode" : "...",
"textContent" : "...",
"code" : "...",
"historized" : true,
"endDate" : 12345,
"parentEntityType" : { },
"referenceCode" : "...",
"subject" : "...",
"tagEndDelimiter" : "...",
"auditableFields" : [ { }, { } ],
"codeChanged" : true,
"htmlContent" : "...",
"version" : 12345,
"media" : "DATABASE",
"description" : "...",
"notified" : true,
"transient" : true,
"startDate" : 12345
},
"description" : "...",
"descriptionOrCode" : "...",
"auditableFields" : [ {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "STATUS",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
}, {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "RENEWAL",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
} ],
"descriptionAndCode" : "...",
"attachDueInvoices" : true,
"historized" : true,
"codeChanged" : true,
"parentEntity" : {
"code" : "...",
"appendGeneratedCode" : true,
"auditableFields" : [ { }, { } ],
"notified" : true,
"parentEntity" : { },
"referenceDescription" : "...",
"id" : 12345,
"auditable" : { },
"codeChanged" : true,
"transient" : true,
"referenceCode" : "...",
"descriptionOrCode" : "...",
"historized" : true,
"version" : 12345,
"parentEntityType" : { },
"description" : "...",
"descriptionAndCode" : "..."
},
"relatedLevels" : [ {
"active" : true,
"chargeCurrency" : { },
"chargeValue" : 12345.0,
"referenceCode" : "...",
"historized" : true,
"code" : "...",
"transient" : true,
"codeChanged" : true,
"parentEntity" : { },
"description" : "...",
"reminder" : true,
"auditable" : { },
"dunningActions" : [ { }, { } ],
"parentEntityType" : { },
"relatedPolicies" : [ { }, { } ],
"version" : 12345,
"referenceDescription" : "...",
"notified" : true,
"daysOverdue" : 12345,
"chargeType" : "FLAT_AMOUNT",
"endOfDunningLevel" : true,
"appendGeneratedCode" : true,
"minBalanceCurrency" : { },
"softDecline" : true,
"minBalance" : 12345.0,
"auditableFields" : [ { }, { } ],
"id" : 12345,
"descriptionOrCode" : "...",
"descriptionAndCode" : "..."
}, {
"active" : true,
"chargeCurrency" : { },
"chargeValue" : 12345.0,
"referenceCode" : "...",
"historized" : true,
"code" : "...",
"transient" : true,
"codeChanged" : true,
"parentEntity" : { },
"description" : "...",
"reminder" : true,
"auditable" : { },
"dunningActions" : [ { }, { } ],
"parentEntityType" : { },
"relatedPolicies" : [ { }, { } ],
"version" : 12345,
"referenceDescription" : "...",
"notified" : true,
"daysOverdue" : 12345,
"chargeType" : "FLAT_AMOUNT",
"endOfDunningLevel" : true,
"appendGeneratedCode" : true,
"minBalanceCurrency" : { },
"softDecline" : true,
"minBalance" : 12345.0,
"auditableFields" : [ { }, { } ],
"id" : 12345,
"descriptionOrCode" : "...",
"descriptionAndCode" : "..."
} ],
"referenceDescription" : "...",
"actionType" : "WRITE_OFF_INVOICE",
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastModified" : 12345,
"updater" : "...",
"updated" : 12345,
"lastUser" : "..."
}
}, {
"code" : "...",
"assignedTo" : {
"id" : 12345,
"notified" : true,
"agentEmailItem" : "...",
"auditable" : { },
"historized" : true,
"agentLastNameItem" : "...",
"collectionAgency" : "...",
"auditableFields" : [ { }, { } ],
"version" : 12345,
"transient" : true,
"external" : true,
"dunningSettings" : { },
"agentFirstNameItem" : "..."
},
"id" : 12345,
"parentEntityType" : { },
"version" : 12345,
"transient" : true,
"attachOverdueInvoices" : true,
"activeAction" : true,
"appendGeneratedCode" : true,
"actionChannel" : "EMAIL",
"scriptInstance" : {
"scriptInstanceCategory" : { },
"sourcingRoles" : [ "...", "..." ],
"parentEntity" : { },
"descriptionOrCode" : "...",
"historized" : true,
"codeChanged" : true,
"id" : 12345,
"executionRoles" : [ "...", "..." ],
"appendGeneratedCode" : true,
"description" : "...",
"transient" : true,
"code" : "...",
"auditable" : { },
"active" : true,
"parentEntityType" : { },
"auditableFields" : [ { }, { } ],
"notified" : true,
"disabled" : true,
"script" : "...",
"sourceTypeEnum" : "JAVA_CLASS",
"referenceDescription" : "...",
"version" : 12345,
"referenceCode" : "...",
"reuse" : true,
"descriptionAndCode" : "...",
"scriptErrors" : [ { }, { } ],
"error" : true
},
"referenceCode" : "...",
"actionMode" : "MANUAL",
"notified" : true,
"actionNotificationTemplate" : {
"id" : 12345,
"referenceDescription" : "...",
"type" : "DUNNING",
"parentEntity" : { },
"appendGeneratedCode" : true,
"tagStartDelimiter" : "...",
"descriptionOrCode" : "...",
"auditable" : { },
"descriptionAndCode" : "...",
"textContent" : "...",
"code" : "...",
"historized" : true,
"endDate" : 12345,
"parentEntityType" : { },
"referenceCode" : "...",
"subject" : "...",
"tagEndDelimiter" : "...",
"auditableFields" : [ { }, { } ],
"codeChanged" : true,
"htmlContent" : "...",
"version" : 12345,
"media" : "SMS",
"description" : "...",
"notified" : true,
"transient" : true,
"startDate" : 12345
},
"description" : "...",
"descriptionOrCode" : "...",
"auditableFields" : [ {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "RENEWAL",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
}, {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "RENEWAL",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
} ],
"descriptionAndCode" : "...",
"attachDueInvoices" : true,
"historized" : true,
"codeChanged" : true,
"parentEntity" : {
"code" : "...",
"appendGeneratedCode" : true,
"auditableFields" : [ { }, { } ],
"notified" : true,
"parentEntity" : { },
"referenceDescription" : "...",
"id" : 12345,
"auditable" : { },
"codeChanged" : true,
"transient" : true,
"referenceCode" : "...",
"descriptionOrCode" : "...",
"historized" : true,
"version" : 12345,
"parentEntityType" : { },
"description" : "...",
"descriptionAndCode" : "..."
},
"relatedLevels" : [ {
"active" : true,
"chargeCurrency" : { },
"chargeValue" : 12345.0,
"referenceCode" : "...",
"historized" : true,
"code" : "...",
"transient" : true,
"codeChanged" : true,
"parentEntity" : { },
"description" : "...",
"reminder" : true,
"auditable" : { },
"dunningActions" : [ { }, { } ],
"parentEntityType" : { },
"relatedPolicies" : [ { }, { } ],
"version" : 12345,
"referenceDescription" : "...",
"notified" : true,
"daysOverdue" : 12345,
"chargeType" : "PERCENTAGE",
"endOfDunningLevel" : true,
"appendGeneratedCode" : true,
"minBalanceCurrency" : { },
"softDecline" : true,
"minBalance" : 12345.0,
"auditableFields" : [ { }, { } ],
"id" : 12345,
"descriptionOrCode" : "...",
"descriptionAndCode" : "..."
}, {
"active" : true,
"chargeCurrency" : { },
"chargeValue" : 12345.0,
"referenceCode" : "...",
"historized" : true,
"code" : "...",
"transient" : true,
"codeChanged" : true,
"parentEntity" : { },
"description" : "...",
"reminder" : true,
"auditable" : { },
"dunningActions" : [ { }, { } ],
"parentEntityType" : { },
"relatedPolicies" : [ { }, { } ],
"version" : 12345,
"referenceDescription" : "...",
"notified" : true,
"daysOverdue" : 12345,
"chargeType" : "PERCENTAGE",
"endOfDunningLevel" : true,
"appendGeneratedCode" : true,
"minBalanceCurrency" : { },
"softDecline" : true,
"minBalance" : 12345.0,
"auditableFields" : [ { }, { } ],
"id" : 12345,
"descriptionOrCode" : "...",
"descriptionAndCode" : "..."
} ],
"referenceDescription" : "...",
"actionType" : "RETRY_PAYMENT",
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastModified" : 12345,
"updater" : "...",
"updated" : 12345,
"lastUser" : "..."
}
} ],
"parentEntityType" : { },
"relatedPolicies" : [ {
"version" : 12345,
"auditableFields" : [ {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "STATUS",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
}, {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "RENEWAL",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
} ],
"historized" : true,
"sequence" : 12345,
"dunningLevel" : {
"active" : true,
"chargeCurrency" : { },
"chargeValue" : 12345.0,
"referenceCode" : "...",
"historized" : true,
"code" : "...",
"transient" : true,
"codeChanged" : true,
"parentEntity" : { },
"description" : "...",
"reminder" : true,
"auditable" : { },
"dunningActions" : [ { }, { } ],
"parentEntityType" : { },
"relatedPolicies" : [ { }, { } ],
"version" : 12345,
"referenceDescription" : "...",
"notified" : true,
"daysOverdue" : 12345,
"chargeType" : "PERCENTAGE",
"endOfDunningLevel" : true,
"appendGeneratedCode" : true,
"minBalanceCurrency" : { },
"softDecline" : true,
"minBalance" : 12345.0,
"auditableFields" : [ { }, { } ],
"id" : 12345,
"descriptionOrCode" : "...",
"descriptionAndCode" : "..."
},
"id" : 12345,
"dunningPolicy" : {
"totalDunningLevels" : 12345,
"version" : 12345,
"minBalanceTriggerCurrency" : { },
"id" : 12345,
"policyDescription" : "...",
"auditable" : { },
"isActivePolicy" : true,
"isDefaultPolicy" : true,
"transient" : true,
"attachInvoicesToEmails" : true,
"policyName" : "...",
"disabled" : true,
"interestForDelaySequence" : 12345,
"dunningLevels" : [ { }, { } ],
"determineLevelBy" : "DAYS_OVERDUE",
"policyPriority" : 12345,
"dunningPolicyRules" : [ { }, { } ],
"minBalanceTrigger" : 12345.0,
"includeDueInvoicesInThreshold" : true,
"includePayReminder" : true,
"auditableFields" : [ { }, { } ],
"notified" : true,
"historized" : true,
"active" : true
},
"transient" : true,
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastModified" : 12345,
"updater" : "...",
"updated" : 12345,
"lastUser" : "..."
},
"collectionPlanStatus" : {
"dunningSettings" : { },
"version" : 12345,
"historized" : true,
"description" : "...",
"auditable" : { },
"status" : "FAILED",
"auditableFields" : [ { }, { } ],
"colorCode" : "...",
"notified" : true,
"id" : 12345,
"transient" : true
},
"notified" : true
}, {
"version" : 12345,
"auditableFields" : [ {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "RENEWAL",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
}, {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "OTHER",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
} ],
"historized" : true,
"sequence" : 12345,
"dunningLevel" : {
"active" : true,
"chargeCurrency" : { },
"chargeValue" : 12345.0,
"referenceCode" : "...",
"historized" : true,
"code" : "...",
"transient" : true,
"codeChanged" : true,
"parentEntity" : { },
"description" : "...",
"reminder" : true,
"auditable" : { },
"dunningActions" : [ { }, { } ],
"parentEntityType" : { },
"relatedPolicies" : [ { }, { } ],
"version" : 12345,
"referenceDescription" : "...",
"notified" : true,
"daysOverdue" : 12345,
"chargeType" : "PERCENTAGE",
"endOfDunningLevel" : true,
"appendGeneratedCode" : true,
"minBalanceCurrency" : { },
"softDecline" : true,
"minBalance" : 12345.0,
"auditableFields" : [ { }, { } ],
"id" : 12345,
"descriptionOrCode" : "...",
"descriptionAndCode" : "..."
},
"id" : 12345,
"dunningPolicy" : {
"totalDunningLevels" : 12345,
"version" : 12345,
"minBalanceTriggerCurrency" : { },
"id" : 12345,
"policyDescription" : "...",
"auditable" : { },
"isActivePolicy" : true,
"isDefaultPolicy" : true,
"transient" : true,
"attachInvoicesToEmails" : true,
"policyName" : "...",
"disabled" : true,
"interestForDelaySequence" : 12345,
"dunningLevels" : [ { }, { } ],
"determineLevelBy" : "DAYS_OVERDUE",
"policyPriority" : 12345,
"dunningPolicyRules" : [ { }, { } ],
"minBalanceTrigger" : 12345.0,
"includeDueInvoicesInThreshold" : true,
"includePayReminder" : true,
"auditableFields" : [ { }, { } ],
"notified" : true,
"historized" : true,
"active" : true
},
"transient" : true,
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastModified" : 12345,
"updater" : "...",
"updated" : 12345,
"lastUser" : "..."
},
"collectionPlanStatus" : {
"dunningSettings" : { },
"version" : 12345,
"historized" : true,
"description" : "...",
"auditable" : { },
"status" : "FAILED",
"auditableFields" : [ { }, { } ],
"colorCode" : "...",
"notified" : true,
"id" : 12345,
"transient" : true
},
"notified" : true
} ],
"version" : 12345,
"referenceDescription" : "...",
"notified" : true,
"daysOverdue" : 12345,
"chargeType" : "PERCENTAGE",
"endOfDunningLevel" : true,
"appendGeneratedCode" : true,
"minBalanceCurrency" : {
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastModified" : 12345,
"updater" : "...",
"updated" : 12345,
"lastUser" : "..."
},
"transient" : true,
"auditableFields" : [ {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "OTHER",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
}, {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "RENEWAL",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
} ],
"version" : 12345,
"id" : 12345,
"notified" : true,
"description" : "...",
"systemCurrency" : true,
"symbol" : "...",
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"historized" : true,
"descriptionEn" : "...",
"currencyCode" : "..."
},
"softDecline" : true,
"minBalance" : 12345.0,
"auditableFields" : [ {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "RENEWAL",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
}, {
"fieldName" : "...",
"historable" : true,
"historized" : true,
"auditType" : "STATUS",
"notfiable" : true,
"currentState" : { },
"notified" : true,
"previousState" : { }
} ],
"id" : 12345,
"descriptionOrCode" : "...",
"descriptionAndCode" : "..."
}