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

Class TransactionLineModel

java.lang.Object
net.avalara.avatax.rest.client.models.TransactionLineModel
public class TransactionLineModel extends Object
One line item on this transaction.

  • Constructor Details

    • TransactionLineModel

      public TransactionLineModel()

  • Method Details

    • getId

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

    • setId

      public void setId(Long value)
      Setter for id The unique ID number of this transaction line item.

    • getTransactionId

      public Long getTransactionId()
      Getter for transactionId The unique ID number of the transaction to which this line item belongs.

    • setTransactionId

      public void setTransactionId(Long value)
      Setter for transactionId The unique ID number of the transaction to which this line item belongs.

    • getLineNumber

      public String getLineNumber()
      Getter for lineNumber The line number or code indicating the line on this invoice or receipt or document.

    • setLineNumber

      public void setLineNumber(String value)
      Setter for lineNumber The line number or code indicating the line on this invoice or receipt or document.

    • getBoundaryOverrideId

      public Integer getBoundaryOverrideId()
      Getter for boundaryOverrideId The unique ID number of the boundary override applied to this line item.

    • setBoundaryOverrideId

      public void setBoundaryOverrideId(Integer value)
      Setter for boundaryOverrideId The unique ID number of the boundary override applied to this line item.

    • 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 line item. Usage type often affects 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 line item. Usage type often affects taxability rules.

    • getEntityUseCode

      public String getEntityUseCode()
      Getter for entityUseCode The entity use code for this line item. Usage type often affects taxability rules.

    • setEntityUseCode

      public void setEntityUseCode(String value)
      Setter for entityUseCode The entity use code for this line item. Usage type often affects taxability rules.

    • getDescription

      public String getDescription()
      Getter for description A description of the item or service represented by this line.

    • setDescription

      public void setDescription(String value)
      Setter for description A description of the item or service represented by this line.

    • getDestinationAddressId

      public Long getDestinationAddressId()
      Getter for destinationAddressId The unique ID number of the destination address where this line was delivered or sold. In the case of a point-of-sale transaction, the destination address and origin address will be the same. In the case of a shipped transaction, they will be different.

    • setDestinationAddressId

      public void setDestinationAddressId(Long value)
      Setter for destinationAddressId The unique ID number of the destination address where this line was delivered or sold. In the case of a point-of-sale transaction, the destination address and origin address will be the same. In the case of a shipped transaction, they will be different.

    • getOriginAddressId

      public Long getOriginAddressId()
      Getter for originAddressId The unique ID number of the origin address where this line was delivered or sold. In the case of a point-of-sale transaction, the origin address and destination address will be the same. In the case of a shipped transaction, they will be different.

    • setOriginAddressId

      public void setOriginAddressId(Long value)
      Setter for originAddressId The unique ID number of the origin address where this line was delivered or sold. In the case of a point-of-sale transaction, the origin address and destination address will be the same. In the case of a shipped transaction, they will be different.

    • getDiscountAmount

      public BigDecimal getDiscountAmount()
      Getter for discountAmount The amount of discount that was applied to this line item. This represents the difference between list price and sale price of the item. In general, a discount represents money that did not change hands; tax is calculated on only the amount of money that changed hands.

    • setDiscountAmount

      public void setDiscountAmount(BigDecimal value)
      Setter for discountAmount The amount of discount that was applied to this line item. This represents the difference between list price and sale price of the item. In general, a discount represents money that did not change hands; tax is calculated on only the amount of money that changed hands.

    • getDiscountTypeId

      public Integer getDiscountTypeId()
      Getter for discountTypeId The type of discount, if any, that was applied to this line item.

    • setDiscountTypeId

      public void setDiscountTypeId(Integer value)
      Setter for discountTypeId The type of discount, if any, that was applied to this line item.

    • getExemptAmount

      public BigDecimal getExemptAmount()
      Getter for exemptAmount The amount of this line item that was exempt.

    • setExemptAmount

      public void setExemptAmount(BigDecimal value)
      Setter for exemptAmount The amount of this line item that was exempt.

    • getExemptCertId

      public Integer getExemptCertId()
      Getter for exemptCertId The unique ID number of the exemption certificate that applied to this line item. It is the calc_id associated with a certificate in CertCapture.

    • setExemptCertId

      public void setExemptCertId(Integer value)
      Setter for exemptCertId The unique ID number of the exemption certificate that applied to this line item. It is the calc_id associated with a certificate in CertCapture.

    • getCertificateId

      public String getCertificateId()
      Getter for certificateId The CertCapture Certificate ID

    • setCertificateId

      public void setCertificateId(String value)
      Setter for certificateId The CertCapture Certificate ID

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

    • getIsItemTaxable

      public Boolean getIsItemTaxable()
      Getter for isItemTaxable True if this item is taxable.

    • setIsItemTaxable

      public void setIsItemTaxable(Boolean value)
      Setter for isItemTaxable True if this item is taxable.

    • getIsSSTP

      public Boolean getIsSSTP()
      Getter for isSSTP True if this item is a Streamlined Sales Tax line item.

    • setIsSSTP

      public void setIsSSTP(Boolean value)
      Setter for isSSTP True if this item is a Streamlined Sales Tax line item.

    • getItemCode

      public String getItemCode()
      Getter for itemCode The code string of the item represented by this line item.

    • setItemCode

      public void setItemCode(String value)
      Setter for itemCode The code string of the item represented by this line item.

    • getLineAmount

      public BigDecimal getLineAmount()
      Getter for lineAmount The total amount of the transaction, including both taxable and exempt. This is the total price for all items. To determine the individual item price, divide this by quantity.

    • setLineAmount

      public void setLineAmount(BigDecimal value)
      Setter for lineAmount The total amount of the transaction, including both taxable and exempt. This is the total price for all items. To determine the individual item price, divide this by quantity.

    • getQuantity

      public BigDecimal getQuantity()
      Getter for quantity The quantity of products sold on this line item.

    • setQuantity

      public void setQuantity(BigDecimal value)
      Setter for quantity The quantity of products sold on this line item.

    • getRef1

      public String getRef1()
      Getter for ref1 A user-defined reference identifier for this transaction line item.

    • setRef1

      public void setRef1(String value)
      Setter for ref1 A user-defined reference identifier for this transaction line item.

    • getRef2

      public String getRef2()
      Getter for ref2 A user-defined reference identifier for this transaction line item.

    • setRef2

      public void setRef2(String value)
      Setter for ref2 A user-defined reference identifier for this transaction line item.

    • getReportingDate

      public Date getReportingDate()
      Getter for reportingDate The date when this transaction should be reported. By default, all transactions are reported on the date when the actual transaction took place. In some cases, line items may be reported later due to delayed shipments or other business reasons.

    • setReportingDate

      public void setReportingDate(Date value)
      Setter for reportingDate The date when this transaction should be reported. By default, all transactions are reported on the date when the actual transaction took place. In some cases, line items may be reported later due to delayed shipments or other business reasons.

    • getRevAccount

      public String getRevAccount()
      Getter for revAccount The revenue account number for this line item.

    • setRevAccount

      public void setRevAccount(String value)
      Setter for revAccount The revenue account number for this line item.

    • getSourcing

      public Sourcing getSourcing()
      Getter for sourcing Indicates whether this line item was taxed according to the origin or destination.

    • setSourcing

      public void setSourcing(Sourcing value)
      Setter for sourcing Indicates whether this line item was taxed according to the origin or destination.

    • getTax

      public BigDecimal getTax()
      Getter for tax The tax for this line in this transaction. If you used a `taxOverride` of type `taxAmount` for this line, this value will represent the amount of your override. AvaTax will still attempt to calculate the correct tax for this line and will store that calculated value in the `taxCalculated` field. You can compare the `tax` and `taxCalculated` fields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax.

    • setTax

      public void setTax(BigDecimal value)
      Setter for tax The tax for this line in this transaction. If you used a `taxOverride` of type `taxAmount` for this line, this value will represent the amount of your override. AvaTax will still attempt to calculate the correct tax for this line and will store that calculated value in the `taxCalculated` field. You can compare the `tax` and `taxCalculated` fields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax.

    • getTaxableAmount

      public BigDecimal getTaxableAmount()
      Getter for taxableAmount The taxable amount of this line item.

    • setTaxableAmount

      public void setTaxableAmount(BigDecimal value)
      Setter for taxableAmount The taxable amount of this line item.

    • getTaxCalculated

      public BigDecimal getTaxCalculated()
      Getter for taxCalculated The amount of tax that AvaTax calculated for the transaction. If you used a `taxOverride` of type `taxAmount`, there may be a difference between the `tax` field which applies your override, and the `taxCalculated` field which represents the amount of tax that AvaTax calculated without the override. You can compare the `tax` and `taxCalculated` fields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax.

    • setTaxCalculated

      public void setTaxCalculated(BigDecimal value)
      Setter for taxCalculated The amount of tax that AvaTax calculated for the transaction. If you used a `taxOverride` of type `taxAmount`, there may be a difference between the `tax` field which applies your override, and the `taxCalculated` field which represents the amount of tax that AvaTax calculated without the override. You can compare the `tax` and `taxCalculated` fields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax.

    • getTaxCode

      public String getTaxCode()
      Getter for taxCode The code string for the tax code that was used to calculate this line item.

    • setTaxCode

      public void setTaxCode(String value)
      Setter for taxCode The code string for the tax code that was used to calculate this line item.

    • getTaxCodeId

      public Integer getTaxCodeId()
      Getter for taxCodeId The unique ID number for the tax code that was used to calculate this line item.

    • setTaxCodeId

      public void setTaxCodeId(Integer value)
      Setter for taxCodeId The unique ID number for the tax code that was used to calculate this line item.

    • getTaxDate

      public Date getTaxDate()
      Getter for taxDate The date that was used for calculating tax amounts for this line item. By default, this date should be the same as the document date. In some cases, for example when a consumer returns a product purchased previously, line items may be calculated using a tax date in the past so that the consumer can receive a refund for the correct tax amount that was charged when the item was originally purchased.

    • setTaxDate

      public void setTaxDate(Date value)
      Setter for taxDate The date that was used for calculating tax amounts for this line item. By default, this date should be the same as the document date. In some cases, for example when a consumer returns a product purchased previously, line items may be calculated using a tax date in the past so that the consumer can receive a refund for the correct tax amount that was charged when the item was originally purchased.

    • getTaxEngine

      public String getTaxEngine()
      Getter for taxEngine The tax engine identifier that was used to calculate this line item.

    • setTaxEngine

      public void setTaxEngine(String value)
      Setter for taxEngine The tax engine identifier that was used to calculate this line item.

    • getTaxOverrideType

      public TaxOverrideType getTaxOverrideType()
      Getter for taxOverrideType If a tax override was specified, this indicates the type of tax override.

    • setTaxOverrideType

      public void setTaxOverrideType(TaxOverrideType value)
      Setter for taxOverrideType If a tax override was specified, this indicates the type of tax override.

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

    • getTaxOverrideAmount

      public BigDecimal getTaxOverrideAmount()
      Getter for taxOverrideAmount If a tax override was specified, this indicates the amount of tax that was requested.

    • setTaxOverrideAmount

      public void setTaxOverrideAmount(BigDecimal value)
      Setter for taxOverrideAmount If a tax override was specified, this indicates the amount of tax that was requested.

    • getTaxOverrideReason

      public String getTaxOverrideReason()
      Getter for taxOverrideReason If a tax override was specified, represents the reason for the tax override.

    • setTaxOverrideReason

      public void setTaxOverrideReason(String value)
      Setter for taxOverrideReason If a tax override was specified, represents the reason for the tax override.

    • getTaxIncluded

      public Boolean getTaxIncluded()
      Getter for taxIncluded Indicates whether the `amount` for this line already includes tax. If this value is `true`, the final price of this line including tax will equal the value in `amount`. If this value is `null` or `false`, the final price will equal `amount` plus whatever taxes apply to this line.

    • setTaxIncluded

      public void setTaxIncluded(Boolean value)
      Setter for taxIncluded Indicates whether the `amount` for this line already includes tax. If this value is `true`, the final price of this line including tax will equal the value in `amount`. If this value is `null` or `false`, the final price will equal `amount` plus whatever taxes apply to this line.

    • getMerchantSellerId

      public Long getMerchantSellerId()
      Getter for merchantSellerId DEPRECATED - Date: 04/15/2021, Version: 21.4, Message: Please use merchantSellerIdentifier instead. ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.

    • setMerchantSellerId

      public void setMerchantSellerId(Long value)
      Setter for merchantSellerId DEPRECATED - Date: 04/15/2021, Version: 21.4, Message: Please use merchantSellerIdentifier instead. ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.

    • getMerchantSellerIdentifier

      public String getMerchantSellerIdentifier()
      Getter for merchantSellerIdentifier ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.

    • setMerchantSellerIdentifier

      public void setMerchantSellerIdentifier(String value)
      Setter for merchantSellerIdentifier ID of the merchant selling on the Marketplace. This field must be populated by Marketplace.

    • getMarketplaceLiabilityType

      public MarketplaceLiabilityType getMarketplaceLiabilityType()
      Getter for marketplaceLiabilityType This field will identify who is remitting Marketplace or Seller. This field must be populated by Marketplace.

    • setMarketplaceLiabilityType

      public void setMarketplaceLiabilityType(MarketplaceLiabilityType value)
      Setter for marketplaceLiabilityType This field will identify who is remitting Marketplace or Seller. This field must be populated by Marketplace.

    • getOriginationDocumentId

      public String getOriginationDocumentId()
      Getter for originationDocumentId The transaction's original ID in its origination system

    • setOriginationDocumentId

      public void setOriginationDocumentId(String value)
      Setter for originationDocumentId The transaction's original ID in its origination system

    • getOriginationSite

      public String getOriginationSite()
      Getter for originationSite Synonym of Marketplace Origination. Name of the Marketplace where the transaction originated from.

    • setOriginationSite

      public void setOriginationSite(String value)
      Setter for originationSite Synonym of Marketplace Origination. Name of the Marketplace where the transaction originated from.

    • getDetails

      public ArrayList<TransactionLineDetailModel> getDetails()
      Getter for details Optional: A list of tax details for this line item. Tax details represent taxes being charged by various tax authorities. Taxes that appear in the `details` collection are intended to be displayed to the customer and charged as a 'tax' on the invoice. To fetch this list, add the query string `?$include=Details` to your URL.

    • setDetails

      public void setDetails(ArrayList<TransactionLineDetailModel> value)
      Setter for details Optional: A list of tax details for this line item. Tax details represent taxes being charged by various tax authorities. Taxes that appear in the `details` collection are intended to be displayed to the customer and charged as a 'tax' on the invoice. To fetch this list, add the query string `?$include=Details` to your URL.

    • getNonPassthroughDetails

      public ArrayList<TransactionLineDetailModel> getNonPassthroughDetails()
      Getter for nonPassthroughDetails Optional: A list of non-passthrough tax details for this line item. Tax details represent taxes being charged by various tax authorities. Taxes that appear in the `nonPassthroughDetails` collection are taxes that must be paid directly by the company and not shown to the customer.

    • setNonPassthroughDetails

      public void setNonPassthroughDetails(ArrayList<TransactionLineDetailModel> value)
      Setter for nonPassthroughDetails Optional: A list of non-passthrough tax details for this line item. Tax details represent taxes being charged by various tax authorities. Taxes that appear in the `nonPassthroughDetails` collection are taxes that must be paid directly by the company and not shown to the customer.

    • getLineLocationTypes

      public ArrayList<TransactionLineLocationTypeModel> getLineLocationTypes()
      Getter for lineLocationTypes Optional: A list of location types for this line item. To fetch this list, add the query string "?$include=LineLocationTypes" to your URL.

    • setLineLocationTypes

      public void setLineLocationTypes(ArrayList<TransactionLineLocationTypeModel> value)
      Setter for lineLocationTypes Optional: A list of location types for this line item. To fetch this list, add the query string "?$include=LineLocationTypes" to your URL.

    • getParameters

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

    • setParameters

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

    • getUserDefinedFields

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

    • setUserDefinedFields

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

    • getHsCode

      public String getHsCode()
      Getter for hsCode The cross-border harmonized system code (HSCode) used to calculate tariffs and duties for this line item. For a full list of HS codes, see `ListCrossBorderCodes()`.

    • setHsCode

      public void setHsCode(String value)
      Setter for hsCode The cross-border harmonized system code (HSCode) used to calculate tariffs and duties for this line item. For a full list of HS codes, see `ListCrossBorderCodes()`.

    • getCostInsuranceFreight

      public BigDecimal getCostInsuranceFreight()
      Getter for costInsuranceFreight Indicates the cost of insurance and freight for this line.

    • setCostInsuranceFreight

      public void setCostInsuranceFreight(BigDecimal value)
      Setter for costInsuranceFreight Indicates the cost of insurance and freight for this line.

    • getVatCode

      public String getVatCode()
      Getter for vatCode Indicates the VAT code for this line item.

    • setVatCode

      public void setVatCode(String value)
      Setter for vatCode Indicates the VAT code for this line item.

    • getVatNumberTypeId

      public Integer getVatNumberTypeId()
      Getter for vatNumberTypeId Indicates the VAT number type for this line item.

    • setVatNumberTypeId

      public void setVatNumberTypeId(Integer value)
      Setter for vatNumberTypeId Indicates the VAT number type for this line item.

    • getTaxAmountByTaxTypes

      public ArrayList<TransactionLineTaxAmountByTaxTypeModel> getTaxAmountByTaxTypes()
      Getter for taxAmountByTaxTypes Contains a list of TaxType that are to be overridden with their respective TaxOverrideAmount.

    • setTaxAmountByTaxTypes

      public void setTaxAmountByTaxTypes(ArrayList<TransactionLineTaxAmountByTaxTypeModel> value)
      Setter for taxAmountByTaxTypes Contains a list of TaxType that are to be overridden with their respective TaxOverrideAmount.

    • getDeemedSupplier

      public DeemedSellerType getDeemedSupplier()
      Getter for deemedSupplier Deemed Supplier field indicates which party on the marketplace transaction is liable for collecting and reporting the VAT. This is based on the 2021 E-commerce legislative reforms in EU and UK. This field will not be used until after July 1, 2021.

    • setDeemedSupplier

      public void setDeemedSupplier(DeemedSellerType value)
      Setter for deemedSupplier Deemed Supplier field indicates which party on the marketplace transaction is liable for collecting and reporting the VAT. This is based on the 2021 E-commerce legislative reforms in EU and UK. This field will not be used until after July 1, 2021.

    • getCategory

      public String getCategory()
      Getter for category Product category breadcrumbs. This is the full path to the category where item is included. Categories should be separated by “ > “. Multiple category paths per item are accepted. In this case, category paths should be separated by “;”.

    • setCategory

      public void setCategory(String value)
      Setter for category Product category breadcrumbs. This is the full path to the category where item is included. Categories should be separated by “ > “. Multiple category paths per item are accepted. In this case, category paths should be separated by “;”.

    • getSummary

      public String getSummary()
      Getter for summary A long description of the product.

    • setSummary

      public void setSummary(String value)
      Setter for summary A long description of the product.

    • toString

      public String toString()
      Returns a JSON string representation of TransactionLineModel
      Overrides:
      toString in class Object