A base class for all API DTO classes
| name | data type | constraints | description |
|---|---|---|---|
| discountList | array of DiscountPlanDto | ||
| id | number | ||
| code | string | required | |
| label | string | ||
| status | ProductStatusEnum | ||
| statusDate | number | ||
| productLineCode | string | ||
| brandCode | string | ||
| reference | string | ||
| model | string | ||
| modelChildren | array of string | ||
| discountFlag | boolean | ||
| packageFlag | boolean | ||
| priceVersionDateSetting | PriceVersionDateSettingEnum | ||
| customFields | CustomFieldsDto | The custom fields. | |
| currentProductVersion | ProductVersionDto | ||
| productChargeTemplateMappingDto | array of ProductChargeTemplateMappingDto | ||
| commercialRuleCodes | array of string | ||
| discountListCodes | array of string | ||
| mediaCodes | array of string | The media codes. | |
| isModel | boolean | ||
| productModelCode | string |
Example
{
"discountList" : [ {
"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" : "PERCENTAGE",
"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" : "QUOTE",
"status" : "INACTIVE",
"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" : "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" : "FIXED",
"discountValue" : 12345.0,
"discountValueEL" : "...",
"targetAccountingArticleCodes" : [ "...", "..." ],
"pricePlanMatrixCode" : "...",
"customFields" : { },
"allowToNegate" : true,
"description" : "...",
"priority" : 12345,
"accountingArticleCode" : "...",
"applyByArticle" : true,
"sequence" : 12345,
"lastDiscount" : true
} ],
"expressionEl" : "...",
"discountPlanType" : "PROMO_CODE",
"status" : "DRAFT",
"statusDate" : 12345,
"initialQuantity" : 12345,
"usedQuantity" : 12345,
"applicationLimit" : 12345,
"applicationFilterEL" : "...",
"incompatibleDiscountPlans" : [ { }, { } ],
"applicableEntities" : [ {
"code" : "...",
"entityClass" : "..."
}, {
"code" : "...",
"entityClass" : "..."
} ],
"applicableOnOverriddenPrice" : true,
"sequence" : 12345,
"applicableOnDiscountedPrice" : true
} ],
"id" : 12345,
"code" : "...",
"label" : "...",
"status" : "CLOSED",
"statusDate" : 12345,
"productLineCode" : "...",
"brandCode" : "...",
"reference" : "...",
"model" : "...",
"modelChildren" : [ "...", "..." ],
"discountFlag" : true,
"packageFlag" : true,
"priceVersionDateSetting" : "QUOTE",
"customFields" : {
"customField" : [ {
"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" : "INDEX_NOT_ANALYZE",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
}, {
"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" : "..."
} ],
"inheritedCustomField" : [ {
"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_NOT_ANALYZE",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
}, {
"code" : "...",
"description" : "...",
"fieldType" : "CHECKBOX_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" : "..."
} ]
},
"currentProductVersion" : {
"shortDescription" : "...",
"productCode" : "...",
"currentVersion" : 12345,
"status" : "DRAFT",
"statusDate" : 12345,
"longDescription" : "...",
"validity" : {
"from" : 12345,
"to" : 12345,
"valid" : true,
"empty" : true,
"strictMatch" : true,
"fromMatch" : 12345,
"toMatch" : 12345
},
"productAttributes" : [ {
"sequence" : 12345,
"mandatoryWithEl" : "...",
"attributeCode" : "...",
"readOnly" : true,
"defaultValue" : "...",
"validationType" : "REGEX",
"validationPattern" : "...",
"validationLabel" : "...",
"mandatory" : true,
"display" : true,
"ruled" : true,
"commercialRuleCodes" : [ "...", "..." ],
"assignedValue" : { },
"selectable" : true
}, {
"sequence" : 12345,
"mandatoryWithEl" : "...",
"attributeCode" : "...",
"readOnly" : true,
"defaultValue" : "...",
"validationType" : "EL",
"validationPattern" : "...",
"validationLabel" : "...",
"mandatory" : true,
"display" : true,
"ruled" : true,
"commercialRuleCodes" : [ "...", "..." ],
"assignedValue" : { },
"selectable" : true
} ],
"groupedAttributeCodes" : [ "...", "..." ],
"tagCodes" : [ "...", "..." ]
},
"productChargeTemplateMappingDto" : [ {
"chargeCode" : "...",
"productCode" : "...",
"counterCode" : "...",
"accumulatorCounterCodes" : [ "...", "..." ]
}, {
"chargeCode" : "...",
"productCode" : "...",
"counterCode" : "...",
"accumulatorCounterCodes" : [ "...", "..." ]
} ],
"commercialRuleCodes" : [ "...", "..." ],
"discountListCodes" : [ "...", "..." ],
"mediaCodes" : [ "...", "..." ],
"isModel" : true,
"productModelCode" : "..."
}