DiscountPlanItemDto Data Type

Discount plan item

Implemented Interfaces
Serializable
Properties
name data type constraints description
code string required Code
discountPlanCode string required Discount plan code
invoiceCategoryCode string   Invoice category code
invoiceSubCategoryCode string   Invoice sub category code
accountingCode string   Accounting code
expressionEl string   /** Expression to determine if discount applies
disabled boolean   Is entity disabled. Value is ignored in Update action - use enable/disable API instead.
discountPlanItemType DiscountPlanItemTypeEnum   Type of discount, whether absolute or percentage.
discountValue number   The absolute or percentage discount amount.
discountValueEL string   The absolute or percentage discount amount EL.
targetAccountingArticleCodes array of string   The accountingArticle
pricePlanMatrixCode string   pricePlanMatrix code
customFields CustomFieldsDto   The custom fields.
allowToNegate boolean   If true, then allows to negate the amount of affected invoice lines. If fase, then amount for the discount line produce by the discount plan item cannot exceed the amount of discounted lines. Default: false
description string  
priority number   The lower number, the higher the priority is
accountingArticleCode string   accounting article code
applyByArticle boolean  
sequence number   defines the order in which discount plans are applied
lastDiscount boolean  

Example

{
  "code" : "...",
  "discountPlanCode" : "...",
  "invoiceCategoryCode" : "...",
  "invoiceSubCategoryCode" : "...",
  "expressionEl" : "...",
  "disabled" : true,
  "discountPlanItemType" : "FIXED",
  "discountValue" : 12345.0,
  "discountValueEL" : "...",
  "targetAccountingArticleCodes" : [ "...", "..." ],
  "pricePlanMatrixCode" : "...",
  "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" : "STORE_ONLY",
      "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" : "ENTITY",
      "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" : "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" : "..."
    } ]
  },
  "allowToNegate" : true,
  "description" : "...",
  "priority" : 12345,
  "accountingArticleCode" : "...",
  "applyByArticle" : true,
  "sequence" : 12345,
  "lastDiscount" : true
}