Package com.xero.models.accounting

Class LineItem

java.lang.Object
com.xero.models.accounting.LineItem
public class LineItem
extends Object
LineItem

  • Constructor Details

    • LineItem

      public LineItem()

  • Method Details

    • lineItemID

      public LineItem lineItemID​(UUID lineItemID)

    • getLineItemID

      public UUID getLineItemID()
      LineItem unique ID
      Returns:
      lineItemID

    • setLineItemID

      public void setLineItemID​(UUID lineItemID)

    • description

      public LineItem description​(String description)

    • getDescription

      public String getDescription()
      Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a <Description> element that contains at least 1 character
      Returns:
      description

    • setDescription

      public void setDescription​(String description)

    • quantity

      public LineItem quantity​(Double quantity)

    • getQuantity

      public Double getQuantity()
      LineItem Quantity
      Returns:
      quantity

    • setQuantity

      public void setQuantity​(Double quantity)

    • unitAmount

      public LineItem unitAmount​(Double unitAmount)

    • getUnitAmount

      public Double getUnitAmount()
      LineItem Unit Amount
      Returns:
      unitAmount

    • setUnitAmount

      public void setUnitAmount​(Double unitAmount)

    • itemCode

      public LineItem itemCode​(String itemCode)

    • getItemCode

      public String getItemCode()
      See Items
      Returns:
      itemCode

    • setItemCode

      public void setItemCode​(String itemCode)

    • accountCode

      public LineItem accountCode​(String accountCode)

    • getAccountCode

      public String getAccountCode()
      See Accounts
      Returns:
      accountCode

    • setAccountCode

      public void setAccountCode​(String accountCode)

    • taxType

      public LineItem taxType​(String taxType)

    • getTaxType

      public String getTaxType()
      The tax type from TaxRates
      Returns:
      taxType

    • setTaxType

      public void setTaxType​(String taxType)

    • taxAmount

      public LineItem taxAmount​(Double taxAmount)

    • getTaxAmount

      public Double getTaxAmount()
      The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct.
      Returns:
      taxAmount

    • setTaxAmount

      public void setTaxAmount​(Double taxAmount)

    • lineAmount

      public LineItem lineAmount​(Double lineAmount)

    • getLineAmount

      public Double getLineAmount()
      If you wish to omit either of the <Quantity> or <UnitAmount> you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if a DiscountRate has been used . i.e LineAmount = Quantity * Unit Amount * ((100 – DiscountRate)/100)
      Returns:
      lineAmount

    • setLineAmount

      public void setLineAmount​(Double lineAmount)

    • tracking

      public LineItem tracking​(List<LineItemTracking> tracking)

    • addTrackingItem

      public LineItem addTrackingItem​(LineItemTracking trackingItem)

    • getTracking

      public List<LineItemTracking> getTracking()
      Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements.
      Returns:
      tracking

    • setTracking

      public void setTracking​(List<LineItemTracking> tracking)

    • discountRate

      public LineItem discountRate​(Double discountRate)

    • getDiscountRate

      public Double getDiscountRate()
      Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts
      Returns:
      discountRate

    • setDiscountRate

      public void setDiscountRate​(Double discountRate)

    • discountAmount

      public LineItem discountAmount​(Double discountAmount)

    • getDiscountAmount

      public Double getDiscountAmount()
      Discount amount being applied to a line item. Only supported on ACCREC invoices - ACCPAY invoices and credit notes in Xero do not support discounts.
      Returns:
      discountAmount

    • setDiscountAmount

      public void setDiscountAmount​(Double discountAmount)

    • repeatingInvoiceID

      public LineItem repeatingInvoiceID​(UUID repeatingInvoiceID)

    • getRepeatingInvoiceID

      public UUID getRepeatingInvoiceID()
      The Xero identifier for a Repeating Invoice
      Returns:
      repeatingInvoiceID

    • setRepeatingInvoiceID

      public void setRepeatingInvoiceID​(UUID repeatingInvoiceID)

    • equals

      public boolean equals​(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object