Package net.pricefx.formulaengine.scripting.queryapi.tables

Interface QapiRebateLineItem

All Superinterfaces:
CalculableLineItemColumns, ClicColumns, InputsColumns, Map<String,SelectableExpression>, OutputsColumns, PersistedObjectColumns, Tables.Columns, Tables.Table
public interface QapiRebateLineItem extends Tables.Table, PersistedObjectColumns, ClicColumns
Table of the line items of one Rebate Agreement. Each row is one line item, which holds the rebate conditions negotiated for one Rebate Type, or one folder.

Example: 


 def q = api.queryApi()
 def t = q.tables().rebateLineItems("MyRebateAgreement")

 return q.source(t, [t.lineId(), t.rebateTypeUniqueName(), t.startDate(), t.endDate(), t.payoutDate()],
         t.rebateTypeUniqueName().isNotNull())
         .stream { it.collect { it } }
Since:
14.0 - Caribou Lou
See Also:

  • Method Details

    • rebateTypeUniqueName

      SelectableExpression rebateTypeUniqueName()
      Returns the unique name of the Rebate Type that the line item represents and calculates.

      Folders have no Rebate Type.

      Returns:
      the rebateTypeUniqueName column as a String expression
      See Also:

    • rebateTypeLabel

      SelectableExpression rebateTypeLabel()
      Returns the label of the Rebate Type of the line item.
      Returns:
      the rebateTypeLabel column as a String expression
      See Also:

    • customerGroup

      SelectableExpression customerGroup()
      Returns the group of customers for whom the rebate conditions on the line item are negotiated.

      The value is a customer group object, not a String.

      Returns:
      the customerGroup column as a Pojo expression
      See Also:

    • productGroup

      SelectableExpression productGroup()
      Returns the group of products for which the rebate conditions on the line item are negotiated.

      The value is a product group object, not a String.

      Returns:
      the productGroup column as a Pojo expression
      See Also:

    • startDate

      SelectableExpression startDate()
      Returns the first day of validity of the conditions on the line item.

      By default, the value is copied from the start date of the Rebate Agreement.

      Returns:
      the startDate column as a DateOnly expression
      See Also:

    • endDate

      SelectableExpression endDate()
      Returns the last day of validity of the conditions on the line item.

      By default, the value is copied from the end date of the Rebate Agreement.

      Returns:
      the endDate column as a DateOnly expression
      See Also:

    • payoutDate

      SelectableExpression payoutDate()
      Returns the date on which the customer expects to receive the rebate.

      By default, the value is copied from the payout date of the Rebate Agreement.

      Returns:
      the payoutDate column as a DateOnly expression

    • calculationBaseJson

      SelectableExpression calculationBaseJson()
      Returns the Datamart data slice that defines the calculation base of the line item.

      The value is the data slice serialized as JSON.

      Returns:
      the calculationBaseJson column as a String expression

    • simulationType

      SelectableExpression simulationType()
      Returns the simulation type of the line item.
      Returns:
      the simulationType column as a String expression