Package com.xero.models.accounting

Class Quote

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

  • Constructor Details

    • Quote

      public Quote()

  • Method Details

    • quoteID

      public Quote quoteID​(UUID quoteID)

    • getQuoteID

      public UUID getQuoteID()
      QuoteID GUID is automatically generated and is returned after create or GET.
      Returns:
      quoteID

    • setQuoteID

      public void setQuoteID​(UUID quoteID)

    • quoteNumber

      public Quote quoteNumber​(String quoteNumber)

    • getQuoteNumber

      public String getQuoteNumber()
      Unique alpha numeric code identifying a quote (Max Length = 255)
      Returns:
      quoteNumber

    • setQuoteNumber

      public void setQuoteNumber​(String quoteNumber)

    • reference

      public Quote reference​(String reference)

    • getReference

      public String getReference()
      Additional reference number
      Returns:
      reference

    • setReference

      public void setReference​(String reference)

    • terms

      public Quote terms​(String terms)

    • getTerms

      public String getTerms()
      Terms of the quote
      Returns:
      terms

    • setTerms

      public void setTerms​(String terms)

    • contact

      public Quote contact​(Contact contact)

    • getContact

      public Contact getContact()
      Get contact
      Returns:
      contact

    • setContact

      public void setContact​(Contact contact)

    • lineItems

      public Quote lineItems​(List<LineItem> lineItems)

    • addLineItemsItem

      public Quote addLineItemsItem​(LineItem lineItemsItem)

    • getLineItems

      public List<LineItem> getLineItems()
      See LineItems
      Returns:
      lineItems

    • setLineItems

      public void setLineItems​(List<LineItem> lineItems)

    • date

      public Quote date​(String date)

    • getDate

      public String getDate()
      Date quote was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation
      Returns:
      date

    • getDateAsDate

      public org.threeten.bp.LocalDate getDateAsDate()

    • setDate

      public void setDate​(String date)

    • setDate

      public void setDate​(org.threeten.bp.LocalDate date)

    • dateString

      public Quote dateString​(String dateString)

    • getDateString

      public String getDateString()
      Date the quote was issued (YYYY-MM-DD)
      Returns:
      dateString

    • setDateString

      public void setDateString​(String dateString)

    • expiryDate

      public Quote expiryDate​(String expiryDate)

    • getExpiryDate

      public String getExpiryDate()
      Date the quote expires – YYYY-MM-DD.
      Returns:
      expiryDate

    • getExpiryDateAsDate

      public org.threeten.bp.LocalDate getExpiryDateAsDate()

    • setExpiryDate

      public void setExpiryDate​(String expiryDate)

    • setExpiryDate

      public void setExpiryDate​(org.threeten.bp.LocalDate expiryDate)

    • expiryDateString

      public Quote expiryDateString​(String expiryDateString)

    • getExpiryDateString

      public String getExpiryDateString()
      Date the quote expires – YYYY-MM-DD.
      Returns:
      expiryDateString

    • setExpiryDateString

      public void setExpiryDateString​(String expiryDateString)

    • status

      public Quote status​(QuoteStatusCodes status)

    • getStatus

      public QuoteStatusCodes getStatus()
      Get status
      Returns:
      status

    • setStatus

      public void setStatus​(QuoteStatusCodes status)

    • currencyCode

      public Quote currencyCode​(CurrencyCode currencyCode)

    • getCurrencyCode

      public CurrencyCode getCurrencyCode()
      Get currencyCode
      Returns:
      currencyCode

    • setCurrencyCode

      public void setCurrencyCode​(CurrencyCode currencyCode)

    • currencyRate

      public Quote currencyRate​(Double currencyRate)

    • getCurrencyRate

      public Double getCurrencyRate()
      The currency rate for a multicurrency quote
      Returns:
      currencyRate

    • setCurrencyRate

      public void setCurrencyRate​(Double currencyRate)

    • getSubTotal

      public Double getSubTotal()
      Total of quote excluding taxes.
      Returns:
      subTotal

    • getTotalTax

      public Double getTotalTax()
      Total tax on quote
      Returns:
      totalTax

    • getTotal

      public Double getTotal()
      Total of Quote tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts
      Returns:
      total

    • getTotalDiscount

      public Double getTotalDiscount()
      Total of discounts applied on the quote line items
      Returns:
      totalDiscount

    • title

      public Quote title​(String title)

    • getTitle

      public String getTitle()
      Title text for the quote
      Returns:
      title

    • setTitle

      public void setTitle​(String title)

    • summary

      public Quote summary​(String summary)

    • getSummary

      public String getSummary()
      Summary text for the quote
      Returns:
      summary

    • setSummary

      public void setSummary​(String summary)

    • brandingThemeID

      public Quote brandingThemeID​(UUID brandingThemeID)

    • getBrandingThemeID

      public UUID getBrandingThemeID()
      See BrandingThemes
      Returns:
      brandingThemeID

    • setBrandingThemeID

      public void setBrandingThemeID​(UUID brandingThemeID)

    • getUpdatedDateUTC

      public String getUpdatedDateUTC()
      Last modified date UTC format
      Returns:
      updatedDateUTC

    • getUpdatedDateUTCAsDate

      public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()

    • lineAmountTypes

      public Quote lineAmountTypes​(QuoteLineAmountTypes lineAmountTypes)

    • getLineAmountTypes

      public QuoteLineAmountTypes getLineAmountTypes()
      Get lineAmountTypes
      Returns:
      lineAmountTypes

    • setLineAmountTypes

      public void setLineAmountTypes​(QuoteLineAmountTypes lineAmountTypes)

    • statusAttributeString

      public Quote statusAttributeString​(String statusAttributeString)

    • getStatusAttributeString

      public String getStatusAttributeString()
      A string to indicate if a invoice status
      Returns:
      statusAttributeString

    • setStatusAttributeString

      public void setStatusAttributeString​(String statusAttributeString)

    • validationErrors

      public Quote validationErrors​(List<ValidationError> validationErrors)

    • addValidationErrorsItem

      public Quote addValidationErrorsItem​(ValidationError validationErrorsItem)

    • getValidationErrors

      public List<ValidationError> getValidationErrors()
      Displays array of validation error messages from the API
      Returns:
      validationErrors

    • setValidationErrors

      public void setValidationErrors​(List<ValidationError> validationErrors)

    • 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