discountPlanItemDto Data Type

Discount plan item

Namespace
(Default)
Properties
name data type type namespace min/max occurs constraints description
code string attribute 1/1 required Code
accountingCode string element 0/1   Accounting code
customFields customFieldsDto element 0/1   The custom fields.
disabled boolean element 0/1   Is entity disabled. Value is ignored in Update action - use enable/disable API instead.
discountPlanCode string element 1/1 required Discount plan code
discountPlanItemType discountPlanItemTypeEnum element 0/1   Type of discount, whether absolute or percentage.
discountValue decimal element 0/1   The absolute or percentage discount amount.
discountValueEL string element 0/1   The absolute or percentage discount amount EL.
discountValueElSpark string element 0/1   Expression to calculate discount percentage - for Spark
expressionEl string element 0/1   Expression to determine if discount applies
expressionElSpark string element 0/1   Expression to determine if discount applies - for Spark
invoiceCategoryCode string element 0/1   Invoice category code
invoiceSubCategoryCode string element 0/1   Invoice sub category code

Example

<DiscountPlanItem code="...">
  <discountPlanCode>...</discountPlanCode>
  <invoiceCategoryCode>...</invoiceCategoryCode>
  <invoiceSubCategoryCode>...</invoiceSubCategoryCode>
  <expressionEl>...</expressionEl>
  <expressionElSpark>...</expressionElSpark>
  <disabled>...</disabled>
  <discountPlanItemType>...</discountPlanItemType>
  <discountValue>...</discountValue>
  <discountValueEL>...</discountValueEL>
  <discountValueElSpark>...</discountValueElSpark>
  <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>
</DiscountPlanItem>