discountPlanDto Data Type

The Class DiscountPlanDto.

Namespace
(Default)
Properties
name data type type namespace min/max occurs wrapped by description
customFields customFieldsDto element 0/1   The custom fields.
defaultDuration int element 0/1   Length of effectivity. If start date is not null and end date is null, we use the defaultDuration from the discount plan. If start date is null, and defaultDuration is not null, defaultDuration is ignored.
discountPlanItem discountPlanItemDto element 0/unbounded discountPlanItems  
durationUnit durationPeriodUnitEnum element 0/1   Unit of duration
endDate dateTime element 0/1   Effective end date
startDate dateTime element 0/1   Effective start date
Properties inherited from enableBusinessDto
code string attribute 1/1   The code
description string attribute 0/1   The description
id long attribute 0/1   The id.
auditable auditableDto element 0/1    
auditableField auditableFieldDto element 0/unbounded auditableFields  
disabled boolean element 0/1   Is entity disabled. Value is ignored in Update action - use enable/disable API instead.
updatedCode string element 0/1   The updated code.

Example

<DiscountPlan code="..." description="..." id="...">
  <startDate>...</startDate>
  <endDate>...</endDate>
  <defaultDuration>...</defaultDuration>
  <durationUnit>...</durationUnit>
  <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>
  <discountPlanItems>
    <discountPlanItem code="...">
      <discountPlanCode>...</discountPlanCode>
      <invoiceCategoryCode>...</invoiceCategoryCode>
      <invoiceSubCategoryCode>...</invoiceSubCategoryCode>
      <expressionEl>...</expressionEl>
      <expressionElSpark>...</expressionElSpark>
      <disabled>...</disabled>
      <discountPlanItemType>...</discountPlanItemType>
      <discountValue>...</discountValue>
      <discountValueEL>...</discountValueEL>
      <discountValueElSpark>...</discountValueElSpark>
      <customFields>
        <customField/>
        <inheritedCustomField/>
      </customFields>
    </discountPlanItem>
  </discountPlanItems>
  <disabled>...</disabled>
  <auditable created="..." creator="..." updated="..." updater="..."/>
  <auditableFields>
    <auditableField actor="..." changeOrigin="..." code="..." created="..." currentState="..." description="..." entityClass="..." fieldName="..." id="..." originName="..." previousState="...">
      <auditable/>
      <auditableFields>
        <auditableField/>
      </auditableFields>
      <updatedCode>...</updatedCode>
    </auditableField>
  </auditableFields>
  <updatedCode>...</updatedCode>
</DiscountPlan>