com.avalara.avatax.services.tax
Class CommitTaxRequest

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

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

Data to pass to TaxSvcSoap.commitTax(com.avalara.avatax.services.tax.CommitTaxRequest) indicating the document that should be committed.

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:
CommitTaxResult, Serialized Form

Constructor Summary
CommitTaxRequest()
          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 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.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.
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 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 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.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CommitTaxRequest

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

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

Implementation for DocCode has been updated. Some seller system generates DocCode at the time of CommitTax. This enables user to provide a new DocCode at the time of CommitTax call and this should overwrite the existing DocCode.

Parameters:
docCode -

equals

public boolean equals(java.lang.Object obj)
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 java.lang.Object
Parameters:
obj -
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 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.


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.