com.avalara.avatax.services.tax
Class GetTaxResult

java.lang.Object
  extended by com.avalara.avatax.services.tax.BaseResult
      extended by com.avalara.avatax.services.tax.GetTaxResult
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
AdjustTaxResult

public class GetTaxResult
extends BaseResult
implements java.io.Serializable

Result data returned from TaxSvcSoap.getTax(com.avalara.avatax.services.tax.GetTaxRequest).

See Also:
GetTaxRequest, Serialized Form

Constructor Summary
GetTaxResult()
          Initializes a new instance of the class.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Determines whether the specified Object is equal to the current Object.
 java.lang.String getAdjustmentDescription()
          Gets the AdjustTaxRequest.adjustmentDescription value for this GetTaxResult.
 int getAdjustmentReason()
          Gets the AdjustTaxRequest.adjustmentReason value for this GetTaxResult.
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.lang.String getDocCode()
          Gets the internal reference code used by the client application; This is used for operations such as Post and GetTaxHistory.
 java.util.Date getDocDate()
          Gets the date on the invoice, purchase order, etc.
 java.lang.String getDocId()
          Gets the Document ID.
 DocStatus getDocStatus()
          Gets the document's status after the tax calculation.
 DocumentType getDocType()
          Gets the Document Type.
 int getHashCode()
          Gets the hashCode value for this GetTaxResult.
 boolean getLocked()
          Gets the locked value for this GetTaxResult.
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.
 ArrayOfTaxAddress getTaxAddresses()
          Gets the taxAddresses value for this GetTaxResult.
 java.util.Date getTaxDate()
          Gets the taxDate value for this GetTaxResult.
 ArrayOfTaxLine getTaxLines()
          Gets the Tax broken down by individual TaxLine.
 ArrayOfTaxDetail getTaxSummary()
          Gets the taxSummary value for this GetTaxResult.
 java.util.Calendar getTimestamp()
          Date of the last status change on the document (i.e.
 java.math.BigDecimal getTotalAmount()
          Gets the sum of all line Line.getAmount() values.
 java.math.BigDecimal getTotalDiscount()
          Gets the sum of all TaxLine TaxLine.getDiscount() amounts; Typically it will equal the requested Discount, but, but it is possible that no lines were marked as discounted.
 java.math.BigDecimal getTotalExemption()
          Deprecated. See TaxDetail.getExemption().
 java.math.BigDecimal getTotalTax()
          Gets the total tax for the document.
 java.math.BigDecimal getTotalTaxable()
          Deprecated. See TaxDetail.getTaxable().
 java.math.BigDecimal getTotalTaxCalculated()
          Gets the totalTaxCalculated value for this GetTaxResult.
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 getVersion()
          Gets the version value for this GetTaxResult.
 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 isReconciled()
          True if the document has been reconciled; Only committed documents can be reconciled.
 void setAdjustmentDescription(java.lang.String adjustmentDescription)
          Sets the adjustmentDescription value for this GetTaxResult.
 void setAdjustmentReason(int adjustmentReason)
          Sets the adjustmentReason value for this GetTaxResult.
 void setDocCode(java.lang.String docCode)
          Sets the internal reference code used by the client application; This is used for operations such as Post and GetTaxHistory.
 void setDocDate(java.util.Date docDate)
          Sets the date on the invoice, purchase order, etc.
 void setDocId(java.lang.String docId)
          Sets the Document ID.
 void setDocStatus(DocStatus docStatus)
          Sets the document's status after the tax calculation.
 void setDocType(DocumentType docType)
          Sets the the Document Type.
 void setHashCode(int hashCode)
          Sets the hashCode value for this GetTaxResult.
 void setLocked(boolean locked)
          Sets the locked value for this GetTaxResult.
 void setReconciled(boolean reconciled)
          True if the document has been reconciled; Only committed documents can be reconciled.
 void setTaxAddresses(ArrayOfTaxAddress taxAddresses)
          Sets the taxAddresses value for this GetTaxResult.
 void setTaxDate(java.util.Date taxDate)
          Sets the taxDate value for this GetTaxResult.
 void setTaxLines(ArrayOfTaxLine taxLines)
          Sets the Tax broken down by individual TaxLine.
 void setTaxSummary(ArrayOfTaxDetail taxSummary)
          Sets the taxSummary value for this GetTaxResult.
 void setTimestamp(java.util.Calendar timestamp)
          Date of the last status change on the document (i.e.
 void setTotalAmount(java.math.BigDecimal totalAmount)
          Sets the sum of all line Line.getAmount() values.
 void setTotalDiscount(java.math.BigDecimal totalDiscount)
          Sets the sum of all TaxLine TaxLine.getDiscount() amounts; Typically it will equal the requested Discount, but, but it is possible that no lines were marked as discounted.
 void setTotalExemption(java.math.BigDecimal totalExemption)
          Deprecated. See TaxDetail.setExemption(java.math.BigDecimal).
 void setTotalTax(java.math.BigDecimal totalTax)
          Sets the total tax for the document.
 void setTotalTaxable(java.math.BigDecimal totalTaxable)
          Deprecated. See TaxDetail.setTaxable(java.math.BigDecimal).
 void setTotalTaxCalculated(java.math.BigDecimal totalTaxCalculated)
          Sets the totalTaxCalculated value for this GetTaxResult.
 void setVersion(int version)
          Sets the version value for this GetTaxResult.
 
Methods inherited from class com.avalara.avatax.services.tax.BaseResult
getMessages, getResultCode, getTransactionId, setMessages, setResultCode, setTransactionId
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetTaxResult

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

Method Detail

getDocId

public java.lang.String getDocId()
Gets the Document ID.

This is a unique AvaTax identifier for this document which can be used for PostTax, CommitTax, CancelTax, and GetTaxHistory.

Returns:
Document ID

setDocId

public void setDocId(java.lang.String docId)
Sets the Document ID.

This is a unique AvaTax identifier for this document which can be used for PostTax, CommitTax, CancelTax, and GetTaxHistory.

Parameters:
docId -

getDocType

public DocumentType getDocType()
Gets the Document Type.

See GetTaxRequest.getDocType() on GetTaxRequest for more information about this member.

Returns:
Document Type

setDocType

public void setDocType(DocumentType docType)
Sets the the Document Type.

See GetTaxRequest.getDocType() on GetTaxRequest for more information about this member.

Parameters:
docType -

getDocCode

public java.lang.String getDocCode()
Gets the internal reference code used by the client application; This is used for operations such as Post and GetTaxHistory.

See GetTaxRequest.getDocCode() on GetTaxRequest for more information about this member.

Returns:
docCode

setDocCode

public void setDocCode(java.lang.String docCode)
Sets the internal reference code used by the client application; This is used for operations such as Post and GetTaxHistory.

See GetTaxRequest.getDocCode() on GetTaxRequest for more information about this member.

Parameters:
docCode -

getDocDate

public java.util.Date getDocDate()
Gets the date on the invoice, purchase order, etc.

See GetTaxRequest.getDocDate() on GetTaxRequest for more information about this member.

Returns:
docDate

setDocDate

public void setDocDate(java.util.Date docDate)
Sets the date on the invoice, purchase order, etc.

See GetTaxRequest.getDocDate() on GetTaxRequest for more information about this member.

Parameters:
docDate -

getDocStatus

public DocStatus getDocStatus()
Gets the document's status after the tax calculation.

Returns:
docStatus

setDocStatus

public void setDocStatus(DocStatus docStatus)
Sets the document's status after the tax calculation.

Parameters:
docStatus -

isReconciled

public boolean isReconciled()
True if the document has been reconciled; Only committed documents can be reconciled.

For information on committing documents, see the TaxSvc's TaxSvcSoap.commitTax(com.avalara.avatax.services.tax.CommitTaxRequest) method. For information on reconciling documents, see the TaxSvcSoap.reconcileTaxHistory(com.avalara.avatax.services.tax.ReconcileTaxHistoryRequest) method.

Returns:
reconciled

setReconciled

public void setReconciled(boolean reconciled)
True if the document has been reconciled; Only committed documents can be reconciled.

For information on committing documents, see the TaxSvc's TaxSvcSoap.commitTax(com.avalara.avatax.services.tax.CommitTaxRequest) method. For information on reconciling documents, see the TaxSvcSoap.reconcileTaxHistory(com.avalara.avatax.services.tax.ReconcileTaxHistoryRequest) method.

Parameters:
reconciled -

getTimestamp

public java.util.Calendar getTimestamp()
Date of the last status change on the document (i.e. Save date, Post date, Commit date, Cancel date).

Returns:
timestamp

setTimestamp

public void setTimestamp(java.util.Calendar timestamp)
Date of the last status change on the document (i.e. Save date, Post date, Commit date, Cancel date).

Parameters:
timestamp -

getTotalAmount

public java.math.BigDecimal getTotalAmount()
Gets the sum of all line Line.getAmount() values.

Returns:
totalAmount

setTotalAmount

public void setTotalAmount(java.math.BigDecimal totalAmount)
Sets the sum of all line Line.getAmount() values.

Parameters:
totalAmount -

getTotalDiscount

public java.math.BigDecimal getTotalDiscount()
Gets the sum of all TaxLine TaxLine.getDiscount() amounts; Typically it will equal the requested Discount, but, but it is possible that no lines were marked as discounted.

Returns:
totalDiscount

setTotalDiscount

public void setTotalDiscount(java.math.BigDecimal totalDiscount)
Sets the sum of all TaxLine TaxLine.getDiscount() amounts; Typically it will equal the requested Discount, but, but it is possible that no lines were marked as discounted.

Parameters:
totalDiscount -

getTotalExemption

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

Gets the sum of all TaxLine TaxLine.getExemption() amounts.

Returns:
totalExemption

setTotalExemption

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

Sets the sum of all TaxLine TaxLine.getExemption() amounts.

Parameters:
totalExemption -

getTotalTaxable

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

Gets the amount the tax is based on; This is the total of all Line Base amounts; Typically it will be equal to the document getTotalAmount() - GetTaxRequest.getDiscount() - getTotalExemption().

Returns:
totalTaxable

setTotalTaxable

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

Sets the amount the tax is based on; This is the total of all Line Base amounts; Typically it will be equal to the document getTotalAmount() - GetTaxRequest.getDiscount() - getTotalExemption().

Parameters:
totalTaxable -

getTotalTax

public java.math.BigDecimal getTotalTax()
Gets the total tax for the document.

Returns:
totalTax

setTotalTax

public void setTotalTax(java.math.BigDecimal totalTax)
Sets the total tax for the document.

Parameters:
totalTax -

getTotalTaxCalculated

public java.math.BigDecimal getTotalTaxCalculated()
Gets the totalTaxCalculated value for this GetTaxResult.

Returns:
totalTaxCalculated

setTotalTaxCalculated

public void setTotalTaxCalculated(java.math.BigDecimal totalTaxCalculated)
Sets the totalTaxCalculated value for this GetTaxResult.

Parameters:
totalTaxCalculated -

getHashCode

public int getHashCode()
Gets the hashCode value for this GetTaxResult.

This should be computed by an SDK developer using some standard algorithm out of the content of the object. This value gets stored in the system and can be retrieved for the cross checking [Internal Reconciliation purpose]. See sample code for more details

Returns:
hashCode

setHashCode

public void setHashCode(int hashCode)
Sets the hashCode value for this GetTaxResult.

This should be computed by an SDK developer using some standard algorithm out of the content of the object. This value gets stored in the system and can be retrieved for the cross checking [Internal Reconciliation purpose].

See sample code for more details

Parameters:
hashCode -

getTaxLines

public ArrayOfTaxLine getTaxLines()
Gets the Tax broken down by individual TaxLine.

Returns:
taxLines

setTaxLines

public void setTaxLines(ArrayOfTaxLine taxLines)
Sets the Tax broken down by individual TaxLine.

Parameters:
taxLines -

getTaxAddresses

public ArrayOfTaxAddress getTaxAddresses()
Gets the taxAddresses value for this GetTaxResult.

Returns:
taxAddresses

setTaxAddresses

public void setTaxAddresses(ArrayOfTaxAddress taxAddresses)
Sets the taxAddresses value for this GetTaxResult.

Parameters:
taxAddresses -

getLocked

public boolean getLocked()
Gets the locked value for this GetTaxResult.

Flag indicating if a Document has been locked by Avalara's MRS process. Locked documents can not be modified and can not be cancelled because they have been reported on Tax Return.

Returns:
locked

setLocked

public void setLocked(boolean locked)
Sets the locked value for this GetTaxResult.

Parameters:
locked -

getAdjustmentReason

public int getAdjustmentReason()
Gets the AdjustTaxRequest.adjustmentReason value for this GetTaxResult.

Returns:
adjustmentReason

setAdjustmentReason

public void setAdjustmentReason(int adjustmentReason)
Sets the adjustmentReason value for this GetTaxResult.

Parameters:
adjustmentReason -

getAdjustmentDescription

public java.lang.String getAdjustmentDescription()
Gets the AdjustTaxRequest.adjustmentDescription value for this GetTaxResult.

Returns:
adjustmentDescription

setAdjustmentDescription

public void setAdjustmentDescription(java.lang.String adjustmentDescription)
Sets the adjustmentDescription value for this GetTaxResult.

Parameters:
adjustmentDescription -

getVersion

public int getVersion()
Gets the version value for this GetTaxResult.

Returns:
version

setVersion

public void setVersion(int version)
Sets the version value for this GetTaxResult.

Parameters:
version -

getTaxDate

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

Returns:
taxDate

setTaxDate

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

Parameters:
taxDate -

getTaxSummary

public ArrayOfTaxDetail getTaxSummary()
Gets the taxSummary value for this GetTaxResult. TaxSummary is an array that gets returned if the DetailLevel in GetTaxRequest is set to summary. It contains summary of TaxDetails for the entire document grouped by Country, JurisType, JurisCode, and Rate.

Returns:
taxSummary

setTaxSummary

public void setTaxSummary(ArrayOfTaxDetail taxSummary)
Sets the taxSummary value for this GetTaxResult.

Parameters:
taxSummary -

equals

public boolean equals(java.lang.Object obj)
Description copied from class: BaseResult
Determines whether the specified Object is equal to the current Object. Note: In current implementation all Java Strings members of the two objects must be exactly alike, including in case, for equal to return true.

Overrides:
equals in class BaseResult
Returns:
true or false, indicating if the two objects are equal.

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 BaseResult
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.


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.


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.