java.lang.Object
- com.broadleafcommerce.tax.domain.TaxDetail

All Implemented Interfaces:

Serializable
```
public class TaxDetail
extends Object
implements Serializable
```
Detailed tax information for a item, via TaxInfo. There would be separate TaxDetail for every tax, i.e., state sales tax, city sales tax.

Author:

Chad Harchar (charchar)

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class TaxDetail.TaxDetailBuilder

Constructor Summary

Constructors
Modifier	Constructor	Description
	`TaxDetail()`
`protected`	`TaxDetail(String country, String region, String jurisdictionName, String jurisdictionType, String taxName, javax.money.MonetaryAmount taxableAmount, BigDecimal rate, javax.money.MonetaryAmount taxCalculated, String transactionId, Map<String,Object> attributes, boolean isVat, boolean isExempt)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static TaxDetail.TaxDetailBuilder`	`builder()`
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`Map<String,Object>`	`getAttributes()`	Additional attributes for this tax detail
`String`	`getCountry()`	The country for this tax.
`String`	`getJurisdictionName()`	The jurisdiction name.
`String`	`getJurisdictionType()`	The jurisdiction type, e.g.
`BigDecimal`	`getRate()`	The rate of this tax.
`String`	`getRegion()`	The region for this tax.
`javax.money.MonetaryAmount`	`getTaxableAmount()`	The amount that was taxable to determine the calculated tax.
`javax.money.MonetaryAmount`	`getTaxCalculated()`	The calculated tax for this detail.
`String`	`getTaxName()`	The name of the tax.
`String`	`getTransactionId()`	The transaction ID for this tax detail.
`int`	`hashCode()`
`boolean`	`isExempt()`	Indicates if this is exempt from taxes, usually based on a tax exemption code.
`boolean`	`isVat()`	Indicates if this is VAT tax
`void`	`setAttributes(Map<String,Object> attributes)`	Additional attributes for this tax detail
`void`	`setCountry(String country)`	The country for this tax.
`void`	`setExempt(boolean isExempt)`	Indicates if this is exempt from taxes, usually based on a tax exemption code.
`void`	`setJurisdictionName(String jurisdictionName)`	The jurisdiction name.
`void`	`setJurisdictionType(String jurisdictionType)`	The jurisdiction type, e.g.
`void`	`setRate(BigDecimal rate)`	The rate of this tax.
`void`	`setRegion(String region)`	The region for this tax.
`void`	`setTaxableAmount(javax.money.MonetaryAmount taxableAmount)`	The amount that was taxable to determine the calculated tax.
`void`	`setTaxCalculated(javax.money.MonetaryAmount taxCalculated)`	The calculated tax for this detail.
`void`	`setTaxName(String taxName)`	The name of the tax.
`void`	`setTransactionId(String transactionId)`	The transaction ID for this tax detail.
`void`	`setVat(boolean isVat)`	Indicates if this is VAT tax
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TaxDetail
```
public TaxDetail()
```
  - TaxDetail
```
protected TaxDetail(String country,
                    String region,
                    String jurisdictionName,
                    String jurisdictionType,
                    String taxName,
                    javax.money.MonetaryAmount taxableAmount,
                    BigDecimal rate,
                    javax.money.MonetaryAmount taxCalculated,
                    String transactionId,
                    Map<String,Object> attributes,
                    boolean isVat,
                    boolean isExempt)
```
- Method Detail
  - builder
```
public static TaxDetail.TaxDetailBuilder builder()
```
  - getCountry
```
public String getCountry()
```
    The country for this tax.
    
    Returns:
    
    The country for this tax.
  - getRegion
```
public String getRegion()
```
    The region for this tax. This is often something like a two digit state code, e.g. (CA, TX, NY, etc.)
    
    Returns:
    
    The region for this tax.
  - getJurisdictionName
```
public String getJurisdictionName()
```
    The jurisdiction name. This may be a state, city, county, etc.
    
    Returns:
    
    The tax jurisdiction name.
  - getJurisdictionType
