Class MultiCompanyLineItemModel


  • public class MultiCompanyLineItemModel
    extends java.lang.Object
    Represents one line item in a multi company transaction
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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 Company Code - Specify the code of the company for this line of transaction.
      java.lang.String getCustomerUsageType()
      Getter for customerUsageType Customer Usage Type - The client application customer or usage type.
      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 getExemptionCode()
      Getter for exemptionCode Exemption number for this line
      java.lang.String getItemCode()
      Getter for itemCode Item Code (SKU)
      java.lang.String getNumber()
      Getter for number Line number within this document
      java.util.HashMap<java.lang.String,​java.lang.String> 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 Reference 1 - Client specific reference field
      java.lang.String getRef2()
      Getter for ref2 Reference 2 - Client specific reference field
      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
      java.lang.String getTaxCode()
      Getter for taxCode Tax Code - System or Custom Tax Code.
      java.lang.Boolean getTaxIncluded()
      Getter for taxIncluded Indicates if line has Tax Included; defaults to false
      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 Company Code - Specify the code of the company for this line of transaction.
      void setCustomerUsageType​(java.lang.String value)
      Setter for customerUsageType Customer Usage Type - The client application customer or usage type.
      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 setExemptionCode​(java.lang.String value)
      Setter for exemptionCode Exemption number for this line
      void setItemCode​(java.lang.String value)
      Setter for itemCode Item Code (SKU)
      void setNumber​(java.lang.String value)
      Setter for number Line number within this document
      void setParameters​(java.util.HashMap<java.lang.String,​java.lang.String> 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 Reference 1 - Client specific reference field
      void setRef2​(java.lang.String value)
      Setter for ref2 Reference 2 - Client specific reference field
      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
      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 if line has Tax Included; defaults to false
      void setTaxOverride​(TaxOverrideModel value)
      Setter for taxOverride Specifies a tax override for this line
      java.lang.String toString()
      Returns a JSON string representation of MultiCompanyLineItemModel
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • MultiCompanyLineItemModel

        public MultiCompanyLineItemModel()
    • Method Detail

      • getCompanyCode

        public java.lang.String getCompanyCode()
        Getter for companyCode Company Code - Specify the code of the company for this line of transaction. If you leave this value null, the company code at document level will be used instead.
      • setCompanyCode

        public void setCompanyCode​(java.lang.String value)
        Setter for companyCode Company Code - Specify the code of the company for this line of transaction. If you leave this value null, the company code at document 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.
      • 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.
      • getNumber

        public java.lang.String getNumber()
        Getter for number Line number within this document
      • setNumber

        public void setNumber​(java.lang.String value)
        Setter for number Line number within this document
      • getQuantity

        public java.math.BigDecimal getQuantity()
        Getter for quantity Quantity of items in this line
      • setQuantity

        public void setQuantity​(java.math.BigDecimal value)
        Setter for quantity Quantity of items in this line
      • getAmount

        public java.math.BigDecimal getAmount()
        Getter for amount Total amount for this line
      • setAmount

        public void setAmount​(java.math.BigDecimal value)
        Setter for amount Total amount for this line
      • 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 Customer Usage Type - The client application customer or usage type.
      • setCustomerUsageType

        public void setCustomerUsageType​(java.lang.String value)
        Setter for customerUsageType Customer Usage Type - The client application customer or usage type.
      • getItemCode

        public java.lang.String getItemCode()
        Getter for itemCode Item Code (SKU)
      • setItemCode

        public void setItemCode​(java.lang.String value)
        Setter for itemCode Item Code (SKU)
      • getExemptionCode

        public java.lang.String getExemptionCode()
        Getter for exemptionCode Exemption number for this line
      • setExemptionCode

        public void setExemptionCode​(java.lang.String value)
        Setter for exemptionCode Exemption number for this line
      • getDiscounted

        public java.lang.Boolean getDiscounted()
        Getter for discounted True if the document discount should be applied to this line
      • setDiscounted

        public void setDiscounted​(java.lang.Boolean value)
        Setter for discounted True if the document discount should be applied to this line
      • getTaxIncluded

        public java.lang.Boolean getTaxIncluded()
        Getter for taxIncluded Indicates if line has Tax Included; defaults to false
      • setTaxIncluded

        public void setTaxIncluded​(java.lang.Boolean value)
        Setter for taxIncluded Indicates if line has Tax Included; defaults to false
      • getRevenueAccount

        public java.lang.String getRevenueAccount()
        Getter for revenueAccount Revenue Account
      • setRevenueAccount

        public void setRevenueAccount​(java.lang.String value)
        Setter for revenueAccount Revenue Account
      • getRef1

        public java.lang.String getRef1()
        Getter for ref1 Reference 1 - Client specific reference field
      • setRef1

        public void setRef1​(java.lang.String value)
        Setter for ref1 Reference 1 - Client specific reference field
      • getRef2

        public java.lang.String getRef2()
        Getter for ref2 Reference 2 - Client specific reference field
      • setRef2

        public void setRef2​(java.lang.String value)
        Setter for ref2 Reference 2 - Client specific reference field
      • getDescription

        public java.lang.String getDescription()
        Getter for description Item description. This is required for SST transactions if an unmapped ItemCode is used.
      • setDescription

        public void setDescription​(java.lang.String value)
        Setter for description Item description. This is required for SST transactions 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.HashMap<java.lang.String,​java.lang.String> 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 /api/v2/definitions/parameters endpoint.
      • setParameters

        public void setParameters​(java.util.HashMap<java.lang.String,​java.lang.String> 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 /api/v2/definitions/parameters endpoint.
      • toString

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