A base class for all API DTO classes
| name | data type | constraints | description |
|---|---|---|---|
| offerTemplateCode | string | required | |
| product | ProductDto | ||
| allowedDiscountPlans | array of DiscountPlanDto | Discount plans allowed for this product. | |
| commercialRules | array of CommercialRuleHeaderDTO | ||
| selectable | boolean | ||
| sequence | number | ||
| ruled | boolean | ||
| mandatory | boolean | ||
| display | boolean | ||
| quantityMin | number | ||
| quantityMax | number | ||
| quantityDefault | number | ||
| productSet | string |
Example
{
"offerTemplateCode" : "...",
"product" : {
"discountList" : [ {
"disabled" : true,
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"startDate" : 12345,
"updatedCode" : "...",
"endDate" : 12345,
"defaultDuration" : 12345,
"durationUnit" : "DAY",
"customFields" : { },
"discountPlanItem" : [ { }, { } ],
"expressionEl" : "...",
"discountPlanType" : "INVOICE_LINE",
"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" : "MONTH",
"customFields" : { },
"discountPlanItem" : [ { }, { } ],
"expressionEl" : "...",
"discountPlanType" : "OFFER",
"status" : "DRAFT",
"statusDate" : 12345,
"initialQuantity" : 12345,
"usedQuantity" : 12345,
"applicationLimit" : 12345,
"applicationFilterEL" : "...",
"incompatibleDiscountPlans" : [ { }, { } ],
"applicableEntities" : [ { }, { } ],
"applicableOnOverriddenPrice" : true,
"sequence" : 12345,
"applicableOnDiscountedPrice" : true
} ],
"id" : 12345,
"code" : "...",
"label" : "...",
"status" : "ACTIVE",
"statusDate" : 12345,
"productLineCode" : "...",
"brandCode" : "...",
"reference" : "...",
"model" : "...",
"modelChildren" : [ "...", "..." ],
"discountFlag" : true,
"packageFlag" : true,
"priceVersionDateSetting" : "EVENT",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"currentProductVersion" : {
"shortDescription" : "...",
"productCode" : "...",
"currentVersion" : 12345,
"status" : "CLOSED",
"statusDate" : 12345,
"longDescription" : "...",
"validity" : { },
"productAttributes" : [ { }, { } ],
"groupedAttributeCodes" : [ "...", "..." ],
"tagCodes" : [ "...", "..." ]
},
"productChargeTemplateMappingDto" : [ {
"chargeCode" : "...",
"productCode" : "...",
"counterCode" : "...",
"accumulatorCounterCodes" : [ "...", "..." ]
}, {
"chargeCode" : "...",
"productCode" : "...",
"counterCode" : "...",
"accumulatorCounterCodes" : [ "...", "..." ]
} ],
"commercialRuleCodes" : [ "...", "..." ],
"discountListCodes" : [ "...", "..." ],
"mediaCodes" : [ "...", "..." ],
"isModel" : true,
"productModelCode" : "..."
},
"allowedDiscountPlans" : [ {
"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" : "...",
"startDate" : 12345,
"updatedCode" : "...",
"endDate" : 12345,
"defaultDuration" : 12345,
"durationUnit" : "DAY",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"discountPlanItem" : [ {
"code" : "...",
"discountPlanCode" : "...",
"invoiceCategoryCode" : "...",
"invoiceSubCategoryCode" : "...",
"expressionEl" : "...",
"disabled" : true,
"discountPlanItemType" : "FIXED",
"discountValue" : 12345.0,
"discountValueEL" : "...",
"targetAccountingArticleCodes" : [ "...", "..." ],
"pricePlanMatrixCode" : "...",
"customFields" : { },
"allowToNegate" : true,
"description" : "...",
"priority" : 12345,
"accountingArticleCode" : "...",
"applyByArticle" : true,
"sequence" : 12345,
"lastDiscount" : true
}, {
"code" : "...",
"discountPlanCode" : "...",
"invoiceCategoryCode" : "...",
"invoiceSubCategoryCode" : "...",
"expressionEl" : "...",
"disabled" : true,
"discountPlanItemType" : "PERCENTAGE",
"discountValue" : 12345.0,
"discountValueEL" : "...",
"targetAccountingArticleCodes" : [ "...", "..." ],
"pricePlanMatrixCode" : "...",
"customFields" : { },
"allowToNegate" : true,
"description" : "...",
"priority" : 12345,
"accountingArticleCode" : "...",
"applyByArticle" : true,
"sequence" : 12345,
"lastDiscount" : true
} ],
"expressionEl" : "...",
"discountPlanType" : "PRODUCT",
"status" : "DRAFT",
"statusDate" : 12345,
"initialQuantity" : 12345,
"usedQuantity" : 12345,
"applicationLimit" : 12345,
"applicationFilterEL" : "...",
"incompatibleDiscountPlans" : [ { }, { } ],
"applicableEntities" : [ {
"code" : "...",
"entityClass" : "..."
}, {
"code" : "...",
"entityClass" : "..."
} ],
"applicableOnOverriddenPrice" : true,
"sequence" : 12345,
"applicableOnDiscountedPrice" : true
}, {
"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" : "...",
"startDate" : 12345,
"updatedCode" : "...",
"endDate" : 12345,
"defaultDuration" : 12345,
"durationUnit" : "MONTH",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"discountPlanItem" : [ {
"code" : "...",
"discountPlanCode" : "...",
"invoiceCategoryCode" : "...",
"invoiceSubCategoryCode" : "...",
"expressionEl" : "...",
"disabled" : true,
"discountPlanItemType" : "FIXED",
"discountValue" : 12345.0,
"discountValueEL" : "...",
"targetAccountingArticleCodes" : [ "...", "..." ],
"pricePlanMatrixCode" : "...",
"customFields" : { },
"allowToNegate" : true,
"description" : "...",
"priority" : 12345,
"accountingArticleCode" : "...",
"applyByArticle" : true,
"sequence" : 12345,
"lastDiscount" : true
}, {
"code" : "...",
"discountPlanCode" : "...",
"invoiceCategoryCode" : "...",
"invoiceSubCategoryCode" : "...",
"expressionEl" : "...",
"disabled" : true,
"discountPlanItemType" : "FIXED",
"discountValue" : 12345.0,
"discountValueEL" : "...",
"targetAccountingArticleCodes" : [ "...", "..." ],
"pricePlanMatrixCode" : "...",
"customFields" : { },
"allowToNegate" : true,
"description" : "...",
"priority" : 12345,
"accountingArticleCode" : "...",
"applyByArticle" : true,
"sequence" : 12345,
"lastDiscount" : true
} ],
"expressionEl" : "...",
"discountPlanType" : "OFFER",
"status" : "INACTIVE",
"statusDate" : 12345,
"initialQuantity" : 12345,
"usedQuantity" : 12345,
"applicationLimit" : 12345,
"applicationFilterEL" : "...",
"incompatibleDiscountPlans" : [ { }, { } ],
"applicableEntities" : [ {
"code" : "...",
"entityClass" : "..."
}, {
"code" : "...",
"entityClass" : "..."
} ],
"applicableOnOverriddenPrice" : true,
"sequence" : 12345,
"applicableOnDiscountedPrice" : true
} ],
"commercialRules" : [ {
"ruleType" : "INCOMPATIBILITY",
"ruleEl" : "...",
"offerCode" : "...",
"productCode" : "...",
"productVersion" : 12345,
"attributeCode" : "...",
"scope" : "QUOTE_OFFER",
"tagCode" : "...",
"groupedAttributeCode" : "...",
"targetAttributeValue" : "...",
"isTarget" : true,
"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" : "..."
} ],
"commercialRuleItems" : [ {
"operator" : "AND",
"ruleItemEl" : "...",
"commercialRuleLines" : [ { }, { } ]
}, {
"operator" : "AND",
"ruleItemEl" : "...",
"commercialRuleLines" : [ { }, { } ]
} ],
"code" : "...",
"description" : "...",
"updatedCode" : "..."
}, {
"ruleType" : "REPLACEMENT",
"ruleEl" : "...",
"offerCode" : "...",
"productCode" : "...",
"productVersion" : 12345,
"attributeCode" : "...",
"scope" : "QUOTE",
"tagCode" : "...",
"groupedAttributeCode" : "...",
"targetAttributeValue" : "...",
"isTarget" : true,
"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" : "..."
} ],
"commercialRuleItems" : [ {
"operator" : "AND",
"ruleItemEl" : "...",
"commercialRuleLines" : [ { }, { } ]
}, {
"operator" : "AND",
"ruleItemEl" : "...",
"commercialRuleLines" : [ { }, { } ]
} ],
"code" : "...",
"description" : "...",
"updatedCode" : "..."
} ],
"selectable" : true,
"sequence" : 12345,
"ruled" : true,
"mandatory" : true,
"display" : true,
"quantityMin" : 12345,
"quantityMax" : 12345,
"quantityDefault" : 12345,
"productSet" : "..."
}