| name | data type | constraints | description |
|---|---|---|---|
| moduleSource | string | ||
| disabled | boolean | ||
| codeChanged | boolean | ||
| code | string | required, max size: 255, min size: 1 | |
| historized | boolean | ||
| parentEntity | BusinessEntity | ||
| installed | boolean | ||
| auditable | Auditable | ||
| serviceTemplate | ServiceTemplate | ||
| auditableFields | array of AuditableFieldHistory | ||
| parentEntityType | object | ||
| active | boolean | ||
| version | number | ||
| descriptionI18n | map of string | ||
| notified | boolean | ||
| logoPicture | string | ||
| moduleItems | array of MeveoModuleItem | ||
| transient | boolean | ||
| appendGeneratedCode | boolean | ||
| description | string | max size: 255, min size: 0 | |
| referenceDescription | string | ||
| id | number | ||
| descriptionOrCode | string | ||
| script | ScriptInstance | ||
| descriptionAndCode | string | ||
| duplicatePricePlan | boolean | ||
| referenceCode | string | ||
| duplicateService | boolean | ||
| downloaded | boolean | ||
| license | ModuleLicenseEnum |
Example
{
"moduleSource" : "...",
"disabled" : true,
"codeChanged" : true,
"code" : "...",
"historized" : true,
"parentEntity" : {
"descriptionOrCode" : "...",
"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" : { }
} ],
"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
},
"installed" : true,
"auditable" : {
"lastModified" : 12345,
"updated" : 12345,
"updater" : "...",
"created" : 12345,
"creator" : "...",
"lastUser" : "..."
},
"serviceTemplate" : {
"descriptionOverride" : "...",
"referenceCode" : "...",
"parentEntityType" : { },
"minimumLabelEl" : "...",
"minimumChargeTemplate" : {
"taxClassEl" : "...",
"revenueRecognitionRule" : { },
"parentEntity" : { },
"inputUnitEL" : "...",
"version" : 12345,
"active" : true,
"referenceCode" : "...",
"historized" : true,
"invoiceSubCategory" : { },
"appendGeneratedCode" : true,
"descriptionI18nNullSafe" : {
"property1" : "...",
"property2" : "..."
},
"oneShotChargeTemplateType" : "SUBSCRIPTION",
"transient" : true,
"uuid" : "...",
"roundingMode" : "DOWN",
"status" : "ACTIVE",
"chargeType" : "...",
"cfAccumulatedValues" : { },
"disabled" : true,
"id" : 12345,
"auditable" : { },
"taxClass" : { },
"parentCFEntities" : [ { }, { } ],
"filterExpression" : "...",
"attributes" : [ { }, { } ],
"auditableFields" : [ { }, { } ],
"ratingUnitOfMeasure" : { },
"productCharges" : [ { }, { } ],
"ratingUnitDescription" : "...",
"notified" : true,
"parentEntityType" : { },
"unitNbDecimal" : 12345,
"cfValues" : { },
"unitMultiplicator" : 12345.0,
"immediateInvoicing" : true,
"descriptionAndCode" : "...",
"edrTemplates" : [ { }, { } ],
"inputUnitOfMeasure" : { },
"dropZeroWo" : true,
"description" : "...",
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"inputUnitDescription" : "...",
"type" : "CREDIT",
"sortIndexEl" : "...",
"descriptionOrCode" : "...",
"chargeMainType" : "RECURRING",
"referenceDescription" : "...",
"code" : "...",
"roundingValuesComputed" : true,
"codeChanged" : true,
"outputUnitEL" : "...",
"ratingScript" : { },
"amountEditable" : true
},
"minimumAmountEl" : "...",
"tags" : [ {
"codeChanged" : true,
"auditableFields" : [ { }, { } ],
"descriptionAndCode" : "...",
"parentTag" : { },
"seller" : { },
"description" : "...",
"parentEntityType" : { },
"id" : 12345,
"auditable" : { },
"descriptionOrCode" : "...",
"notified" : true,
"code" : "...",
"historized" : true,
"transient" : true,
"tagType" : { },
"referenceCode" : "...",
"version" : 12345,
"appendGeneratedCode" : true,
"parentEntity" : { },
"filterEl" : "...",
"referenceDescription" : "...",
"name" : "..."
}, {
"codeChanged" : true,
"auditableFields" : [ { }, { } ],
"descriptionAndCode" : "...",
"parentTag" : { },
"seller" : { },
"description" : "...",
"parentEntityType" : { },
"id" : 12345,
"auditable" : { },
"descriptionOrCode" : "...",
"notified" : true,
"code" : "...",
"historized" : true,
"transient" : true,
"tagType" : { },
"referenceCode" : "...",
"version" : 12345,
"appendGeneratedCode" : true,
"parentEntity" : { },
"filterEl" : "...",
"referenceDescription" : "...",
"name" : "..."
} ],
"attributes" : [ {
"productVersionAttributes" : [ { }, { } ],
"auditableFields" : [ { }, { } ],
"parentEntityType" : { },
"attributeCategory" : "BUSINESS",
"attributeType" : "INTEGER",
"unitNbDecimal" : 12345,
"disabled" : true,
"parentAttribute" : { },
"descriptionAndCode" : "...",
"chargeTemplates" : [ { }, { } ],
"priority" : 12345,
"appendGeneratedCode" : true,
"assignedAttributes" : [ { }, { } ],
"active" : true,
"allowedValues" : [ "...", "..." ],
"parentEntity" : { },
"transient" : true,
"version" : 12345,
"offerTemplateAttribute" : [ { }, { } ],
"commercialRules" : [ { }, { } ],
"descriptionOrCode" : "...",
"uuid" : "...",
"code" : "...",
"tags" : [ { }, { } ],
"groupedAttributes" : [ { }, { } ],
"auditable" : { },
"cfAccumulatedValues" : { },
"description" : "...",
"historized" : true,
"elValue" : "...",
"medias" : [ { }, { } ],
"codeChanged" : true,
"referenceDescription" : "...",
"cfValues" : { },
"id" : 12345,
"parentCFEntities" : [ { }, { } ],
"notified" : true,
"referenceCode" : "..."
}, {
"productVersionAttributes" : [ { }, { } ],
"auditableFields" : [ { }, { } ],
"parentEntityType" : { },
"attributeCategory" : "REGULAR",
"attributeType" : "PHONE",
"unitNbDecimal" : 12345,
"disabled" : true,
"parentAttribute" : { },
"descriptionAndCode" : "...",
"chargeTemplates" : [ { }, { } ],
"priority" : 12345,
"appendGeneratedCode" : true,
"assignedAttributes" : [ { }, { } ],
"active" : true,
"allowedValues" : [ "...", "..." ],
"parentEntity" : { },
"transient" : true,
"version" : 12345,
"offerTemplateAttribute" : [ { }, { } ],
"commercialRules" : [ { }, { } ],
"descriptionOrCode" : "...",
"uuid" : "...",
"code" : "...",
"tags" : [ { }, { } ],
"groupedAttributes" : [ { }, { } ],
"auditable" : { },
"cfAccumulatedValues" : { },
"description" : "...",
"historized" : true,
"elValue" : "...",
"medias" : [ { }, { } ],
"codeChanged" : true,
"referenceDescription" : "...",
"cfValues" : { },
"id" : 12345,
"parentCFEntities" : [ { }, { } ],
"notified" : true,
"referenceCode" : "..."
} ],
"cfAccumulatedValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"referenceDescription" : "...",
"minimumInvoiceSubCategory" : {
"referenceCode" : "...",
"cfValues" : { },
"description" : "...",
"parentEntityType" : { },
"descriptionI18nNullSafe" : {
"property1" : "...",
"property2" : "..."
},
"appendGeneratedCode" : true,
"descriptionAndCode" : "...",
"accountingCode" : { },
"code" : "...",
"uuid" : "...",
"occTemplateNegative" : { },
"auditable" : { },
"historized" : true,
"version" : 12345,
"parentCFEntities" : [ { }, { } ],
"sortIndex" : 12345,
"referenceDescription" : "...",
"invoiceCategory" : { },
"discount" : 12345.0,
"id" : 12345,
"auditableFields" : [ { }, { } ],
"notified" : true,
"parentEntity" : { },
"occTemplate" : { },
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"cfAccumulatedValues" : { },
"transient" : true,
"codeChanged" : true,
"descriptionOrCode" : "..."
},
"imagePath" : "...",
"active" : true,
"uuid" : "...",
"businessServiceModel" : {
"moduleSource" : "...",
"disabled" : true,
"codeChanged" : true,
"code" : "...",
"historized" : true,
"parentEntity" : { },
"installed" : true,
"auditable" : { },
"serviceTemplate" : { },
"auditableFields" : [ { }, { } ],
"parentEntityType" : { },
"active" : true,
"version" : 12345,
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"notified" : true,
"logoPicture" : "...",
"moduleItems" : [ { }, { } ],
"transient" : true,
"appendGeneratedCode" : true,
"description" : "...",
"referenceDescription" : "...",
"id" : 12345,
"descriptionOrCode" : "...",
"script" : { },
"descriptionAndCode" : "...",
"duplicatePricePlan" : true,
"referenceCode" : "...",
"duplicateService" : true,
"downloaded" : true,
"license" : "OPEN"
},
"parentCFEntities" : [ {
"parentCFEntities" : [ { }, { } ],
"dirtyCF" : true,
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfAccumulatedValues" : { },
"cfValuesNullSafe" : { },
"cfAccumulatedValuesNullSafe" : { },
"cfValues" : { },
"CFValuesCopy" : { },
"uuid" : "..."
}, {
"parentCFEntities" : [ { }, { } ],
"dirtyCF" : true,
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfAccumulatedValues" : { },
"cfValuesNullSafe" : { },
"cfAccumulatedValuesNullSafe" : { },
"cfValues" : { },
"CFValuesCopy" : { },
"uuid" : "..."
} ],
"notified" : true,
"description" : "...",
"auditableFields" : [ {
"historized" : true,
"notified" : true,
"auditType" : "STATUS",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
}, {
"historized" : true,
"notified" : true,
"auditType" : "OTHER",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
} ],
"serviceSubscriptionCharges" : [ {
"counterTemplate" : { },
"walletTemplates" : [ { }, { } ],
"version" : 12345,
"accumulatorCounterTemplates" : [ { }, { } ],
"id" : 12345,
"chargeTemplate" : { },
"transient" : true,
"serviceTemplate" : { }
}, {
"counterTemplate" : { },
"walletTemplates" : [ { }, { } ],
"version" : 12345,
"accumulatorCounterTemplates" : [ { }, { } ],
"id" : 12345,
"chargeTemplate" : { },
"transient" : true,
"serviceTemplate" : { }
} ],
"id" : 12345,
"serviceUsageCharges" : [ {
"chargeTemplate" : { },
"accumulatorCounterTemplates" : [ { }, { } ],
"counterTemplate" : { },
"id" : 12345,
"serviceTemplate" : { },
"version" : 12345,
"transient" : true,
"walletTemplates" : [ { }, { } ]
}, {
"chargeTemplate" : { },
"accumulatorCounterTemplates" : [ { }, { } ],
"counterTemplate" : { },
"id" : 12345,
"serviceTemplate" : { },
"version" : 12345,
"transient" : true,
"walletTemplates" : [ { }, { } ]
} ],
"version" : 12345,
"cfValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"appendGeneratedCode" : true,
"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
},
"transient" : true,
"code" : "...",
"descriptionAndCode" : "...",
"historized" : true,
"serviceTerminationCharges" : [ {
"counterTemplate" : { },
"serviceTemplate" : { },
"accumulatorCounterTemplates" : [ { }, { } ],
"id" : 12345,
"walletTemplates" : [ { }, { } ],
"transient" : true,
"chargeTemplate" : { },
"version" : 12345
}, {
"counterTemplate" : { },
"serviceTemplate" : { },
"accumulatorCounterTemplates" : [ { }, { } ],
"id" : 12345,
"walletTemplates" : [ { }, { } ],
"transient" : true,
"chargeTemplate" : { },
"version" : 12345
} ],
"invoicingCalendar" : {
"referenceDescription" : "...",
"parentEntityType" : { },
"codeChanged" : true,
"auditable" : { },
"appendGeneratedCode" : true,
"historized" : true,
"version" : 12345,
"descriptionAndCode" : "...",
"parentEntity" : { },
"initializationRequired" : true,
"code" : "...",
"id" : 12345,
"description" : "...",
"referenceCode" : "...",
"transient" : true,
"notified" : true,
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"initDate" : 12345,
"initDateEL" : "...",
"calendarTypeWSubtypes" : "...",
"descriptionOrCode" : "...",
"calendarType" : "...",
"auditableFields" : [ { }, { } ]
},
"autoEndOfEngagement" : true,
"disabled" : true,
"selected" : true,
"serviceRecurringCharges" : [ {
"transient" : true,
"walletTemplates" : [ { }, { } ],
"serviceTemplate" : { },
"counterTemplate" : { },
"version" : 12345,
"id" : 12345,
"accumulatorCounterTemplates" : [ { }, { } ],
"chargeTemplate" : { }
}, {
"transient" : true,
"walletTemplates" : [ { }, { } ],
"serviceTemplate" : { },
"counterTemplate" : { },
"version" : 12345,
"id" : 12345,
"accumulatorCounterTemplates" : [ { }, { } ],
"chargeTemplate" : { }
} ],
"instantiatedFromBSM" : true,
"serviceRenewal" : {
"version" : 12345,
"calendarInitialyActiveFor" : { },
"auditable" : { },
"parentEntityType" : { },
"referenceDescription" : "...",
"renewForUnit" : "MONTH",
"initialTermType" : "RECURRING",
"id" : 12345,
"applyTerminationCharges" : true,
"notified" : true,
"historized" : true,
"parentEntity" : { },
"transient" : true,
"endOfTermAction" : "SUSPEND",
"initialyActiveForUnit" : "DAY",
"extendAgreementPeriodToSubscribedTillDate" : true,
"auditableFields" : [ { }, { } ],
"applyAgreement" : true,
"referenceCode" : "...",
"codeChanged" : true,
"descriptionAndCode" : "...",
"invoiceAgreementImmediately" : true,
"applyReimbursment" : true,
"overrideProrata" : "NO_PRORATA",
"reimburseOneshots" : true,
"autoRenew" : true,
"daysNotifyRenewal" : 12345,
"initialyActiveFor" : 12345,
"autoRenewDate" : 12345,
"calendarRenewFor" : { },
"renewalTermType" : "RECURRING",
"appendGeneratedCode" : true,
"code" : "...",
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"description" : "...",
"renewFor" : 12345,
"descriptionOrCode" : "..."
},
"auditable" : {
"lastModified" : 12345,
"updated" : 12345,
"updater" : "...",
"created" : 12345,
"creator" : "...",
"lastUser" : "..."
},
"codeChanged" : true,
"longDescription" : "...",
"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" : { }
} ],
"parentEntityType" : { },
"active" : true,
"version" : 12345,
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"notified" : true,
"logoPicture" : "...",
"moduleItems" : [ {
"itemEntity" : {
"descriptionOrCode" : "...",
"auditableFields" : [ { }, { } ],
"version" : 12345,
"historized" : true,
"appendGeneratedCode" : true,
"auditable" : { },
"parentEntity" : { },
"parentEntityType" : { },
"description" : "...",
"referenceDescription" : "...",
"codeChanged" : true,
"referenceCode" : "...",
"code" : "...",
"transient" : true,
"descriptionAndCode" : "...",
"id" : 12345,
"notified" : true
},
"id" : 12345,
"validity" : {
"from" : 12345,
"to" : 12345,
"valid" : true,
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345
},
"version" : 12345,
"itemClassSimpleName" : "...",
"meveoModule" : {
"transient" : true,
"appendGeneratedCode" : true,
"referenceCode" : "...",
"descriptionAndCode" : "...",
"active" : true,
"script" : { },
"parentEntityType" : { },
"license" : "GPL",
"notified" : true,
"disabled" : true,
"historized" : true,
"codeChanged" : true,
"logoPicture" : "...",
"auditable" : { },
"descriptionOrCode" : "...",
"code" : "...",
"description" : "...",
"referenceDescription" : "...",
"downloaded" : true,
"id" : 12345,
"installed" : true,
"version" : 12345,
"auditableFields" : [ { }, { } ],
"moduleItems" : [ { }, { } ],
"moduleSource" : "...",
"parentEntity" : { }
},
"itemCode" : "...",
"itemClass" : "...",
"appliesTo" : "...",
"transient" : true
}, {
"itemEntity" : {
"descriptionOrCode" : "...",
"auditableFields" : [ { }, { } ],
"version" : 12345,
"historized" : true,
"appendGeneratedCode" : true,
"auditable" : { },
"parentEntity" : { },
"parentEntityType" : { },
"description" : "...",
"referenceDescription" : "...",
"codeChanged" : true,
"referenceCode" : "...",
"code" : "...",
"transient" : true,
"descriptionAndCode" : "...",
"id" : 12345,
"notified" : true
},
"id" : 12345,
"validity" : {
"from" : 12345,
"to" : 12345,
"valid" : true,
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345
},
"version" : 12345,
"itemClassSimpleName" : "...",
"meveoModule" : {
"transient" : true,
"appendGeneratedCode" : true,
"referenceCode" : "...",
"descriptionAndCode" : "...",
"active" : true,
"script" : { },
"parentEntityType" : { },
"license" : "CDDL",
"notified" : true,
"disabled" : true,
"historized" : true,
"codeChanged" : true,
"logoPicture" : "...",
"auditable" : { },
"descriptionOrCode" : "...",
"code" : "...",
"description" : "...",
"referenceDescription" : "...",
"downloaded" : true,
"id" : 12345,
"installed" : true,
"version" : 12345,
"auditableFields" : [ { }, { } ],
"moduleItems" : [ { }, { } ],
"moduleSource" : "...",
"parentEntity" : { }
},
"itemCode" : "...",
"itemClass" : "...",
"appliesTo" : "...",
"transient" : true
} ],
"transient" : true,
"appendGeneratedCode" : true,
"description" : "...",
"referenceDescription" : "...",
"id" : 12345,
"descriptionOrCode" : "...",
"script" : {
"id" : 12345,
"appendGeneratedCode" : true,
"parentEntityType" : { },
"referenceCode" : "...",
"sourcingRoles" : [ "...", "..." ],
"active" : true,
"descriptionAndCode" : "...",
"script" : "...",
"description" : "...",
"codeChanged" : true,
"referenceDescription" : "...",
"code" : "...",
"error" : true,
"sourceTypeEnum" : "JAVA_CLASS",
"version" : 12345,
"descriptionOrCode" : "...",
"reuse" : true,
"executionRoles" : [ "...", "..." ],
"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
},
"scriptInstanceCategory" : {
"version" : 12345,
"transient" : true,
"referenceDescription" : "...",
"descriptionOrCode" : "...",
"historized" : true,
"appendGeneratedCode" : true,
"parentEntity" : { },
"parentEntityType" : { },
"code" : "...",
"referenceCode" : "...",
"description" : "...",
"auditableFields" : [ { }, { } ],
"notified" : true,
"id" : 12345,
"auditable" : { },
"descriptionAndCode" : "...",
"codeChanged" : true
},
"scriptErrors" : [ {
"columnNumber" : 12345,
"message" : "...",
"sourceFile" : "...",
"lineNumber" : 12345
}, {
"columnNumber" : 12345,
"message" : "...",
"sourceFile" : "...",
"lineNumber" : 12345
} ],
"notified" : true,
"disabled" : true,
"transient" : true,
"auditableFields" : [ {
"historized" : true,
"notified" : true,
"auditType" : "STATUS",
"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" : "..."
},
"historized" : true
},
"descriptionAndCode" : "...",
"duplicatePricePlan" : true,
"referenceCode" : "...",
"duplicateService" : true,
"downloaded" : true,
"license" : "CDDL"
}