Package com.xero.models.accounting
Class PurchaseOrder
java.lang.Object
com.xero.models.accounting.PurchaseOrder
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumSee Purchase Order Status Codes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAttachmentsItem(Attachment attachmentsItem) Displays array of attachments from the APIaddLineItemsItem(LineItem lineItemsItem) See LineItemsaddValidationErrorsItem(ValidationError validationErrorsItem) Displays array of validation error messages from the APIaddWarningsItem(ValidationError warningsItem) Displays array of warning messages from the APIattachments(List<Attachment> attachments) Displays array of attachments from the APIattentionTo(String attentionTo) The person that the delivery is going tobrandingThemeID(UUID brandingThemeID) See BrandingThemescontactcurrencyCode(CurrencyCode currencyCode) currencyCodecurrencyRate(Double currencyRate) The currency rate for a multicurrency purchase order.Date purchase order was issued – YYYY-MM-DD.deliveryAddress(String deliveryAddress) The address the goods are to be delivered todeliveryDate(String deliveryDate) Date the goods are to be delivered – YYYY-MM-DDdeliveryInstructions(String deliveryInstructions) A free text feild for instructions (500 characters max)booleanexpectedArrivalDate(String expectedArrivalDate) The date the goods are expected to arrive.Displays array of attachments from the APIThe person that the delivery is going toSee BrandingThemesGet contactGet currencyCodeThe currency rate for a multicurrency purchase order.getDate()Date purchase order was issued – YYYY-MM-DD.org.threeten.bp.LocalDateDate purchase order was issued – YYYY-MM-DD.The address the goods are to be delivered toDate the goods are to be delivered – YYYY-MM-DDorg.threeten.bp.LocalDateDate the goods are to be delivered – YYYY-MM-DDA free text feild for instructions (500 characters max)The date the goods are expected to arrive.org.threeten.bp.LocalDateThe date the goods are expected to arrive.boolean to indicate if a purchase order has an attachmentGet lineAmountTypesSee LineItemsXero generated unique identifier for purchase orderUnique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)Additional reference numberBoolean to set whether the purchase order should be marked as “sent”.See Purchase Order Status CodesA string to indicate if a invoice statusTotal of purchase order excluding taxesThe phone number for the person accepting the deliverygetTotal()Total of Purchase Order tax inclusive (i.e.Total of discounts applied on the purchase order line itemsTotal tax on purchase orderLast modified date UTC formatorg.threeten.bp.OffsetDateTimeLast modified date UTC formatDisplays array of validation error messages from the APIDisplays array of warning messages from the APIinthashCode()lineAmountTypes(LineAmountTypes lineAmountTypes) lineAmountTypesSee LineItemspurchaseOrderID(UUID purchaseOrderID) Xero generated unique identifier for purchase orderpurchaseOrderNumber(String purchaseOrderNumber) Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)Additional reference numbersentToContact(Boolean sentToContact) Boolean to set whether the purchase order should be marked as “sent”.voidsetAttachments(List<Attachment> attachments) Displays array of attachments from the APIvoidsetAttentionTo(String attentionTo) The person that the delivery is going tovoidsetBrandingThemeID(UUID brandingThemeID) See BrandingThemesvoidsetContact(Contact contact) contactvoidsetCurrencyCode(CurrencyCode currencyCode) currencyCodevoidsetCurrencyRate(Double currencyRate) The currency rate for a multicurrency purchase order.voidDate purchase order was issued – YYYY-MM-DD.voidsetDate(org.threeten.bp.LocalDate date) Date purchase order was issued – YYYY-MM-DD.voidsetDeliveryAddress(String deliveryAddress) The address the goods are to be delivered tovoidsetDeliveryDate(String deliveryDate) Date the goods are to be delivered – YYYY-MM-DDvoidsetDeliveryDate(org.threeten.bp.LocalDate deliveryDate) Date the goods are to be delivered – YYYY-MM-DDvoidsetDeliveryInstructions(String deliveryInstructions) A free text feild for instructions (500 characters max)voidsetExpectedArrivalDate(String expectedArrivalDate) The date the goods are expected to arrive.voidsetExpectedArrivalDate(org.threeten.bp.LocalDate expectedArrivalDate) The date the goods are expected to arrive.voidsetLineAmountTypes(LineAmountTypes lineAmountTypes) lineAmountTypesvoidsetLineItems(List<LineItem> lineItems) See LineItemsvoidsetPurchaseOrderID(UUID purchaseOrderID) Xero generated unique identifier for purchase ordervoidsetPurchaseOrderNumber(String purchaseOrderNumber) Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)voidsetReference(String reference) Additional reference numbervoidsetSentToContact(Boolean sentToContact) Boolean to set whether the purchase order should be marked as “sent”.voidsetStatus(PurchaseOrder.StatusEnum status) See Purchase Order Status CodesvoidsetStatusAttributeString(String statusAttributeString) A string to indicate if a invoice statusvoidsetTelephone(String telephone) The phone number for the person accepting the deliveryvoidsetValidationErrors(List<ValidationError> validationErrors) Displays array of validation error messages from the APIvoidsetWarnings(List<ValidationError> warnings) Displays array of warning messages from the APIstatus(PurchaseOrder.StatusEnum status) See Purchase Order Status CodesstatusAttributeString(String statusAttributeString) A string to indicate if a invoice statusThe phone number for the person accepting the deliverytoString()validationErrors(List<ValidationError> validationErrors) Displays array of validation error messages from the APIwarnings(List<ValidationError> warnings) Displays array of warning messages from the API
-
Constructor Details
-
PurchaseOrder
public PurchaseOrder()
-
-
Method Details
-
contact
contact- Parameters:
contact- Contact- Returns:
- PurchaseOrder
-
getContact
-
setContact
-
lineItems
See LineItems- Parameters:
lineItems- List<LineItem>- Returns:
- PurchaseOrder
-
addLineItemsItem
See LineItems- Parameters:
lineItemsItem- LineItem- Returns:
- PurchaseOrder
-
getLineItems
-
setLineItems
-
date
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- Parameters:
date- String- Returns:
- PurchaseOrder
-
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
-
getDateAsDate
public org.threeten.bp.LocalDate getDateAsDate()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:
- LocalDate
-
setDate
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- Parameters:
date- String
-
setDate
public void setDate(org.threeten.bp.LocalDate date) 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- Parameters:
date- LocalDateTime
-
deliveryDate
Date the goods are to be delivered – YYYY-MM-DD- Parameters:
deliveryDate- String- Returns:
- PurchaseOrder
-
getDeliveryDate
Date the goods are to be delivered – YYYY-MM-DD- Returns:
- deliveryDate
-
getDeliveryDateAsDate
public org.threeten.bp.LocalDate getDeliveryDateAsDate()Date the goods are to be delivered – YYYY-MM-DD- Returns:
- LocalDate
-
setDeliveryDate
Date the goods are to be delivered – YYYY-MM-DD- Parameters:
deliveryDate- String
-
setDeliveryDate
public void setDeliveryDate(org.threeten.bp.LocalDate deliveryDate) Date the goods are to be delivered – YYYY-MM-DD- Parameters:
deliveryDate- LocalDateTime
-
lineAmountTypes
lineAmountTypes- Parameters:
lineAmountTypes- LineAmountTypes- Returns:
- PurchaseOrder
-
getLineAmountTypes
-
setLineAmountTypes
lineAmountTypes- Parameters:
lineAmountTypes- LineAmountTypes
-
purchaseOrderNumber
Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)- Parameters:
purchaseOrderNumber- String- Returns:
- PurchaseOrder
-
getPurchaseOrderNumber
Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)- Returns:
- purchaseOrderNumber
-
setPurchaseOrderNumber
Unique alpha numeric code identifying purchase order (when missing will auto-generate from your Organisation Invoice Settings)- Parameters:
purchaseOrderNumber- String
-
reference
Additional reference number- Parameters:
reference- String- Returns:
- PurchaseOrder
-
getReference
-
setReference
Additional reference number- Parameters:
reference- String
-
brandingThemeID
See BrandingThemes- Parameters:
brandingThemeID- UUID- Returns:
- PurchaseOrder
-
getBrandingThemeID
-
setBrandingThemeID
See BrandingThemes- Parameters:
brandingThemeID- UUID
-
currencyCode
currencyCode- Parameters:
currencyCode- CurrencyCode- Returns:
- PurchaseOrder
-
getCurrencyCode
-
setCurrencyCode
currencyCode- Parameters:
currencyCode- CurrencyCode
-
status
See Purchase Order Status Codes- Parameters:
status- StatusEnum- Returns:
- PurchaseOrder
-
getStatus
-
setStatus
See Purchase Order Status Codes- Parameters:
status- StatusEnum
-
sentToContact
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- Parameters:
sentToContact- Boolean- Returns:
- PurchaseOrder
-
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
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- Parameters:
sentToContact- Boolean
-
deliveryAddress
The address the goods are to be delivered to- Parameters:
deliveryAddress- String- Returns:
- PurchaseOrder
-
getDeliveryAddress
The address the goods are to be delivered to- Returns:
- deliveryAddress
-
setDeliveryAddress
The address the goods are to be delivered to- Parameters:
deliveryAddress- String
-
attentionTo
The person that the delivery is going to- Parameters:
attentionTo- String- Returns:
- PurchaseOrder
-
getAttentionTo
-
setAttentionTo
The person that the delivery is going to- Parameters:
attentionTo- String
-
telephone
The phone number for the person accepting the delivery- Parameters:
telephone- String- Returns:
- PurchaseOrder
-
getTelephone
The phone number for the person accepting the delivery- Returns:
- telephone
-
setTelephone
The phone number for the person accepting the delivery- Parameters:
telephone- String
-
deliveryInstructions
A free text feild for instructions (500 characters max)- Parameters:
deliveryInstructions- String- Returns:
- PurchaseOrder
-
getDeliveryInstructions
A free text feild for instructions (500 characters max)- Returns:
- deliveryInstructions
-
setDeliveryInstructions
A free text feild for instructions (500 characters max)- Parameters:
deliveryInstructions- String
-
expectedArrivalDate
The date the goods are expected to arrive.- Parameters:
expectedArrivalDate- String- Returns:
- PurchaseOrder
-
getExpectedArrivalDate
The date the goods are expected to arrive.- Returns:
- expectedArrivalDate
-
getExpectedArrivalDateAsDate
public org.threeten.bp.LocalDate getExpectedArrivalDateAsDate()The date the goods are expected to arrive.- Returns:
- LocalDate
-
setExpectedArrivalDate
The date the goods are expected to arrive.- Parameters:
expectedArrivalDate- String
-
setExpectedArrivalDate
public void setExpectedArrivalDate(org.threeten.bp.LocalDate expectedArrivalDate) The date the goods are expected to arrive.- Parameters:
expectedArrivalDate- LocalDateTime
-
purchaseOrderID
Xero generated unique identifier for purchase order- Parameters:
purchaseOrderID- UUID- Returns:
- PurchaseOrder
-
getPurchaseOrderID
Xero generated unique identifier for purchase order- Returns:
- purchaseOrderID
-
setPurchaseOrderID
Xero generated unique identifier for purchase order- Parameters:
purchaseOrderID- UUID
-
currencyRate
The currency rate for a multicurrency purchase order. If no rate is specified, the XE.com day rate is used.- Parameters:
currencyRate- Double- Returns:
- PurchaseOrder
-
getCurrencyRate
The currency rate for a multicurrency purchase order. If no rate is specified, the XE.com day rate is used.- Returns:
- currencyRate
-
setCurrencyRate
The currency rate for a multicurrency purchase order. If no rate is specified, the XE.com day rate is used.- Parameters:
currencyRate- Double
-
getSubTotal
-
getTotalTax
-
getTotal
Total of Purchase Order tax inclusive (i.e. SubTotal + TotalTax)- Returns:
- total
-
getTotalDiscount
Total of discounts applied on the purchase order line items- Returns:
- totalDiscount
-
getHasAttachments
boolean to indicate if a purchase order has an attachment- Returns:
- hasAttachments
-
getUpdatedDateUTC
-
getUpdatedDateUTCAsDate
public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()Last modified date UTC format- Returns:
- OffsetDateTime
-
statusAttributeString
A string to indicate if a invoice status- Parameters:
statusAttributeString- String- Returns:
- PurchaseOrder
-
getStatusAttributeString
A string to indicate if a invoice status- Returns:
- statusAttributeString
-
setStatusAttributeString
A string to indicate if a invoice status- Parameters:
statusAttributeString- String
-
validationErrors
Displays array of validation error messages from the API- Parameters:
validationErrors- List<ValidationError>- Returns:
- PurchaseOrder
-
addValidationErrorsItem
Displays array of validation error messages from the API- Parameters:
validationErrorsItem- ValidationError- Returns:
- PurchaseOrder
-
getValidationErrors
Displays array of validation error messages from the API- Returns:
- validationErrors
-
setValidationErrors
Displays array of validation error messages from the API- Parameters:
validationErrors- List<ValidationError>
-
warnings
Displays array of warning messages from the API- Parameters:
warnings- List<ValidationError>- Returns:
- PurchaseOrder
-
addWarningsItem
Displays array of warning messages from the API- Parameters:
warningsItem- ValidationError- Returns:
- PurchaseOrder
-
getWarnings
Displays array of warning messages from the API- Returns:
- warnings
-
setWarnings
Displays array of warning messages from the API- Parameters:
warnings- List<ValidationError>
-
attachments
Displays array of attachments from the API- Parameters:
attachments- List<Attachment>- Returns:
- PurchaseOrder
-
addAttachmentsItem
Displays array of attachments from the API- Parameters:
attachmentsItem- Attachment- Returns:
- PurchaseOrder
-
getAttachments
Displays array of attachments from the API- Returns:
- attachments
-
setAttachments
Displays array of attachments from the API- Parameters:
attachments- List<Attachment>
-
equals
-
hashCode
-
toString
-