The Class ServiceTemplateDto.
| name | data type | constraints | description |
|---|---|---|---|
| disabled | boolean | Is entity disabled. Value is ignored in Update action - use enable/disable API instead. | |
| id | number | The id. | |
| auditableField | array of AuditableFieldDto | ||
| code | string | required | The code |
| description | string | The description | |
| updatedCode | string | The updated code. | |
| longDescription | string | The long description. | |
| invoicingCalendar | string | The invoicing calendar. | |
| serviceChargeTemplateRecurrings | ServiceChargeTemplateRecurringsDto | The service charge template recurrings. | |
| serviceChargeTemplateSubscriptions | ServiceChargeTemplateSubscriptionsDto | The service charge template subscriptions. | |
| serviceChargeTemplateTerminations | ServiceChargeTemplateTerminationsDto | The service charge template terminations. | |
| serviceChargeTemplateUsages | ServiceChargeTemplateUsagesDto | The service charge template usages. | |
| customFields | CustomFieldsDto | The custom fields. | |
| |
|
|
|
| somCode | string | BusinessServiceModel code. | |
| imagePath | string | The image path. | |
| imageBase64 | string | The image base 64. | |
| minimumAmountEl | string | Expression to determine minimum amount value | |
| minimumLabelEl | string | Expression to determine rated transaction description to reach minimum amount value | |
| minimumInvoiceSubCategory | string | Corresponding to minimum invoice subcategory | |
| autoEndOfEngagement | boolean | ||
| minimumChargeTemplate | string | Corresponding to minimum one shot charge template code. | |
| renewalRule | SubscriptionRenewalDto | The renewal rule. | |
| languageDescriptions | array of LanguageDescriptionDto | The language descriptions. | |
| groupedServiceCode | string | Corresponding to minimum one shot charge template code. | |
| values | array of object | Corresponding to predefined allowed values | |
| valueValidator | string | Corresponding to the value validator (regex expression) | |
| serviceTypeCode | string | The service type code | |
| display | boolean | The display . | |
| param | string | this field will contain the additional information entered in the "CPQ configurator" and linked to the type of service | |
| medias | array of MediaDto | The medias |
Example
{
"disabled" : true,
"id" : 12345,
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"code" : "...",
"description" : "...",
"updatedCode" : "...",
"longDescription" : "...",
"invoicingCalendar" : "...",
"serviceChargeTemplateRecurrings" : {
"serviceChargeTemplateRecurring" : [ {
"code" : "...",
"wallets" : { },
"accumulatorCounterTemplates" : { }
}, {
"code" : "...",
"wallets" : { },
"accumulatorCounterTemplates" : { }
} ]
},
"serviceChargeTemplateSubscriptions" : {
"serviceChargeTemplateSubscription" : [ {
"code" : "...",
"wallets" : { },
"accumulatorCounterTemplates" : { }
}, {
"code" : "...",
"wallets" : { },
"accumulatorCounterTemplates" : { }
} ]
},
"serviceChargeTemplateTerminations" : {
"serviceChargeTemplateTermination" : [ {
"code" : "...",
"wallets" : { },
"accumulatorCounterTemplates" : { }
}, {
"code" : "...",
"wallets" : { },
"accumulatorCounterTemplates" : { }
} ]
},
"serviceChargeTemplateUsages" : {
"serviceChargeTemplateUsage" : [ {
"code" : "...",
"wallets" : { },
"accumulatorCounterTemplates" : { }
}, {
"code" : "...",
"wallets" : { },
"accumulatorCounterTemplates" : { }
} ]
},
"customFields" : {
"customField" : [ {
"code" : "...",
"description" : "...",
"fieldType" : "DATE",
"languageDescriptions" : [ { }, { } ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValue" : { },
"indexType" : "INDEX_NOT_ANALYZE",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
}, {
"code" : "...",
"description" : "...",
"fieldType" : "CHILD_ENTITY",
"languageDescriptions" : [ { }, { } ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValue" : { },
"indexType" : "INDEX",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
} ],
"inheritedCustomField" : [ {
"code" : "...",
"description" : "...",
"fieldType" : "LONG",
"languageDescriptions" : [ { }, { } ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValue" : { },
"indexType" : "STORE_ONLY",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
}, {
"code" : "...",
"description" : "...",
"fieldType" : "TEXT_AREA",
"languageDescriptions" : [ { }, { } ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValue" : { },
"indexType" : "INDEX_NOT_ANALYZE",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
} ]
},
"somCode" : "...",
"imagePath" : "...",
"imageBase64" : "...",
"minimumAmountEl" : "...",
"minimumLabelEl" : "...",
"minimumInvoiceSubCategory" : "...",
"autoEndOfEngagement" : true,
"minimumChargeTemplate" : "...",
"renewalRule" : {
"initialTermType" : "FIXED",
"renewalTermType" : "RECURRING",
"initialyActiveFor" : 12345,
"initialyActiveForUnit" : "MONTH",
"calendarInitialyActiveFor" : {
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"updatedCode" : "...",
"calendarType" : "DAILY",
"fixedDates" : [ "...", "..." ],
"days" : [ { }, { } ],
"hours" : [ { }, { } ],
"periodLength" : 12345,
"periodUnit" : "SECOND",
"nbPeriods" : 12345,
"joinCalendar1Code" : "...",
"joinCalendar2Code" : "...",
"intervalType" : "HOUR",
"intervals" : [ { }, { } ],
"weekendBegin" : 12345,
"weekendEnd" : 12345,
"endDate" : 12345,
"startDate" : 12345,
"initDateEL" : "...",
"holidays" : [ { }, { } ],
"languageDescriptions" : [ { }, { } ]
},
"autoRenew" : true,
"daysNotifyRenewal" : 12345,
"endOfTermAction" : "TERMINATE",
"terminationReasonCode" : "...",
"renewFor" : 12345,
"calendarRenewFor" : {
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"updatedCode" : "...",
"calendarType" : "YEARLY",
"fixedDates" : [ "...", "..." ],
"days" : [ { }, { } ],
"hours" : [ { }, { } ],
"periodLength" : 12345,
"periodUnit" : "SECOND",
"nbPeriods" : 12345,
"joinCalendar1Code" : "...",
"joinCalendar2Code" : "...",
"intervalType" : "HOUR",
"intervals" : [ { }, { } ],
"weekendBegin" : 12345,
"weekendEnd" : 12345,
"endDate" : 12345,
"startDate" : 12345,
"initDateEL" : "...",
"holidays" : [ { }, { } ],
"languageDescriptions" : [ { }, { } ]
},
"renewForUnit" : "DAY",
"extendAgreementPeriodToSubscribedTillDate" : true
},
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"groupedServiceCode" : "...",
"values" : [ { }, { } ],
"valueValidator" : "...",
"serviceTypeCode" : "...",
"display" : true,
"param" : "...",
"medias" : [ {
"code" : "...",
"description" : "...",
"mediaName" : "...",
"label" : "...",
"main" : true,
"mediaType" : "IMAGE",
"mediaPath" : "...",
"id" : 12345,
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
}
}, {
"code" : "...",
"description" : "...",
"mediaName" : "...",
"label" : "...",
"main" : true,
"mediaType" : "IMAGE",
"mediaPath" : "...",
"id" : 12345,
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
}
} ]
}