TaxRate (IPP V3 Java DevKit 3.0.0 API)

java.lang.Object
- com.intuit.ipp.data.IntuitEntity
- - com.intuit.ipp.data.TaxRate

All Implemented Interfaces:: IEntity, Serializable, org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2

public class TaxRate
extends IntuitEntity
implements Serializable, org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2

Product: ALL Description: A sales tax rate specifies the tax rate for the specific TaxCode.[br]See [a href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01100_Global_Tax_Model"]Global Tax Model[/a].

Java class for TaxRate complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="TaxRate">
   <complexContent>
     <extension base="{http://schema.intuit.com/finance/v3}IntuitEntity">
       <sequence>
         <element name="Name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Active" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="RateValue" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
         <element name="AgencyRef" type="{http://schema.intuit.com/finance/v3}ReferenceType" minOccurs="0"/>
         <element name="TaxReturnLineRef" type="{http://schema.intuit.com/finance/v3}ReferenceType" minOccurs="0"/>
         <element name="EffectiveTaxRate" type="{http://schema.intuit.com/finance/v3}EffectiveTaxRate" maxOccurs="unbounded" minOccurs="0"/>
         <element name="SpecialTaxType" type="{http://schema.intuit.com/finance/v3}SpecialTaxTypeEnum" minOccurs="0"/>
         <element name="DisplayType" type="{http://schema.intuit.com/finance/v3}TaxRateDisplayTypeEnum" minOccurs="0"/>
         <element name="TaxRateEx" type="{http://schema.intuit.com/finance/v3}IntuitAnyType" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`active`
`protected ReferenceType`	`agencyRef`
`protected String`	`description`
`protected TaxRateDisplayTypeEnum`	`displayType`
`protected List<EffectiveTaxRate>`	`effectiveTaxRate`
`protected String`	`name`
`protected BigDecimal`	`rateValue`
`protected SpecialTaxTypeEnum`	`specialTaxType`
`protected IntuitAnyType`	`taxRateEx`
`protected ReferenceType`	`taxReturnLineRef`

Fields inherited from class com.intuit.ipp.data.IntuitEntity
attachableRef, customField, domain, id, metaData, sparse, status, syncToken

Constructor Summary

Constructors
Constructor and Description

TaxRate()

Constructors
Constructor and Description
`TaxRate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object object)`
`boolean`	`equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)`
`ReferenceType`	`getAgencyRef()` Gets the value of the agencyRef property.
`String`	`getDescription()` Gets the value of the description property.
`TaxRateDisplayTypeEnum`	`getDisplayType()` Gets the value of the displayType property.
`List<EffectiveTaxRate>`	`getEffectiveTaxRate()` Gets the value of the effectiveTaxRate property.
`String`	`getName()` Gets the value of the name property.
`BigDecimal`	`getRateValue()` Gets the value of the rateValue property.
`SpecialTaxTypeEnum`	`getSpecialTaxType()` Gets the value of the specialTaxType property.
`IntuitAnyType`	`getTaxRateEx()` Gets the value of the taxRateEx property.
`ReferenceType`	`getTaxReturnLineRef()` Gets the value of the taxReturnLineRef property.
`int`	`hashCode()`
`int`	`hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)`
`Boolean`	`isActive()` Gets the value of the active property.
`void`	`setActive(Boolean value)` Sets the value of the active property.
`void`	`setAgencyRef(ReferenceType value)` Sets the value of the agencyRef property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setDisplayType(TaxRateDisplayTypeEnum value)` Sets the value of the displayType property.
`void`	`setEffectiveTaxRate(List<EffectiveTaxRate> effectiveTaxRate)` Sets the value of the effectiveTaxRate property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setRateValue(BigDecimal value)` Sets the value of the rateValue property.
`void`	`setSpecialTaxType(SpecialTaxTypeEnum value)` Sets the value of the specialTaxType property.
`void`	`setTaxRateEx(IntuitAnyType value)` Sets the value of the taxRateEx property.
`void`	`setTaxReturnLineRef(ReferenceType value)` Sets the value of the taxReturnLineRef property.

Methods inherited from class com.intuit.ipp.data.IntuitEntity
getAttachableRef, getCustomField, getDomain, getId, getMetaData, getStatus, getSyncToken, isSparse, setAttachableRef, setCustomField, setDomain, setId, setMetaData, setSparse, setStatus, setSyncToken

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

- Field Detail
  - name
```
protected String name
```
  - description
```
protected String description
```
  - active
```
protected Boolean active
```
  - rateValue
```
protected BigDecimal rateValue
```
  - agencyRef
```
protected ReferenceType agencyRef
```
  - taxReturnLineRef
```
protected ReferenceType taxReturnLineRef
```
  - effectiveTaxRate
```
protected List<EffectiveTaxRate> effectiveTaxRate
```
  - specialTaxType
```
protected SpecialTaxTypeEnum specialTaxType
```
  - displayType
```
protected TaxRateDisplayTypeEnum displayType
```
  - taxRateEx
```
protected IntuitAnyType taxRateEx
```
- Constructor Detail
  - TaxRate
```
public TaxRate()
```
- Method Detail
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    
    value - allowed object is String
  - isActive
```
public Boolean isActive()
```
    Gets the value of the active property.
    
    Returns:
    
    possible object is Boolean
  - setActive
```
public void setActive(Boolean value)
```
    Sets the value of the active property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getRateValue
```
public BigDecimal getRateValue()
```
    Gets the value of the rateValue property.
    
    Returns:
    
    possible object is BigDecimal
  - setRateValue
```
public void setRateValue(BigDecimal value)
```
    Sets the value of the rateValue property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getAgencyRef
```
public ReferenceType getAgencyRef()
```
    Gets the value of the agencyRef property.
    
    Returns:
    
    possible object is ReferenceType
  - setAgencyRef
```
public void setAgencyRef(ReferenceType value)
```
    Sets the value of the agencyRef property.
    
    Parameters:
    
    value - allowed object is ReferenceType
  - getTaxReturnLineRef
```
public ReferenceType getTaxReturnLineRef()
```
    Gets the value of the taxReturnLineRef property.
    
    Returns:
    
    possible object is ReferenceType
  - setTaxReturnLineRef
```
public void setTaxReturnLineRef(ReferenceType value)
```
    Sets the value of the taxReturnLineRef property.
    
    Parameters:
    
    value - allowed object is ReferenceType
  - getEffectiveTaxRate
```
public List<EffectiveTaxRate> getEffectiveTaxRate()
```
    Gets the value of the effectiveTaxRate property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the effectiveTaxRate property.
    For example, to add a new item, do as follows:
```
    getEffectiveTaxRate().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list EffectiveTaxRate
  - getSpecialTaxType
```
public SpecialTaxTypeEnum getSpecialTaxType()
```
    Gets the value of the specialTaxType property.
    
    Returns:
    
    possible object is SpecialTaxTypeEnum
  - setSpecialTaxType
```
public void setSpecialTaxType(SpecialTaxTypeEnum value)
```
    Sets the value of the specialTaxType property.
    
    Parameters:
    
    value - allowed object is SpecialTaxTypeEnum
  - getDisplayType
```
public TaxRateDisplayTypeEnum getDisplayType()
```
    Gets the value of the displayType property.
    
    Returns:
    
    possible object is TaxRateDisplayTypeEnum
  - setDisplayType
```
public void setDisplayType(TaxRateDisplayTypeEnum value)
```
    Sets the value of the displayType property.
    
    Parameters:
    
    value - allowed object is TaxRateDisplayTypeEnum
  - getTaxRateEx
```
public IntuitAnyType getTaxRateEx()
```
    Gets the value of the taxRateEx property.
    
    Returns:
    
    possible object is IntuitAnyType
  - setTaxRateEx
```
public void setTaxRateEx(IntuitAnyType value)
```
    Sets the value of the taxRateEx property.
    
    Parameters:
    
    value - allowed object is IntuitAnyType
  - setEffectiveTaxRate
```
public void setEffectiveTaxRate(List<EffectiveTaxRate> effectiveTaxRate)
```
    Sets the value of the effectiveTaxRate property.
    
    Parameters:
    
    effectiveTaxRate - allowed object is EffectiveTaxRate
  - equals
```
public boolean equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator,
                      org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator,
                      Object object,
                      org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)
