public class TransactionModel
extends java.lang.Object
Constructor and Description |
---|
TransactionModel() |
Modifier and Type | Method and Description |
---|---|
java.util.ArrayList<TransactionAddressModel> |
getAddresses()
Getter for addresses - Optional: A list of line items in this transaction.
|
java.lang.String |
getAdjustmentDescription()
Getter for adjustmentDescription - If this transaction was adjusted, indicates a description of the reason why the transaction was adjusted.
|
AdjustmentReason |
getAdjustmentReason()
Getter for adjustmentReason - If this transaction was adjusted, indicates the unique ID number of the reason why the transaction was adjusted.
|
java.lang.String |
getBatchCode()
Getter for batchCode - If this transaction was created as part of a batch, this code indicates which batch.
|
java.lang.String |
getCode()
Getter for code - A unique customer-provided code identifying this transaction.
|
java.lang.Integer |
getCompanyId()
Getter for companyId - The unique ID number of the company that recorded this transaction.
|
java.lang.String |
getCountry()
Getter for country - The two-character ISO 3166 code of the country for this transaction.
|
java.lang.String |
getCurrencyCode()
Getter for currencyCode - The three-character ISO 4217 currency code that was used for payment for this transaction.
|
java.lang.String |
getCustomerUsageType()
Getter for customerUsageType - The customer usage type for this transaction.
|
java.lang.String |
getCustomerVendorCode()
Getter for customerVendorCode - CustomerVendorCode
|
java.util.Date |
getDate()
Getter for date - The date on which this transaction occurred.
|
java.lang.String |
getDescription()
Getter for description - Description of this transaction.
|
java.lang.Long |
getDestinationAddressId()
Getter for destinationAddressId - The unique ID number of the destination address for this transaction.
|
java.lang.String |
getEmail()
Getter for email - Email address associated with this transaction.
|
java.math.BigDecimal |
getExchangeRate()
Getter for exchangeRate - If this transaction included foreign currency exchange, this is the exchange rate that was used.
|
java.util.Date |
getExchangeRateEffectiveDate()
Getter for exchangeRateEffectiveDate - If this transaction included foreign currency exchange, this is the date as of which the exchange rate was calculated.
|
java.lang.String |
getExemptNo()
Getter for exemptNo - If this transaction was exempt, this field will contain the word "Exempt".
|
java.util.ArrayList<TransactionModel> |
getHistory()
Getter for history - If this transaction has been adjusted, this list contains all the previous versions of the document.
|
java.lang.Long |
getId()
Getter for id - The unique ID number of this transaction.
|
java.lang.Boolean |
getIsSellerImporterOfRecord()
Getter for isSellerImporterOfRecord - If true, this seller was considered the importer of record of a product shipped internationally.
|
java.util.ArrayList<TransactionLineModel> |
getLines()
Getter for lines - Optional: A list of line items in this transaction.
|
java.lang.String |
getLocationCode()
Getter for locationCode - If this transaction was made from a specific reporting location, this is the code string of the location.
|
java.lang.Boolean |
getLocked()
Getter for locked - If this transaction has been reported to a tax authority, this transaction is considered locked and may not be adjusted after reporting.
|
java.util.ArrayList<AvaTaxMessage> |
getMessages()
Getter for messages - List of informational and warning messages regarding this API call.
|
java.util.Date |
getModifiedDate()
Getter for modifiedDate - The date/time when this record was last modified.
|
java.lang.Integer |
getModifiedUserId()
Getter for modifiedUserId - The user ID of the user who last modified this record.
|
java.lang.Long |
getOriginAddressId()
Getter for originAddressId - The unique ID number of the origin address for this transaction.
|
java.util.HashMap<java.lang.String,java.lang.String> |
getParameters()
Getter for parameters - Contains a list of extra parameters that were set when the transaction was created.
|
java.util.Date |
getPaymentDate()
Getter for paymentDate - The date when payment was made on this transaction.
|
java.lang.String |
getPurchaseOrderNo()
Getter for purchaseOrderNo - The customer-supplied purchase order number of this transaction.
|
java.lang.Boolean |
getReconciled()
Getter for reconciled - If this transaction has been reconciled against the company's ledger, this value is set to true.
|
java.lang.String |
getReferenceCode()
Getter for referenceCode - A user-defined reference code for this transaction.
|
java.lang.String |
getRegion()
Getter for region - The two-or-three character ISO region code of the region for this transaction.
|
java.lang.String |
getSalespersonCode()
Getter for salespersonCode - The salesperson who provided this transaction.
|
java.lang.String |
getSoftwareVersion()
Getter for softwareVersion - The software version used to calculate this transaction.
|
DocumentStatus |
getStatus()
Getter for status - The status of the transaction.
|
java.util.ArrayList<TransactionSummary> |
getSummary()
Getter for summary - Contains a summary of tax on this transaction.
|
java.util.Date |
getTaxDate()
Getter for taxDate - The date that was used when calculating tax for this transaction.
|
java.math.BigDecimal |
getTaxOverrideAmount()
Getter for taxOverrideAmount - If a tax override was applied to this transaction, indicates the amount of tax that was requested by the customer.
|
java.lang.String |
getTaxOverrideReason()
Getter for taxOverrideReason - If a tax override was applied to this transaction, indicates the reason for the tax override.
|
TaxOverrideTypeId |
getTaxOverrideType()
Getter for taxOverrideType - If a tax override was applied to this transaction, indicates what type of tax override was applied.
|
java.math.BigDecimal |
getTotalAmount()
Getter for totalAmount - The total amount of this transaction.
|
java.math.BigDecimal |
getTotalExempt()
Getter for totalExempt - The amount of this transaction that was exempt.
|
java.math.BigDecimal |
getTotalTax()
Getter for totalTax - The total tax calculated for all lines in this transaction.
|
java.math.BigDecimal |
getTotalTaxable()
Getter for totalTaxable - The portion of the total amount of this transaction that was taxable.
|
java.math.BigDecimal |
getTotalTaxCalculated()
Getter for totalTaxCalculated - If a tax override was applied to this transaction, indicates the amount of tax Avalara calculated for the transaction.
|
DocumentType |
getType()
Getter for type - The type of the transaction.
|
java.lang.Integer |
getVersion()
Getter for version - If this transaction was adjusted, this indicates the version number of this transaction.
|
void |
setAddresses(java.util.ArrayList<TransactionAddressModel> addresses)
Setter for addresses - Optional: A list of line items in this transaction.
|
void |
setAdjustmentDescription(java.lang.String adjustmentDescription)
Setter for adjustmentDescription - If this transaction was adjusted, indicates a description of the reason why the transaction was adjusted.
|
void |
setAdjustmentReason(AdjustmentReason adjustmentReason)
Setter for adjustmentReason - If this transaction was adjusted, indicates the unique ID number of the reason why the transaction was adjusted.
|
void |
setBatchCode(java.lang.String batchCode)
Setter for batchCode - If this transaction was created as part of a batch, this code indicates which batch.
|
void |
setCode(java.lang.String code)
Setter for code - A unique customer-provided code identifying this transaction.
|
void |
setCompanyId(java.lang.Integer companyId)
Setter for companyId - The unique ID number of the company that recorded this transaction.
|
void |
setCountry(java.lang.String country)
Setter for country - The two-character ISO 3166 code of the country for this transaction.
|
void |
setCurrencyCode(java.lang.String currencyCode)
Setter for currencyCode - The three-character ISO 4217 currency code that was used for payment for this transaction.
|
void |
setCustomerUsageType(java.lang.String customerUsageType)
Setter for customerUsageType - The customer usage type for this transaction.
|
void |
setCustomerVendorCode(java.lang.String customerVendorCode)
Setter for customerVendorCode - CustomerVendorCode
|
void |
setDate(java.util.Date date)
Setter for date - The date on which this transaction occurred.
|
void |
setDescription(java.lang.String description)
Setter for description - Description of this transaction.
|
void |
setDestinationAddressId(java.lang.Long destinationAddressId)
Setter for destinationAddressId - The unique ID number of the destination address for this transaction.
|
void |
setEmail(java.lang.String email)
Setter for email - Email address associated with this transaction.
|
void |
setExchangeRate(java.math.BigDecimal exchangeRate)
Setter for exchangeRate - If this transaction included foreign currency exchange, this is the exchange rate that was used.
|
void |
setExchangeRateEffectiveDate(java.util.Date exchangeRateEffectiveDate)
Setter for exchangeRateEffectiveDate - If this transaction included foreign currency exchange, this is the date as of which the exchange rate was calculated.
|
void |
setExemptNo(java.lang.String exemptNo)
Setter for exemptNo - If this transaction was exempt, this field will contain the word "Exempt".
|
void |
setHistory(java.util.ArrayList<TransactionModel> history)
Setter for history - If this transaction has been adjusted, this list contains all the previous versions of the document.
|
void |
setId(java.lang.Long id)
Setter for id - The unique ID number of this transaction.
|
void |
setIsSellerImporterOfRecord(java.lang.Boolean isSellerImporterOfRecord)
Setter for isSellerImporterOfRecord - If true, this seller was considered the importer of record of a product shipped internationally.
|
void |
setLines(java.util.ArrayList<TransactionLineModel> lines)
Setter for lines - Optional: A list of line items in this transaction.
|
void |
setLocationCode(java.lang.String locationCode)
Setter for locationCode - If this transaction was made from a specific reporting location, this is the code string of the location.
|
void |
setLocked(java.lang.Boolean locked)
Setter for locked - If this transaction has been reported to a tax authority, this transaction is considered locked and may not be adjusted after reporting.
|
void |
setMessages(java.util.ArrayList<AvaTaxMessage> messages)
Setter for messages - List of informational and warning messages regarding this API call.
|
void |
setModifiedDate(java.util.Date modifiedDate)
Setter for modifiedDate - The date/time when this record was last modified.
|
void |
setModifiedUserId(java.lang.Integer modifiedUserId)
Setter for modifiedUserId - The user ID of the user who last modified this record.
|
void |
setOriginAddressId(java.lang.Long originAddressId)
Setter for originAddressId - The unique ID number of the origin address for this transaction.
|
void |
setParameters(java.util.HashMap<java.lang.String,java.lang.String> parameters)
Setter for parameters - Contains a list of extra parameters that were set when the transaction was created.
|
void |
setPaymentDate(java.util.Date paymentDate)
Setter for paymentDate - The date when payment was made on this transaction.
|
void |
setPurchaseOrderNo(java.lang.String purchaseOrderNo)
Setter for purchaseOrderNo - The customer-supplied purchase order number of this transaction.
|
void |
setReconciled(java.lang.Boolean reconciled)
Setter for reconciled - If this transaction has been reconciled against the company's ledger, this value is set to true.
|
void |
setReferenceCode(java.lang.String referenceCode)
Setter for referenceCode - A user-defined reference code for this transaction.
|
void |
setRegion(java.lang.String region)
Setter for region - The two-or-three character ISO region code of the region for this transaction.
|
void |
setSalespersonCode(java.lang.String salespersonCode)
Setter for salespersonCode - The salesperson who provided this transaction.
|
void |
setSoftwareVersion(java.lang.String softwareVersion)
Setter for softwareVersion - The software version used to calculate this transaction.
|
void |
setStatus(DocumentStatus status)
Setter for status - The status of the transaction.
|
void |
setSummary(java.util.ArrayList<TransactionSummary> summary)
Setter for summary - Contains a summary of tax on this transaction.
|
void |
setTaxDate(java.util.Date taxDate)
Setter for taxDate - The date that was used when calculating tax for this transaction.
|
void |
setTaxOverrideAmount(java.math.BigDecimal taxOverrideAmount)
Setter for taxOverrideAmount - If a tax override was applied to this transaction, indicates the amount of tax that was requested by the customer.
|
void |
setTaxOverrideReason(java.lang.String taxOverrideReason)
Setter for taxOverrideReason - If a tax override was applied to this transaction, indicates the reason for the tax override.
|
void |
setTaxOverrideType(TaxOverrideTypeId taxOverrideType)
Setter for taxOverrideType - If a tax override was applied to this transaction, indicates what type of tax override was applied.
|
void |
setTotalAmount(java.math.BigDecimal totalAmount)
Setter for totalAmount - The total amount of this transaction.
|
void |
setTotalExempt(java.math.BigDecimal totalExempt)
Setter for totalExempt - The amount of this transaction that was exempt.
|
void |
setTotalTax(java.math.BigDecimal totalTax)
Setter for totalTax - The total tax calculated for all lines in this transaction.
|
void |
setTotalTaxable(java.math.BigDecimal totalTaxable)
Setter for totalTaxable - The portion of the total amount of this transaction that was taxable.
|
void |
setTotalTaxCalculated(java.math.BigDecimal totalTaxCalculated)
Setter for totalTaxCalculated - If a tax override was applied to this transaction, indicates the amount of tax Avalara calculated for the transaction.
|
void |
setType(DocumentType type)
Setter for type - The type of the transaction.
|
void |
setVersion(java.lang.Integer version)
Setter for version - If this transaction was adjusted, this indicates the version number of this transaction.
|
java.lang.String |
toString()
Returns a JSON string representation of TransactionModel.
|
public java.util.ArrayList<AvaTaxMessage> getMessages()
public void setMessages(java.util.ArrayList<AvaTaxMessage> messages)
public java.lang.String getBatchCode()
public void setBatchCode(java.lang.String batchCode)
public java.lang.String getCustomerUsageType()
public void setCustomerUsageType(java.lang.String customerUsageType)
public java.util.ArrayList<TransactionModel> getHistory()
public void setHistory(java.util.ArrayList<TransactionModel> history)
public java.lang.String getEmail()
public void setEmail(java.lang.String email)
public TaxOverrideTypeId getTaxOverrideType()
public void setTaxOverrideType(TaxOverrideTypeId taxOverrideType)
public java.lang.Long getOriginAddressId()
public void setOriginAddressId(java.lang.Long originAddressId)
public java.lang.String getDescription()
public void setDescription(java.lang.String description)
public java.lang.String getSoftwareVersion()
public void setSoftwareVersion(java.lang.String softwareVersion)
public java.lang.String getExemptNo()
public void setExemptNo(java.lang.String exemptNo)
public java.util.Date getModifiedDate()
public void setModifiedDate(java.util.Date modifiedDate)
public java.lang.String getLocationCode()
public void setLocationCode(java.lang.String locationCode)
public java.lang.String getPurchaseOrderNo()
public void setPurchaseOrderNo(java.lang.String purchaseOrderNo)
public java.lang.Boolean getLocked()
public void setLocked(java.lang.Boolean locked)
public java.lang.String getCountry()
public void setCountry(java.lang.String country)
public java.math.BigDecimal getTotalTaxable()
public void setTotalTaxable(java.math.BigDecimal totalTaxable)
public java.math.BigDecimal getExchangeRate()
public void setExchangeRate(java.math.BigDecimal exchangeRate)
public java.lang.String getCode()
public void setCode(java.lang.String code)
public java.lang.String getReferenceCode()
public void setReferenceCode(java.lang.String referenceCode)
public java.math.BigDecimal getTotalAmount()
public void setTotalAmount(java.math.BigDecimal totalAmount)
public java.lang.Integer getVersion()
public void setVersion(java.lang.Integer version)
public java.lang.Long getId()
public void setId(java.lang.Long id)
public java.util.Date getExchangeRateEffectiveDate()
public void setExchangeRateEffectiveDate(java.util.Date exchangeRateEffectiveDate)
public java.util.Date getDate()
public void setDate(java.util.Date date)
public java.lang.Long getDestinationAddressId()
public void setDestinationAddressId(java.lang.Long destinationAddressId)
public DocumentStatus getStatus()
public void setStatus(DocumentStatus status)
public java.lang.String getTaxOverrideReason()
public void setTaxOverrideReason(java.lang.String taxOverrideReason)
public java.lang.Boolean getIsSellerImporterOfRecord()
public void setIsSellerImporterOfRecord(java.lang.Boolean isSellerImporterOfRecord)
public java.lang.Integer getModifiedUserId()
public void setModifiedUserId(java.lang.Integer modifiedUserId)
public java.lang.String getCurrencyCode()
public void setCurrencyCode(java.lang.String currencyCode)
public java.lang.String getRegion()
public void setRegion(java.lang.String region)
public java.math.BigDecimal getTaxOverrideAmount()
public void setTaxOverrideAmount(java.math.BigDecimal taxOverrideAmount)
public java.math.BigDecimal getTotalTax()
public void setTotalTax(java.math.BigDecimal totalTax)
public java.util.Date getPaymentDate()
public void setPaymentDate(java.util.Date paymentDate)
public java.math.BigDecimal getTotalTaxCalculated()
public void setTotalTaxCalculated(java.math.BigDecimal totalTaxCalculated)
public java.lang.String getCustomerVendorCode()
public void setCustomerVendorCode(java.lang.String customerVendorCode)
public java.lang.String getSalespersonCode()
public void setSalespersonCode(java.lang.String salespersonCode)
public DocumentType getType()
public void setType(DocumentType type)
public java.math.BigDecimal getTotalExempt()
public void setTotalExempt(java.math.BigDecimal totalExempt)
public java.util.ArrayList<TransactionLineModel> getLines()
public void setLines(java.util.ArrayList<TransactionLineModel> lines)
public java.util.HashMap<java.lang.String,java.lang.String> getParameters()
public void setParameters(java.util.HashMap<java.lang.String,java.lang.String> parameters)
public java.util.Date getTaxDate()
public void setTaxDate(java.util.Date taxDate)
public java.lang.String getAdjustmentDescription()
public void setAdjustmentDescription(java.lang.String adjustmentDescription)
public java.util.ArrayList<TransactionSummary> getSummary()
public void setSummary(java.util.ArrayList<TransactionSummary> summary)
public AdjustmentReason getAdjustmentReason()
public void setAdjustmentReason(AdjustmentReason adjustmentReason)
public java.lang.Integer getCompanyId()
public void setCompanyId(java.lang.Integer companyId)
public java.lang.Boolean getReconciled()
public void setReconciled(java.lang.Boolean reconciled)
public java.util.ArrayList<TransactionAddressModel> getAddresses()
public void setAddresses(java.util.ArrayList<TransactionAddressModel> addresses)
public java.lang.String toString()
toString
in class java.lang.Object