Class Quote


  • public class Quote
    extends Object
    Quote
    • Constructor Detail

      • Quote

        public Quote()
    • Method Detail

      • quoteID

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

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

        public void setQuoteID​(UUID quoteID)
        QuoteID GUID is automatically generated and is returned after create or GET.
        Parameters:
        quoteID - UUID
      • quoteNumber

        public Quote quoteNumber​(String quoteNumber)
        Unique alpha numeric code identifying a quote (Max Length = 255)
        Parameters:
        quoteNumber - String
        Returns:
        Quote
      • getQuoteNumber

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

        public void setQuoteNumber​(String quoteNumber)
        Unique alpha numeric code identifying a quote (Max Length = 255)
        Parameters:
        quoteNumber - String
      • reference

        public Quote reference​(String reference)
        Additional reference number
        Parameters:
        reference - String
        Returns:
        Quote
      • getReference

        public String getReference()
        Additional reference number
        Returns:
        reference
      • setReference

        public void setReference​(String reference)
        Additional reference number
        Parameters:
        reference - String
      • terms

        public Quote terms​(String terms)
        Terms of the quote
        Parameters:
        terms - String
        Returns:
        Quote
      • getTerms

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

        public void setTerms​(String terms)
        Terms of the quote
        Parameters:
        terms - String
      • contact

        public Quote contact​(Contact contact)
        contact
        Parameters:
        contact - Contact
        Returns:
        Quote
      • getContact

        public Contact getContact()
        Get contact
        Returns:
        contact
      • setContact

        public void setContact​(Contact contact)
        contact
        Parameters:
        contact - Contact
      • lineItems

        public Quote lineItems​(List<LineItem> lineItems)
        See LineItems
        Parameters:
        lineItems - List<LineItem>
        Returns:
        Quote
      • addLineItemsItem

        public Quote addLineItemsItem​(LineItem lineItemsItem)
        See LineItems
        Parameters:
        lineItemsItem - LineItem
        Returns:
        Quote
      • getLineItems

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

        public void setLineItems​(List<LineItem> lineItems)
        See LineItems
        Parameters:
        lineItems - List<LineItem>
      • date

        public Quote date​(String date)
        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
        Parameters:
        date - String
        Returns:
        Quote
      • 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()
        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:
        LocalDate
      • setDate

        public void setDate​(String date)
        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
        Parameters:
        date - String
      • setDate

        public void setDate​(org.threeten.bp.LocalDate date)
        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
        Parameters:
        date - LocalDateTime
      • dateString

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

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

        public void setDateString​(String dateString)
        Date the quote was issued (YYYY-MM-DD)
        Parameters:
        dateString - String
      • expiryDate

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

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

        public org.threeten.bp.LocalDate getExpiryDateAsDate()
        Date the quote expires – YYYY-MM-DD.
        Returns:
        LocalDate
      • setExpiryDate

        public void setExpiryDate​(String expiryDate)
        Date the quote expires – YYYY-MM-DD.
        Parameters:
        expiryDate - String
      • setExpiryDate

        public void setExpiryDate​(org.threeten.bp.LocalDate expiryDate)
        Date the quote expires – YYYY-MM-DD.
        Parameters:
        expiryDate - LocalDateTime
      • expiryDateString

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

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

        public void setExpiryDateString​(String expiryDateString)
        Date the quote expires – YYYY-MM-DD.
        Parameters:
        expiryDateString - String
      • status

        public Quote status​(QuoteStatusCodes status)
        status
        Parameters:
        status - QuoteStatusCodes
        Returns:
        Quote
      • setStatus

        public void setStatus​(QuoteStatusCodes status)
        status
        Parameters:
        status - QuoteStatusCodes
      • currencyCode

        public Quote currencyCode​(CurrencyCode currencyCode)
        currencyCode
        Parameters:
        currencyCode - CurrencyCode
        Returns:
        Quote
      • getCurrencyCode

        public CurrencyCode getCurrencyCode()
        Get currencyCode
        Returns:
        currencyCode
      • setCurrencyCode

        public void setCurrencyCode​(CurrencyCode currencyCode)
        currencyCode
        Parameters:
        currencyCode - CurrencyCode
      • currencyRate

        public Quote currencyRate​(Double currencyRate)
        The currency rate for a multicurrency quote
        Parameters:
        currencyRate - Double
        Returns:
        Quote
      • getCurrencyRate

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

        public void setCurrencyRate​(Double currencyRate)
        The currency rate for a multicurrency quote
        Parameters:
        currencyRate - Double
      • 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)
        Title text for the quote
        Parameters:
        title - String
        Returns:
        Quote
      • getTitle

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

        public void setTitle​(String title)
        Title text for the quote
        Parameters:
        title - String
      • summary

        public Quote summary​(String summary)
        Summary text for the quote
        Parameters:
        summary - String
        Returns:
        Quote
      • getSummary

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

        public void setSummary​(String summary)
        Summary text for the quote
        Parameters:
        summary - String
      • brandingThemeID

        public Quote brandingThemeID​(UUID brandingThemeID)
        See BrandingThemes
        Parameters:
        brandingThemeID - UUID
        Returns:
        Quote
      • getBrandingThemeID

        public UUID getBrandingThemeID()
        See BrandingThemes
        Returns:
        brandingThemeID
      • setBrandingThemeID

        public void setBrandingThemeID​(UUID brandingThemeID)
        See BrandingThemes
        Parameters:
        brandingThemeID - UUID
      • getUpdatedDateUTC

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

        public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()
        Last modified date UTC format
        Returns:
        OffsetDateTime
      • lineAmountTypes

        public Quote lineAmountTypes​(QuoteLineAmountTypes lineAmountTypes)
        lineAmountTypes
        Parameters:
        lineAmountTypes - QuoteLineAmountTypes
        Returns:
        Quote
      • getLineAmountTypes

        public QuoteLineAmountTypes getLineAmountTypes()
        Get lineAmountTypes
        Returns:
        lineAmountTypes
      • setLineAmountTypes

        public void setLineAmountTypes​(QuoteLineAmountTypes lineAmountTypes)
        lineAmountTypes
        Parameters:
        lineAmountTypes - QuoteLineAmountTypes
      • statusAttributeString

        public Quote statusAttributeString​(String statusAttributeString)
        A string to indicate if a invoice status
        Parameters:
        statusAttributeString - String
        Returns:
        Quote
      • getStatusAttributeString

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

        public void setStatusAttributeString​(String statusAttributeString)
        A string to indicate if a invoice status
        Parameters:
        statusAttributeString - String
      • validationErrors

        public Quote validationErrors​(List<ValidationError> validationErrors)
        Displays array of validation error messages from the API
        Parameters:
        validationErrors - List<ValidationError>
        Returns:
        Quote
      • addValidationErrorsItem

        public Quote addValidationErrorsItem​(ValidationError validationErrorsItem)
        Displays array of validation error messages from the API
        Parameters:
        validationErrorsItem - ValidationError
        Returns:
        Quote
      • getValidationErrors

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

        public void setValidationErrors​(List<ValidationError> validationErrors)
        Displays array of validation error messages from the API
        Parameters:
        validationErrors - List<ValidationError>
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object