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

Modifier and Type	Method	Description
Quote	addLineItemsItem(LineItem lineItemsItem)	See LineItems
Quote	addValidationErrorsItem(ValidationError validationErrorsItem)	Displays array of validation error messages from the API
Quote	brandingThemeID(UUID brandingThemeID)	See BrandingThemes
Quote	contact(Contact contact)	contact
Quote	currencyCode(CurrencyCode currencyCode)	currencyCode
Quote	currencyRate(Double currencyRate)	The currency rate for a multicurrency quote
Quote	date(String date)	Date quote was issued – YYYY-MM-DD.
Quote	dateString(String dateString)	Date the quote was issued (YYYY-MM-DD)
boolean	equals(Object o)
Quote	expiryDate(String expiryDate)	Date the quote expires – YYYY-MM-DD.
Quote	expiryDateString(String expiryDateString)	Date the quote expires – YYYY-MM-DD.
UUID	getBrandingThemeID()	See BrandingThemes
Contact	getContact()	Get contact
CurrencyCode	getCurrencyCode()	Get currencyCode
Double	getCurrencyRate()	The currency rate for a multicurrency quote
String	getDate()	Date quote was issued – YYYY-MM-DD.
org.threeten.bp.LocalDate	getDateAsDate()	Date quote was issued – YYYY-MM-DD.
String	getDateString()	Date the quote was issued (YYYY-MM-DD)
String	getExpiryDate()	Date the quote expires – YYYY-MM-DD.
org.threeten.bp.LocalDate	getExpiryDateAsDate()	Date the quote expires – YYYY-MM-DD.
String	getExpiryDateString()	Date the quote expires – YYYY-MM-DD.
QuoteLineAmountTypes	getLineAmountTypes()	Get lineAmountTypes
List<LineItem>	getLineItems()	See LineItems
UUID	getQuoteID()	QuoteID GUID is automatically generated and is returned after create or GET.
String	getQuoteNumber()	Unique alpha numeric code identifying a quote (Max Length = 255)
String	getReference()	Additional reference number
QuoteStatusCodes	getStatus()	Get status
String	getStatusAttributeString()	A string to indicate if a invoice status
Double	getSubTotal()	Total of quote excluding taxes.
String	getSummary()	Summary text for the quote
String	getTerms()	Terms of the quote
String	getTitle()	Title text for the quote
Double	getTotal()	Total of Quote tax inclusive (i.e.
Double	getTotalDiscount()	Total of discounts applied on the quote line items
Double	getTotalTax()	Total tax on quote
String	getUpdatedDateUTC()	Last modified date UTC format
org.threeten.bp.OffsetDateTime	getUpdatedDateUTCAsDate()	Last modified date UTC format
List<ValidationError>	getValidationErrors()	Displays array of validation error messages from the API
int	hashCode()
Quote	lineAmountTypes(QuoteLineAmountTypes lineAmountTypes)	lineAmountTypes
Quote	lineItems(List<LineItem> lineItems)	See LineItems
Quote	quoteID(UUID quoteID)	QuoteID GUID is automatically generated and is returned after create or GET.
Quote	quoteNumber(String quoteNumber)	Unique alpha numeric code identifying a quote (Max Length = 255)
Quote	reference(String reference)	Additional reference number
void	setBrandingThemeID(UUID brandingThemeID)	See BrandingThemes
void	setContact(Contact contact)	contact
void	setCurrencyCode(CurrencyCode currencyCode)	currencyCode
void	setCurrencyRate(Double currencyRate)	The currency rate for a multicurrency quote
void	setDate(String date)	Date quote was issued – YYYY-MM-DD.
void	setDate(org.threeten.bp.LocalDate date)	Date quote was issued – YYYY-MM-DD.
void	setDateString(String dateString)	Date the quote was issued (YYYY-MM-DD)
void	setExpiryDate(String expiryDate)	Date the quote expires – YYYY-MM-DD.
void	setExpiryDate(org.threeten.bp.LocalDate expiryDate)	Date the quote expires – YYYY-MM-DD.
void	setExpiryDateString(String expiryDateString)	Date the quote expires – YYYY-MM-DD.
void	setLineAmountTypes(QuoteLineAmountTypes lineAmountTypes)	lineAmountTypes
void	setLineItems(List<LineItem> lineItems)	See LineItems
void	setQuoteID(UUID quoteID)	QuoteID GUID is automatically generated and is returned after create or GET.
void	setQuoteNumber(String quoteNumber)	Unique alpha numeric code identifying a quote (Max Length = 255)
void	setReference(String reference)	Additional reference number
void	setStatus(QuoteStatusCodes status)	status
void	setStatusAttributeString(String statusAttributeString)	A string to indicate if a invoice status
void	setSummary(String summary)	Summary text for the quote
void	setTerms(String terms)	Terms of the quote
void	setTitle(String title)	Title text for the quote
void	setValidationErrors(List<ValidationError> validationErrors)	Displays array of validation error messages from the API
Quote	status(QuoteStatusCodes status)	status
Quote	statusAttributeString(String statusAttributeString)	A string to indicate if a invoice status
Quote	summary(String summary)	Summary text for the quote
Quote	terms(String terms)	Terms of the quote
Quote	title(String title)	Title text for the quote
String	toString()
Quote	validationErrors(List<ValidationError> validationErrors)	Displays array of validation error messages from the API

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Quote

public Quote()

Method Details

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

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>

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