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

Class TransactionModel

java.lang.Object

net.avalara.avatax.rest.client.models.TransactionModel

public class TransactionModel
extends 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
ArrayList<TransactionAddressModel>	getAddresses()	Getter for addresses A list of line items in this transaction.
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.
String	getApStatus()	Getter for apStatus An Accounts Payable (AP) status indicates an action that needs to be taken when the tolerance amount falls above or below certain threshold limits.
APStatus	getApStatusCode()	Getter for apStatusCode Users can set tolerance or threshold limits on transactions and inform users of appropriate actions to take if a transaction falls outside of these values.
String	getBatchCode()	Getter for batchCode If this transaction was created as part of a batch, this code indicates which batch.
String	getBusinessIdentificationNo()	Getter for businessIdentificationNo VAT business identification number used for this transaction.
String	getCode()	Getter for code A unique customer-provided code identifying this transaction.
Integer	getCompanyId()	Getter for companyId The unique ID number of the company that recorded this transaction.
String	getCountry()	Getter for country The two-character ISO 3166 code of the country for this transaction.
String	getCurrencyCode()	Getter for currencyCode The three-character ISO 4217 currency code that was used for payment for this transaction.
String	getCustomerCode()	Getter for customerCode Unique code identifying the customer that requested this transaction.
String	getCustomerSupplierName()	Getter for customerSupplierName The name of the supplier / exporter / seller.
String	getCustomerUsageType()	Getter for customerUsageType DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead.
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.
Integer	getDataSourceId()	Getter for dataSourceId The Id of the datasource from which this transaction originated.
Date	getDate()	Getter for date The date on which this transaction occurred.
DeliveryTerms	getDeliveryTerms()	Getter for deliveryTerms Delivery Terms (or Incoterms) refer to agreed-upon conditions between a buyer and a seller for the delivery of goods.
String	getDescription()	Getter for description Description of this transaction.
Long	getDestinationAddressId()	Getter for destinationAddressId The unique ID number of the destination address for this transaction.
String	getEmail()	Getter for email Email address associated with this transaction.
String	getEntityUseCode()	Getter for entityUseCode The entity use code for this transaction.
BigDecimal	getExchangeRate()	Getter for exchangeRate If this transaction included foreign currency exchange, this is the exchange rate that was used.
String	getExchangeRateCurrencyCode()	Getter for exchangeRateCurrencyCode The three-character ISO 4217 exchange rate currency code that was used for payment for this transaction.
Date	getExchangeRateEffectiveDate()	Getter for exchangeRateEffectiveDate If this transaction included foreign currency exchange, this is the date as of which the exchange rate was calculated.
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.
Long	getId()	Getter for id The unique ID number of this transaction.
ArrayList<InvoiceMessageModel>	getInvoiceMessages()	Getter for invoiceMessages Invoice messages associated with this document.
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.
ArrayList<TransactionLineModel>	getLines()	Getter for lines A list of line items in this transaction.
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.
ArrayList<TransactionLocationTypeModel>	getLocationTypes()	Getter for locationTypes A list of location types in this transaction.
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.
ArrayList<AvaTaxMessage>	getMessages()	Getter for messages List of informational and warning messages regarding this API call.
Date	getModifiedDate()	Getter for modifiedDate The date/time when this record was last modified.
Integer	getModifiedUserId()	Getter for modifiedUserId The user ID of the user who last modified this record.
Long	getOriginAddressId()	Getter for originAddressId The unique ID number of the origin address for this transaction.
ArrayList<TransactionParameterModel>	getParameters()	Getter for parameters Contains a list of extra parameters that were set when the transaction was created.
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.
String	getPurchaseOrderNo()	Getter for purchaseOrderNo The customer-supplied purchase order number of this transaction.
Boolean	getReconciled()	Getter for reconciled If this transaction has been reconciled against the company's ledger, this value is set to true.
String	getReferenceCode()	Getter for referenceCode A user-defined reference code for this transaction.
String	getRegion()	Getter for region The two-or-three character ISO region code of the region for this transaction.
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.
String	getSalespersonCode()	Getter for salespersonCode The salesperson who provided this transaction.
String	getSoftwareVersion()	Getter for softwareVersion The software version used to calculate this transaction.
DocumentStatus	getStatus()	Getter for status The status of the transaction.
ArrayList<TransactionSummary>	getSummary()	Getter for summary Contains a summary of tax on this transaction.
Date	getTaxDate()	Getter for taxDate Tax date for this transaction
ArrayList<TaxDetailsByTaxType>	getTaxDetailsByTaxType()	Getter for taxDetailsByTaxType Contains the tax details per tax type
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.
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.
BigDecimal	getTotalAmount()	Getter for totalAmount The total amount of this transaction.
BigDecimal	getTotalDiscount()	Getter for totalDiscount The total amount of discounts applied to all lines within this transaction.
BigDecimal	getTotalExempt()	Getter for totalExempt The amount of this transaction that was exempt.
BigDecimal	getTotalTax()	Getter for totalTax The total tax for all lines in this transaction.
BigDecimal	getTotalTaxable()	Getter for totalTaxable The portion of the total amount of this transaction that was taxable.
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.
ArrayList<TransactionUserDefinedFieldModel>	getUserDefinedFields()	Getter for userDefinedFields Custom user fields/flex fields for this transaction.
Integer	getVersion()	Getter for version If this transaction was adjusted, this indicates the version number of this transaction.
void	setAddresses(ArrayList<TransactionAddressModel> value)	Setter for addresses A list of line items in this transaction.
void	setAdjustmentDescription(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	setApStatus(String value)	Setter for apStatus An Accounts Payable (AP) status indicates an action that needs to be taken when the tolerance amount falls above or below certain threshold limits.
void	setApStatusCode(APStatus value)	Setter for apStatusCode Users can set tolerance or threshold limits on transactions and inform users of appropriate actions to take if a transaction falls outside of these values.
void	setBatchCode(String value)	Setter for batchCode If this transaction was created as part of a batch, this code indicates which batch.
void	setBusinessIdentificationNo(String value)	Setter for businessIdentificationNo VAT business identification number used for this transaction.
void	setCode(String value)	Setter for code A unique customer-provided code identifying this transaction.
void	setCompanyId(Integer value)	Setter for companyId The unique ID number of the company that recorded this transaction.
void	setCountry(String value)	Setter for country The two-character ISO 3166 code of the country for this transaction.
void	setCurrencyCode(String value)	Setter for currencyCode The three-character ISO 4217 currency code that was used for payment for this transaction.
void	setCustomerCode(String value)	Setter for customerCode Unique code identifying the customer that requested this transaction.
void	setCustomerSupplierName(String value)	Setter for customerSupplierName The name of the supplier / exporter / seller.
void	setCustomerUsageType(String value)	Setter for customerUsageType DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead.
void	setCustomerVendorCode(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(Integer value)	Setter for dataSourceId The Id of the datasource from which this transaction originated.
void	setDate(Date value)	Setter for date The date on which this transaction occurred.
void	setDeliveryTerms(DeliveryTerms value)	Setter for deliveryTerms Delivery Terms (or Incoterms) refer to agreed-upon conditions between a buyer and a seller for the delivery of goods.
void	setDescription(String value)	Setter for description Description of this transaction.
void	setDestinationAddressId(Long value)	Setter for destinationAddressId The unique ID number of the destination address for this transaction.
void	setEmail(String value)	Setter for email Email address associated with this transaction.
void	setEntityUseCode(String value)	Setter for entityUseCode The entity use code for this transaction.
void	setExchangeRate(BigDecimal value)	Setter for exchangeRate If this transaction included foreign currency exchange, this is the exchange rate that was used.
void	setExchangeRateCurrencyCode(String value)	Setter for exchangeRateCurrencyCode The three-character ISO 4217 exchange rate currency code that was used for payment for this transaction.
void	setExchangeRateEffectiveDate(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(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(Long value)	Setter for id The unique ID number of this transaction.
void	setInvoiceMessages(ArrayList<InvoiceMessageModel> value)	Setter for invoiceMessages Invoice messages associated with this document.
void	setIsSellerImporterOfRecord(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(ArrayList<TransactionLineModel> value)	Setter for lines A list of line items in this transaction.
void	setLocationCode(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(ArrayList<TransactionLocationTypeModel> value)	Setter for locationTypes A list of location types in this transaction.
void	setLocked(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(ArrayList<AvaTaxMessage> value)	Setter for messages List of informational and warning messages regarding this API call.
void	setModifiedDate(Date value)	Setter for modifiedDate The date/time when this record was last modified.
void	setModifiedUserId(Integer value)	Setter for modifiedUserId The user ID of the user who last modified this record.
void	setOriginAddressId(Long value)	Setter for originAddressId The unique ID number of the origin address for this transaction.
void	setParameters(ArrayList<TransactionParameterModel> value)	Setter for parameters Contains a list of extra parameters that were set when the transaction was created.
void	setPaymentDate(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(String value)	Setter for purchaseOrderNo The customer-supplied purchase order number of this transaction.
void	setReconciled(Boolean value)	Setter for reconciled If this transaction has been reconciled against the company's ledger, this value is set to true.
void	setReferenceCode(String value)	Setter for referenceCode A user-defined reference code for this transaction.
void	setRegion(String value)	Setter for region The two-or-three character ISO region code of the region for this transaction.
void	setReportingLocationCode(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(String value)	Setter for salespersonCode The salesperson who provided this transaction.
void	setSoftwareVersion(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(ArrayList<TransactionSummary> value)	Setter for summary Contains a summary of tax on this transaction.
void	setTaxDate(Date value)	Setter for taxDate Tax date for this transaction
void	setTaxDetailsByTaxType(ArrayList<TaxDetailsByTaxType> value)	Setter for taxDetailsByTaxType Contains the tax details per tax type
void	setTaxOverrideAmount(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(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(BigDecimal value)	Setter for totalAmount The total amount of this transaction.
void	setTotalDiscount(BigDecimal value)	Setter for totalDiscount The total amount of discounts applied to all lines within this transaction.
void	setTotalExempt(BigDecimal value)	Setter for totalExempt The amount of this transaction that was exempt.
void	setTotalTax(BigDecimal value)	Setter for totalTax The total tax for all lines in this transaction.
void	setTotalTaxable(BigDecimal value)	Setter for totalTaxable The portion of the total amount of this transaction that was taxable.
void	setTotalTaxCalculated(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(ArrayList<TransactionUserDefinedFieldModel> value)	Setter for userDefinedFields Custom user fields/flex fields for this transaction.
void	setVersion(Integer value)	Setter for version If this transaction was adjusted, this indicates the version number of this transaction.
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

TransactionModel

public TransactionModel()

Method Details

getId

public Long getId()

Getter for id The unique ID number of this transaction.

setId

public void setId(Long value)

Setter for id The unique ID number of this transaction.

getCode

public String getCode()

Getter for code A unique customer-provided code identifying this transaction.

setCode

public void setCode(String value)

Setter for code A unique customer-provided code identifying this transaction.

getCompanyId

public Integer getCompanyId()

Getter for companyId The unique ID number of the company that recorded this transaction.

setCompanyId

public void setCompanyId(Integer value)

Setter for companyId The unique ID number of the company that recorded this transaction.

getDate

public Date getDate()

Getter for date The date on which this transaction occurred.

setDate

public void setDate(Date value)

Setter for date The date on which this transaction occurred.

getPaymentDate

public 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(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 String getBatchCode()

Getter for batchCode If this transaction was created as part of a batch, this code indicates which batch.

setBatchCode

public void setBatchCode(String value)

Setter for batchCode If this transaction was created as part of a batch, this code indicates which batch.

getCurrencyCode

public String getCurrencyCode()

Getter for currencyCode The three-character ISO 4217 currency code that was used for payment for this transaction.

setCurrencyCode

public void setCurrencyCode(String value)

Setter for currencyCode The three-character ISO 4217 currency code that was used for payment for this transaction.

getExchangeRateCurrencyCode

public 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(String value)

Setter for exchangeRateCurrencyCode The three-character ISO 4217 exchange rate currency code that was used for payment for this transaction.

getCustomerUsageType

public 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(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 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(String value)

Setter for entityUseCode The entity use code for this transaction. Entity use codes often affect exemption or taxability rules.

getCustomerVendorCode

public 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(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 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(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 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(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 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(Boolean value)

Setter for reconciled If this transaction has been reconciled against the company's ledger, this value is set to true.

getLocationCode

public 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(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 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(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 String getPurchaseOrderNo()

Getter for purchaseOrderNo The customer-supplied purchase order number of this transaction.

setPurchaseOrderNo

public void setPurchaseOrderNo(String value)

Setter for purchaseOrderNo The customer-supplied purchase order number of this transaction.

getReferenceCode

public String getReferenceCode()

Getter for referenceCode A user-defined reference code for this transaction.

setReferenceCode

public void setReferenceCode(String value)

Setter for referenceCode A user-defined reference code for this transaction.

getSalespersonCode

public String getSalespersonCode()

Getter for salespersonCode The salesperson who provided this transaction. Not required.

setSalespersonCode

public void setSalespersonCode(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 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(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 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(String value)

Setter for taxOverrideReason If a tax override was applied to this transaction, indicates the reason for the tax override.

getTotalAmount

public BigDecimal getTotalAmount()

Getter for totalAmount The total amount of this transaction.

setTotalAmount

public void setTotalAmount(BigDecimal value)

Setter for totalAmount The total amount of this transaction.

getTotalExempt

public BigDecimal getTotalExempt()

Getter for totalExempt The amount of this transaction that was exempt.

setTotalExempt

public void setTotalExempt(BigDecimal value)

Setter for totalExempt The amount of this transaction that was exempt.

getTotalDiscount

public BigDecimal getTotalDiscount()

Getter for totalDiscount The total amount of discounts applied to all lines within this transaction.

setTotalDiscount

public void setTotalDiscount(BigDecimal value)

Setter for totalDiscount The total amount of discounts applied to all lines within this transaction.

getTotalTax

public 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(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 BigDecimal getTotalTaxable()

Getter for totalTaxable The portion of the total amount of this transaction that was taxable.

setTotalTaxable

public void setTotalTaxable(BigDecimal value)

Setter for totalTaxable The portion of the total amount of this transaction that was taxable.

getTotalTaxCalculated

public 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(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 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(String value)

Setter for adjustmentDescription If this transaction was adjusted, indicates a description of the reason why the transaction was adjusted.

getLocked

public 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(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 String getRegion()

Getter for region The two-or-three character ISO region code of the region for this transaction.

setRegion

public void setRegion(String value)

Setter for region The two-or-three character ISO region code of the region for this transaction.

getCountry

public String getCountry()

Getter for country The two-character ISO 3166 code of the country for this transaction.

setCountry

public void setCountry(String value)

Setter for country The two-character ISO 3166 code of the country for this transaction.

getVersion

public 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(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 String getSoftwareVersion()

Getter for softwareVersion The software version used to calculate this transaction.

setSoftwareVersion

public void setSoftwareVersion(String value)

Setter for softwareVersion The software version used to calculate this transaction.

getOriginAddressId

public Long getOriginAddressId()

Getter for originAddressId The unique ID number of the origin address for this transaction.

setOriginAddressId

public void setOriginAddressId(Long value)

Setter for originAddressId The unique ID number of the origin address for this transaction.

getDestinationAddressId

public Long getDestinationAddressId()

Getter for destinationAddressId The unique ID number of the destination address for this transaction.

setDestinationAddressId

public void setDestinationAddressId(Long value)

Setter for destinationAddressId The unique ID number of the destination address for this transaction.

getExchangeRateEffectiveDate

public 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(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 BigDecimal getExchangeRate()

Getter for exchangeRate If this transaction included foreign currency exchange, this is the exchange rate that was used.

setExchangeRate

public void setExchangeRate(BigDecimal value)

Setter for exchangeRate If this transaction included foreign currency exchange, this is the exchange rate that was used.

getIsSellerImporterOfRecord

public 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(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 String getDescription()

Getter for description Description of this transaction. Field permits unicode values.

setDescription

public void setDescription(String value)

Setter for description Description of this transaction. Field permits unicode values.

getEmail

public String getEmail()

Getter for email Email address associated with this transaction.

setEmail

public void setEmail(String value)

Setter for email Email address associated with this transaction.

getBusinessIdentificationNo

public String getBusinessIdentificationNo()

Getter for businessIdentificationNo VAT business identification number used for this transaction.

setBusinessIdentificationNo

public void setBusinessIdentificationNo(String value)

Setter for businessIdentificationNo VAT business identification number used for this transaction.

getModifiedDate

public Date getModifiedDate()

Getter for modifiedDate The date/time when this record was last modified.

setModifiedDate

public void setModifiedDate(Date value)

Setter for modifiedDate The date/time when this record was last modified.

getModifiedUserId

public Integer getModifiedUserId()

Getter for modifiedUserId The user ID of the user who last modified this record.

setModifiedUserId

public void setModifiedUserId(Integer value)

Setter for modifiedUserId The user ID of the user who last modified this record.

getTaxDate

public Date getTaxDate()

Getter for taxDate Tax date for this transaction

setTaxDate

public void setTaxDate(Date value)

Setter for taxDate Tax date for this transaction

getLines

public 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(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 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(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 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(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 ArrayList<TransactionSummary> getSummary()

Getter for summary Contains a summary of tax on this transaction.

setSummary

public void setSummary(ArrayList<TransactionSummary> value)

Setter for summary Contains a summary of tax on this transaction.

getTaxDetailsByTaxType

public ArrayList<TaxDetailsByTaxType> getTaxDetailsByTaxType()

Getter for taxDetailsByTaxType Contains the tax details per tax type

setTaxDetailsByTaxType

public void setTaxDetailsByTaxType(ArrayList<TaxDetailsByTaxType> value)

Setter for taxDetailsByTaxType Contains the tax details per tax type

getParameters

public ArrayList<TransactionParameterModel> getParameters()

Getter for parameters Contains a list of extra parameters that were set when the transaction was created.

setParameters

public void setParameters(ArrayList<TransactionParameterModel> value)

Setter for parameters Contains a list of extra parameters that were set when the transaction was created.

getUserDefinedFields

public ArrayList<TransactionUserDefinedFieldModel> getUserDefinedFields()

Getter for userDefinedFields Custom user fields/flex fields for this transaction.

setUserDefinedFields

public void setUserDefinedFields(ArrayList<TransactionUserDefinedFieldModel> value)

Setter for userDefinedFields Custom user fields/flex fields for this transaction.

getMessages

public 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(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 ArrayList<InvoiceMessageModel> getInvoiceMessages()

Getter for invoiceMessages Invoice messages associated with this document. Currently, this stores legally-required VAT messages.

setInvoiceMessages

public void setInvoiceMessages(ArrayList<InvoiceMessageModel> value)

Setter for invoiceMessages Invoice messages associated with this document. Currently, this stores legally-required VAT messages.

getCustomerSupplierName

public 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(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 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(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 Delivery Terms (or Incoterms) refer to agreed-upon conditions between a buyer and a seller for the delivery of goods. They are three-letter trade terms that describe the practical arrangements for the delivery of goods from sellers to buyers and set out the obligations, costs, and risks between the two parties. The DeliveryTerms field determines who acts as the Importer of Record and who arranges the Transport of the goods when this information is not separately sent to AvaTax in the request. When used in conjunction with isSellerImporterOfRecord, this parameter can also influence whether AvaTax includes Import Duty and Tax in the transaction totals. If the fields for transport or isSellerImporterOfRecord are passed in the request and conflict with the DeliveryTerms, the values provided in the first will take priority over the DeliveryTerms parameter. If neither transport nor isSellerImporterOfRecord is passed in the request and DeliveryTerms is passed, AvaTax will determine who acts as Importer of Record and who arranges the Transport of the goods based on the specified DeliveryTerms. If none of these fields is passed, AvaTax will keep the current behavior and default transport to "Seller" for goods and isSellerImporterOfRecord to "False" (i.e., the AvaTax user does not act as Importer of record)." Finally, this field is also used for reports. The Delivery Terms that the user can pass are the following: 1. Ex Works (EXW) 2. Free Carrier (FCA) 3. Carrier and Insurance Paid to (CIP) 4. Carriage Paid To (CPT) 5. Delivered at Place (DAP) 6. Delivered at Place Unloaded (DPU) 7. Delivered Duty Paid (DDP) 8. Free Alongside Ship (FAS) 9. Free on Board (FOB) 10. Cost and Freight (CFR) 11. Cost, Insurance and Freight (CIF) DAP and DDP are two delivery terms that indicate that Import Duty and Tax should be included in the transaction total.

setDeliveryTerms

public void setDeliveryTerms(DeliveryTerms value)

Setter for deliveryTerms Delivery Terms (or Incoterms) refer to agreed-upon conditions between a buyer and a seller for the delivery of goods. They are three-letter trade terms that describe the practical arrangements for the delivery of goods from sellers to buyers and set out the obligations, costs, and risks between the two parties. The DeliveryTerms field determines who acts as the Importer of Record and who arranges the Transport of the goods when this information is not separately sent to AvaTax in the request. When used in conjunction with isSellerImporterOfRecord, this parameter can also influence whether AvaTax includes Import Duty and Tax in the transaction totals. If the fields for transport or isSellerImporterOfRecord are passed in the request and conflict with the DeliveryTerms, the values provided in the first will take priority over the DeliveryTerms parameter. If neither transport nor isSellerImporterOfRecord is passed in the request and DeliveryTerms is passed, AvaTax will determine who acts as Importer of Record and who arranges the Transport of the goods based on the specified DeliveryTerms. If none of these fields is passed, AvaTax will keep the current behavior and default transport to "Seller" for goods and isSellerImporterOfRecord to "False" (i.e., the AvaTax user does not act as Importer of record)." Finally, this field is also used for reports. The Delivery Terms that the user can pass are the following: 1. Ex Works (EXW) 2. Free Carrier (FCA) 3. Carrier and Insurance Paid to (CIP) 4. Carriage Paid To (CPT) 5. Delivered at Place (DAP) 6. Delivered at Place Unloaded (DPU) 7. Delivered Duty Paid (DDP) 8. Free Alongside Ship (FAS) 9. Free on Board (FOB) 10. Cost and Freight (CFR) 11. Cost, Insurance and Freight (CIF) DAP and DDP are two delivery terms that indicate that Import Duty and Tax should be included in the transaction total.

getApStatusCode

public APStatus getApStatusCode()

Getter for apStatusCode Users can set tolerance or threshold limits on transactions and inform users of appropriate actions to take if a transaction falls outside of these values. An Accounts Payable (AP) status code indicates the action that needs to be taken when the tolerance/threshold falls above or below the tolerance/threshold limits. Available AP status codes are: 1. NoAccrualMatch 2. NoAccrualUndercharge 3. NoAccrualOvercharge 4. NoAccrualAmountThresholdNotMet 5. NoAccrualTrustedVendor 6. NoAccrualExemptedCostCenter 7. NoAccrualExemptedItem 8. NoAccrualExemptedVendor 9. AccruedUndercharge 10. AccruedVendor 11. NeedReviewUndercharge 12. NeedReviewVendor 13. PendingAccrualVendor 14. PendingAccrualUndercharge

setApStatusCode

public void setApStatusCode(APStatus value)

Setter for apStatusCode Users can set tolerance or threshold limits on transactions and inform users of appropriate actions to take if a transaction falls outside of these values. An Accounts Payable (AP) status code indicates the action that needs to be taken when the tolerance/threshold falls above or below the tolerance/threshold limits. Available AP status codes are: 1. NoAccrualMatch 2. NoAccrualUndercharge 3. NoAccrualOvercharge 4. NoAccrualAmountThresholdNotMet 5. NoAccrualTrustedVendor 6. NoAccrualExemptedCostCenter 7. NoAccrualExemptedItem 8. NoAccrualExemptedVendor 9. AccruedUndercharge 10. AccruedVendor 11. NeedReviewUndercharge 12. NeedReviewVendor 13. PendingAccrualVendor 14. PendingAccrualUndercharge

getApStatus

public String getApStatus()

Getter for apStatus An Accounts Payable (AP) status indicates an action that needs to be taken when the tolerance amount falls above or below certain threshold limits.

setApStatus

public void setApStatus(String value)

Setter for apStatus An Accounts Payable (AP) status indicates an action that needs to be taken when the tolerance amount falls above or below certain threshold limits.

toString

public String toString()

Returns a JSON string representation of TransactionModel

Overrides:

toString in class Object