pricePlanMatrixDto Data Type

DTO for PricePlanMatrix.

Namespace
(Default)
Properties
name data type type namespace min/max occurs constraints description
amountWithTax decimal element 0/1   The amount with tax.
amountWithTaxEL string element 0/1   The amount with tax EL.
amountWithTaxELSpark string element 0/1   The amount with tax EL - for Spark
amountWithoutTax decimal element 0/1   The amount without tax.
amountWithoutTaxEL string element 0/1   The amount without tax EL.
amountWithoutTaxELSpark string element 0/1   The amount without tax EL - for Spark
country string element 0/1   The country.
criteria1 string element 0/1   The criteria 1.
criteria2 string element 0/1   The criteria 2.
criteria3 string element 0/1   The criteria 3.
criteriaEL string element 0/1   The criteria EL.
criteriaELSpark string element 0/1   The criteria EL - for Spark
currency string element 0/1   The currency.
customFields customFieldsDto element 0/1   The custom fields.
endRatingDate dateTime element 0/1   The end rating date.
endSubscriptionDate dateTime element 0/1   The end subscription date.
eventCode string element 1/1 required The event code.
invoiceSubCategoryEL string element 0/1   Expression for getting the InvoiceSubCategory.
languageDescriptions languageDescriptionDto element 0/unbounded   The language descriptions.
maxQuantity decimal element 0/1   The max quantity.
maxSubscriptionAgeInMonth long element 0/1   The max subscription age in month.
minQuantity decimal element 0/1   The min quantity.
minSubscriptionAgeInMonth long element 0/1   The min subscription age in month.
minimumAmountEL string element 0/1   Minimum allowed amount for a walletOperation. If this amount is less than the walletOperation this amount is save and the old value is save in rawAmount.
minimumAmountELSpark string element 0/1   Minimum allowed amount for a walletOperation. If this amount is less than the walletOperation this amount is save and the old value is save in rawAmount - for Spark.
minimumAmountWithTaxELSpark string element 0/1   The minimum amount with tax el - for Spark
minimumAmountWithTaxEl string element 0/1   The minimum amount with tax el.
minimumAmountWithoutTaxELSpark string element 0/1   The minimum amount without tax el - for Spark
minimumAmountWithoutTaxEl string element 0/1   The minimum amount without tax el.
offerTemplate string element 0/1   The offer template.
offerTemplateVersion offerTemplateDto element 0/1   The offer template version.
priority int element 0/1   The priority.
ratingWithTaxEL string element 0/1 max size: 2000, min size: 0 Expression to calculate price with tax.
ratingWithTaxELSpark string element 0/1 max size: 2000, min size: 0 Expression to calculate price with tax - for Spark.
ratingWithoutTaxEL string element 0/1 max size: 2000, min size: 0 Expression to calculate price without tax
ratingWithoutTaxELSpark string element 0/1 max size: 2000, min size: 0 Expression to calculate price without tax - for Spark.
scriptInstance string element 0/1   The script instance.
seller string element 0/1   The seller.
startRatingDate dateTime element 0/1   The start rating date.
startSubscriptionDate dateTime element 0/1   The start subscription date.
totalAmountEL string element 0/1   Expression to calculate price with/without tax. It overrides quantity x unitPrice when set.
totalAmountELSpark string element 0/1   Expression to calculate price with/without tax, It overrides quantity x unitPrice when set - for Spark.
validityCalendarCode string element 0/1   The validity calendar code.
woDescriptionEL string element 0/1   The wo description EL.
woDescriptionELSpark string element 0/1   The wo description EL - for Spark
Properties inherited from enableBusinessDto
code string attribute 1/1   The code
description string attribute 0/1   The description
id long attribute 0/1   The id.
auditable auditableDto element 0/1    
auditableField auditableFieldDto element 0/unbounded    
disabled boolean element 0/1   Is entity disabled. Value is ignored in Update action - use enable/disable API instead.
updatedCode string element 0/1   The updated code.

Example

