Package com.commercetools.api.models.cart

Interface CartSetCartTotalTaxAction

All Superinterfaces:
CartUpdateAction, ResourceUpdateAction<CartUpdateAction>
public interface CartSetCartTotalTaxAction extends CartUpdateAction

Can be used if the Cart has the ExternalAmount TaxMode. This update action adds the taxedPrice field to the Cart. It sets the totalGross amount, and Composable Commerce calculates the totalNet and totalTax values based on the provided externalTotalGross. You must use this update action after any price-affecting change occurs within the Cart.

Example to create an instance using the builder pattern 

     CartSetCartTotalTaxAction cartSetCartTotalTaxAction = CartSetCartTotalTaxAction.builder()
             .externalTotalGross(externalTotalGrossBuilder -> externalTotalGrossBuilder)
             .build()

  • Field Details

    • SET_CART_TOTAL_TAX

      static final String SET_CART_TOTAL_TAX
      discriminator value for CartSetCartTotalTaxAction
      See Also:

  • Method Details

    • getExternalTotalGross

      @NotNull @Valid @NotNull @Valid Money getExternalTotalGross()

      The total gross amount of the Cart, including tax. This value is used to calculate the totalNet and totalTax fields of the Cart's taxedPrice.

      Returns:
      externalTotalGross

    • getExternalTaxPortions

      @Valid @Valid List<TaxPortionDraft> getExternalTaxPortions()

      Set if the externalTotalGross price is a sum of portions with different tax rates.

      Returns:
      externalTaxPortions

    • setExternalTotalGross

      void setExternalTotalGross(Money externalTotalGross)

      The total gross amount of the Cart, including tax. This value is used to calculate the totalNet and totalTax fields of the Cart's taxedPrice.

      Parameters:
      externalTotalGross - value to be set

    • setExternalTaxPortions

      void setExternalTaxPortions(TaxPortionDraft... externalTaxPortions)

      Set if the externalTotalGross price is a sum of portions with different tax rates.

      Parameters:
      externalTaxPortions - values to be set

    • setExternalTaxPortions

      void setExternalTaxPortions(List<TaxPortionDraft> externalTaxPortions)

      Set if the externalTotalGross price is a sum of portions with different tax rates.

      Parameters:
      externalTaxPortions - values to be set

    • of

      static CartSetCartTotalTaxAction of()
      factory method
      Returns:
      instance of CartSetCartTotalTaxAction

    • of

      static CartSetCartTotalTaxAction of(CartSetCartTotalTaxAction template)
      factory method to create a shallow copy CartSetCartTotalTaxAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      CartSetCartTotalTaxAction copyDeep()
      Specified by:
      copyDeep in interface CartUpdateAction

    • deepCopy

      @Nullable static CartSetCartTotalTaxAction deepCopy(@Nullable CartSetCartTotalTaxAction template)
      factory method to create a deep copy of CartSetCartTotalTaxAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static CartSetCartTotalTaxActionBuilder builder()
      builder factory method for CartSetCartTotalTaxAction
      Returns:
      builder

    • builder

      static CartSetCartTotalTaxActionBuilder builder(CartSetCartTotalTaxAction template)
      create builder for CartSetCartTotalTaxAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withCartSetCartTotalTaxAction

      default <T> T withCartSetCartTotalTaxAction(Function<CartSetCartTotalTaxAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<CartSetCartTotalTaxAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference