Package net.avalara.avatax.rest.client.models

Class TransactionModel

java.lang.Object
net.avalara.avatax.rest.client.models.TransactionModel
public class TransactionModel
extends java.lang.Object
This object represents a single transaction; for example, a sales invoice or purchase order.

  • Constructor Summary

    Constructors 
    Constructor Description
    TransactionModel()  

  • Method Summary

    Modifier and Type Method Description
    java.util.ArrayList<TransactionAddressModel> getAddresses()
    Getter for addresses 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 getBusinessIdentificationNo()
    Getter for businessIdentificationNo VAT business identification number used for this transaction.
    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 getCustomerCode()
    Getter for customerCode Unique code identifying the customer that requested this transaction.
    java.lang.String getCustomerSupplierName()
    Getter for customerSupplierName The name of the supplier / exporter / seller.
    java.lang.String getCustomerUsageType()
    Getter for customerUsageType DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead.
    java.lang.String getCustomerVendorCode()
    Getter for customerVendorCode DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: Please use `customerCode` This field has been renamed to `customerCode` to match documentation for other APIs related to exemption customers.
    java.lang.Integer getDataSourceId()
    Getter for dataSourceId The Id of the datasource from which this transaction originated.
    java.util.Date getDate()
    Getter for date The date on which this transaction occurred.
    DeliveryTerms getDeliveryTerms()
    Getter for deliveryTerms The Delivery Terms is a field used in conjunction with Importer of Record to influence whether AvaTax includes Import Duty and Tax values in the transaction totals or not.
    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.lang.String getEntityUseCode()
    Getter for entityUseCode The entity use code for 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.lang.String getExchangeRateCurrencyCode()
    Getter for exchangeRateCurrencyCode The three-character ISO 4217 exchange rate currency code that was used for payment for this transaction.
    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 The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable ECMS entry available, and will utilize it for exemption processing.
    java.lang.Long getId()
    Getter for id The unique ID number of this transaction.
    java.util.ArrayList<InvoiceMessageModel> getInvoiceMessages()
    Getter for invoiceMessages Invoice messages associated with this document.
    java.lang.Boolean getIsSellerImporterOfRecord()
    Getter for isSellerImporterOfRecord By default, the value is null, when the value is null, the value can be set at nexus level and used.
    java.util.ArrayList<TransactionLineModel> getLines()
    Getter for lines A list of line items in this transaction.
    java.lang.String getLocationCode()
    Getter for locationCode DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: In order to ensure consistency of field names, Please use reportingLocationCode instead.
    java.util.ArrayList<TransactionLocationTypeModel> getLocationTypes()
    Getter for locationTypes A list of location types in this transaction.
    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.ArrayList<TransactionParameterModel> 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 DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null till its removed.
    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 getReportingLocationCode()
    Getter for reportingLocationCode For customers who use [location-based tax reporting](https://developer.avalara.com/avatax/dev-guide/locations/location-based-reporting), this field controls how this transaction will be filed for multi-location tax filings.
    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 Tax date for this transaction
    java.util.ArrayList<TaxDetailsByTaxType> getTaxDetailsByTaxType()
    Getter for taxDetailsByTaxType Contains the tax details per tax type
    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.
    TaxOverrideType 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 getTotalDiscount()
    Getter for totalDiscount The total amount of discounts applied to all lines within 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 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 The amount of tax that AvaTax calculated for the transaction.
    DocumentType getType()
    Getter for type The type of the transaction.
    java.util.ArrayList<TransactionUserDefinedFieldModel> getUserDefinedFields()
    Getter for userDefinedFields Custom user fields/flex fields for this 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> value)
    Setter for addresses A list of line items in this transaction.
    void setAdjustmentDescription​(java.lang.String value)
    Setter for adjustmentDescription If this transaction was adjusted, indicates a description of the reason why the transaction was adjusted.
    void setAdjustmentReason​(AdjustmentReason value)
    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 value)
    Setter for batchCode If this transaction was created as part of a batch, this code indicates which batch.
    void setBusinessIdentificationNo​(java.lang.String value)
    Setter for businessIdentificationNo VAT business identification number used for this transaction.
    void setCode​(java.lang.String value)
    Setter for code A unique customer-provided code identifying this transaction.
    void setCompanyId​(java.lang.Integer value)
    Setter for companyId The unique ID number of the company that recorded this transaction.
    void setCountry​(java.lang.String value)
    Setter for country The two-character ISO 3166 code of the country for this transaction.
    void setCurrencyCode​(java.lang.String value)
    Setter for currencyCode The three-character ISO 4217 currency code that was used for payment for this transaction.
    void setCustomerCode​(java.lang.String value)
    Setter for customerCode Unique code identifying the customer that requested this transaction.
    void setCustomerSupplierName​(java.lang.String value)
    Setter for customerSupplierName The name of the supplier / exporter / seller.
    void setCustomerUsageType​(java.lang.String value)
    Setter for customerUsageType DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead.
    void setCustomerVendorCode​(java.lang.String value)
    Setter for customerVendorCode DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: Please use `customerCode` This field has been renamed to `customerCode` to match documentation for other APIs related to exemption customers.
    void setDataSourceId​(java.lang.Integer value)
    Setter for dataSourceId The Id of the datasource from which this transaction originated.
    void setDate​(java.util.Date value)
    Setter for date The date on which this transaction occurred.
    void setDeliveryTerms​(DeliveryTerms value)
    Setter for deliveryTerms The Delivery Terms is a field used in conjunction with Importer of Record to influence whether AvaTax includes Import Duty and Tax values in the transaction totals or not.
    void setDescription​(java.lang.String value)
    Setter for description Description of this transaction.
    void setDestinationAddressId​(java.lang.Long value)
    Setter for destinationAddressId The unique ID number of the destination address for this transaction.
    void setEmail​(java.lang.String value)
    Setter for email Email address associated with this transaction.
    void setEntityUseCode​(java.lang.String value)
    Setter for entityUseCode The entity use code for this transaction.
    void setExchangeRate​(java.math.BigDecimal value)
    Setter for exchangeRate If this transaction included foreign currency exchange, this is the exchange rate that was used.
    void setExchangeRateCurrencyCode​(java.lang.String value)
    Setter for exchangeRateCurrencyCode The three-character ISO 4217 exchange rate currency code that was used for payment for this transaction.
    void setExchangeRateEffectiveDate​(java.util.Date value)
    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 value)
    Setter for exemptNo The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable ECMS entry available, and will utilize it for exemption processing.
    void setId​(java.lang.Long value)
    Setter for id The unique ID number of this transaction.
    void setInvoiceMessages​(java.util.ArrayList<InvoiceMessageModel> value)
    Setter for invoiceMessages Invoice messages associated with this document.
    void setIsSellerImporterOfRecord​(java.lang.Boolean value)
    Setter for isSellerImporterOfRecord By default, the value is null, when the value is null, the value can be set at nexus level and used.
    void setLines​(java.util.ArrayList<TransactionLineModel> value)
    Setter for lines A list of line items in this transaction.
    void setLocationCode​(java.lang.String value)
    Setter for locationCode DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: In order to ensure consistency of field names, Please use reportingLocationCode instead.
    void setLocationTypes​(java.util.ArrayList<TransactionLocationTypeModel> value)
    Setter for locationTypes A list of location types in this transaction.
    void setLocked​(java.lang.Boolean value)
    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> value)
    Setter for messages List of informational and warning messages regarding this API call.
    void setModifiedDate​(java.util.Date value)
    Setter for modifiedDate The date/time when this record was last modified.
    void setModifiedUserId​(java.lang.Integer value)
    Setter for modifiedUserId The user ID of the user who last modified this record.
    void setOriginAddressId​(java.lang.Long value)
    Setter for originAddressId The unique ID number of the origin address for this transaction.
    void setParameters​(java.util.ArrayList<TransactionParameterModel> value)
    Setter for parameters Contains a list of extra parameters that were set when the transaction was created.
    void setPaymentDate​(java.util.Date value)
    Setter for paymentDate DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null till its removed.
    void setPurchaseOrderNo​(java.lang.String value)
    Setter for purchaseOrderNo The customer-supplied purchase order number of this transaction.
    void setReconciled​(java.lang.Boolean value)
    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 value)
    Setter for referenceCode A user-defined reference code for this transaction.
    void setRegion​(java.lang.String value)
    Setter for region The two-or-three character ISO region code of the region for this transaction.
    void setReportingLocationCode​(java.lang.String value)
    Setter for reportingLocationCode For customers who use [location-based tax reporting](https://developer.avalara.com/avatax/dev-guide/locations/location-based-reporting), this field controls how this transaction will be filed for multi-location tax filings.
    void setSalespersonCode​(java.lang.String value)
    Setter for salespersonCode The salesperson who provided this transaction.
    void setSoftwareVersion​(java.lang.String value)
    Setter for softwareVersion The software version used to calculate this transaction.
    void setStatus​(DocumentStatus value)
    Setter for status The status of the transaction.
    void setSummary​(java.util.ArrayList<TransactionSummary> value)
    Setter for summary Contains a summary of tax on this transaction.
    void setTaxDate​(java.util.Date value)
    Setter for taxDate Tax date for this transaction
    void setTaxDetailsByTaxType​(java.util.ArrayList<TaxDetailsByTaxType> value)
    Setter for taxDetailsByTaxType Contains the tax details per tax type
    void setTaxOverrideAmount​(java.math.BigDecimal value)
    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 value)
    Setter for taxOverrideReason If a tax override was applied to this transaction, indicates the reason for the tax override.
    void setTaxOverrideType​(TaxOverrideType value)
    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 value)
    Setter for totalAmount The total amount of this transaction.
    void setTotalDiscount​(java.math.BigDecimal value)
    Setter for totalDiscount The total amount of discounts applied to all lines within this transaction.
    void setTotalExempt​(java.math.BigDecimal value)
    Setter for totalExempt The amount of this transaction that was exempt.
    void setTotalTax​(java.math.BigDecimal value)
    Setter for totalTax The total tax for all lines in this transaction.
    void setTotalTaxable​(java.math.BigDecimal value)
    Setter for totalTaxable The portion of the total amount of this transaction that was taxable.
    void setTotalTaxCalculated​(java.math.BigDecimal value)
    Setter for totalTaxCalculated The amount of tax that AvaTax calculated for the transaction.
    void setType​(DocumentType value)
    Setter for type The type of the transaction.
    void setUserDefinedFields​(java.util.ArrayList<TransactionUserDefinedFieldModel> value)
    Setter for userDefinedFields Custom user fields/flex fields for this transaction.
    void setVersion​(java.lang.Integer value)
    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

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

  • Method Details

    • getId

      public java.lang.Long getId()
      Getter for id The unique ID number of this transaction.

    • setId

      public void setId​(java.lang.Long value)
      Setter for id The unique ID number of this transaction.

    • getCode

      public java.lang.String getCode()
      Getter for code A unique customer-provided code identifying this transaction.

    • setCode

      public void setCode​(java.lang.String value)
      Setter for code A unique customer-provided code identifying this transaction.

    • getCompanyId

      public java.lang.Integer getCompanyId()
      Getter for companyId The unique ID number of the company that recorded this transaction.

    • setCompanyId

      public void setCompanyId​(java.lang.Integer value)
      Setter for companyId The unique ID number of the company that recorded this transaction.

    • getDate

      public java.util.Date getDate()
      Getter for date The date on which this transaction occurred.

    • setDate

      public void setDate​(java.util.Date value)
      Setter for date The date on which this transaction occurred.

    • getPaymentDate

      public java.util.Date getPaymentDate()
      Getter for paymentDate DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null till its removed. The date when payment was made on this transaction. By default, this should be the same as the date of the transaction.

    • setPaymentDate

      public void setPaymentDate​(java.util.Date value)
      Setter for paymentDate DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null till its removed. The date when payment was made on this transaction. By default, this should be the same as the date of the transaction.

    • getStatus

      public DocumentStatus getStatus()
      Getter for status The status of the transaction.

    • setStatus

      public void setStatus​(DocumentStatus value)
      Setter for status The status of the transaction.

    • getType

      public DocumentType getType()
      Getter for type The type of the transaction. Transactions of type `SalesOrder`, `ReturnOrder`, and so on are temporary estimates and will not be saved. Transactions of type `SalesInvoice, `ReturnInvoice`, and so on are permanent transactions that can be reported to tax authorities if they are in status `Committed`. A sales transaction represents a sale from the company to a customer. A purchase transaction represents a purchase made by the company. A return transaction represents a customer who decided to request a refund after purchasing a product from the company. An inventory transfer transaction represents goods that were moved from one location of the company to another location without changing ownership.

    • setType

      public void setType​(DocumentType value)
      Setter for type The type of the transaction. Transactions of type `SalesOrder`, `ReturnOrder`, and so on are temporary estimates and will not be saved. Transactions of type `SalesInvoice, `ReturnInvoice`, and so on are permanent transactions that can be reported to tax authorities if they are in status `Committed`. A sales transaction represents a sale from the company to a customer. A purchase transaction represents a purchase made by the company. A return transaction represents a customer who decided to request a refund after purchasing a product from the company. An inventory transfer transaction represents goods that were moved from one location of the company to another location without changing ownership.

    • getBatchCode

      public java.lang.String getBatchCode()
      Getter for batchCode If this transaction was created as part of a batch, this code indicates which batch.

    • setBatchCode

      public void setBatchCode​(java.lang.String value)
      Setter for batchCode If this transaction was created as part of a batch, this code indicates which batch.

    • getCurrencyCode

      public java.lang.String getCurrencyCode()
      Getter for currencyCode The three-character ISO 4217 currency code that was used for payment for this transaction.

    • setCurrencyCode

      public void setCurrencyCode​(java.lang.String value)
      Setter for currencyCode The three-character ISO 4217 currency code that was used for payment for this transaction.

    • getExchangeRateCurrencyCode

      public java.lang.String getExchangeRateCurrencyCode()
      Getter for exchangeRateCurrencyCode The three-character ISO 4217 exchange rate currency code that was used for payment for this transaction.

    • setExchangeRateCurrencyCode

      public void setExchangeRateCurrencyCode​(java.lang.String value)
      Setter for exchangeRateCurrencyCode The three-character ISO 4217 exchange rate currency code that was used for payment for this transaction.

    • getCustomerUsageType

      public java.lang.String getCustomerUsageType()
      Getter for customerUsageType DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead. The customer usage type for this transaction. Customer usage types often affect exemption or taxability rules.

    • setCustomerUsageType

      public void setCustomerUsageType​(java.lang.String value)
      Setter for customerUsageType DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead. The customer usage type for this transaction. Customer usage types often affect exemption or taxability rules.

    • getEntityUseCode

      public java.lang.String getEntityUseCode()
      Getter for entityUseCode The entity use code for this transaction. Entity use codes often affect exemption or taxability rules.

    • setEntityUseCode

      public void setEntityUseCode​(java.lang.String value)
      Setter for entityUseCode The entity use code for this transaction. Entity use codes often affect exemption or taxability rules.

    • getCustomerVendorCode

      public java.lang.String getCustomerVendorCode()
      Getter for customerVendorCode DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: Please use `customerCode` This field has been renamed to `customerCode` to match documentation for other APIs related to exemption customers.

    • setCustomerVendorCode

      public void setCustomerVendorCode​(java.lang.String value)
      Setter for customerVendorCode DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: Please use `customerCode` This field has been renamed to `customerCode` to match documentation for other APIs related to exemption customers.

    • getCustomerCode

      public java.lang.String getCustomerCode()
      Getter for customerCode Unique code identifying the customer that requested this transaction. When you specify a `customerCode`, AvaTax will look to see if a customer exists with this code in the exemption certificate system. If that customer exists, and if that customer has uploaded an exemption certificate that applies to this transaction, the relevant parts of this transaction that can use the exemption certificate will be treated as exempt.

    • setCustomerCode

      public void setCustomerCode​(java.lang.String value)
      Setter for customerCode Unique code identifying the customer that requested this transaction. When you specify a `customerCode`, AvaTax will look to see if a customer exists with this code in the exemption certificate system. If that customer exists, and if that customer has uploaded an exemption certificate that applies to this transaction, the relevant parts of this transaction that can use the exemption certificate will be treated as exempt.

    • getExemptNo

      public java.lang.String getExemptNo()
      Getter for exemptNo The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable ECMS entry available, and will utilize it for exemption processing. If no applicable ECMS entry is available, the AvaTax service will determine if an Exemption Number field is populated or an Entity/Use Code is included in the sales tax calculation request, and will perform exemption processing using either of those two options.

    • setExemptNo

      public void setExemptNo​(java.lang.String value)
      Setter for exemptNo The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable ECMS entry available, and will utilize it for exemption processing. If no applicable ECMS entry is available, the AvaTax service will determine if an Exemption Number field is populated or an Entity/Use Code is included in the sales tax calculation request, and will perform exemption processing using either of those two options.

    • getReconciled

      public java.lang.Boolean getReconciled()
      Getter for reconciled If this transaction has been reconciled against the company's ledger, this value is set to true.

    • setReconciled

      public void setReconciled​(java.lang.Boolean value)
      Setter for reconciled If this transaction has been reconciled against the company's ledger, this value is set to true.

    • getLocationCode

      public java.lang.String getLocationCode()
      Getter for locationCode DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: In order to ensure consistency of field names, Please use reportingLocationCode instead. This field has been replaced by the reportingLocationCode field

    • setLocationCode

      public void setLocationCode​(java.lang.String value)
      Setter for locationCode DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: In order to ensure consistency of field names, Please use reportingLocationCode instead. This field has been replaced by the reportingLocationCode field

    • getReportingLocationCode

      public java.lang.String getReportingLocationCode()
      Getter for reportingLocationCode For customers who use [location-based tax reporting](https://developer.avalara.com/avatax/dev-guide/locations/location-based-reporting), this field controls how this transaction will be filed for multi-location tax filings. If you specify a non-null value for this field, AvaTax will ensure that this transaction is reported on the tax return associated with the [LocationModel](https://developer.avalara.com/api-reference/avatax/rest/v2/models/LocationModel/) identified by this code. This field does not affect any addresses for the transaction. It only controls the tax filing behavior of this transaction. If you are looking for information about how to set up addresses for a transaction, please see [Using Address Types](https://developer.avalara.com/avatax/dev-guide/customizing-transaction/address-types/) in the AvaTax Developer Guide.

    • setReportingLocationCode

      public void setReportingLocationCode​(java.lang.String value)
      Setter for reportingLocationCode For customers who use [location-based tax reporting](https://developer.avalara.com/avatax/dev-guide/locations/location-based-reporting), this field controls how this transaction will be filed for multi-location tax filings. If you specify a non-null value for this field, AvaTax will ensure that this transaction is reported on the tax return associated with the [LocationModel](https://developer.avalara.com/api-reference/avatax/rest/v2/models/LocationModel/) identified by this code. This field does not affect any addresses for the transaction. It only controls the tax filing behavior of this transaction. If you are looking for information about how to set up addresses for a transaction, please see [Using Address Types](https://developer.avalara.com/avatax/dev-guide/customizing-transaction/address-types/) in the AvaTax Developer Guide.

    • getPurchaseOrderNo

      public java.lang.String getPurchaseOrderNo()
      Getter for purchaseOrderNo The customer-supplied purchase order number of this transaction.

    • setPurchaseOrderNo

      public void setPurchaseOrderNo​(java.lang.String value)
      Setter for purchaseOrderNo The customer-supplied purchase order number of this transaction.

    • getReferenceCode

      public java.lang.String getReferenceCode()
      Getter for referenceCode A user-defined reference code for this transaction.

    • setReferenceCode

      public void setReferenceCode​(java.lang.String value)
      Setter for referenceCode A user-defined reference code for this transaction.

    • getSalespersonCode

      public java.lang.String getSalespersonCode()
      Getter for salespersonCode The salesperson who provided this transaction. Not required.

    • setSalespersonCode

      public void setSalespersonCode​(java.lang.String value)
      Setter for salespersonCode The salesperson who provided this transaction. Not required.

    • getTaxOverrideType

      public TaxOverrideType getTaxOverrideType()
      Getter for taxOverrideType If a tax override was applied to this transaction, indicates what type of tax override was applied.

    • setTaxOverrideType

      public void setTaxOverrideType​(TaxOverrideType value)
      Setter for taxOverrideType If a tax override was applied to this transaction, indicates what type of tax override was applied.

    • getTaxOverrideAmount

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

    • setTaxOverrideAmount

      public void setTaxOverrideAmount​(java.math.BigDecimal value)
      Setter for taxOverrideAmount If a tax override was applied to this transaction, indicates the amount of tax that was requested by the customer.

    • getTaxOverrideReason

      public java.lang.String getTaxOverrideReason()
      Getter for taxOverrideReason If a tax override was applied to this transaction, indicates the reason for the tax override.

    • setTaxOverrideReason

      public void setTaxOverrideReason​(java.lang.String value)
      Setter for taxOverrideReason If a tax override was applied to this transaction, indicates the reason for the tax override.

    • getTotalAmount

      public java.math.BigDecimal getTotalAmount()
      Getter for totalAmount The total amount of this transaction.

    • setTotalAmount

      public void setTotalAmount​(java.math.BigDecimal value)
      Setter for totalAmount The total amount of this transaction.

    • getTotalExempt

      public java.math.BigDecimal getTotalExempt()
      Getter for totalExempt The amount of this transaction that was exempt.

    • setTotalExempt

      public void setTotalExempt​(java.math.BigDecimal value)
      Setter for totalExempt The amount of this transaction that was exempt.

    • getTotalDiscount

      public java.math.BigDecimal getTotalDiscount()
      Getter for totalDiscount The total amount of discounts applied to all lines within this transaction.

    • setTotalDiscount

      public void setTotalDiscount​(java.math.BigDecimal value)
      Setter for totalDiscount The total amount of discounts applied to all lines within this transaction.

    • getTotalTax

      public java.math.BigDecimal getTotalTax()
      Getter for totalTax The total tax for all lines in this transaction. If you used a `taxOverride` of type `taxAmount` for any lines in this transaction, this value may be different than the amount of tax calculated by AvaTax. The amount of tax calculated by AvaTax will be stored in the `totalTaxCalculated` field, whereas this field will contain the total tax that was charged on the transaction. You can compare the `totalTax` and `totalTaxCalculated` fields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax.

    • setTotalTax

      public void setTotalTax​(java.math.BigDecimal value)
      Setter for totalTax The total tax for all lines in this transaction. If you used a `taxOverride` of type `taxAmount` for any lines in this transaction, this value may be different than the amount of tax calculated by AvaTax. The amount of tax calculated by AvaTax will be stored in the `totalTaxCalculated` field, whereas this field will contain the total tax that was charged on the transaction. You can compare the `totalTax` and `totalTaxCalculated` fields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax.

    • getTotalTaxable

      public java.math.BigDecimal getTotalTaxable()
      Getter for totalTaxable The portion of the total amount of this transaction that was taxable.

    • setTotalTaxable

      public void setTotalTaxable​(java.math.BigDecimal value)
      Setter for totalTaxable The portion of the total amount of this transaction that was taxable.

    • getTotalTaxCalculated

      public java.math.BigDecimal getTotalTaxCalculated()
      Getter for totalTaxCalculated The amount of tax that AvaTax calculated for the transaction. If you used a `taxOverride` of type `taxAmount` for any lines in this transaction, this value will represent the amount that AvaTax calculated for this transaction without applying the override. The field `totalTax` will be the total amount of tax after all overrides are applied. You can compare the `totalTax` and `totalTaxCalculated` fields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax.

    • setTotalTaxCalculated

      public void setTotalTaxCalculated​(java.math.BigDecimal value)
      Setter for totalTaxCalculated The amount of tax that AvaTax calculated for the transaction. If you used a `taxOverride` of type `taxAmount` for any lines in this transaction, this value will represent the amount that AvaTax calculated for this transaction without applying the override. The field `totalTax` will be the total amount of tax after all overrides are applied. You can compare the `totalTax` and `totalTaxCalculated` fields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax.

    • getAdjustmentReason

      public AdjustmentReason getAdjustmentReason()
      Getter for adjustmentReason If this transaction was adjusted, indicates the unique ID number of the reason why the transaction was adjusted.

    • setAdjustmentReason

      public void setAdjustmentReason​(AdjustmentReason value)
      Setter for adjustmentReason If this transaction was adjusted, indicates the unique ID number of the reason why the transaction was adjusted.

    • getAdjustmentDescription

      public java.lang.String getAdjustmentDescription()
      Getter for adjustmentDescription If this transaction was adjusted, indicates a description of the reason why the transaction was adjusted.

    • setAdjustmentDescription

      public void setAdjustmentDescription​(java.lang.String value)
      Setter for adjustmentDescription If this transaction was adjusted, indicates a description of the reason why the transaction was adjusted.

    • getLocked

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

    • setLocked

      public void setLocked​(java.lang.Boolean value)
      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.

    • getRegion

      public java.lang.String getRegion()
      Getter for region The two-or-three character ISO region code of the region for this transaction.

    • setRegion

      public void setRegion​(java.lang.String value)
      Setter for region The two-or-three character ISO region code of the region for this transaction.

    • getCountry

      public java.lang.String getCountry()
      Getter for country The two-character ISO 3166 code of the country for this transaction.

    • setCountry

      public void setCountry​(java.lang.String value)
      Setter for country The two-character ISO 3166 code of the country for this transaction.

    • getVersion

      public java.lang.Integer getVersion()
      Getter for version If this transaction was adjusted, this indicates the version number of this transaction. Incremented each time the transaction is adjusted.

    • setVersion

      public void setVersion​(java.lang.Integer value)
      Setter for version If this transaction was adjusted, this indicates the version number of this transaction. Incremented each time the transaction is adjusted.

    • getSoftwareVersion

      public java.lang.String getSoftwareVersion()
      Getter for softwareVersion The software version used to calculate this transaction.

    • setSoftwareVersion

      public void setSoftwareVersion​(java.lang.String value)
      Setter for softwareVersion The software version used to calculate this transaction.

    • getOriginAddressId

      public java.lang.Long getOriginAddressId()
      Getter for originAddressId The unique ID number of the origin address for this transaction.

    • setOriginAddressId

      public void setOriginAddressId​(java.lang.Long value)
      Setter for originAddressId The unique ID number of the origin address for this transaction.

    • getDestinationAddressId

      public java.lang.Long getDestinationAddressId()
      Getter for destinationAddressId The unique ID number of the destination address for this transaction.

    • setDestinationAddressId

      public void setDestinationAddressId​(java.lang.Long value)
      Setter for destinationAddressId The unique ID number of the destination address for this transaction.

    • getExchangeRateEffectiveDate

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

    • setExchangeRateEffectiveDate

      public void setExchangeRateEffectiveDate​(java.util.Date value)
      Setter for exchangeRateEffectiveDate If this transaction included foreign currency exchange, this is the date as of which the exchange rate was calculated.

    • getExchangeRate

      public java.math.BigDecimal getExchangeRate()
      Getter for exchangeRate If this transaction included foreign currency exchange, this is the exchange rate that was used.

    • setExchangeRate

      public void setExchangeRate​(java.math.BigDecimal value)
      Setter for exchangeRate If this transaction included foreign currency exchange, this is the exchange rate that was used.

    • getIsSellerImporterOfRecord

      public java.lang.Boolean getIsSellerImporterOfRecord()
      Getter for isSellerImporterOfRecord By default, the value is null, when the value is null, the value can be set at nexus level and used. If the value is not null, it will override the value at nexus level. If true, this seller was considered the importer of record of a product shipped internationally. If this transaction is not an international transaction, this field may be left blank. The "importer of record" is liable to pay customs and import duties for products shipped internationally. If you specify that the seller is the importer of record, then estimates of customs and import duties will be added as tax details to the transaction. Otherwise, the buyer is considered the importer of record, and customs and import duties will not be added to the tax details for this transaction.

    • setIsSellerImporterOfRecord

      public void setIsSellerImporterOfRecord​(java.lang.Boolean value)
      Setter for isSellerImporterOfRecord By default, the value is null, when the value is null, the value can be set at nexus level and used. If the value is not null, it will override the value at nexus level. If true, this seller was considered the importer of record of a product shipped internationally. If this transaction is not an international transaction, this field may be left blank. The "importer of record" is liable to pay customs and import duties for products shipped internationally. If you specify that the seller is the importer of record, then estimates of customs and import duties will be added as tax details to the transaction. Otherwise, the buyer is considered the importer of record, and customs and import duties will not be added to the tax details for this transaction.

    • getDescription

      public java.lang.String getDescription()
      Getter for description Description of this transaction. Field permits unicode values.

    • setDescription

      public void setDescription​(java.lang.String value)
      Setter for description Description of this transaction. Field permits unicode values.

    • getEmail

      public java.lang.String getEmail()
      Getter for email Email address associated with this transaction.

    • setEmail

      public void setEmail​(java.lang.String value)
      Setter for email Email address associated with this transaction.

    • getBusinessIdentificationNo

      public java.lang.String getBusinessIdentificationNo()
      Getter for businessIdentificationNo VAT business identification number used for this transaction.

    • setBusinessIdentificationNo

      public void setBusinessIdentificationNo​(java.lang.String value)
      Setter for businessIdentificationNo VAT business identification number used for this transaction.

    • getModifiedDate

      public java.util.Date getModifiedDate()
      Getter for modifiedDate The date/time when this record was last modified.

    • setModifiedDate

      public void setModifiedDate​(java.util.Date value)
      Setter for modifiedDate The date/time when this record was last modified.

    • getModifiedUserId

      public java.lang.Integer getModifiedUserId()
      Getter for modifiedUserId The user ID of the user who last modified this record.

    • setModifiedUserId

      public void setModifiedUserId​(java.lang.Integer value)
      Setter for modifiedUserId The user ID of the user who last modified this record.

    • getTaxDate

      public java.util.Date getTaxDate()
      Getter for taxDate Tax date for this transaction

    • setTaxDate

      public void setTaxDate​(java.util.Date value)
      Setter for taxDate Tax date for this transaction

    • getLines

      public java.util.ArrayList<TransactionLineModel> getLines()
      Getter for lines A list of line items in this transaction. To fetch this list, add the query string `?$include=Lines` or `?$include=Details` to your URL.

    • setLines

      public void setLines​(java.util.ArrayList<TransactionLineModel> value)
      Setter for lines A list of line items in this transaction. To fetch this list, add the query string `?$include=Lines` or `?$include=Details` to your URL.

    • getAddresses

      public java.util.ArrayList<TransactionAddressModel> getAddresses()
      Getter for addresses A list of line items in this transaction. To fetch this list, add the query string `?$include=Addresses` to your URL. For more information about transaction addresses, please see [Using Address Types](https://developer.avalara.com/avatax/dev-guide/customizing-transaction/address-types/) in the AvaTax Developer Guide.

    • setAddresses

      public void setAddresses​(java.util.ArrayList<TransactionAddressModel> value)
      Setter for addresses A list of line items in this transaction. To fetch this list, add the query string `?$include=Addresses` to your URL. For more information about transaction addresses, please see [Using Address Types](https://developer.avalara.com/avatax/dev-guide/customizing-transaction/address-types/) in the AvaTax Developer Guide.

    • getLocationTypes

      public java.util.ArrayList<TransactionLocationTypeModel> getLocationTypes()
      Getter for locationTypes A list of location types in this transaction. To fetch this list, add the query string `?$include=Addresses` to your URL.

    • setLocationTypes

      public void setLocationTypes​(java.util.ArrayList<TransactionLocationTypeModel> value)
      Setter for locationTypes A list of location types in this transaction. To fetch this list, add the query string `?$include=Addresses` to your URL.

    • getSummary

      public java.util.ArrayList<TransactionSummary> getSummary()
      Getter for summary Contains a summary of tax on this transaction.

    • setSummary

      public void setSummary​(java.util.ArrayList<TransactionSummary> value)
      Setter for summary Contains a summary of tax on this transaction.

    • getTaxDetailsByTaxType

      public java.util.ArrayList<TaxDetailsByTaxType> getTaxDetailsByTaxType()
      Getter for taxDetailsByTaxType Contains the tax details per tax type

    • setTaxDetailsByTaxType

      public void setTaxDetailsByTaxType​(java.util.ArrayList<TaxDetailsByTaxType> value)
      Setter for taxDetailsByTaxType Contains the tax details per tax type

    • getParameters

      public java.util.ArrayList<TransactionParameterModel> getParameters()
      Getter for parameters Contains a list of extra parameters that were set when the transaction was created.

    • setParameters

      public void setParameters​(java.util.ArrayList<TransactionParameterModel> value)
      Setter for parameters Contains a list of extra parameters that were set when the transaction was created.

    • getUserDefinedFields

      public java.util.ArrayList<TransactionUserDefinedFieldModel> getUserDefinedFields()
      Getter for userDefinedFields Custom user fields/flex fields for this transaction.

    • setUserDefinedFields

      public void setUserDefinedFields​(java.util.ArrayList<TransactionUserDefinedFieldModel> value)
      Setter for userDefinedFields Custom user fields/flex fields for this transaction.

    • getMessages

      public java.util.ArrayList<AvaTaxMessage> getMessages()
      Getter for messages List of informational and warning messages regarding this API call. These messages are only relevant to the current API call.

    • setMessages

      public void setMessages​(java.util.ArrayList<AvaTaxMessage> value)
      Setter for messages List of informational and warning messages regarding this API call. These messages are only relevant to the current API call.

    • getInvoiceMessages

      public java.util.ArrayList<InvoiceMessageModel> getInvoiceMessages()
      Getter for invoiceMessages Invoice messages associated with this document. Currently, this stores legally-required VAT messages.

    • setInvoiceMessages

      public void setInvoiceMessages​(java.util.ArrayList<InvoiceMessageModel> value)
      Setter for invoiceMessages Invoice messages associated with this document. Currently, this stores legally-required VAT messages.

    • getCustomerSupplierName

      public java.lang.String getCustomerSupplierName()
      Getter for customerSupplierName The name of the supplier / exporter / seller. For sales doctype this will be the name of your own company for which you are reporting. For purchases doctype this will be the name of the supplier you have purchased from.

    • setCustomerSupplierName

      public void setCustomerSupplierName​(java.lang.String value)
      Setter for customerSupplierName The name of the supplier / exporter / seller. For sales doctype this will be the name of your own company for which you are reporting. For purchases doctype this will be the name of the supplier you have purchased from.

    • getDataSourceId

      public java.lang.Integer getDataSourceId()
      Getter for dataSourceId The Id of the datasource from which this transaction originated. This value will be overridden by the system to take the datasource Id from the call header.

    • setDataSourceId

      public void setDataSourceId​(java.lang.Integer value)
      Setter for dataSourceId The Id of the datasource from which this transaction originated. This value will be overridden by the system to take the datasource Id from the call header.

    • getDeliveryTerms

      public DeliveryTerms getDeliveryTerms()
      Getter for deliveryTerms The Delivery Terms is a field used in conjunction with Importer of Record to influence whether AvaTax includes Import Duty and Tax values in the transaction totals or not. Delivered at Place (DAP) and Delivered Duty Paid (DDP) are two delivery terms that indicate that Import Duty and Tax should be included in the transaction total. This field is also used for reports. This field is used for future feature support. This field is not currently in use.

    • setDeliveryTerms

      public void setDeliveryTerms​(DeliveryTerms value)
      Setter for deliveryTerms The Delivery Terms is a field used in conjunction with Importer of Record to influence whether AvaTax includes Import Duty and Tax values in the transaction totals or not. Delivered at Place (DAP) and Delivered Duty Paid (DDP) are two delivery terms that indicate that Import Duty and Tax should be included in the transaction total. This field is also used for reports. This field is used for future feature support. This field is not currently in use.

    • toString

      public java.lang.String toString()
      Returns a JSON string representation of TransactionModel
      Overrides:
      toString in class java.lang.Object