com.xero.models.accounting

Class PurchaseOrder

java.lang.Object

com.xero.models.accounting.PurchaseOrder

public class PurchaseOrder
extends Object

PurchaseOrder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PurchaseOrder.StatusEnum See Purchase Order Status Codes

Constructor Summary

Constructors

Constructor and Description
PurchaseOrder()

Method Summary

Modifier and Type	Method and Description
PurchaseOrder	addAttachmentsItem(Attachment attachmentsItem)
PurchaseOrder	addLineItemsItem(LineItem lineItemsItem)
PurchaseOrder	addValidationErrorsItem(ValidationError validationErrorsItem)
PurchaseOrder	addWarningsItem(ValidationError warningsItem)
PurchaseOrder	attachments(List<Attachment> attachments)
PurchaseOrder	attentionTo(String attentionTo)
PurchaseOrder	brandingThemeID(UUID brandingThemeID)
PurchaseOrder	contact(Contact contact)
PurchaseOrder	currencyCode(CurrencyCode currencyCode)
PurchaseOrder	currencyRate(Double currencyRate)
PurchaseOrder	date(org.threeten.bp.LocalDate date)
PurchaseOrder	deliveryAddress(String deliveryAddress)
PurchaseOrder	deliveryDate(org.threeten.bp.LocalDate deliveryDate)
PurchaseOrder	deliveryInstructions(String deliveryInstructions)
boolean	equals(Object o)
PurchaseOrder	expectedArrivalDate(org.threeten.bp.LocalDate expectedArrivalDate)
List<Attachment>	getAttachments() Displays array of attachments from the API
String	getAttentionTo() The person that the delivery is going to
UUID	getBrandingThemeID() See BrandingThemes
Contact	getContact() Get contact
CurrencyCode	getCurrencyCode() Get currencyCode
Double	getCurrencyRate() The currency rate for a multicurrency purchase order.
org.threeten.bp.LocalDate	getDate() Date purchase order was issued – YYYY-MM-DD.
String	getDeliveryAddress() The address the goods are to be delivered to
org.threeten.bp.LocalDate	getDeliveryDate() Date the goods are to be delivered – YYYY-MM-DD
String	getDeliveryInstructions() A free text feild for instructions (500 characters max)
org.threeten.bp.LocalDate	getExpectedArrivalDate() The date the goods are expected to arrive.
Boolean	getHasAttachments() boolean to indicate if a purchase order has an attachment
LineAmountTypes	getLineAmountTypes() Get lineAmountTypes
List<LineItem>	getLineItems() See LineItems
UUID	getPurchaseOrderID() Xero generated unique identifier for purchase order
String	getPurchaseOrderNumber() Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)
String	getReference() Additional reference number
Boolean	getSentToContact() Boolean to set whether the purchase order should be marked as “sent”.
PurchaseOrder.StatusEnum	getStatus() See Purchase Order Status Codes
String	getStatusAttributeString() A string to indicate if a invoice status
Double	getSubTotal() Total of purchase order excluding taxes
String	getTelephone() The phone number for the person accepting the delivery
Double	getTotal() Total of Purchase Order tax inclusive (i.e.
Double	getTotalDiscount() Total of discounts applied on the purchase order line items
Double	getTotalTax() Total tax on purchase order
org.threeten.bp.OffsetDateTime	getUpdatedDateUTC() Last modified date UTC format
List<ValidationError>	getValidationErrors() Displays array of validation error messages from the API
List<ValidationError>	getWarnings() Displays array of warning messages from the API
int	hashCode()
PurchaseOrder	lineAmountTypes(LineAmountTypes lineAmountTypes)
PurchaseOrder	lineItems(List<LineItem> lineItems)
PurchaseOrder	purchaseOrderID(UUID purchaseOrderID)
PurchaseOrder	purchaseOrderNumber(String purchaseOrderNumber)
PurchaseOrder	reference(String reference)
PurchaseOrder	sentToContact(Boolean sentToContact)
void	setAttachments(List<Attachment> attachments)
void	setAttentionTo(String attentionTo)
void	setBrandingThemeID(UUID brandingThemeID)
void	setContact(Contact contact)
void	setCurrencyCode(CurrencyCode currencyCode)
void	setCurrencyRate(Double currencyRate)
void	setDate(org.threeten.bp.LocalDate date)
void	setDeliveryAddress(String deliveryAddress)
void	setDeliveryDate(org.threeten.bp.LocalDate deliveryDate)
void	setDeliveryInstructions(String deliveryInstructions)
void	setExpectedArrivalDate(org.threeten.bp.LocalDate expectedArrivalDate)
void	setLineAmountTypes(LineAmountTypes lineAmountTypes)
void	setLineItems(List<LineItem> lineItems)
void	setPurchaseOrderID(UUID purchaseOrderID)
void	setPurchaseOrderNumber(String purchaseOrderNumber)
void	setReference(String reference)
void	setSentToContact(Boolean sentToContact)
void	setStatus(PurchaseOrder.StatusEnum status)
void	setStatusAttributeString(String statusAttributeString)
void	setTelephone(String telephone)
void	setValidationErrors(List<ValidationError> validationErrors)
void	setWarnings(List<ValidationError> warnings)
PurchaseOrder	status(PurchaseOrder.StatusEnum status)
PurchaseOrder	statusAttributeString(String statusAttributeString)
PurchaseOrder	telephone(String telephone)
String	toString()
PurchaseOrder	validationErrors(List<ValidationError> validationErrors)
PurchaseOrder	warnings(List<ValidationError> warnings)

Methods inherited from class java.lang.Object

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

Constructor Detail

PurchaseOrder

public PurchaseOrder()

Method Detail

contact

public PurchaseOrder contact(Contact contact)

getContact

public Contact getContact()

Get contact

Returns:

contact

setContact

public void setContact(Contact contact)

lineItems

public PurchaseOrder lineItems(List<LineItem> lineItems)

addLineItemsItem

public PurchaseOrder addLineItemsItem(LineItem lineItemsItem)

getLineItems

public List<LineItem> getLineItems()

See LineItems

Returns:

lineItems

setLineItems

public void setLineItems(List<LineItem> lineItems)

date

public PurchaseOrder date(org.threeten.bp.LocalDate date)

getDate

public org.threeten.bp.LocalDate getDate()

Date purchase order was issued – YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation

Returns:

date

setDate

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

deliveryDate

public PurchaseOrder deliveryDate(org.threeten.bp.LocalDate deliveryDate)

getDeliveryDate

public org.threeten.bp.LocalDate getDeliveryDate()

Date the goods are to be delivered – YYYY-MM-DD

Returns:

deliveryDate

setDeliveryDate

public void setDeliveryDate(org.threeten.bp.LocalDate deliveryDate)

lineAmountTypes

public PurchaseOrder lineAmountTypes(LineAmountTypes lineAmountTypes)

getLineAmountTypes

public LineAmountTypes getLineAmountTypes()

Get lineAmountTypes

Returns:

lineAmountTypes

setLineAmountTypes

public void setLineAmountTypes(LineAmountTypes lineAmountTypes)

purchaseOrderNumber

public PurchaseOrder purchaseOrderNumber(String purchaseOrderNumber)

getPurchaseOrderNumber

public String getPurchaseOrderNumber()

Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)

