ChargeTemplateDto Data Type

The Class ChargeTemplateDto.

Subtypes
OneShotChargeTemplateDto, UsageChargeTemplateDto, ProductChargeTemplateDto, RecurringChargeTemplateDto
Implemented Interfaces
Serializable
Properties
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
invoiceSubCategory string   The invoice sub category.
updatedCode string   The updated code.
amountEditable boolean   The amount editable.
languageDescriptions array of LanguageDescriptionDto   The language descriptions.
inputUnitDescription string   The input unit description.
ratingUnitDescription string   The rating unit description.
unitMultiplicator number   The unit multiplicator.
inputUnitOfMeasureCode string  
ratingUnitOfMeasureCode string  
inputUnitEL string  
outputUnitEL string  
unitNbDecimal number   EDR and WO quantity field value precision
roundingModeDtoEnum RoundingModeEnum   EDR and WO quantity field value rounding
revenueRecognitionRuleCode string   The revenue recognition rule code.
filterExpression string max size: 2000, min size: 0 The filter expression.
taxClassCode string   Charge tax class code
taxClassEl string   Expression to determine tax class
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" : "..."
  } ],
  "code" : "...",
  "description" : "...",
  "invoiceSubCategory" : "...",
  "updatedCode" : "...",
  "amountEditable" : true,
  "languageDescriptions" : [ {
    "languageCode" : "...",
    "description" : "..."
  }, {
    "languageCode" : "...",
    "description" : "..."
  } ],
  "inputUnitOfMeasureCode" : "...",
  "ratingUnitOfMeasureCode" : "...",
  "inputUnitEL" : "...",
  "outputUnitEL" : "...",
  "unitNbDecimal" : 12345,
  "roundingModeDtoEnum" : "UP",
  "revenueRecognitionRuleCode" : "...",
  "filterExpression" : "...",
  "taxClassCode" : "...",
  "taxClassEl" : "...",
  "ratingScriptCode" : "...",
  "customFields" : {
    "customField" : [ {
      "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" : "LIST",
      "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" : "CUSTOM_TABLE_WRAPPER",
      "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" : "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" : "STORE_ONLY",
      "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" : "DRAFT",
  "linkedAttributes" : [ "...", "..." ]
}