com.avalara.avatax.services.tax
Class TaxLine

java.lang.Object
  extended by com.avalara.avatax.services.tax.TaxLine
All Implemented Interfaces:
java.io.Serializable

public class TaxLine
extends java.lang.Object
implements java.io.Serializable

Taxes for a specific document Line.

See Also:
ArrayOfTaxLine, GetTaxResult, Serialized Form

Constructor Summary
TaxLine()
          Initializes a new instance of the class.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 AccountingMethod getAccountingMethod()
          Gets the accountingMethod value for this TaxLine.
 BoundaryLevel getBoundaryLevel()
          The level of jurisdiction boundary precision used for the tax calculation.
static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
          Get Axis Custom Deserializer; this method is used internally by the adapter and not intended to be used by external implementation code.
 java.math.BigDecimal getDiscount()
          Discount amount applied to this line
 int getExemptCertId()
          Gets the exemptCertId value for this TaxLine.
 java.math.BigDecimal getExemption()
          Deprecated. See TaxDetail.getExemption().
 java.lang.String getNo()
          Line Number.
 java.math.BigDecimal getRate()
          Deprecated. See TaxDetail.getRate().
 java.util.Date getReportingDate()
          Gets the reportingDate value for this TaxLine.
static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
          Get Axis Custom Serializer; this method is used internally by the adapter and not intended to be used by external implementation code.
 java.math.BigDecimal getTax()
          The tax amount, i.e.
 java.math.BigDecimal getTaxable()
          Deprecated. See TaxDetail.getTaxable().
 java.math.BigDecimal getTaxCalculated()
          Gets the taxCalculated value for this TaxLine.
 java.lang.String getTaxCode()
          System Tax Code.
 java.util.Date getTaxDate()
          Gets the taxDate value for this TaxLine.
 ArrayOfTaxDetail getTaxDetails()
          Tax by jurisdiction.
static org.apache.axis.description.TypeDesc getTypeDesc()
          Return Axis type metadata object; this method is used internally by the adapter and not intended to be used by external implementation code.
 int hashCode()
          Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
 boolean isTaxability()
          Is the item taxable?
 boolean isTaxIncluded()
          True if tax is included in the line.
 void setAccountingMethod(AccountingMethod accountingMethod)
          Sets the accountingMethod value for this TaxLine.
 void setBoundaryLevel(BoundaryLevel boundaryLevel)
          The level of jurisdiction boundary precision used for the tax calculation.
 void setDiscount(java.math.BigDecimal discount)
          Discount amount applied to this line
 void setExemptCertId(int exemptCertId)
          Sets the exemptCertId value for this TaxLine.
 void setExemption(java.math.BigDecimal exemption)
          Deprecated. See TaxDetail.setExemption(java.math.BigDecimal).
 void setNo(java.lang.String no)
          Line Number.
 void setRate(java.math.BigDecimal rate)
          Deprecated. See TaxDetail.setRate(java.math.BigDecimal).
 void setReportingDate(java.util.Date reportingDate)
          Sets the reportingDate value for this TaxLine.
 void setTax(java.math.BigDecimal tax)
          The tax amount, i.e.
 void setTaxability(boolean taxability)
          Is the item taxable?
 void setTaxable(java.math.BigDecimal taxable)
          Deprecated. See TaxDetail.setTaxable(java.math.BigDecimal).
 void setTaxCalculated(java.math.BigDecimal taxCalculated)
          Sets the taxCalculated value for this TaxLine.
 void setTaxCode(java.lang.String taxCode)
          System Tax Code.
 void setTaxDate(java.util.Date taxDate)
          Sets the taxDate value for this TaxLine.
 void setTaxDetails(ArrayOfTaxDetail taxDetails)
          Tax by jurisdiction.
 void setTaxIncluded(boolean taxIncluded)
          True if tax is included in the line.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TaxLine

public TaxLine()
Initializes a new instance of the class.

Method Detail

getNo

public java.lang.String getNo()
Line Number.

Lines are added to a GetTaxRequest object when preparing a document for tax calculation. The line No unqiuely identifies a particular line item for the client.

Example:

 [Java]
  GetTaxRequest request = new GetTaxRequest();
  Line line = new Line(request);
  line.setNo("01");
  line = new Line(request);
  line.setNo("02");

  System.out.println("No Lines: " + request.getLines().getLine().length); // 2 Lines

  System.out.println("1st Line's Number: " + request.getLines().getLine(0).getNo()); // "01"

  System.out.println("1st Line's Number: " + request.getLines().getLine(1).getNo());  // "02"
  

Returns:
no

setNo

public void setNo(java.lang.String no)
Line Number.

Lines are added to a GetTaxRequest object when preparing a document for tax calculation. The line No unqiuely identifies a particular line item for the client.

Example:

 [Java]
  GetTaxRequest request = new GetTaxRequest();
  Line line = new Line(request);
  line.setNo("01");
  line = new Line(request);
  line.setNo("02");

  System.out.println("No Lines: " + request.getLines().getLine().length); // 2 Lines

  System.out.println("1st Line's Number: " + request.getLines().getLine(0).getNo()); // "01"

  System.out.println("1st Line's Number: " + request.getLines().getLine(1).getNo());  // "02"
  

