UsageChargeTemplateDto Data Type

The Class UsageChargeTemplateDto.

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  
filterParam1 string max size: 255, min size: 0 The filter param 1.
code string required The code
filterParam2 string max size: 255, min size: 0 The filter param 2.
description string   The description
filterParam3 string max size: 255, min size: 0 The filter param 3.
invoiceSubCategory string   The invoice sub category.
updatedCode string   The updated code.
amountEditable boolean   The amount editable.
filterParam4 string max size: 255, min size: 0 The filter param 4.
languageDescriptions array of LanguageDescriptionDto   The language descriptions.
priority number   The priority.
inputUnitDescription string   The input unit description.
triggerNextCharge boolean   If true and (charge has no counter associated) then the next matching charge with the full quantity of the EDR.
ratingUnitDescription string   The rating unit description.
unitMultiplicator number   The unit multiplicator.
inputUnitOfMeasureCode string  
ratingUnitOfMeasureCode string  
triggerNextChargeEL string   Overrides the triggerNextCharge switch.
inputUnitEL string  
usageQuantityAttributeCode 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" : "..."
  } ],
  "filterParam1" : "...",
  "code" : "...",
  "filterParam2" : "...",
  "description" : "...",
  "filterParam3" : "...",
  "invoiceSubCategory" : "...",
  "updatedCode" : "...",
  "amountEditable" : true,
  "filterParam4" : "...",
  "languageDescriptions" : [ {
    "languageCode" : "...",
    "description" : "..."
  }, {
    "languageCode" : "...",
    "description" : "..."
  } ],
  "priority" : 12345,
  "triggerNextCharge" : true,
  "inputUnitOfMeasureCode" : "...",
  "ratingUnitOfMeasureCode" : "...",
  "triggerNextChargeEL" : "...",
  "inputUnitEL" : "...",
  "usageQuantityAttributeCode" : "...",
  "outputUnitEL" : "...",
  "unitNbDecimal" : 12345,
  "roundingModeDtoEnum" : "HALF_EVEN",
  "revenueRecognitionRuleCode" : "...",
  "filterExpression" : "...",
  "taxClassCode" : "...",
  "taxClassEl" : "...",
  "ratingScriptCode" : "...",
  "customFields" : {
    "customField" : [ {
      "code" : "...",
      "description" : "...",
      "fieldType" : "BOOLEAN",
      "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" : "MULTI_VALUE",
      "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" : "..."
    } ],
    "inheritedCustomField" : [ {
      "code" : "...",
      "description" : "...",
      "fieldType" : "DOUBLE",
      "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" : "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" : "..."
    } ]
  },
  "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" : [ "...", "..." ]
}