```
public String getJurisdictionType()
```
    The jurisdiction type, e.g. city, state, county, etc.
  - getTaxName
```
public String getTaxName()
```
    The name of the tax.
    
    Returns:
    
    The name of the tax.
  - getTaxableAmount
```
public javax.money.MonetaryAmount getTaxableAmount()
```
    The amount that was taxable to determine the calculated tax.
    
    Returns:
    
    The amount that was taxable to determine the calculated tax.
  - getRate
```
public BigDecimal getRate()
```
    The rate of this tax.
    
    Returns:
    
    The rate of this tax.
  - getTaxCalculated
```
public javax.money.MonetaryAmount getTaxCalculated()
```
    The calculated tax for this detail.
    
    Returns:
    
    The calculated tax for this detail.
  - getTransactionId
```
public String getTransactionId()
```
    The transaction ID for this tax detail. Used to reconcile this tax detail with a specific transaction when using an external tax provider.
  - getAttributes
```
public Map<String,Object> getAttributes()
```
    Additional attributes for this tax detail
  - isVat
```
public boolean isVat()
```
    Indicates if this is VAT tax
  - isExempt
```
public boolean isExempt()
```
    Indicates if this is exempt from taxes, usually based on a tax exemption code.
  - setCountry
```
public void setCountry(String country)
```
    The country for this tax.
    
    Parameters:
    
    country - The country for this tax.
  - setRegion
```
public void setRegion(String region)
```
    The region for this tax. This is often something like a two digit state code, e.g. (CA, TX, NY, etc.)
    
    Parameters:
    
    region - The region for this tax.
  - setJurisdictionName
```
public void setJurisdictionName(String jurisdictionName)
```
    The jurisdiction name. This may be a state, city, county, etc.
    
    Parameters:
    
    jurisdictionName - The tax jurisdiction name.
  - setJurisdictionType
```
public void setJurisdictionType(String jurisdictionType)
```
    The jurisdiction type, e.g. city, state, county, etc.
  - setTaxName
```
public void setTaxName(String taxName)
```
    The name of the tax.
    
    Parameters:
    
    taxName - The name of the tax.
  - setTaxableAmount
```
public void setTaxableAmount(javax.money.MonetaryAmount taxableAmount)
```
    The amount that was taxable to determine the calculated tax.
    
    Parameters:
    
    taxableAmount - The amount that was taxable to determine the calculated tax.
  - setRate
```
public void setRate(BigDecimal rate)
```
    The rate of this tax.
    
    Parameters:
    
    The - rate of this tax.
  - setTaxCalculated
```
public void setTaxCalculated(javax.money.MonetaryAmount taxCalculated)
```
    The calculated tax for this detail.
    
    Parameters:
    
    taxCalculated - The calculated tax for this detail.
  - setTransactionId
```
public void setTransactionId(String transactionId)
```
    The transaction ID for this tax detail. Used to reconcile this tax detail with a specific transaction when using an external tax provider.
  - setAttributes
```
public void setAttributes(Map<String,Object> attributes)
```
    Additional attributes for this tax detail
  - setVat
```
public void setVat(boolean isVat)
```
    Indicates if this is VAT tax
  - setExempt
```
public void setExempt(boolean isExempt)
```
    Indicates if this is exempt from taxes, usually based on a tax exemption code.
  - 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

Class TaxDetail

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TaxDetail

TaxDetail

Method Detail

builder

getCountry

getRegion

getJurisdictionName

getJurisdictionType

getTaxName

getTaxableAmount

getRate

getTaxCalculated

getTransactionId

getAttributes

isVat

isExempt

setCountry

setRegion

setJurisdictionName

setJurisdictionType

setTaxName

setTaxableAmount

setRate

setTaxCalculated

setTransactionId

setAttributes

setVat

setExempt

equals

canEqual

hashCode

toString