Package com.xero.models.accounting

Class PurchaseOrder

java.lang.Object
com.xero.models.accounting.PurchaseOrder
public class PurchaseOrder
extends Object
PurchaseOrder

  • Constructor Details

    • PurchaseOrder

      public PurchaseOrder()

  • Method Details

    • 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​(String date)

    • getDate

      public String 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()

    • setDate

      public void setDate​(String date)

    • setDate

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

    • deliveryDate

      public PurchaseOrder deliveryDate​(String deliveryDate)

    • getDeliveryDate

      public String getDeliveryDate()
      Date the goods are to be delivered – YYYY-MM-DD
      Returns:
      deliveryDate

    • getDeliveryDateAsDate

      public org.threeten.bp.LocalDate getDeliveryDateAsDate()

    • setDeliveryDate

      public void setDeliveryDate​(String 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​(String expectedArrivalDate)

    • getExpectedArrivalDate

      public String getExpectedArrivalDate()
      The date the goods are expected to arrive.
      Returns:
      expectedArrivalDate

    • getExpectedArrivalDateAsDate

      public org.threeten.bp.LocalDate getExpectedArrivalDateAsDate()

    • setExpectedArrivalDate

      public void setExpectedArrivalDate​(String 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 String getUpdatedDateUTC()
      Last modified date UTC format
      Returns:
      updatedDateUTC

    • getUpdatedDateUTCAsDate

      public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()

    • 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