TransactionLineModel

java.lang.Object
- net.avalara.avatax.rest.client.models.TransactionLineModel

public class TransactionLineModel
extends java.lang.Object

One line item on this transaction.

Constructor Summary

Constructors
Constructor and Description

TransactionLineModel()

Constructors
Constructor and Description
`TransactionLineModel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Integer`	`getBoundaryOverrideId()` Getter for boundaryOverrideId - The unique ID number of the boundary override applied to this line item.
`java.lang.String`	`getCustomerUsageType()` Getter for customerUsageType - The customer usage type for this line item.
`java.lang.String`	`getDescription()` Getter for description - A description of the item or service represented by this line.
`java.lang.Long`	`getDestinationAddressId()` Getter for destinationAddressId - The unique ID number of the destination address where this line was delivered or sold.
`java.util.ArrayList<TransactionLineDetailModel>`	`getDetails()` Getter for details - Optional: A list of tax details for this line item.
`java.math.BigDecimal`	`getDiscountAmount()` Getter for discountAmount - The amount of discount that was applied to this line item.
`java.lang.Integer`	`getDiscountTypeId()` Getter for discountTypeId - The type of discount, if any, that was applied to this line item.
`java.math.BigDecimal`	`getExemptAmount()` Getter for exemptAmount - The amount of this line item that was exempt.
`java.lang.Integer`	`getExemptCertId()` Getter for exemptCertId - The unique ID number of the exemption certificate that applied to this line item.
`java.lang.String`	`getExemptNo()` Getter for exemptNo - If this line item was exempt, this string contains the word 'Exempt'.
`java.lang.Long`	`getId()` Getter for id - The unique ID number of this transaction line item.
`java.lang.Boolean`	`getIsItemTaxable()` Getter for isItemTaxable - True if this item is taxable.
`java.lang.Boolean`	`getIsSSTP()` Getter for isSSTP - True if this item is a Streamlined Sales Tax line item.
`java.lang.String`	`getItemCode()` Getter for itemCode - The code string of the item represented by this line item.
`java.math.BigDecimal`	`getLineAmount()` Getter for lineAmount - The total amount of the transaction, including both taxable and exempt.
`java.lang.String`	`getLineNumber()` Getter for lineNumber - The line number or code indicating the line on this invoice or receipt or document.
`java.lang.Long`	`getOriginAddressId()` Getter for originAddressId - The unique ID number of the origin address where this line was delivered or sold.
`java.util.HashMap<java.lang.String,java.lang.String>`	`getParameters()` Getter for parameters - Contains a list of extra parameters that were set when the transaction was created.
`java.math.BigDecimal`	`getQuantity()` Getter for quantity - The quantity of products sold on this line item.
`java.lang.String`	`getRef1()` Getter for ref1 - A user-defined reference identifier for this transaction line item.
`java.lang.String`	`getRef2()` Getter for ref2 - A user-defined reference identifier for this transaction line item.
`java.util.Date`	`getReportingDate()` Getter for reportingDate - The date when this transaction should be reported.
`java.lang.String`	`getRevAccount()` Getter for revAccount - The revenue account number for this line item.
`Sourcing`	`getSourcing()` Getter for sourcing - Indicates whether this line item was taxed according to the origin or destination.
`java.math.BigDecimal`	`getTax()` Getter for tax - The amount of tax generated for this line item.
`java.math.BigDecimal`	`getTaxableAmount()` Getter for taxableAmount - The taxable amount of this line item.
`java.math.BigDecimal`	`getTaxCalculated()` Getter for taxCalculated - The tax calculated for this line by Avalara.
`java.lang.String`	`getTaxCode()` Getter for taxCode - The code string for the tax code that was used to calculate this line item.
`java.lang.Integer`	`getTaxCodeId()` Getter for taxCodeId - The unique ID number for the tax code that was used to calculate this line item.
`java.util.Date`	`getTaxDate()` Getter for taxDate - The date that was used for calculating tax amounts for this line item.
`java.lang.String`	`getTaxEngine()` Getter for taxEngine - The tax engine identifier that was used to calculate this line item.
`java.lang.Boolean`	`getTaxIncluded()` Getter for taxIncluded - True if tax was included in the purchase price of the item.
`java.math.BigDecimal`	`getTaxOverrideAmount()` Getter for taxOverrideAmount - If a tax override was specified, this indicates the amount of tax that was requested.
`java.lang.String`	`getTaxOverrideReason()` Getter for taxOverrideReason - If a tax override was specified, represents the reason for the tax override.
`TaxOverrideTypeId`	`getTaxOverrideType()` Getter for taxOverrideType - If a tax override was specified, this indicates the type of tax override.
`java.lang.Long`	`getTransactionId()` Getter for transactionId - The unique ID number of the transaction to which this line item belongs.
`void`	`setBoundaryOverrideId(java.lang.Integer boundaryOverrideId)` Setter for boundaryOverrideId - The unique ID number of the boundary override applied to this line item.
`void`	`setCustomerUsageType(java.lang.String customerUsageType)` Setter for customerUsageType - The customer usage type for this line item.
`void`	`setDescription(java.lang.String description)` Setter for description - A description of the item or service represented by this line.
`void`	`setDestinationAddressId(java.lang.Long destinationAddressId)` Setter for destinationAddressId - The unique ID number of the destination address where this line was delivered or sold.
`void`	`setDetails(java.util.ArrayList<TransactionLineDetailModel> details)` Setter for details - Optional: A list of tax details for this line item.
`void`	`setDiscountAmount(java.math.BigDecimal discountAmount)` Setter for discountAmount - The amount of discount that was applied to this line item.
`void`	`setDiscountTypeId(java.lang.Integer discountTypeId)` Setter for discountTypeId - The type of discount, if any, that was applied to this line item.
`void`	`setExemptAmount(java.math.BigDecimal exemptAmount)` Setter for exemptAmount - The amount of this line item that was exempt.
`void`	`setExemptCertId(java.lang.Integer exemptCertId)` Setter for exemptCertId - The unique ID number of the exemption certificate that applied to this line item.
`void`	`setExemptNo(java.lang.String exemptNo)` Setter for exemptNo - If this line item was exempt, this string contains the word 'Exempt'.
`void`	`setId(java.lang.Long id)` Setter for id - The unique ID number of this transaction line item.
`void`	`setIsItemTaxable(java.lang.Boolean isItemTaxable)` Setter for isItemTaxable - True if this item is taxable.
`void`	`setIsSSTP(java.lang.Boolean isSSTP)` Setter for isSSTP - True if this item is a Streamlined Sales Tax line item.
`void`	`setItemCode(java.lang.String itemCode)` Setter for itemCode - The code string of the item represented by this line item.
`void`	`setLineAmount(java.math.BigDecimal lineAmount)` Setter for lineAmount - The total amount of the transaction, including both taxable and exempt.
`void`	`setLineNumber(java.lang.String lineNumber)` Setter for lineNumber - The line number or code indicating the line on this invoice or receipt or document.
`void`	`setOriginAddressId(java.lang.Long originAddressId)` Setter for originAddressId - The unique ID number of the origin address where this line was delivered or sold.
`void`	`setParameters(java.util.HashMap<java.lang.String,java.lang.String> parameters)` Setter for parameters - Contains a list of extra parameters that were set when the transaction was created.
`void`	`setQuantity(java.math.BigDecimal quantity)` Setter for quantity - The quantity of products sold on this line item.
`void`	`setRef1(java.lang.String ref1)` Setter for ref1 - A user-defined reference identifier for this transaction line item.
`void`	`setRef2(java.lang.String ref2)` Setter for ref2 - A user-defined reference identifier for this transaction line item.
`void`	`setReportingDate(java.util.Date reportingDate)` Setter for reportingDate - The date when this transaction should be reported.
`void`	`setRevAccount(java.lang.String revAccount)` Setter for revAccount - The revenue account number for this line item.
`void`	`setSourcing(Sourcing sourcing)` Setter for sourcing - Indicates whether this line item was taxed according to the origin or destination.
`void`	`setTax(java.math.BigDecimal tax)` Setter for tax - The amount of tax generated for this line item.
`void`	`setTaxableAmount(java.math.BigDecimal taxableAmount)` Setter for taxableAmount - The taxable amount of this line item.
`void`	`setTaxCalculated(java.math.BigDecimal taxCalculated)` Setter for taxCalculated - The tax calculated for this line by Avalara.
`void`	`setTaxCode(java.lang.String taxCode)` Setter for taxCode - The code string for the tax code that was used to calculate this line item.
`void`	`setTaxCodeId(java.lang.Integer taxCodeId)` Setter for taxCodeId - The unique ID number for the tax code that was used to calculate this line item.
`void`	`setTaxDate(java.util.Date taxDate)` Setter for taxDate - The date that was used for calculating tax amounts for this line item.
`void`	`setTaxEngine(java.lang.String taxEngine)` Setter for taxEngine - The tax engine identifier that was used to calculate this line item.
`void`	`setTaxIncluded(java.lang.Boolean taxIncluded)` Setter for taxIncluded - True if tax was included in the purchase price of the item.
`void`	`setTaxOverrideAmount(java.math.BigDecimal taxOverrideAmount)` Setter for taxOverrideAmount - If a tax override was specified, this indicates the amount of tax that was requested.
`void`	`setTaxOverrideReason(java.lang.String taxOverrideReason)` Setter for taxOverrideReason - If a tax override was specified, represents the reason for the tax override.
`void`	`setTaxOverrideType(TaxOverrideTypeId taxOverrideType)` Setter for taxOverrideType - If a tax override was specified, this indicates the type of tax override.
`void`	`setTransactionId(java.lang.Long transactionId)` Setter for transactionId - The unique ID number of the transaction to which this line item belongs.
`java.lang.String`	`toString()` Returns a JSON string representation of TransactionLineModel.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TransactionLineModel
```
public TransactionLineModel()
```
- Method Detail
  - getExemptAmount
```
public java.math.BigDecimal getExemptAmount()
```
    Getter for exemptAmount - The amount of this line item that was exempt.
  - setExemptAmount
```
public void setExemptAmount(java.math.BigDecimal exemptAmount)
```
    Setter for exemptAmount - The amount of this line item that was exempt.
  - getTaxCode
```
public java.lang.String getTaxCode()
```
    Getter for taxCode - The code string for the tax code that was used to calculate this line item.
  - setTaxCode
```
public void setTaxCode(java.lang.String taxCode)
```
    Setter for taxCode - The code string for the tax code that was used to calculate this line item.
  - getQuantity
```
public java.math.BigDecimal getQuantity()
```
    Getter for quantity - The quantity of products sold on this line item.
  - setQuantity
```
public void setQuantity(java.math.BigDecimal quantity)
```
    Setter for quantity - The quantity of products sold on this line item.
  - getTaxEngine
```
public java.lang.String getTaxEngine()
```
    Getter for taxEngine - The tax engine identifier that was used to calculate this line item.
  - setTaxEngine
```
public void setTaxEngine(java.lang.String taxEngine)
```
    Setter for taxEngine - The tax engine identifier that was used to calculate this line item.
  - getCustomerUsageType
```
public java.lang.String getCustomerUsageType()
```
    Getter for customerUsageType - The customer usage type for this line item. Usage type often affects taxability rules.
  - setCustomerUsageType
```
public void setCustomerUsageType(java.lang.String customerUsageType)
```
    Setter for customerUsageType - The customer usage type for this line item. Usage type often affects taxability rules.
  - getIsItemTaxable
```
public java.lang.Boolean getIsItemTaxable()
```
    Getter for isItemTaxable - True if this item is taxable.
  - setIsItemTaxable
```
public void setIsItemTaxable(java.lang.Boolean isItemTaxable)
```
    Setter for isItemTaxable - True if this item is taxable.
  - getTaxOverrideType
```
public TaxOverrideTypeId getTaxOverrideType()
```
    Getter for taxOverrideType - If a tax override was specified, this indicates the type of tax override.
  - setTaxOverrideType
```
public void setTaxOverrideType(TaxOverrideTypeId taxOverrideType)
```
    Setter for taxOverrideType - If a tax override was specified, this indicates the type of tax override.
  - getTax
```
public java.math.BigDecimal getTax()
```
    Getter for tax - The amount of tax generated for this line item.
  - setTax
```
public void setTax(java.math.BigDecimal tax)
```
    Setter for tax - The amount of tax generated for this line item.
  - getOriginAddressId
```
public java.lang.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(java.lang.Long originAddressId)
```
    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.
  - getDescription
```
public java.lang.String getDescription()
```
    Getter for description - A description of the item or service represented by this line.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Setter for description - A description of the item or service represented by this line.
  - getDiscountTypeId
```
public java.lang.Integer getDiscountTypeId()
```
    Getter for discountTypeId - The type of discount, if any, that was applied to this line item.
  - setDiscountTypeId
```
public void setDiscountTypeId(java.lang.Integer discountTypeId)
```
    Setter for discountTypeId - The type of discount, if any, that was applied to this line item.
  - getExemptNo
```
public java.lang.String getExemptNo()
```
    Getter for exemptNo - If this line item was exempt, this string contains the word 'Exempt'.
  - setExemptNo
```
public void setExemptNo(java.lang.String exemptNo)
```
    Setter for exemptNo - If this line item was exempt, this string contains the word 'Exempt'.
  - getBoundaryOverrideId
```
public java.lang.Integer getBoundaryOverrideId()
```
    Getter for boundaryOverrideId - The unique ID number of the boundary override applied to this line item.
  - setBoundaryOverrideId
```
public void setBoundaryOverrideId(java.lang.Integer boundaryOverrideId)
```
    Setter for boundaryOverrideId - The unique ID number of the boundary override applied to this line item.
  - getRef1
```
public java.lang.String getRef1()
```
    Getter for ref1 - A user-defined reference identifier for this transaction line item.
  - setRef1
```
public void setRef1(java.lang.String ref1)
```
    Setter for ref1 - A user-defined reference identifier for this transaction line item.
  - getReportingDate
```
public java.util.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(java.util.Date reportingDate)
```
    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.
  - 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 sourcing)
```
    Setter for sourcing - Indicates whether this line item was taxed according to the origin or destination.
  - getExemptCertId
```
public java.lang.Integer getExemptCertId()
```
    Getter for exemptCertId - The unique ID number of the exemption certificate that applied to this line item.
  - setExemptCertId
```
public void setExemptCertId(java.lang.Integer exemptCertId)
```
    Setter for exemptCertId - The unique ID number of the exemption certificate that applied to this line item.
  - getTaxCodeId
```
public java.lang.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(java.lang.Integer taxCodeId)
```
    Setter for taxCodeId - The unique ID number for the tax code that was used to calculate this line item.
  - getRef2
```
public java.lang.String getRef2()
```
    Getter for ref2 - A user-defined reference identifier for this transaction line item.
  - setRef2
```
public void setRef2(java.lang.String ref2)
```
    Setter for ref2 - A user-defined reference identifier for this transaction line item.
  - getLineNumber
```
public java.lang.String getLineNumber()
```
    Getter for lineNumber - The line number or code indicating the line on this invoice or receipt or document.
  - setLineNumber
```
public void setLineNumber(java.lang.String lineNumber)
```
    Setter for lineNumber - The line number or code indicating the line on this invoice or receipt or document.
  - getRevAccount
```
public java.lang.String getRevAccount()
```
    Getter for revAccount - The revenue account number for this line item.
  - setRevAccount
```
public void setRevAccount(java.lang.String revAccount)
```
    Setter for revAccount - The revenue account number for this line item.
  - getId
```
public java.lang.Long getId()
```
    Getter for id - The unique ID number of this transaction line item.
  - setId
```
public void setId(java.lang.Long id)
```
    Setter for id - The unique ID number of this transaction line item.
  - getTaxCalculated
```
public java.math.BigDecimal getTaxCalculated()
```
    Getter for taxCalculated - The tax calculated for this line by Avalara. If the transaction was calculated with a tax override, this amount will be different from the "tax" value.
  - setTaxCalculated
```
public void setTaxCalculated(java.math.BigDecimal taxCalculated)
```
    Setter for taxCalculated - The tax calculated for this line by Avalara. If the transaction was calculated with a tax override, this amount will be different from the "tax" value.
  - getLineAmount
```
public java.math.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(java.math.BigDecimal lineAmount)
```
    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.
  - getDestinationAddressId
```
public java.lang.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(java.lang.Long destinationAddressId)
```
    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.
  - getIsSSTP
```
public java.lang.Boolean getIsSSTP()
```
    Getter for isSSTP - True if this item is a Streamlined Sales Tax line item.
  - setIsSSTP
```
public void setIsSSTP(java.lang.Boolean isSSTP)
```
    Setter for isSSTP - True if this item is a Streamlined Sales Tax line item.
  - getTaxOverrideReason
```
public java.lang.String getTaxOverrideReason()
```
    Getter for taxOverrideReason - If a tax override was specified, represents the reason for the tax override.
  - setTaxOverrideReason
```
public void setTaxOverrideReason(java.lang.String taxOverrideReason)
```
    Setter for taxOverrideReason - If a tax override was specified, represents the reason for the tax override.
  - getItemCode
```
public java.lang.String getItemCode()
```
    Getter for itemCode - The code string of the item represented by this line item.
  - setItemCode
```
public void setItemCode(java.lang.String itemCode)
```
    Setter for itemCode - The code string of the item represented by this line item.
  - getDetails
```
public java.util.ArrayList<TransactionLineDetailModel> getDetails()
```
    Getter for details - Optional: A list of tax details for this line item. To fetch this list, add the query string "?$include=Details" to your URL.
  - setDetails
```
public void setDetails(java.util.ArrayList<TransactionLineDetailModel> details)
```
    Setter for details - Optional: A list of tax details for this line item. To fetch this list, add the query string "?$include=Details" to your URL.
  - getTaxOverrideAmount
```
public java.math.BigDecimal getTaxOverrideAmount()
```
    Getter for taxOverrideAmount - If a tax override was specified, this indicates the amount of tax that was requested.
  - setTaxOverrideAmount
```
public void setTaxOverrideAmount(java.math.BigDecimal taxOverrideAmount)
```
    Setter for taxOverrideAmount - If a tax override was specified, this indicates the amount of tax that was requested.
  - getTaxableAmount
```
public java.math.BigDecimal getTaxableAmount()
```
    Getter for taxableAmount - The taxable amount of this line item.
  - setTaxableAmount
```
public void setTaxableAmount(java.math.BigDecimal taxableAmount)
```
    Setter for taxableAmount - The taxable amount of this line item.
  - getTaxIncluded
```
public java.lang.Boolean getTaxIncluded()
```
    Getter for taxIncluded - True if tax was included in the purchase price of the item.
  - setTaxIncluded
```
public void setTaxIncluded(java.lang.Boolean taxIncluded)
```
    Setter for taxIncluded - True if tax was included in the purchase price of the item.
  - getParameters
```
public java.util.HashMap<java.lang.String,java.lang.String> getParameters()
```
    Getter for parameters - Contains a list of extra parameters that were set when the transaction was created.
  - setParameters
```
public void setParameters(java.util.HashMap<java.lang.String,java.lang.String> parameters)
```
    Setter for parameters - Contains a list of extra parameters that were set when the transaction was created.
  - getTaxDate
```
public java.util.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(java.util.Date taxDate)
```
    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.
  - getTransactionId
```
public java.lang.Long getTransactionId()
```
    Getter for transactionId - The unique ID number of the transaction to which this line item belongs.
  - setTransactionId
```
public void setTransactionId(java.lang.Long transactionId)
```
    Setter for transactionId - The unique ID number of the transaction to which this line item belongs.
  - getDiscountAmount
```
public java.math.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(java.math.BigDecimal discountAmount)
```
    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.
  - toString
```
public java.lang.String toString()
```
    Returns a JSON string representation of TransactionLineModel.
    
    Overrides:
    
    toString in class java.lang.Object

Class TransactionLineModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TransactionLineModel

Method Detail

getExemptAmount

setExemptAmount

getTaxCode

setTaxCode

getQuantity

setQuantity

getTaxEngine

setTaxEngine

getCustomerUsageType

setCustomerUsageType

getIsItemTaxable

setIsItemTaxable

getTaxOverrideType

setTaxOverrideType

getTax

setTax

getOriginAddressId

setOriginAddressId

getDescription

setDescription

getDiscountTypeId

setDiscountTypeId

getExemptNo

setExemptNo

getBoundaryOverrideId

setBoundaryOverrideId

getRef1

setRef1

getReportingDate

setReportingDate

getSourcing

setSourcing

getExemptCertId

setExemptCertId

getTaxCodeId

setTaxCodeId

getRef2

setRef2

getLineNumber

setLineNumber

getRevAccount

setRevAccount

getId

setId

getTaxCalculated

setTaxCalculated

getLineAmount

setLineAmount

getDestinationAddressId

setDestinationAddressId

getIsSSTP

setIsSSTP

getTaxOverrideReason

setTaxOverrideReason

getItemCode

setItemCode

getDetails

setDetails

getTaxOverrideAmount

setTaxOverrideAmount

getTaxableAmount

setTaxableAmount

getTaxIncluded

setTaxIncluded

getParameters

setParameters

getTaxDate

setTaxDate

getTransactionId

setTransactionId

getDiscountAmount

setDiscountAmount

toString