Returns:

purchaseOrderNumber

setPurchaseOrderNumber

public void setPurchaseOrderNumber(String purchaseOrderNumber)

reference

public PurchaseOrder reference(String reference)

getReference

public String getReference()

Additional reference number

Returns:

reference

setReference

public void setReference(String reference)

brandingThemeID

public PurchaseOrder brandingThemeID(UUID brandingThemeID)

getBrandingThemeID

public UUID getBrandingThemeID()

See BrandingThemes

Returns:

brandingThemeID

setBrandingThemeID

public void setBrandingThemeID(UUID brandingThemeID)

currencyCode

public PurchaseOrder currencyCode(CurrencyCode currencyCode)

getCurrencyCode

public CurrencyCode getCurrencyCode()

Get currencyCode

Returns:

currencyCode

setCurrencyCode

public void setCurrencyCode(CurrencyCode currencyCode)

status

public PurchaseOrder status(PurchaseOrder.StatusEnum status)

getStatus

public PurchaseOrder.StatusEnum getStatus()

See Purchase Order Status Codes

Returns:

status

setStatus

public void setStatus(PurchaseOrder.StatusEnum status)

sentToContact

public PurchaseOrder sentToContact(Boolean sentToContact)

getSentToContact

public Boolean getSentToContact()

Boolean to set whether the purchase order should be marked as “sent”. This can be set only on purchase orders that have been approved or billed

