MultiDocumentLineItemModel

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

public class MultiDocumentLineItemModel
extends java.lang.Object

Represents one line item in a MultiDocument transaction

Constructor Summary

Constructors
Constructor and Description

MultiDocumentLineItemModel()

Constructors
Constructor and Description
`MultiDocumentLineItemModel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddressesModel`	`getAddresses()` Getter for addresses The addresses to use for this transaction line.
`java.math.BigDecimal`	`getAmount()` Getter for amount Total amount for this line.
`java.lang.String`	`getBusinessIdentificationNo()` Getter for businessIdentificationNo VAT business identification number for the customer for this line item.
`java.lang.String`	`getCompanyCode()` Getter for companyCode Specify the code of the company for this line of transaction.
`java.lang.String`	`getCustomerUsageType()` Getter for customerUsageType DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use `entityUseCode` instead.
`java.lang.String`	`getDescription()` Getter for description Item description.
`java.lang.Boolean`	`getDiscounted()` Getter for discounted True if the document discount should be applied to this line.
`java.lang.String`	`getEntityUseCode()` Getter for entityUseCode Entity Use Code - The client application customer or usage type.
`java.lang.String`	`getExemptionCode()` Getter for exemptionCode The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable ECMS entry available, and will utilize it for exemption processing.
`java.lang.String`	`getHsCode()` Getter for hsCode The Item code for Custom Duty / Global Import tax determination Harmonized Tariff System code for this transaction.
`java.lang.String`	`getItemCode()` Getter for itemCode Item Code (SKU).
`java.lang.String`	`getNumber()` Getter for number The line number of this line within the document.
`java.util.ArrayList<TransactionLineParameterModel>`	`getParameters()` Getter for parameters Special parameters that apply to this line within this transaction.
`java.math.BigDecimal`	`getQuantity()` Getter for quantity Quantity of items in this line.
`java.lang.String`	`getRef1()` Getter for ref1 Ref1 (Customer Defined Field) This field is available for you to use to provide whatever information your implementation requires.
`java.lang.String`	`getRef2()` Getter for ref2 Ref2 (Customer Defined Field) This field is available for you to use to provide whatever information your implementation requires.
`java.lang.String`	`getReportingLocationCode()` Getter for reportingLocationCode Sets the sale location code (Outlet ID) for reporting this document to the tax authority.
`java.lang.String`	`getRevenueAccount()` Getter for revenueAccount Revenue Account (Customer Defined Field).
`java.lang.String`	`getTaxCode()` Getter for taxCode Tax Code - System or Custom Tax Code.
`java.lang.Boolean`	`getTaxIncluded()` Getter for taxIncluded Indicates whether the `amount` for this line already includes tax.
`TaxOverrideModel`	`getTaxOverride()` Getter for taxOverride Specifies a tax override for this line.
`void`	`setAddresses(AddressesModel value)` Setter for addresses The addresses to use for this transaction line.
`void`	`setAmount(java.math.BigDecimal value)` Setter for amount Total amount for this line.
`void`	`setBusinessIdentificationNo(java.lang.String value)` Setter for businessIdentificationNo VAT business identification number for the customer for this line item.
`void`	`setCompanyCode(java.lang.String value)` Setter for companyCode Specify the code of the company for this line of transaction.
`void`	`setCustomerUsageType(java.lang.String value)` Setter for customerUsageType DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use `entityUseCode` instead.
`void`	`setDescription(java.lang.String value)` Setter for description Item description.
`void`	`setDiscounted(java.lang.Boolean value)` Setter for discounted True if the document discount should be applied to this line.
`void`	`setEntityUseCode(java.lang.String value)` Setter for entityUseCode Entity Use Code - The client application customer or usage type.
`void`	`setExemptionCode(java.lang.String value)` Setter for exemptionCode 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`	`setHsCode(java.lang.String value)` Setter for hsCode The Item code for Custom Duty / Global Import tax determination Harmonized Tariff System code for this transaction.
`void`	`setItemCode(java.lang.String value)` Setter for itemCode Item Code (SKU).
`void`	`setNumber(java.lang.String value)` Setter for number The line number of this line within the document.
`void`	`setParameters(java.util.ArrayList<TransactionLineParameterModel> value)` Setter for parameters Special parameters that apply to this line within this transaction.
`void`	`setQuantity(java.math.BigDecimal value)` Setter for quantity Quantity of items in this line.
`void`	`setRef1(java.lang.String value)` Setter for ref1 Ref1 (Customer Defined Field) This field is available for you to use to provide whatever information your implementation requires.
`void`	`setRef2(java.lang.String value)` Setter for ref2 Ref2 (Customer Defined Field) This field is available for you to use to provide whatever information your implementation requires.
`void`	`setReportingLocationCode(java.lang.String value)` Setter for reportingLocationCode Sets the sale location code (Outlet ID) for reporting this document to the tax authority.
`void`	`setRevenueAccount(java.lang.String value)` Setter for revenueAccount Revenue Account (Customer Defined Field).
`void`	`setTaxCode(java.lang.String value)` Setter for taxCode Tax Code - System or Custom Tax Code.
`void`	`setTaxIncluded(java.lang.Boolean value)` Setter for taxIncluded Indicates whether the `amount` for this line already includes tax.
`void`	`setTaxOverride(TaxOverrideModel value)` Setter for taxOverride Specifies a tax override for this line.
`java.lang.String`	`toString()` Returns a JSON string representation of MultiDocumentLineItemModel

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

- Constructor Detail
  - MultiDocumentLineItemModel
```
public MultiDocumentLineItemModel()
```
- Method Detail
  - getCompanyCode
```
public java.lang.String getCompanyCode()
```
    Getter for companyCode Specify the code of the company for this line of transaction. If you leave this value null, the `companyCode` at the root level will be used instead.
  - setCompanyCode
```
public void setCompanyCode(java.lang.String value)
```
    Setter for companyCode Specify the code of the company for this line of transaction. If you leave this value null, the `companyCode` at the root level will be used instead.
  - getReportingLocationCode
```
public java.lang.String getReportingLocationCode()
```
    Getter for reportingLocationCode Sets the sale location code (Outlet ID) for reporting this document to the tax authority. If you leave this value `null`, the `reportingLocationCode` at the root level will be used instead.
  - setReportingLocationCode
```
public void setReportingLocationCode(java.lang.String value)
```
    Setter for reportingLocationCode Sets the sale location code (Outlet ID) for reporting this document to the tax authority. If you leave this value `null`, the `reportingLocationCode` at the root level will be used instead.
  - getNumber
```
public java.lang.String getNumber()
```
    Getter for number The line number of this line within the document. This can be any text that is useful to you, such as numeric line numbers, alphabetic line numbers, or other text.
  - setNumber
```
public void setNumber(java.lang.String value)
```
    Setter for number The line number of this line within the document. This can be any text that is useful to you, such as numeric line numbers, alphabetic line numbers, or other text.
  - getQuantity
```
public java.math.BigDecimal getQuantity()
```
    Getter for quantity Quantity of items in this line. This quantity value should always be a positive value representing the quantity of product that changed hands, even when handling returns or refunds. If not provided, or if set to zero, the quantity value is assumed to be one (1).
  - setQuantity
```
public void setQuantity(java.math.BigDecimal value)
```
    Setter for quantity Quantity of items in this line. This quantity value should always be a positive value representing the quantity of product that changed hands, even when handling returns or refunds. If not provided, or if set to zero, the quantity value is assumed to be one (1).
  - getAmount
```
public java.math.BigDecimal getAmount()
```
    Getter for amount Total amount for this line. The amount represents the net currency value that changed hands from the customer (represented by the `customerCode` field) to the company (represented by the `companyCode`) field. For sale transactions, this value must be positive. It indicates the amount of money paid by the customer to the company. For refund or return transactions, this value must be negative.
  - setAmount
```
public void setAmount(java.math.BigDecimal value)
```
    Setter for amount Total amount for this line. The amount represents the net currency value that changed hands from the customer (represented by the `customerCode` field) to the company (represented by the `companyCode`) field. For sale transactions, this value must be positive. It indicates the amount of money paid by the customer to the company. For refund or return transactions, this value must be negative.
  - getAddresses
```
public AddressesModel getAddresses()
```
    Getter for addresses The addresses to use for this transaction line. If you set this value to `null`, or if you omit this element from your API call, then instead the transaction will use the `addresses` from the document level. If you specify any other value besides `null`, only addresses specified for this line will be used for this line.
  - setAddresses
```
public void setAddresses(AddressesModel value)
```
    Setter for addresses The addresses to use for this transaction line. If you set this value to `null`, or if you omit this element from your API call, then instead the transaction will use the `addresses` from the document level. If you specify any other value besides `null`, only addresses specified for this line will be used for this line.
  - getTaxCode
```
public java.lang.String getTaxCode()
```
    Getter for taxCode Tax Code - System or Custom Tax Code. You can use your own tax code mapping or standard Avalara tax codes. For a full list of tax codes, see `ListTaxCodes`.
  - setTaxCode
```
public void setTaxCode(java.lang.String value)
```
    Setter for taxCode Tax Code - System or Custom Tax Code. You can use your own tax code mapping or standard Avalara tax codes. For a full list of tax codes, see `ListTaxCodes`.
  - getCustomerUsageType
```
public java.lang.String getCustomerUsageType()
```
    Getter for customerUsageType DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use `entityUseCode` instead.
  - setCustomerUsageType
```
public void setCustomerUsageType(java.lang.String value)
```
    Setter for customerUsageType DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use `entityUseCode` instead.
  - getEntityUseCode
```
public java.lang.String getEntityUseCode()
```
    Getter for entityUseCode Entity Use Code - The client application customer or usage type. This field allows you to designate a type of usage that may make this transaction considered exempt by reason of exempt usage. For a list of entity use codes, see the Definitions API `ListEntityUseCodes`.
  - setEntityUseCode
```
public void setEntityUseCode(java.lang.String value)
```
    Setter for entityUseCode Entity Use Code - The client application customer or usage type. This field allows you to designate a type of usage that may make this transaction considered exempt by reason of exempt usage. For a list of entity use codes, see the Definitions API `ListEntityUseCodes`.
  - getItemCode
```
public java.lang.String getItemCode()
```
    Getter for itemCode Item Code (SKU). If you provide an `itemCode` field, the AvaTax API will look up the item you created with the `CreateItems` API call and use all the information available about that item for this transaction.
  - setItemCode
```
public void setItemCode(java.lang.String value)
```
    Setter for itemCode Item Code (SKU). If you provide an `itemCode` field, the AvaTax API will look up the item you created with the `CreateItems` API call and use all the information available about that item for this transaction.
  - getExemptionCode
```
public java.lang.String getExemptionCode()
```
    Getter for exemptionCode 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. Note: This is same as 'exemptNo' in TransactionModel.
  - setExemptionCode
```
public void setExemptionCode(java.lang.String value)
```
    Setter for exemptionCode 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. Note: This is same as 'exemptNo' in TransactionModel.
  - getDiscounted
```
public java.lang.Boolean getDiscounted()
```
    Getter for discounted True if the document discount should be applied to this line. If this value is false, or not provided, discounts will not be applied to this line even if they are specified on the root `discount` element.
  - setDiscounted
```
public void setDiscounted(java.lang.Boolean value)
```
    Setter for discounted True if the document discount should be applied to this line. If this value is false, or not provided, discounts will not be applied to this line even if they are specified on the root `discount` element.
  - getTaxIncluded
```
public java.lang.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(java.lang.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.
  - getRevenueAccount
```
public java.lang.String getRevenueAccount()
```
    Getter for revenueAccount Revenue Account (Customer Defined Field). This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation.
  - setRevenueAccount
```
public void setRevenueAccount(java.lang.String value)
```
    Setter for revenueAccount Revenue Account (Customer Defined Field). This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation.
  - getRef1
```
public java.lang.String getRef1()
```
    Getter for ref1 Ref1 (Customer Defined Field) This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation.
  - setRef1
```
public void setRef1(java.lang.String value)
```
    Setter for ref1 Ref1 (Customer Defined Field) This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation.
  - getRef2
```
public java.lang.String getRef2()
```
    Getter for ref2 Ref2 (Customer Defined Field) This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation.
  - setRef2
```
public void setRef2(java.lang.String value)
```
    Setter for ref2 Ref2 (Customer Defined Field) This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation.
  - getDescription
```
public java.lang.String getDescription()
```
    Getter for description Item description. For Streamlined Sales Tax (SST) customers, this field is required if an unmapped `itemCode` is used.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    Setter for description Item description. For Streamlined Sales Tax (SST) customers, this field is required if an unmapped `itemCode` is used.
  - getBusinessIdentificationNo
```
public java.lang.String getBusinessIdentificationNo()
```
    Getter for businessIdentificationNo VAT business identification number for the customer for this line item. If you leave this field empty, this line item will use whatever business identification number you provided at the transaction level. If you specify a VAT business identification number for the customer in this transaction and you have also set up a business identification number for your company during company setup, this transaction will be treated as a business-to-business transaction for VAT purposes and it will be calculated according to VAT tax rules.
  - setBusinessIdentificationNo
```
public void setBusinessIdentificationNo(java.lang.String value)
```
    Setter for businessIdentificationNo VAT business identification number for the customer for this line item. If you leave this field empty, this line item will use whatever business identification number you provided at the transaction level. If you specify a VAT business identification number for the customer in this transaction and you have also set up a business identification number for your company during company setup, this transaction will be treated as a business-to-business transaction for VAT purposes and it will be calculated according to VAT tax rules.
  - getTaxOverride
```
public TaxOverrideModel getTaxOverride()
```
    Getter for taxOverride Specifies a tax override for this line.
  - setTaxOverride
```
public void setTaxOverride(TaxOverrideModel value)
```
    Setter for taxOverride Specifies a tax override for this line.
  - getParameters
```
public java.util.ArrayList<TransactionLineParameterModel> getParameters()
```
    Getter for parameters Special parameters that apply to this line within this transaction. To get a full list of available parameters, please use the `ListParameters` API.
  - setParameters
```
public void setParameters(java.util.ArrayList<TransactionLineParameterModel> value)
```
    Setter for parameters Special parameters that apply to this line within this transaction. To get a full list of available parameters, please use the `ListParameters` API.
  - getHsCode
```
public java.lang.String getHsCode()
```
    Getter for hsCode The Item code for Custom Duty / Global Import tax determination Harmonized Tariff System code for this transaction. For a list of harmonized tariff codes, see the Definitions API for harmonized tariff codes.
  - setHsCode
```
public void setHsCode(java.lang.String value)
```
    Setter for hsCode The Item code for Custom Duty / Global Import tax determination Harmonized Tariff System code for this transaction. For a list of harmonized tariff codes, see the Definitions API for harmonized tariff codes.
  - toString
```
public java.lang.String toString()
```
    Returns a JSON string representation of MultiDocumentLineItemModel
    
    Overrides:
    
    toString in class java.lang.Object

Class MultiDocumentLineItemModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MultiDocumentLineItemModel

Method Detail

getCompanyCode

setCompanyCode

getReportingLocationCode

setReportingLocationCode

getNumber

setNumber

getQuantity

setQuantity

getAmount

setAmount

getAddresses

setAddresses

getTaxCode

setTaxCode

getCustomerUsageType

setCustomerUsageType

getEntityUseCode

setEntityUseCode

getItemCode

setItemCode

getExemptionCode

setExemptionCode

getDiscounted

setDiscounted

getTaxIncluded

setTaxIncluded

getRevenueAccount

setRevenueAccount

getRef1

setRef1

getRef2

setRef2

getDescription

setDescription

getBusinessIdentificationNo

setBusinessIdentificationNo

getTaxOverride

setTaxOverride

getParameters

setParameters

getHsCode

setHsCode

toString