Package com.commercetools.api.models.cart

Interface TaxedPrice

public interface TaxedPrice
TaxedPrice
Example to create an instance using the builder pattern 

     TaxedPrice taxedPrice = TaxedPrice.builder()
             .totalNet(totalNetBuilder -> totalNetBuilder)
             .totalGross(totalGrossBuilder -> totalGrossBuilder)
             .plusTaxPortions(taxPortionsBuilder -> taxPortionsBuilder)
             .build()

  • Method Details

    • getTotalNet

      @NotNull @Valid @NotNull @Valid CentPrecisionMoney getTotalNet()

      Total net price of the Cart or Order.

      Returns:
      totalNet

    • getTotalGross

      @NotNull @Valid @NotNull @Valid CentPrecisionMoney getTotalGross()

      Total gross price of the Cart or Order.

      Returns:
      totalGross

    • getTaxPortions

      @NotNull @Valid @NotNull @Valid List<TaxPortion> getTaxPortions()

      Taxable portions added to the total net price.

      Calculated from the TaxRates.

      Returns:
      taxPortions

    • getTotalTax

      @Valid @Valid CentPrecisionMoney getTotalTax()

      Total tax applicable for the Cart or Order.

      Automatically calculated as the difference between the totalGross and totalNet values.

      Returns:
      totalTax

    • setTotalNet

      void setTotalNet(CentPrecisionMoney totalNet)

      Total net price of the Cart or Order.

      Parameters:
      totalNet - value to be set

    • setTotalGross

      void setTotalGross(CentPrecisionMoney totalGross)

      Total gross price of the Cart or Order.

      Parameters:
      totalGross - value to be set

    • setTaxPortions

      void setTaxPortions(TaxPortion... taxPortions)

      Taxable portions added to the total net price.

      Calculated from the TaxRates.

      Parameters:
      taxPortions - values to be set

    • setTaxPortions

      void setTaxPortions(List<TaxPortion> taxPortions)

      Taxable portions added to the total net price.

      Calculated from the TaxRates.

      Parameters:
      taxPortions - values to be set

    • setTotalTax

      void setTotalTax(CentPrecisionMoney totalTax)

      Total tax applicable for the Cart or Order.

      Automatically calculated as the difference between the totalGross and totalNet values.

      Parameters:
      totalTax - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static TaxedPriceBuilder builder()
      builder factory method for TaxedPrice
      Returns:
      builder

    • builder

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

    • withTaxedPrice

      default <T> T withTaxedPrice(Function<TaxedPrice,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<TaxedPrice> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference