| name | data type | constraints | description |
|---|---|---|---|
| scriptInstance | ScriptInstance | ||
| attachOverdueInvoices | boolean | ||
| attachDueInvoices | boolean | ||
| actionNotificationTemplate | EmailTemplate | ||
| assignedTo | DunningAgent | ||
| array of DunningLevel | |||
| descriptionOrCode | string | ||
| transient | boolean | ||
| parentEntityType | object | ||
| referenceDescription | string | ||
| actionChannel | ActionChannelEnum | ||
| referenceCode | string | ||
| notified | boolean | ||
| descriptionAndCode | string | ||
| parentEntity | BusinessEntity | ||
| appendGeneratedCode | boolean | ||
| auditable | Auditable | ||
| auditableFields | array of AuditableFieldHistory | ||
| description | string | max size: 255, min size: 0 | |
| historized | boolean | ||
| code | string | required, max size: 255, min size: 1 | |
| id | number | ||
| version | number | ||
| codeChanged | boolean | ||
| actionType | ActionTypeEnum | ||
| actionMode | ActionModeEnum | ||
| activeAction | boolean |
Example
{
"scriptInstance" : {
"description" : "...",
"scriptParameters" : [ {
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"defaultValue" : "...",
"mandatory" : true,
"scriptInstance" : { },
"allowedValues" : "...",
"collection" : true,
"className" : "...",
"valuesSeparator" : "...",
"code" : "...",
"id" : 12345,
"version" : 12345,
"transient" : true
}, {
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"defaultValue" : "...",
"mandatory" : true,
"scriptInstance" : { },
"allowedValues" : "...",
"collection" : true,
"className" : "...",
"valuesSeparator" : "...",
"code" : "...",
"id" : 12345,
"version" : 12345,
"transient" : true
} ],
"parentEntityType" : { },
"historized" : true,
"code" : "...",
"descriptionAndCode" : "...",
"id" : 12345,
"transient" : true,
"referenceDescription" : "...",
"sourcingRoles" : [ "...", "..." ],
"parentEntity" : {
"description" : "...",
"code" : "...",
"version" : 12345,
"parentEntity" : { },
"id" : 12345,
"transient" : true,
"historized" : true,
"descriptionOrCode" : "...",
"auditable" : { },
"referenceDescription" : "...",
"referenceCode" : "...",
"codeChanged" : true,
"parentEntityType" : { },
"notified" : true,
"appendGeneratedCode" : true,
"descriptionAndCode" : "...",
"auditableFields" : [ { }, { } ]
},
"disabled" : true,
"scriptErrors" : [ {
"message" : "...",
"sourceFile" : "...",
"lineNumber" : 12345,
"columnNumber" : 12345
}, {
"message" : "...",
"sourceFile" : "...",
"lineNumber" : 12345,
"columnNumber" : 12345
} ],
"referenceCode" : "...",
"descriptionOrCode" : "...",
"version" : 12345,
"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" : { }
} ],
"error" : true,
"codeChanged" : true,
"executionRoles" : [ "...", "..." ],
"notified" : true,
"appendGeneratedCode" : true,
"auditable" : {
"created" : 12345,
"updater" : "...",
"lastModified" : 12345,
"updated" : 12345,
"lastUser" : "...",
"creator" : "..."
},
"reuse" : true,
"script" : "...",
"sourceTypeEnum" : "JAVA_CLASS",
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"active" : true,
"scriptInstanceCategory" : {
"descriptionOrCode" : "...",
"appendGeneratedCode" : true,
"version" : 12345,
"transient" : true,
"historized" : true,
"descriptionAndCode" : "...",
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"description" : "...",
"notified" : true,
"referenceDescription" : "...",
"auditableFields" : [ { }, { } ],
"code" : "...",
"parentEntityType" : { },
"referenceCode" : "...",
"id" : 12345,
"codeChanged" : true,
"auditable" : { },
"parentEntity" : { }
}
},
"attachOverdueInvoices" : true,
"attachDueInvoices" : true,
"actionNotificationTemplate" : {
"transient" : true,
"referenceCode" : "...",
"textContent" : "...",
"translatedSubject" : {
"property1" : "...",
"property2" : "..."
},
"tagStartDelimiter" : "...",
"descriptionAndCode" : "...",
"type" : "DUNNING",
"description" : "...",
"referenceDescription" : "...",
"codeChanged" : true,
"version" : 12345,
"auditable" : {
"created" : 12345,
"updater" : "...",
"lastModified" : 12345,
"updated" : 12345,
"lastUser" : "...",
"creator" : "..."
},
"subject" : "...",
"notified" : true,
"historized" : true,
"translatedTextContent" : {
"property1" : "...",
"property2" : "..."
},
"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" : { }
} ],
"startDate" : 12345,
"descriptionOrCode" : "...",
"translatedHtmlContent" : {
"property1" : "...",
"property2" : "..."
},
"parentEntityType" : { },
"code" : "...",
"appendGeneratedCode" : true,
"parentEntity" : {
"description" : "...",
"code" : "...",
"version" : 12345,
"parentEntity" : { },
"id" : 12345,
"transient" : true,
"historized" : true,
"descriptionOrCode" : "...",
"auditable" : { },
"referenceDescription" : "...",
"referenceCode" : "...",
"codeChanged" : true,
"parentEntityType" : { },
"notified" : true,
"appendGeneratedCode" : true,
"descriptionAndCode" : "...",
"auditableFields" : [ { }, { } ]
},
"htmlContent" : "...",
"id" : 12345,
"media" : "VOICE",
"endDate" : 12345,
"tagEndDelimiter" : "..."
},
"assignedTo" : {
"version" : 12345,
"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" : { }
} ],
"historized" : true,
"notified" : true,
"agentLastNameItem" : "...",
"external" : true,
"agentFirstNameItem" : "...",
"agentEmailItem" : "...",
"dunningSettings" : {
"parentEntity" : { },
"auditableFields" : [ { }, { } ],
"allowInterestForDelay" : true,
"maxDaysOutstanding" : 12345,
"dunningPaymentRetries" : [ { }, { } ],
"parentEntityType" : { },
"id" : 12345,
"notified" : true,
"accountingArticle" : { },
"code" : "...",
"dunningMode" : "CUSTOMER_LEVEL",
"allowDunningCharges" : true,
"dunningAgents" : [ { }, { } ],
"dunningStopReasons" : [ { }, { } ],
"historized" : true,
"interestForDelayRate" : 12345.0,
"dunningCollectionPlanStatuses" : [ { }, { } ],
"referenceCode" : "...",
"referenceDescription" : "...",
"dunningPauseReasons" : [ { }, { } ],
"description" : "...",
"maxDunningLevels" : 12345,
"auditable" : { },
"applyDunningChargeFxExchangeRate" : true,
"codeChanged" : true,
"descriptionAndCode" : "...",
"appendGeneratedCode" : true,
"descriptionOrCode" : "...",
"transient" : true,
"version" : 12345
},
"collectionAgency" : "...",
"transient" : true,
"auditable" : {
"created" : 12345,
"updater" : "...",
"lastModified" : 12345,
"updated" : 12345,
"lastUser" : "...",
"creator" : "..."
},
"id" : 12345
},
"relatedLevels" : [ {
"chargeCurrency" : {
"notified" : true,
"descriptionEn" : "...",
"description" : "...",
"auditableFields" : [ { }, { } ],
"systemCurrency" : true,
"historized" : true,
"id" : 12345,
"transient" : true,
"currencyCode" : "...",
"symbol" : "...",
"auditable" : { },
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"version" : 12345
},
"relatedPolicies" : [ {
"sequence" : 12345,
"historized" : true,
"notified" : true,
"id" : 12345,
"transient" : true,
"collectionPlanStatus" : { },
"version" : 12345,
"auditable" : { },
"dunningPolicy" : { },
"auditableFields" : [ { }, { } ],
"dunningLevel" : { }
}, {
"sequence" : 12345,
"historized" : true,
"notified" : true,
"id" : 12345,
"transient" : true,
"collectionPlanStatus" : { },
"version" : 12345,
"auditable" : { },
"dunningPolicy" : { },
"auditableFields" : [ { }, { } ],
"dunningLevel" : { }
} ],
"chargeType" : "FLAT_AMOUNT",
"appendGeneratedCode" : true,
"historized" : true,
"chargeValue" : 12345.0,
"endOfDunningLevel" : true,
"parentEntityType" : { },
"auditable" : {
"created" : 12345,
"updater" : "...",
"lastModified" : 12345,
"updated" : 12345,
"lastUser" : "...",
"creator" : "..."
},
"referenceCode" : "...",
"descriptionOrCode" : "...",
"description" : "...",
"softDecline" : true,
"id" : 12345,
"parentEntity" : {
"description" : "...",
"code" : "...",
"version" : 12345,
"parentEntity" : { },
"id" : 12345,
"transient" : true,
"historized" : true,
"descriptionOrCode" : "...",
"auditable" : { },
"referenceDescription" : "...",
"referenceCode" : "...",
"codeChanged" : true,
"parentEntityType" : { },
"notified" : true,
"appendGeneratedCode" : true,
"descriptionAndCode" : "...",
"auditableFields" : [ { }, { } ]
},
"reminder" : true,
"daysOverdue" : 12345,
"active" : true,
"minBalance" : 12345.0,
"auditableFields" : [ {
"notified" : true,
"historized" : true,
"notfiable" : true,
"historable" : true,
"auditType" : "RENEWAL",
"fieldName" : "...",
"currentState" : { },
"previousState" : { }
}, {
"notified" : true,
"historized" : true,
"notfiable" : true,
"historable" : true,
"auditType" : "STATUS",
"fieldName" : "...",
"currentState" : { },
"previousState" : { }
} ],
"codeChanged" : true,
"referenceDescription" : "...",
"minBalanceCurrency" : {
"notified" : true,
"descriptionEn" : "...",
"description" : "...",
"auditableFields" : [ { }, { } ],
"systemCurrency" : true,
"historized" : true,
"id" : 12345,
"transient" : true,
"currencyCode" : "...",
"symbol" : "...",
"auditable" : { },
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"version" : 12345
},
"dunningActions" : [ {
"scriptInstance" : { },
"attachOverdueInvoices" : true,
"attachDueInvoices" : true,
"actionNotificationTemplate" : { },
"assignedTo" : { },
"relatedLevels" : [ { }, { } ],
"descriptionOrCode" : "...",
"transient" : true,
"parentEntityType" : { },
"referenceDescription" : "...",
"actionChannel" : "LETTER",
"referenceCode" : "...",
"notified" : true,
"descriptionAndCode" : "...",
"parentEntity" : { },
"appendGeneratedCode" : true,
"auditable" : { },
"auditableFields" : [ { }, { } ],
"description" : "...",
"historized" : true,
"code" : "...",
"id" : 12345,
"version" : 12345,
"codeChanged" : true,
"actionType" : "SCRIPT",
"actionMode" : "MANUAL",
"activeAction" : true
}, {
"scriptInstance" : { },
"attachOverdueInvoices" : true,
"attachDueInvoices" : true,
"actionNotificationTemplate" : { },
"assignedTo" : { },
"relatedLevels" : [ { }, { } ],
"descriptionOrCode" : "...",
"transient" : true,
"parentEntityType" : { },
"referenceDescription" : "...",
"actionChannel" : "CALL",
"referenceCode" : "...",
"notified" : true,
"descriptionAndCode" : "...",
"parentEntity" : { },
"appendGeneratedCode" : true,
"auditable" : { },
"auditableFields" : [ { }, { } ],
"description" : "...",
"historized" : true,
"code" : "...",
"id" : 12345,
"version" : 12345,
"codeChanged" : true,
"actionType" : "RETRY_PAYMENT",
"actionMode" : "AUTOMATIC",
"activeAction" : true
} ],
"notified" : true,
"descriptionAndCode" : "...",
"code" : "...",
"transient" : true,
"version" : 12345
}, {
"chargeCurrency" : {
"notified" : true,
"descriptionEn" : "...",
"description" : "...",
"auditableFields" : [ { }, { } ],
"systemCurrency" : true,
"historized" : true,
"id" : 12345,
"transient" : true,
"currencyCode" : "...",
"symbol" : "...",
"auditable" : { },
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"version" : 12345
},
"relatedPolicies" : [ {
"sequence" : 12345,
"historized" : true,
"notified" : true,
"id" : 12345,
"transient" : true,
"collectionPlanStatus" : { },
"version" : 12345,
"auditable" : { },
"dunningPolicy" : { },
"auditableFields" : [ { }, { } ],
"dunningLevel" : { }
}, {
"sequence" : 12345,
"historized" : true,
"notified" : true,
"id" : 12345,
"transient" : true,
"collectionPlanStatus" : { },
"version" : 12345,
"auditable" : { },
"dunningPolicy" : { },
"auditableFields" : [ { }, { } ],
"dunningLevel" : { }
} ],
"chargeType" : "FLAT_AMOUNT",
"appendGeneratedCode" : true,
"historized" : true,
"chargeValue" : 12345.0,
"endOfDunningLevel" : true,
"parentEntityType" : { },
"auditable" : {
"created" : 12345,
"updater" : "...",
"lastModified" : 12345,
"updated" : 12345,
"lastUser" : "...",
"creator" : "..."
},
"referenceCode" : "...",
"descriptionOrCode" : "...",
"description" : "...",
"softDecline" : true,
"id" : 12345,
"parentEntity" : {
"description" : "...",
"code" : "...",
"version" : 12345,
"parentEntity" : { },
"id" : 12345,
"transient" : true,
"historized" : true,
"descriptionOrCode" : "...",
"auditable" : { },
"referenceDescription" : "...",
"referenceCode" : "...",
"codeChanged" : true,
"parentEntityType" : { },
"notified" : true,
"appendGeneratedCode" : true,
"descriptionAndCode" : "...",
"auditableFields" : [ { }, { } ]
},
"reminder" : true,
"daysOverdue" : 12345,
"active" : true,
"minBalance" : 12345.0,
"auditableFields" : [ {
"notified" : true,
"historized" : true,
"notfiable" : true,
"historable" : true,
"auditType" : "RENEWAL",
"fieldName" : "...",
"currentState" : { },
"previousState" : { }
}, {
"notified" : true,
"historized" : true,
"notfiable" : true,
"historable" : true,
"auditType" : "RENEWAL",
"fieldName" : "...",
"currentState" : { },
"previousState" : { }
} ],
"codeChanged" : true,
"referenceDescription" : "...",
"minBalanceCurrency" : {
"notified" : true,
"descriptionEn" : "...",
"description" : "...",
"auditableFields" : [ { }, { } ],
"systemCurrency" : true,
"historized" : true,
"id" : 12345,
"transient" : true,
"currencyCode" : "...",
"symbol" : "...",
"auditable" : { },
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"version" : 12345
},
"dunningActions" : [ {
"scriptInstance" : { },
"attachOverdueInvoices" : true,
"attachDueInvoices" : true,
"actionNotificationTemplate" : { },
"assignedTo" : { },
"relatedLevels" : [ { }, { } ],
"descriptionOrCode" : "...",
"transient" : true,
"parentEntityType" : { },
"referenceDescription" : "...",
"actionChannel" : "CALL",
"referenceCode" : "...",
"notified" : true,
"descriptionAndCode" : "...",
"parentEntity" : { },
"appendGeneratedCode" : true,
"auditable" : { },
"auditableFields" : [ { }, { } ],
"description" : "...",
"historized" : true,
"code" : "...",
"id" : 12345,
"version" : 12345,
"codeChanged" : true,
"actionType" : "RETRY_PAYMENT",
"actionMode" : "AUTOMATIC",
"activeAction" : true
}, {
"scriptInstance" : { },
"attachOverdueInvoices" : true,
"attachDueInvoices" : true,
"actionNotificationTemplate" : { },
"assignedTo" : { },
"relatedLevels" : [ { }, { } ],
"descriptionOrCode" : "...",
"transient" : true,
"parentEntityType" : { },
"referenceDescription" : "...",
"actionChannel" : "LETTER",
"referenceCode" : "...",
"notified" : true,
"descriptionAndCode" : "...",
"parentEntity" : { },
"appendGeneratedCode" : true,
"auditable" : { },
"auditableFields" : [ { }, { } ],
"description" : "...",
"historized" : true,
"code" : "...",
"id" : 12345,
"version" : 12345,
"codeChanged" : true,
"actionType" : "ISSUE_A_CREDIT_NOTE",
"actionMode" : "AUTOMATIC",
"activeAction" : true
} ],
"notified" : true,
"descriptionAndCode" : "...",
"code" : "...",
"transient" : true,
"version" : 12345
} ],
"descriptionOrCode" : "...",
"transient" : true,
"parentEntityType" : { },
"referenceDescription" : "...",
"actionChannel" : "LETTER",
"referenceCode" : "...",
"notified" : true,
"descriptionAndCode" : "...",
"parentEntity" : {
"description" : "...",
"code" : "...",
"version" : 12345,
"parentEntity" : { },
"id" : 12345,
"transient" : true,
"historized" : true,
"descriptionOrCode" : "...",
"auditable" : {
"created" : 12345,
"updater" : "...",
"lastModified" : 12345,
"updated" : 12345,
"lastUser" : "...",
"creator" : "..."
},
"referenceDescription" : "...",
"referenceCode" : "...",
"codeChanged" : true,
"parentEntityType" : { },
"notified" : true,
"appendGeneratedCode" : true,
"descriptionAndCode" : "...",
"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" : { }
} ]
},
"appendGeneratedCode" : true,
"auditable" : {
"created" : 12345,
"updater" : "...",
"lastModified" : 12345,
"updated" : 12345,
"lastUser" : "...",
"creator" : "..."
},
"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" : { }
} ],
"description" : "...",
"historized" : true,
"code" : "...",
"id" : 12345,
"version" : 12345,
"codeChanged" : true,
"actionType" : "ISSUE_A_CREDIT_NOTE",
"actionMode" : "MANUAL",
"activeAction" : true
}