Package com.xero.models.accounting
Class Quote
- java.lang.Object
-
- com.xero.models.accounting.Quote
-
public class Quote extends Object
Quote
-
-
Constructor Summary
Constructors Constructor Description Quote()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description QuoteaddLineItemsItem(LineItem lineItemsItem)See LineItemsQuoteaddValidationErrorsItem(ValidationError validationErrorsItem)Displays array of validation error messages from the APIQuotebrandingThemeID(UUID brandingThemeID)See BrandingThemesQuotecontact(Contact contact)contactQuotecurrencyCode(CurrencyCode currencyCode)currencyCodeQuotecurrencyRate(Double currencyRate)The currency rate for a multicurrency quoteQuotedate(String date)Date quote was issued – YYYY-MM-DD.QuotedateString(String dateString)Date the quote was issued (YYYY-MM-DD)booleanequals(Object o)QuoteexpiryDate(String expiryDate)Date the quote expires – YYYY-MM-DD.QuoteexpiryDateString(String expiryDateString)Date the quote expires – YYYY-MM-DD.UUIDgetBrandingThemeID()See BrandingThemesContactgetContact()Get contactCurrencyCodegetCurrencyCode()Get currencyCodeDoublegetCurrencyRate()The currency rate for a multicurrency quoteStringgetDate()Date quote was issued – YYYY-MM-DD.org.threeten.bp.LocalDategetDateAsDate()Date quote was issued – YYYY-MM-DD.StringgetDateString()Date the quote was issued (YYYY-MM-DD)StringgetExpiryDate()Date the quote expires – YYYY-MM-DD.org.threeten.bp.LocalDategetExpiryDateAsDate()Date the quote expires – YYYY-MM-DD.StringgetExpiryDateString()Date the quote expires – YYYY-MM-DD.QuoteLineAmountTypesgetLineAmountTypes()Get lineAmountTypesList<LineItem>getLineItems()See LineItemsUUIDgetQuoteID()QuoteID GUID is automatically generated and is returned after create or GET.StringgetQuoteNumber()Unique alpha numeric code identifying a quote (Max Length = 255)StringgetReference()Additional reference numberQuoteStatusCodesgetStatus()Get statusStringgetStatusAttributeString()A string to indicate if a invoice statusDoublegetSubTotal()Total of quote excluding taxes.StringgetSummary()Summary text for the quoteStringgetTerms()Terms of the quoteStringgetTitle()Title text for the quoteDoublegetTotal()Total of Quote tax inclusive (i.e.DoublegetTotalDiscount()Total of discounts applied on the quote line itemsDoublegetTotalTax()Total tax on quoteStringgetUpdatedDateUTC()Last modified date UTC formatorg.threeten.bp.OffsetDateTimegetUpdatedDateUTCAsDate()Last modified date UTC formatList<ValidationError>getValidationErrors()Displays array of validation error messages from the APIinthashCode()QuotelineAmountTypes(QuoteLineAmountTypes lineAmountTypes)lineAmountTypesQuotelineItems(List<LineItem> lineItems)See LineItemsQuotequoteID(UUID quoteID)QuoteID GUID is automatically generated and is returned after create or GET.QuotequoteNumber(String quoteNumber)Unique alpha numeric code identifying a quote (Max Length = 255)Quotereference(String reference)Additional reference numbervoidsetBrandingThemeID(UUID brandingThemeID)See BrandingThemesvoidsetContact(Contact contact)contactvoidsetCurrencyCode(CurrencyCode currencyCode)currencyCodevoidsetCurrencyRate(Double currencyRate)The currency rate for a multicurrency quotevoidsetDate(String date)Date quote was issued – YYYY-MM-DD.voidsetDate(org.threeten.bp.LocalDate date)Date quote was issued – YYYY-MM-DD.voidsetDateString(String dateString)Date the quote was issued (YYYY-MM-DD)voidsetExpiryDate(String expiryDate)Date the quote expires – YYYY-MM-DD.voidsetExpiryDate(org.threeten.bp.LocalDate expiryDate)Date the quote expires – YYYY-MM-DD.voidsetExpiryDateString(String expiryDateString)Date the quote expires – YYYY-MM-DD.voidsetLineAmountTypes(QuoteLineAmountTypes lineAmountTypes)lineAmountTypesvoidsetLineItems(List<LineItem> lineItems)See LineItemsvoidsetQuoteID(UUID quoteID)QuoteID GUID is automatically generated and is returned after create or GET.voidsetQuoteNumber(String quoteNumber)Unique alpha numeric code identifying a quote (Max Length = 255)voidsetReference(String reference)Additional reference numbervoidsetStatus(QuoteStatusCodes status)statusvoidsetStatusAttributeString(String statusAttributeString)A string to indicate if a invoice statusvoidsetSummary(String summary)Summary text for the quotevoidsetTerms(String terms)Terms of the quotevoidsetTitle(String title)Title text for the quotevoidsetValidationErrors(List<ValidationError> validationErrors)Displays array of validation error messages from the APIQuotestatus(QuoteStatusCodes status)statusQuotestatusAttributeString(String statusAttributeString)A string to indicate if a invoice statusQuotesummary(String summary)Summary text for the quoteQuoteterms(String terms)Terms of the quoteQuotetitle(String title)Title text for the quoteStringtoString()QuotevalidationErrors(List<ValidationError> validationErrors)Displays array of validation error messages from the API
-
-
-
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
-
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
-
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
-
getStatus
public QuoteStatusCodes getStatus()
Get status- Returns:
- status
-
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>
-
-