Embeddable set of renewal fields. Use in ServiceTemplate and Subscription.
| name | data type | constraints | description |
|---|---|---|---|
| version | number | ||
| calendarInitialyActiveFor | Calendar | ||
| auditable | Auditable | ||
| parentEntityType | object | ||
| referenceDescription | string | ||
| renewForUnit | RenewalPeriodUnitEnum | ||
| initialTermType | InitialTermTypeEnum | ||
| id | number | ||
| applyTerminationCharges | boolean | ||
| notified | boolean | ||
| historized | boolean | ||
| parentEntity | BusinessEntity | ||
| transient | boolean | ||
| endOfTermAction | EndOfTermActionEnum | ||
| initialyActiveForUnit | RenewalPeriodUnitEnum | ||
| extendAgreementPeriodToSubscribedTillDate | boolean | ||
| auditableFields | array of AuditableFieldHistory | ||
| applyAgreement | boolean | ||
| referenceCode | string | ||
| codeChanged | boolean | ||
| descriptionAndCode | string | ||
| invoiceAgreementImmediately | boolean | ||
| applyReimbursment | boolean | ||
| overrideProrata | OverrideProrataEnum | Gets the Override Prorata value. | |
| reimburseOneshots | boolean | ||
| autoRenew | boolean | ||
| daysNotifyRenewal | number | ||
| initialyActiveFor | number | ||
| autoRenewDate | number | AutoRenewDate getter | |
| calendarRenewFor | Calendar | ||
| renewalTermType | RenewalTermTypeEnum | ||
| appendGeneratedCode | boolean | ||
| code | string | required, max size: 255, min size: 1 | |
| descriptionI18n | map of string | ||
| description | string | max size: 255, min size: 0 | |
| renewFor | number | ||
| descriptionOrCode | string |
Example
{
"version" : 12345,
"calendarInitialyActiveFor" : {
"referenceDescription" : "...",
"parentEntityType" : { },
"codeChanged" : true,
"auditable" : {
"lastModified" : 12345,
"updated" : 12345,
"updater" : "...",
"created" : 12345,
"creator" : "...",
"lastUser" : "..."
},
"appendGeneratedCode" : true,
"historized" : true,
"version" : 12345,
"descriptionAndCode" : "...",
"parentEntity" : {
"descriptionOrCode" : "...",
"auditableFields" : [ { }, { } ],
"version" : 12345,
"historized" : true,
"appendGeneratedCode" : true,
"auditable" : { },
"parentEntity" : { },
"parentEntityType" : { },
"description" : "...",
"referenceDescription" : "...",
"codeChanged" : true,
"referenceCode" : "...",
"code" : "...",
"transient" : true,
"descriptionAndCode" : "...",
"id" : 12345,
"notified" : true
},
"initializationRequired" : true,
"code" : "...",
"id" : 12345,
"description" : "...",
"referenceCode" : "...",
"transient" : true,
"notified" : true,
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"initDate" : 12345,
"initDateEL" : "...",
"calendarTypeWSubtypes" : "...",
"descriptionOrCode" : "...",
"calendarType" : "...",
"auditableFields" : [ {
"historized" : true,
"notified" : true,
"auditType" : "OTHER",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
}, {
"historized" : true,
"notified" : true,
"auditType" : "STATUS",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
} ]
},
"auditable" : {
"lastModified" : 12345,
"updated" : 12345,
"updater" : "...",
"created" : 12345,
"creator" : "...",
"lastUser" : "..."
},
"parentEntityType" : { },
"referenceDescription" : "...",
"renewForUnit" : "DAY",
"initialTermType" : "CALENDAR",
"id" : 12345,
"applyTerminationCharges" : true,
"notified" : true,
"historized" : true,
"parentEntity" : {
"descriptionOrCode" : "...",
"auditableFields" : [ {
"historized" : true,
"notified" : true,
"auditType" : "RENEWAL",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
}, {
"historized" : true,
"notified" : true,
"auditType" : "RENEWAL",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
} ],
"version" : 12345,
"historized" : true,
"appendGeneratedCode" : true,
"auditable" : {
"lastModified" : 12345,
"updated" : 12345,
"updater" : "...",
"created" : 12345,
"creator" : "...",
"lastUser" : "..."
},
"parentEntity" : { },
"parentEntityType" : { },
"description" : "...",
"referenceDescription" : "...",
"codeChanged" : true,
"referenceCode" : "...",
"code" : "...",
"transient" : true,
"descriptionAndCode" : "...",
"id" : 12345,
"notified" : true
},
"transient" : true,
"endOfTermAction" : "TERMINATE",
"initialyActiveForUnit" : "MONTH",
"extendAgreementPeriodToSubscribedTillDate" : true,
"auditableFields" : [ {
"historized" : true,
"notified" : true,
"auditType" : "RENEWAL",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
}, {
"historized" : true,
"notified" : true,
"auditType" : "OTHER",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
} ],
"applyAgreement" : true,
"referenceCode" : "...",
"codeChanged" : true,
"descriptionAndCode" : "...",
"invoiceAgreementImmediately" : true,
"applyReimbursment" : true,
"overrideProrata" : "NO_OVERRIDE",
"reimburseOneshots" : true,
"autoRenew" : true,
"daysNotifyRenewal" : 12345,
"initialyActiveFor" : 12345,
"autoRenewDate" : 12345,
"calendarRenewFor" : {
"referenceDescription" : "...",
"parentEntityType" : { },
"codeChanged" : true,
"auditable" : {
"lastModified" : 12345,
"updated" : 12345,
"updater" : "...",
"created" : 12345,
"creator" : "...",
"lastUser" : "..."
},
"appendGeneratedCode" : true,
"historized" : true,
"version" : 12345,
"descriptionAndCode" : "...",
"parentEntity" : {
"descriptionOrCode" : "...",
"auditableFields" : [ { }, { } ],
"version" : 12345,
"historized" : true,
"appendGeneratedCode" : true,
"auditable" : { },
"parentEntity" : { },
"parentEntityType" : { },
"description" : "...",
"referenceDescription" : "...",
"codeChanged" : true,
"referenceCode" : "...",
"code" : "...",
"transient" : true,
"descriptionAndCode" : "...",
"id" : 12345,
"notified" : true
},
"initializationRequired" : true,
"code" : "...",
"id" : 12345,
"description" : "...",
"referenceCode" : "...",
"transient" : true,
"notified" : true,
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"initDate" : 12345,
"initDateEL" : "...",
"calendarTypeWSubtypes" : "...",
"descriptionOrCode" : "...",
"calendarType" : "...",
"auditableFields" : [ {
"historized" : true,
"notified" : true,
"auditType" : "OTHER",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
}, {
"historized" : true,
"notified" : true,
"auditType" : "RENEWAL",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
} ]
},
"renewalTermType" : "CALENDAR",
"appendGeneratedCode" : true,
"code" : "...",
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"description" : "...",
"renewFor" : 12345,
"descriptionOrCode" : "..."
}