com.avalara.avatax.services.tax
Class PostTaxRequest

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

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

Data to pass to TaxSvcSoap.postTax(com.avalara.avatax.services.tax.PostTaxRequest).

A document can be indicated solely by the getDocId() if it is known. Otherwise the request must specify all of getCompanyCode(), getDocCode(), and getDocType() in order to uniquely identify the document.

See Also:
PostTaxResult, Serialized Form

Constructor Summary
PostTaxRequest()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 boolean getCommit()
          Gets the commit value for this PostTaxRequest.
 java.lang.String getCompanyCode()
          Gets the client application company reference code.
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 Document Code, that is the internal reference code used by the client application.
 java.util.Date getDocDate()
          Gets the Document Date, i.e.
 java.lang.String getDocId()
          A unique document ID.
 DocumentType getDocType()
          The original document's type, such as Sales Invoice or Purchase Invoice.
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 getTotalAmount()
          The total amount (not including tax) for the document.
 java.math.BigDecimal getTotalTax()
          The total tax for the document.
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.
 void setCommit(boolean commit)
           
 void setCompanyCode(java.lang.String companyCode)
          Sets the client application company reference code.
 void setDocCode(java.lang.String docCode)
          Sets the Document Code, that is the internal reference code used by the client application.
 void setDocDate(java.util.Date docDate)
          Sets the Document Date, i.e.
 void setDocId(java.lang.String docId)
          A unique document ID.
 void setDocType(DocumentType docType)
          The original document's type, such as Sales Invoice or Purchase Invoice.
 void setHashCode(int hashCode)
          Sets the hashCode value for this PostTaxRequest.
 void setTotalAmount(java.math.BigDecimal totalAmount)
          The total amount (not including tax) for the document.
 void setTotalTax(java.math.BigDecimal totalTax)
          The total tax for the document.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PostTaxRequest

public PostTaxRequest()
Method Detail

getDocId

public java.lang.String getDocId()
A unique document ID.

This is a unique AvaTax identifier for this document. If known, the CompanyCode, DocCode, and DocType are not needed.

Returns:
docId
See Also:
GetTaxResult.getDocId()

setDocId

public void setDocId(java.lang.String docId)
A unique document ID.

This is a unique AvaTax identifier for this document. If known, the CompanyCode, DocCode, and DocType are not needed.

Parameters:
docId -
See Also:
GetTaxResult.getDocId()

getCompanyCode

public java.lang.String getCompanyCode()
Gets the client application company reference code.
If docId is specified, this is not needed.

Returns:
companyCode

setCompanyCode

public void setCompanyCode(java.lang.String companyCode)
Sets the client application company reference code.
If docId is specified, this is not needed.

Parameters:
companyCode -

getDocType

public DocumentType getDocType()
The original document's type, such as Sales Invoice or Purchase Invoice.

Returns:
docType

setDocType

public void setDocType(DocumentType docType)
The original document's type, such as Sales Invoice or Purchase Invoice.

Parameters:
docType -

getDocCode

public java.lang.String getDocCode()
Gets the Document Code, that is the internal reference code used by the client application.
If docId is specified, this is not needed.

Returns:
docCode

setDocCode

public void setDocCode(java.lang.String docCode)
Sets the Document Code, that is the internal reference code used by the client application.
If docId is specified, this is not needed.

Parameters:
docCode -

getDocDate

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

Returns:
docDate

setDocDate

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

Parameters:
docDate -

getTotalAmount

public java.math.BigDecimal getTotalAmount()
The total amount (not including tax) for the document.

This is used for verification and reconciliation. This should be the TotalAmount returned by GetTaxResult when tax was calculated for this document; otherwise the web service will return an error.

Returns:
totalAmount
See Also:
getTotalTax()

setTotalAmount

public void setTotalAmount(java.math.BigDecimal totalAmount)
The total amount (not including tax) for the document.

This is used for verification and reconciliation. This should be the TotalAmount returned by GetTaxResult when tax was calculated for this document; otherwise the web service will return an error.

Parameters:
totalAmount -
See Also:
getTotalTax()

getTotalTax

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

This is used for verification and reconciliation. This should be the TotalTax returned by GetTaxResult when tax was calculated for this document; otherwise the web service will return an error.

Returns:
totalTax
See Also:
getTotalAmount()

setTotalTax

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

This is used for verification and reconciliation. This should be the TotalTax returned by GetTaxResult when tax was calculated for this document; otherwise the web service will return an error.

Parameters:
totalTax -
See Also:
getTotalAmount()

setHashCode

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

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 -

getCommit

public boolean getCommit()
Gets the commit value for this PostTaxRequest.

Returns:
commit

setCommit

public void setCommit(boolean commit)

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