DTO for PricePlanMatrix.
| 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 |
| eventCode | string | The event code. | |
| description | string | The description | |
| seller | string | The seller. | |
| country | string | The country. | |
| updatedCode | string | The updated code. | |
| currency | string | The currency. | |
| minQuantity | number | The min quantity. | |
| maxQuantity | number | The max quantity. | |
| offerTemplate | string | The offer template. | |
| offerTemplateVersion | OfferTemplateDto | The offer template version. | |
| startSubscriptionDate | number | The start subscription date. | |
| endSubscriptionDate | number | The end subscription date. | |
| startRatingDate | number | The start rating date. | |
| endRatingDate | number | The end rating date. | |
| minSubscriptionAgeInMonth | number | The min subscription age in month. | |
| maxSubscriptionAgeInMonth | number | The max subscription age in month. | |
| amountWithoutTax | number | The amount without tax. | |
| amountWithTax | number | The amount with tax. | |
| amountWithoutTaxEL | string | The amount without tax EL. | |
| amountWithTaxEL | string | The amount with tax EL. | |
| minimumAmountWithoutTaxEl | string | The minimum amount without tax el. | |
| minimumAmountWithTaxEl | string | The minimum amount with tax el. | |
| priority | number | The priority. | |
| criteria1 | string | The criteria 1. | |
| criteria2 | string | The criteria 2. | |
| criteria3 | string | The criteria 3. | |
| criteriaEL | string | The criteria EL. | |
| validityCalendarCode | string | The validity calendar code. | |
| scriptInstance | string | The script instance. | |
| customFields | CustomFieldsDto | The custom fields. | |
| languageDescriptions | array of LanguageDescriptionDto | The language descriptions. | |
| woDescriptionEL | string | The wo description EL. | |
| ratingWithTaxEL | string | max size: 2000, min size: 0 | Expression to calculate price with tax. |
| ratingWithoutTaxEL | string | max size: 2000, min size: 0 | Expression to calculate price without tax |
| versions | array of PricePlanMatrixVersionDto | ||
| invoiceSubCategoryEL | string | Expression for getting the InvoiceSubCategory. | |
| totalAmountEL | string | Expression to calculate price with/without tax. It overrides quantity x unitPrice when set. | |
| minimumAmountEL | string | 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. | |
| parameter1El | string | An El expression used to override wallet operation's parameter1El. | |
| parameter2El | string | An El expression used to override wallet operation's parameter2El. | |
| parameter3El | string | An El expression used to override wallet operation's parameter3El. |
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" : "...",
"eventCode" : "...",
"description" : "...",
"seller" : "...",
"country" : "...",
"updatedCode" : "...",
"currency" : "...",
"minQuantity" : 12345.0,
"maxQuantity" : 12345.0,
"offerTemplate" : "...",
"offerTemplateVersion" : {
"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" : "...",
"bomCode" : "...",
"updatedCode" : "...",
"validFrom" : 12345,
"validTo" : 12345,
"offerServiceTemplate" : [ {
"serviceTemplate" : { },
"mandatory" : true,
"incompatibleServiceTemplate" : [ { }, { } ]
}, {
"serviceTemplate" : { },
"mandatory" : true,
"incompatibleServiceTemplate" : [ { }, { } ]
} ],
"newValidFrom" : 12345,
"newValidTo" : 12345,
"name" : "...",
"offerTemplateCategory" : [ {
"disabled" : true,
"name" : "...",
"id" : 12345,
"offerTemplateCategoryCode" : "...",
"auditableField" : [ { }, { } ],
"href" : "...",
"code" : "...",
"version" : 12345,
"lastModified" : 12345,
"description" : "...",
"parentId" : 12345,
"updatedCode" : "...",
"imagePath" : "...",
"imageBase64" : "...",
"customFields" : { },
"languageDescriptions" : [ { }, { } ],
"languageLabels" : [ { }, { } ]
}, {
"disabled" : true,
"name" : "...",
"id" : 12345,
"offerTemplateCategoryCode" : "...",
"auditableField" : [ { }, { } ],
"href" : "...",
"code" : "...",
"version" : 12345,
"lastModified" : 12345,
"description" : "...",
"parentId" : 12345,
"updatedCode" : "...",
"imagePath" : "...",
"imageBase64" : "...",
"customFields" : { },
"languageDescriptions" : [ { }, { } ],
"languageLabels" : [ { }, { } ]
} ],
"offerProducts" : [ {
"offerTemplateCode" : "...",
"product" : { },
"allowedDiscountPlans" : [ { }, { } ],
"commercialRules" : [ { }, { } ],
"selectable" : true,
"sequence" : 12345,
"ruled" : true,
"mandatory" : true,
"display" : true,
"quantityMin" : 12345,
"quantityMax" : 12345,
"quantityDefault" : 12345,
"productSet" : "..."
}, {
"offerTemplateCode" : "...",
"product" : { },
"allowedDiscountPlans" : [ { }, { } ],
"commercialRules" : [ { }, { } ],
"selectable" : true,
"sequence" : 12345,
"ruled" : true,
"mandatory" : true,
"display" : true,
"quantityMin" : 12345,
"quantityMax" : 12345,
"quantityDefault" : 12345,
"productSet" : "..."
} ],
"channel" : [ {
"disabled" : true,
"languageDescriptions" : [ { }, { } ],
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"updatedCode" : "..."
}, {
"disabled" : true,
"languageDescriptions" : [ { }, { } ],
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"updatedCode" : "..."
} ],
"digitalResource" : [ {
"uri" : "...",
"mimeType" : "...",
"disabled" : true,
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"updatedCode" : "..."
}, {
"uri" : "...",
"mimeType" : "...",
"disabled" : true,
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"updatedCode" : "..."
} ],
"allowedDiscountPlans" : [ {
"disabled" : true,
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"startDate" : 12345,
"updatedCode" : "...",
"endDate" : 12345,
"defaultDuration" : 12345,
"durationUnit" : "MONTH",
"customFields" : { },
"discountPlanItem" : [ { }, { } ],
"expressionEl" : "...",
"discountPlanType" : "PROMO_CODE",
"status" : "DRAFT",
"statusDate" : 12345,
"initialQuantity" : 12345,
"usedQuantity" : 12345,
"applicationLimit" : 12345,
"applicationFilterEL" : "...",
"incompatibleDiscountPlans" : [ { }, { } ],
"applicableEntities" : [ { }, { } ],
"applicableOnOverriddenPrice" : true,
"sequence" : 12345,
"applicableOnDiscountedPrice" : true
}, {
"disabled" : true,
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"startDate" : 12345,
"updatedCode" : "...",
"endDate" : 12345,
"defaultDuration" : 12345,
"durationUnit" : "DAY",
"customFields" : { },
"discountPlanItem" : [ { }, { } ],
"expressionEl" : "...",
"discountPlanType" : "PRODUCT",
"status" : "IN_USE",
"statusDate" : 12345,
"initialQuantity" : 12345,
"usedQuantity" : 12345,
"applicationLimit" : 12345,
"applicationFilterEL" : "...",
"incompatibleDiscountPlans" : [ { }, { } ],
"applicableEntities" : [ { }, { } ],
"applicableOnOverriddenPrice" : true,
"sequence" : 12345,
"applicableOnDiscountedPrice" : true
} ],
"modelCode" : "...",
"lifeCycleStatus" : "IN_DESIGN",
"offerAttributes" : [ {
"sequence" : 12345,
"mandatoryWithEl" : "...",
"attributeCode" : "...",
"display" : true,
"readOnly" : true,
"defaultValue" : "...",
"validationType" : "REGEX",
"validationPattern" : "...",
"validationLabel" : "...",
"mandatory" : true,
"ruled" : true,
"commercialRuleCodes" : [ "...", "..." ],
"assignedValue" : { },
"selectable" : true
}, {
"sequence" : 12345,
"mandatoryWithEl" : "...",
"attributeCode" : "...",
"display" : true,
"readOnly" : true,
"defaultValue" : "...",
"validationType" : "EL",
"validationPattern" : "...",
"validationLabel" : "...",
"mandatory" : true,
"ruled" : true,
"commercialRuleCodes" : [ "...", "..." ],
"assignedValue" : { },
"selectable" : true
} ],
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"imagePath" : "...",
"imageBase64" : "...",
"attributes" : [ {
"disabled" : true,
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"updatedCode" : "...",
"attributeType" : "NUMERIC",
"allowedValues" : [ "...", "..." ],
"priority" : 12345,
"selectable" : true,
"ruled" : true,
"chargeTemplateCodes" : [ "...", "..." ],
"commercialRuleCodes" : [ "...", "..." ],
"mediaCodes" : [ "...", "..." ],
"tags" : [ "...", "..." ],
"assignedAttributeCodes" : [ "...", "..." ],
"unitNbDecimal" : 12345,
"customFields" : { },
"groupedAttributes" : [ { }, { } ]
}, {
"disabled" : true,
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"updatedCode" : "...",
"attributeType" : "LIST_TEXT",
"allowedValues" : [ "...", "..." ],
"priority" : 12345,
"selectable" : true,
"ruled" : true,
"chargeTemplateCodes" : [ "...", "..." ],
"commercialRuleCodes" : [ "...", "..." ],
"mediaCodes" : [ "...", "..." ],
"tags" : [ "...", "..." ],
"assignedAttributeCodes" : [ "...", "..." ],
"unitNbDecimal" : 12345,
"customFields" : { },
"groupedAttributes" : [ { }, { } ]
} ],
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"commercialRuleCodes" : [ "...", "..." ],
"longDescription" : "...",
"longDescriptionsTranslated" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"globalRatingScriptInstance" : "...",
"mediaCodes" : [ "...", "..." ],
"seller" : [ "...", "..." ],
"customerCategory" : [ {
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"exoneratedFromTaxes" : true,
"exonerationTaxEl" : "...",
"description" : "...",
"exonerationReason" : "...",
"updatedCode" : "...",
"accountingCode" : "...",
"taxCategoryCode" : "...",
"taxCategoryEl" : "...",
"languageDescriptions" : [ { }, { } ]
}, {
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"exoneratedFromTaxes" : true,
"exonerationTaxEl" : "...",
"description" : "...",
"exonerationReason" : "...",
"updatedCode" : "...",
"accountingCode" : "...",
"taxCategoryCode" : "...",
"taxCategoryEl" : "...",
"languageDescriptions" : [ { }, { } ]
} ],
"isOfferChangeRestricted" : true,
"allowedOfferChange" : [ "...", "..." ],
"renewalRule" : {
"initialTermType" : "CALENDAR",
"renewalTermType" : "RECURRING",
"initialyActiveFor" : 12345,
"initialyActiveForUnit" : "MONTH",
"calendarInitialyActiveFor" : { },
"autoRenew" : true,
"daysNotifyRenewal" : 12345,
"endOfTermAction" : "TERMINATE",
"terminationReasonCode" : "...",
"renewFor" : 12345,
"calendarRenewFor" : { },
"renewForUnit" : "MONTH",
"extendAgreementPeriodToSubscribedTillDate" : true
},
"minimumAmountEl" : "...",
"minimumLabelEl" : "...",
"minimumInvoiceSubCategory" : "...",
"autoEndOfEngagement" : true,
"minimumChargeTemplate" : "...",
"tagCodes" : [ "...", "..." ],
"statusDate" : 12345,
"isModel" : true,
"offerModelCode" : "...",
"generateQuoteEdrPerProduct" : true
},
"startSubscriptionDate" : 12345,
"endSubscriptionDate" : 12345,
"startRatingDate" : 12345,
"endRatingDate" : 12345,
"minSubscriptionAgeInMonth" : 12345,
"maxSubscriptionAgeInMonth" : 12345,
"amountWithoutTax" : 12345.0,
"amountWithTax" : 12345.0,
"amountWithoutTaxEL" : "...",
"amountWithTaxEL" : "...",
"minimumAmountWithoutTaxEl" : "...",
"minimumAmountWithTaxEl" : "...",
"priority" : 12345,
"criteria1" : "...",
"criteria2" : "...",
"criteria3" : "...",
"criteriaEL" : "...",
"validityCalendarCode" : "...",
"scriptInstance" : "...",
"customFields" : {
"customField" : [ {
"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_NOT_ANALYZE",
"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",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
} ],
"inheritedCustomField" : [ {
"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" : "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" : "..."
} ]
},
"languageDescriptions" : [ {
"languageCode" : "...",
"description" : "..."
}, {
"languageCode" : "...",
"description" : "..."
} ],
"woDescriptionEL" : "...",
"ratingWithTaxEL" : "...",
"ratingWithoutTaxEL" : "...",
"versions" : [ {
"id" : 12345,
"pricePlanMatrixCode" : "...",
"statusEnum" : "PUBLISHED",
"version" : 12345,
"statusDate" : 12345,
"label" : "...",
"validity" : {
"from" : 12345,
"to" : 12345,
"valid" : true,
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345
},
"isMatrix" : true,
"price" : 12345.0,
"priceEL" : "...",
"priority" : 12345,
"priceVersionType" : "FIXED",
"columns" : [ {
"code" : "...",
"pricePlanMatrixCode" : "...",
"pricePlanMatrixVersion" : 12345,
"productCode" : "...",
"offerTemplateCode" : "...",
"attributeCode" : "...",
"position" : 12345,
"type" : "Double",
"elValue" : "...",
"isRange" : true
}, {
"code" : "...",
"pricePlanMatrixCode" : "...",
"pricePlanMatrixVersion" : 12345,
"productCode" : "...",
"offerTemplateCode" : "...",
"attributeCode" : "...",
"position" : 12345,
"type" : "Boolean",
"elValue" : "...",
"isRange" : true
} ],
"lines" : [ {
"ppmLineId" : 12345,
"value" : 12345.0,
"pricePlanMatrixCode" : "...",
"pricePlanMatrixVersion" : 12345,
"description" : "...",
"pricePlanMatrixValues" : [ { }, { } ],
"priority" : 12345,
"priceEL" : "...",
"valueEL" : "..."
}, {
"ppmLineId" : 12345,
"value" : 12345.0,
"pricePlanMatrixCode" : "...",
"pricePlanMatrixVersion" : 12345,
"description" : "...",
"pricePlanMatrixValues" : [ { }, { } ],
"priority" : 12345,
"priceEL" : "...",
"valueEL" : "..."
} ]
}, {
"id" : 12345,
"pricePlanMatrixCode" : "...",
"statusEnum" : "CLOSED",
"version" : 12345,
"statusDate" : 12345,
"label" : "...",
"validity" : {
"from" : 12345,
"to" : 12345,
"valid" : true,
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345
},
"isMatrix" : true,
"price" : 12345.0,
"priceEL" : "...",
"priority" : 12345,
"priceVersionType" : "PERCENTAGE",
"columns" : [ {
"code" : "...",
"pricePlanMatrixCode" : "...",
"pricePlanMatrixVersion" : 12345,
"productCode" : "...",
"offerTemplateCode" : "...",
"attributeCode" : "...",
"position" : 12345,
"type" : "Double",
"elValue" : "...",
"isRange" : true
}, {
"code" : "...",
"pricePlanMatrixCode" : "...",
"pricePlanMatrixVersion" : 12345,
"productCode" : "...",
"offerTemplateCode" : "...",
"attributeCode" : "...",
"position" : 12345,
"type" : "Boolean",
"elValue" : "...",
"isRange" : true
} ],
"lines" : [ {
"ppmLineId" : 12345,
"value" : 12345.0,
"pricePlanMatrixCode" : "...",
"pricePlanMatrixVersion" : 12345,
"description" : "...",
"pricePlanMatrixValues" : [ { }, { } ],
"priority" : 12345,
"priceEL" : "...",
"valueEL" : "..."
}, {
"ppmLineId" : 12345,
"value" : 12345.0,
"pricePlanMatrixCode" : "...",
"pricePlanMatrixVersion" : 12345,
"description" : "...",
"pricePlanMatrixValues" : [ { }, { } ],
"priority" : 12345,
"priceEL" : "...",
"valueEL" : "..."
} ]
} ],
"invoiceSubCategoryEL" : "...",
"totalAmountEL" : "...",
"minimumAmountEL" : "...",
"parameter1El" : "...",
"parameter2El" : "...",
"parameter3El" : "..."
}