Returns:

sentToContact

setSentToContact

public void setSentToContact(Boolean sentToContact)

deliveryAddress

public PurchaseOrder deliveryAddress(String deliveryAddress)

getDeliveryAddress

public String getDeliveryAddress()

The address the goods are to be delivered to

Returns:

deliveryAddress

setDeliveryAddress

public void setDeliveryAddress(String deliveryAddress)

attentionTo

public PurchaseOrder attentionTo(String attentionTo)

getAttentionTo

public String getAttentionTo()

The person that the delivery is going to

Returns:

attentionTo

setAttentionTo

public void setAttentionTo(String attentionTo)

telephone

public PurchaseOrder telephone(String telephone)

getTelephone

public String getTelephone()

The phone number for the person accepting the delivery

Returns:

telephone

setTelephone

public void setTelephone(String telephone)

deliveryInstructions

public PurchaseOrder deliveryInstructions(String deliveryInstructions)

getDeliveryInstructions

public String getDeliveryInstructions()

A free text feild for instructions (500 characters max)

Returns:

deliveryInstructions

setDeliveryInstructions

public void setDeliveryInstructions(String deliveryInstructions)

expectedArrivalDate

public PurchaseOrder expectedArrivalDate(org.threeten.bp.LocalDate expectedArrivalDate)

getExpectedArrivalDate

public org.threeten.bp.LocalDate getExpectedArrivalDate()

The date the goods are expected to arrive.

Returns:

expectedArrivalDate

setExpectedArrivalDate

public void setExpectedArrivalDate(org.threeten.bp.LocalDate expectedArrivalDate)

purchaseOrderID

public PurchaseOrder purchaseOrderID(UUID purchaseOrderID)

getPurchaseOrderID

public UUID getPurchaseOrderID()

Xero generated unique identifier for purchase order

Returns:

purchaseOrderID

setPurchaseOrderID

public void setPurchaseOrderID(UUID purchaseOrderID)

currencyRate

public PurchaseOrder currencyRate(Double currencyRate)

getCurrencyRate

public Double getCurrencyRate()

The currency rate for a multicurrency purchase order. If no rate is specified, the XE.com day rate is used.

Returns:

currencyRate

setCurrencyRate

public void setCurrencyRate(Double currencyRate)

getSubTotal

public Double getSubTotal()

Total of purchase order excluding taxes

Returns:

subTotal

getTotalTax

public Double getTotalTax()

Total tax on purchase order

Returns:

totalTax

getTotal

public Double getTotal()

Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax)

Returns:

total

getTotalDiscount

public Double getTotalDiscount()

Total of discounts applied on the purchase order line items

Returns:

totalDiscount

getHasAttachments

public Boolean getHasAttachments()

boolean to indicate if a purchase order has an attachment

Returns:

hasAttachments

getUpdatedDateUTC

public org.threeten.bp.OffsetDateTime getUpdatedDateUTC()

Last modified date UTC format

Returns:

updatedDateUTC

statusAttributeString

public PurchaseOrder 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 PurchaseOrder validationErrors(List<ValidationError> validationErrors)

addValidationErrorsItem

public PurchaseOrder 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)

warnings

public PurchaseOrder warnings(List<ValidationError> warnings)

addWarningsItem

public PurchaseOrder addWarningsItem(ValidationError warningsItem)

getWarnings

public List<ValidationError> getWarnings()

Displays array of warning messages from the API

Returns:

warnings

setWarnings

public void setWarnings(List<ValidationError> warnings)

attachments

public PurchaseOrder attachments(List<Attachment> attachments)

addAttachmentsItem

public PurchaseOrder addAttachmentsItem(Attachment attachmentsItem)

getAttachments

public List<Attachment> getAttachments()

Displays array of attachments from the API

Returns:

attachments

setAttachments

public void setAttachments(List<Attachment> attachments)

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