The Class RecurringChargeTemplateDto.
| 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 | ||
| calendar | string | required | The calendar. |
| code | string | required | The code |
| durationTermInMonth | number | The duration term in month. | |
| description | string | The description | |
| invoiceSubCategory | string | The invoice sub category. | |
| subscriptionProrata | boolean | The subscription prorata. | |
| updatedCode | string | The updated code. | |
| amountEditable | boolean | The amount editable. | |
| terminationProrata | boolean | The termination prorata. | |
| languageDescriptions | array of LanguageDescriptionDto | The language descriptions. | |
| applyInAdvance | boolean | The apply in advance. | |
| number | The share level. | ||
| |
|
|
|
| |
|
|
|
| calendarCodeEl | string | max size: 2000, min size: 0 | The calendar code el. |
| |
|
|
|
| inputUnitOfMeasureCode | string | ||
| durationTermInMonthEl | string | max size: 2000, min size: 0 | The duration term in month El. |
| ratingUnitOfMeasureCode | string | ||
| subscriptionProrataEl | string | max size: 2000, min size: 0 | The subscription prorata el. |
| inputUnitEL | string | ||
| outputUnitEL | string | ||
| terminationProrataEl | string | max size: 2000, min size: 0 | The termination prorata el. |
| unitNbDecimal | number | EDR and WO quantity field value precision | |
| applyInAdvanceEl | string | max size: 2000, min size: 0 | The apply in advance el. |
| roundingModeDtoEnum | RoundingModeEnum | EDR and WO quantity field value rounding | |
| applyTerminatedChargeToDateEL | string | Expression to determine and override the date that recurring charge should be charged to upon charge/service termination | |
| revenueRecognitionRuleCode | string | The revenue recognition rule code. | |
| filterExpression | string | max size: 2000, min size: 0 | The filter expression. |
| recurrenceType | RecurrenceTypeEnum | ||
| taxClassCode | string | Charge tax class code | |
| attributeDurationCode | string | ||
| taxClassEl | string | Expression to determine tax class | |
| attributeCalendarCode | string | ||
| ratingScriptCode | string | Code of a rating script | |
| customFields | CustomFieldsDto | The custom fields. | |
| triggeredEdrs | TriggeredEdrTemplatesDto | The triggered edrs. | |
| dropZeroWo | boolean | Enable/disable removing WO rated to 0. | |
| sortIndexEl | string | max size: 2000, min size: 0 | Sorting index EL. |
| status | ChargeTemplateStatusEnum | ||
| linkedAttributes | array of string |
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" : "..."
} ],
"calendar" : "...",
"code" : "...",
"durationTermInMonth" : 12345,
"description" : "...",
"invoiceSubCategory" : "...",
"subscriptionProrata" : true,
"updatedCode" : "...",
"amountEditable" : true,
"terminationProrata" : true,
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"applyInAdvance" : true,
"shareLevel" : 12345,
"calendarCodeEl" : "...",
"inputUnitOfMeasureCode" : "...",
"durationTermInMonthEl" : "...",
"ratingUnitOfMeasureCode" : "...",
"subscriptionProrataEl" : "...",
"inputUnitEL" : "...",
"outputUnitEL" : "...",
"terminationProrataEl" : "...",
"unitNbDecimal" : 12345,
"applyInAdvanceEl" : "...",
"roundingModeDtoEnum" : "HALF_EVEN",
"applyTerminatedChargeToDateEL" : "...",
"revenueRecognitionRuleCode" : "...",
"filterExpression" : "...",
"recurrenceType" : "CALENDAR",
"taxClassCode" : "...",
"attributeDurationCode" : "...",
"taxClassEl" : "...",
"attributeCalendarCode" : "...",
"ratingScriptCode" : "...",
"customFields" : {
"customField" : [ {
"code" : "...",
"description" : "...",
"fieldType" : "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_NOT_ANALYZE",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
}, {
"code" : "...",
"description" : "...",
"fieldType" : "STRING",
"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" : "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",
"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_NOT_ANALYZE",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
} ]
},
"triggeredEdrs" : {
"triggeredEdr" : [ {
"subscriptionEl" : "...",
"id" : 12345,
"auditableField" : [ { }, { } ],
"meveoInstanceCode" : "...",
"conditionEl" : "...",
"code" : "...",
"quantityEl" : "...",
"param1El" : "...",
"description" : "...",
"param2El" : "...",
"param3El" : "...",
"param4El" : "...",
"updatedCode" : "...",
"opencellInstanceEL" : "...",
"triggeredEdrScript" : "..."
}, {
"subscriptionEl" : "...",
"id" : 12345,
"auditableField" : [ { }, { } ],
"meveoInstanceCode" : "...",
"conditionEl" : "...",
"code" : "...",
"quantityEl" : "...",
"param1El" : "...",
"description" : "...",
"param2El" : "...",
"param3El" : "...",
"param4El" : "...",
"updatedCode" : "...",
"opencellInstanceEL" : "...",
"triggeredEdrScript" : "..."
} ]
},
"dropZeroWo" : true,
"sortIndexEl" : "...",
"status" : "ACTIVE",
"linkedAttributes" : [ "...", "..." ]
}