Package com.broadleafcommerce.tax.domain

Class TaxItem

java.lang.Object
com.broadleafcommerce.tax.domain.TaxItem
All Implemented Interfaces:
Serializable
public class TaxItem extends Object implements Serializable
An item to be taxed.
Author:
Chad Harchar (charchar)
See Also:

  • Constructor Details

    • TaxItem

      public TaxItem()

  • Method Details

    • getItemId

      public String getItemId()
      The unique identifier for this line item.
      Returns:
      The unique identifier for this line item.

    • getType

      public String getType()
      Specifies the kind of item this is such as FULFILLMENT or ORDER.
      Returns:
      The type of this item
      See Also:

    • getSkuCode

      public String getSkuCode()
      The sku code for this item.
      Returns:
      The sku code for this item.

    • getTaxCode

      public String getTaxCode()
      The tax code for this item.
      Returns:
      The tax code for this item.

    • getJurisType

      public String getJurisType()
      The jurisdiction type for this item.
      Returns:
      The jurisdiction type for this item.

    • getJurisName

      public String getJurisName()
      The jurisdiction name for this item.
      Returns:
      The jurisdiction name for this item.

    • getJurisCode

      public String getJurisCode()
      The jurisdiction code for this item.
      Returns:
      The jurisdiction code for this item.

    • getDescription

      public String getDescription()
      The description for this item.
      Returns:
      The description for this item.

    • getSubtotal

      public javax.money.MonetaryAmount getSubtotal()
      The subtotal of this item being paid for by a customer.
      Returns:
      The subtotal of this item being paid for by a customer.

    • isTaxable

      public boolean isTaxable()
      Is this item tax exempt? Default is true

    • getTaxIncluded

      public Boolean getTaxIncluded()
      Indicates if the taxes are already included in the price (subtotal). This is common for VAT taxes, especially in Europe, where prices displayed have to include VAT. Some tax providers will use this to back-calculate taxes from the price for reporting purposes.
      Returns:
      Boolean value indicating whether taxes are included in the subtotal (default null)

    • getQuantity

      public int getQuantity()
      The tax item quantity. Default is 1

    • getAttributes

      public Map<String,Object> getAttributes()
      Any additional attributes for this tax item.

    • setItemId

      public void setItemId(String itemId)
      The unique identifier for this line item.
      Parameters:
      itemId - The unique identifier for this line item.

    • setType

      public void setType(String type)
      Specifies the kind of item this is such as FULFILLMENT or ORDER.
      Parameters:
      type - The type of this item
      See Also:

    • setSkuCode

      public void setSkuCode(String skuCode)
      The sku code for this item.
      Parameters:
      skuCode - The sku code for this item.

    • setTaxCode

      public void setTaxCode(String taxCode)
      The tax code for this item.
      Parameters:
      taxCode - The tax code for this item.

    • setJurisType

      public void setJurisType(String jurisType)
      The jurisdiction type for this item.
      Parameters:
      jurisType - The jurisdiction type for this item.

    • setJurisName

      public void setJurisName(String jurisName)
      The jurisdiction name for this item.
      Parameters:
      jurisName - The jurisdiction name for this item.

    • setJurisCode

      public void setJurisCode(String jurisCode)
      The jurisdiction code for this item.
      Parameters:
      jurisCode - The jurisdiction code for this item.

    • setDescription

      public void setDescription(String description)
      The description for this item.
      Parameters:
      description - The description for this item.

    • setSubtotal

      public void setSubtotal(javax.money.MonetaryAmount subtotal)
      The subtotal of this item being paid for by a customer.
      Parameters:
      subtotal - The subtotal of this item being paid for by a customer.

    • setTaxable

      public void setTaxable(boolean taxable)
      Is this item tax exempt? Default is true

    • setTaxIncluded

      public void setTaxIncluded(Boolean taxIncluded)
      Indicates if the taxes are already included in the price (subtotal). This is common for VAT taxes, especially in Europe, where prices displayed have to include VAT. Some tax providers will use this to back-calculate taxes from the price for reporting purposes.
      Parameters:
      taxIncluded - indicates if taxes are already included in the provided subtotal

    • setQuantity

      public void setQuantity(int quantity)
      The tax item quantity. Default is 1

    • setAttributes

      public void setAttributes(Map<String,Object> attributes)
      Any additional attributes for this tax item.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object