Parameters:
no -

getTaxCode

public java.lang.String getTaxCode()
System Tax Code.

Returns:
taxCode

setTaxCode

public void setTaxCode(java.lang.String taxCode)
System Tax Code.

Parameters:
taxCode -

isTaxability

public boolean isTaxability()
Is the item taxable?

Returns:
taxability

setTaxability

public void setTaxability(boolean taxability)
Is the item taxable?

Parameters:
taxability -

getBoundaryLevel

public BoundaryLevel getBoundaryLevel()
The level of jurisdiction boundary precision used for the tax calculation.

Returns:
boundaryLevel

setBoundaryLevel

public void setBoundaryLevel(BoundaryLevel boundaryLevel)
The level of jurisdiction boundary precision used for the tax calculation.

Parameters:
boundaryLevel -

getExemption

public java.math.BigDecimal getExemption()
Deprecated. See TaxDetail.getExemption().

Exempt amount for this line.

Returns:
exemption

setExemption

public void setExemption(java.math.BigDecimal exemption)
Deprecated. See TaxDetail.setExemption(java.math.BigDecimal).

Exempt amount for this line.

Parameters:
exemption -

getDiscount

public java.math.BigDecimal getDiscount()
Discount amount applied to this line

Returns:
discount

setDiscount

public void setDiscount(java.math.BigDecimal discount)
Discount amount applied to this line

Parameters:
discount -

getTaxable

public java.math.BigDecimal getTaxable()
Deprecated. See TaxDetail.getTaxable().

The tax base, i.e. the taxable amount based on the discount and tax rules

Returns:
taxable

setTaxable

public void setTaxable(java.math.BigDecimal taxable)
Deprecated. See TaxDetail.setTaxable(java.math.BigDecimal).

The tax base, i.e. the taxable amount based on the discount and tax rules

Parameters:
taxable -

getRate

public java.math.BigDecimal getRate()
Deprecated. See TaxDetail.getRate().

The tax rate percentage (0.0 - 1.0).

Returns:
rate

setRate

public void setRate(java.math.BigDecimal rate)
Deprecated. See TaxDetail.setRate(java.math.BigDecimal).

The tax rate percentage (0.0 - 1.0).

Parameters:
rate -

getTax

public java.math.BigDecimal getTax()
The tax amount, i.e. the calculated tax amount (getTaxable() * getRate()).

Returns:
tax

setTax

public void setTax(java.math.BigDecimal tax)
The tax amount, i.e. the calculated tax amount (getTaxable() * getRate()).

Parameters:
tax -

getTaxCalculated

public java.math.BigDecimal getTaxCalculated()
Gets the taxCalculated value for this TaxLine.

Returns:
taxCalculated

setTaxCalculated

public void setTaxCalculated(java.math.BigDecimal taxCalculated)
Sets the taxCalculated value for this TaxLine.

Parameters:
taxCalculated -

getTaxDetails

public ArrayOfTaxDetail getTaxDetails()
Tax by jurisdiction.

Returns:
taxDetails

setTaxDetails

public void setTaxDetails(ArrayOfTaxDetail taxDetails)
Tax by jurisdiction.

Parameters:
taxDetails -

getExemptCertId

public int getExemptCertId()
Gets the exemptCertId value for this TaxLine.

Returns:
exemptCertId

setExemptCertId

public void setExemptCertId(int exemptCertId)
Sets the exemptCertId value for this TaxLine.

Parameters:
exemptCertId -

getTaxDate

public java.util.Date getTaxDate()
Gets the taxDate value for this TaxLine.

Returns:
taxDate

setTaxDate

public void setTaxDate(java.util.Date taxDate)
Sets the taxDate value for this TaxLine.

Parameters:
taxDate -

getReportingDate

public java.util.Date getReportingDate()
Gets the reportingDate value for this TaxLine.

Returns:
reportingDate

setReportingDate

public void setReportingDate(java.util.Date reportingDate)
Sets the reportingDate value for this TaxLine.

Parameters:
reportingDate -

getAccountingMethod

public AccountingMethod getAccountingMethod()
Gets the accountingMethod value for this TaxLine.

Returns:
accountingMethod

setAccountingMethod

public void setAccountingMethod(AccountingMethod accountingMethod)
Sets the accountingMethod value for this TaxLine.

Parameters:
accountingMethod -

isTaxIncluded

public boolean isTaxIncluded()
True if tax is included in the line.

Returns:
taxIncluded

setTaxIncluded

public void setTaxIncluded(boolean taxIncluded)
True if tax is included in the line.

Parameters:
taxIncluded -

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.

Overrides:
hashCode in class java.lang.Object
Returns:
hash code for this GetTaxRequest object
See Also:
Object.hashCode()

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()
Return Axis type metadata object; this method is used internally by the adapter and not intended to be used by external implementation code.

Returns:
Type Description

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)
Get Axis Custom Serializer; this method is used internally by the adapter and not intended to be used by external implementation code.

Parameters:
mechType -
_javaType -
_xmlType -
Returns:
Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)
Get Axis Custom Deserializer; this method is used internally by the adapter and not intended to be used by external implementation code.

Parameters:
mechType -
_javaType -
_xmlType -
Returns:
Deserializer