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