<PricePlan code="..." description="..." id="...">
  <eventCode>...</eventCode>
  <seller>...</seller>
  <country>...</country>
  <currency>...</currency>
  <minQuantity>...</minQuantity>
  <maxQuantity>...</maxQuantity>
  <offerTemplate>...</offerTemplate>
  <offerTemplateVersion validFrom="..." validTo="...">
    <bomCode>...</bomCode>
    <offerServiceTemplates>
      <offerServiceTemplate>
        <serviceTemplate/>
        <mandatory>...</mandatory>
        <incompatibleServices>
          <incompatibleServiceTemplate/>
        </incompatibleServices>
      </offerServiceTemplate>
    </offerServiceTemplates>
    <offerProductTemplates>
      <offerProductTemplate>
        <productTemplate/>
        <mandatory>...</mandatory>
      </offerProductTemplate>
    </offerProductTemplates>
    <allowedDiscountPlans>
      <allowedDiscountPlans>
        <startDate>...</startDate>
        <endDate>...</endDate>
        <defaultDuration>...</defaultDuration>
        <durationUnit>...</durationUnit>
        <customFields/>
        <discountPlanItems>
          <discountPlanItem/>
        </discountPlanItems>
      </allowedDiscountPlans>
    </allowedDiscountPlans>
    <renewalRule>
      <initialyActiveFor>...</initialyActiveFor>
      <initialyActiveForUnit>...</initialyActiveForUnit>
      <autoRenew>...</autoRenew>
      <daysNotifyRenewal>...</daysNotifyRenewal>
      <endOfTermAction>...</endOfTermAction>
      <terminationReasonCode>...</terminationReasonCode>
      <renewFor>...</renewFor>
      <renewForUnit>...</renewForUnit>
      <extendAgreementPeriodToSubscribedTillDate>...</extendAgreementPeriodToSubscribedTillDate>
    </renewalRule>
    <minimumAmountEl>...</minimumAmountEl>
    <minimumAmountElSpark>...</minimumAmountElSpark>
    <minimumLabelEl>...</minimumLabelEl>
    <minimumLabelElSpark>...</minimumLabelElSpark>
    <autoEndOfEngagement>...</autoEndOfEngagement>
    <name>...</name>
    <offerTemplateCategories>
      <offerTemplateCategory/>
    </offerTemplateCategories>
    <channels>
      <channel/>
    </channels>
    <digitalResources>
      <digitalResource/>
    </digitalResources>
    <modelCode>...</modelCode>
    <lifeCycleStatus>...</lifeCycleStatus>
    <customFields/>
    <imagePath>...</imagePath>
    <imageBase64>...</imageBase64>
    <languageDescriptions/>
    <longDescription>...</longDescription>
    <longDescriptionsTranslated/>
    <globalRatingScriptInstance>...</globalRatingScriptInstance>
    <sellers>
      <seller>...</seller>
    </sellers>
    <customerCategories>
      <customerCategory/>
    </customerCategories>
  </offerTemplateVersion>
  <startSubscriptionDate>...</startSubscriptionDate>
  <endSubscriptionDate>...</endSubscriptionDate>
  <startRatingDate>...</startRatingDate>
  <endRatingDate>...</endRatingDate>
  <minSubscriptionAgeInMonth>...</minSubscriptionAgeInMonth>
  <maxSubscriptionAgeInMonth>...</maxSubscriptionAgeInMonth>
  <amountWithoutTax>...</amountWithoutTax>
  <amountWithTax>...</amountWithTax>
  <amountWithoutTaxEL>...</amountWithoutTaxEL>
  <amountWithoutTaxELSpark>...</amountWithoutTaxELSpark>
  <amountWithTaxEL>...</amountWithTaxEL>
  <amountWithTaxELSpark>...</amountWithTaxELSpark>
  <minimumAmountWithoutTaxEl>...</minimumAmountWithoutTaxEl>
  <minimumAmountWithoutTaxELSpark>...</minimumAmountWithoutTaxELSpark>
  <minimumAmountWithTaxEl>...</minimumAmountWithTaxEl>
  <minimumAmountWithTaxELSpark>...</minimumAmountWithTaxELSpark>
  <priority>...</priority>
  <criteria1>...</criteria1>
  <criteria2>...</criteria2>
  <criteria3>...</criteria3>
  <criteriaEL>...</criteriaEL>
  <criteriaELSpark>...</criteriaELSpark>
  <validityCalendarCode>...</validityCalendarCode>
  <scriptInstance>...</scriptInstance>
  <customFields>
    <customField code="..." description="..." valueDate="..." valuePeriodEndDate="..." valuePeriodPriority="..." valuePeriodStartDate="...">
      <fieldType>...</fieldType>
      <languageDescriptions/>
      <stringValue>...</stringValue>
      <dateValue>...</dateValue>
      <longValue>...</longValue>
      <doubleValue>...</doubleValue>
      <booleanValue>...</booleanValue>
      <listValue>
        <value/>
      </listValue>
      <mapValue>...</mapValue>
      <entityReferenceValue/>
      <indexType>...</indexType>
      <fileValue>...</fileValue>
      <formattedValue/>
      <guiPosition>...</guiPosition>
    </customField>
    <inheritedCustomField code="..." description="..." valueDate="..." valuePeriodEndDate="..." valuePeriodPriority="..." valuePeriodStartDate="...">
      <fieldType>...</fieldType>
      <languageDescriptions/>
      <stringValue>...</stringValue>
      <dateValue>...</dateValue>
      <longValue>...</longValue>
      <doubleValue>...</doubleValue>
      <booleanValue>...</booleanValue>
      <listValue>
        <value/>
      </listValue>
      <mapValue>...</mapValue>
      <entityReferenceValue/>
      <indexType>...</indexType>
      <fileValue>...</fileValue>
      <formattedValue/>
      <guiPosition>...</guiPosition>
    </inheritedCustomField>
  </customFields>
  <languageDescriptions>
    <languageCode>...</languageCode>
    <description>...</description>
  </languageDescriptions>
  <woDescriptionEL>...</woDescriptionEL>
  <woDescriptionELSpark>...</woDescriptionELSpark>
  <ratingWithTaxEL>...</ratingWithTaxEL>
  <ratingWithTaxELSpark>...</ratingWithTaxELSpark>
  <ratingWithoutTaxEL>...</ratingWithoutTaxEL>
  <ratingWithoutTaxELSpark>...</ratingWithoutTaxELSpark>
  <invoiceSubCategoryEL>...</invoiceSubCategoryEL>
  <totalAmountEL>...</totalAmountEL>
  <totalAmountELSpark>...</totalAmountELSpark>
  <minimumAmountEL>...</minimumAmountEL>
  <minimumAmountELSpark>...</minimumAmountELSpark>
  <disabled>...</disabled>
  <auditable created="..." creator="..." updated="..." updater="..."/>
  <auditableFields>
    <auditableField actor="..." changeOrigin="..." code="..." created="..." currentState="..." description="..." entityClass="..." fieldName="..." id="..." originName="..." previousState="...">
      <auditable/>
      <auditableFields>
        <auditableField/>
      </auditableFields>
      <updatedCode>...</updatedCode>
    </auditableField>
  </auditableFields>
  <updatedCode>...</updatedCode>
</PricePlan>