```
    Specified by:
    
    equals in interface org.jvnet.jaxb2_commons.lang.Equals2
    
    Overrides:
    
    equals in class IntuitEntity
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class IntuitEntity
  - hashCode
```
public int hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                    org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)
```
    Specified by:
    
    hashCode in interface org.jvnet.jaxb2_commons.lang.HashCode2
    
    Overrides:
    
    hashCode in class IntuitEntity
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class IntuitEntity

Class TaxRate

Field Summary

Fields inherited from class com.intuit.ipp.data.IntuitEntity

Constructor Summary

Method Summary

Methods inherited from class com.intuit.ipp.data.IntuitEntity

Methods inherited from class java.lang.Object

Field Detail

name

description

active

rateValue

agencyRef

taxReturnLineRef

effectiveTaxRate

specialTaxType

displayType

taxRateEx

Constructor Detail

TaxRate

Method Detail

getName

setName

getDescription

setDescription

isActive

setActive

getRateValue

setRateValue

getAgencyRef

setAgencyRef

getTaxReturnLineRef

setTaxReturnLineRef

getEffectiveTaxRate

getSpecialTaxType

setSpecialTaxType

getDisplayType

setDisplayType

getTaxRateEx

setTaxRateEx

setEffectiveTaxRate

equals

equals

hashCode

hashCode