Class Receipt


  • public class Receipt
    extends Object
    Receipt
    • Constructor Detail

      • Receipt

        public Receipt()
    • Method Detail

      • date

        public Receipt date​(String date)
        Date of receipt – YYYY-MM-DD
        Parameters:
        date - String
        Returns:
        Receipt
      • getDate

        public String getDate()
        Date of receipt – YYYY-MM-DD
        Returns:
        date
      • getDateAsDate

        public org.threeten.bp.LocalDate getDateAsDate()
        Date of receipt – YYYY-MM-DD
        Returns:
        LocalDate
      • setDate

        public void setDate​(String date)
        Date of receipt – YYYY-MM-DD
        Parameters:
        date - String
      • setDate

        public void setDate​(org.threeten.bp.LocalDate date)
        Date of receipt – YYYY-MM-DD
        Parameters:
        date - LocalDateTime
      • contact

        public Receipt contact​(Contact contact)
        contact
        Parameters:
        contact - Contact
        Returns:
        Receipt
      • getContact

        public Contact getContact()
        Get contact
        Returns:
        contact
      • setContact

        public void setContact​(Contact contact)
        contact
        Parameters:
        contact - Contact
      • lineItems

        public Receipt lineItems​(List<LineItem> lineItems)
        lineItems
        Parameters:
        lineItems - List<LineItem>
        Returns:
        Receipt
      • addLineItemsItem

        public Receipt addLineItemsItem​(LineItem lineItemsItem)
        lineItems
        Parameters:
        lineItemsItem - LineItem
        Returns:
        Receipt
      • getLineItems

        public List<LineItem> getLineItems()
        Get lineItems
        Returns:
        lineItems
      • setLineItems

        public void setLineItems​(List<LineItem> lineItems)
        lineItems
        Parameters:
        lineItems - List<LineItem>
      • user

        public Receipt user​(User user)
        user
        Parameters:
        user - User
        Returns:
        Receipt
      • getUser

        public User getUser()
        Get user
        Returns:
        user
      • setUser

        public void setUser​(User user)
        user
        Parameters:
        user - User
      • reference

        public Receipt reference​(String reference)
        Additional reference number
        Parameters:
        reference - String
        Returns:
        Receipt
      • getReference

        public String getReference()
        Additional reference number
        Returns:
        reference
      • setReference

        public void setReference​(String reference)
        Additional reference number
        Parameters:
        reference - String
      • lineAmountTypes

        public Receipt lineAmountTypes​(LineAmountTypes lineAmountTypes)
        lineAmountTypes
        Parameters:
        lineAmountTypes - LineAmountTypes
        Returns:
        Receipt
      • getLineAmountTypes

        public LineAmountTypes getLineAmountTypes()
        Get lineAmountTypes
        Returns:
        lineAmountTypes
      • setLineAmountTypes

        public void setLineAmountTypes​(LineAmountTypes lineAmountTypes)
        lineAmountTypes
        Parameters:
        lineAmountTypes - LineAmountTypes
      • subTotal

        public Receipt subTotal​(Double subTotal)
        Total of receipt excluding taxes
        Parameters:
        subTotal - Double
        Returns:
        Receipt
      • getSubTotal

        public Double getSubTotal()
        Total of receipt excluding taxes
        Returns:
        subTotal
      • setSubTotal

        public void setSubTotal​(Double subTotal)
        Total of receipt excluding taxes
        Parameters:
        subTotal - Double
      • totalTax

        public Receipt totalTax​(Double totalTax)
        Total tax on receipt
        Parameters:
        totalTax - Double
        Returns:
        Receipt
      • getTotalTax

        public Double getTotalTax()
        Total tax on receipt
        Returns:
        totalTax
      • setTotalTax

        public void setTotalTax​(Double totalTax)
        Total tax on receipt
        Parameters:
        totalTax - Double
      • total

        public Receipt total​(Double total)
        Total of receipt tax inclusive (i.e. SubTotal + TotalTax)
        Parameters:
        total - Double
        Returns:
        Receipt
      • getTotal

        public Double getTotal()
        Total of receipt tax inclusive (i.e. SubTotal + TotalTax)
        Returns:
        total
      • setTotal

        public void setTotal​(Double total)
        Total of receipt tax inclusive (i.e. SubTotal + TotalTax)
        Parameters:
        total - Double
      • receiptID

        public Receipt receiptID​(UUID receiptID)
        Xero generated unique identifier for receipt
        Parameters:
        receiptID - UUID
        Returns:
        Receipt
      • getReceiptID

        public UUID getReceiptID()
        Xero generated unique identifier for receipt
        Returns:
        receiptID
      • setReceiptID

        public void setReceiptID​(UUID receiptID)
        Xero generated unique identifier for receipt
        Parameters:
        receiptID - UUID
      • status

        public Receipt status​(Receipt.StatusEnum status)
        Current status of receipt – see status types
        Parameters:
        status - StatusEnum
        Returns:
        Receipt
      • getStatus

        public Receipt.StatusEnum getStatus()
        Current status of receipt – see status types
        Returns:
        status
      • setStatus

        public void setStatus​(Receipt.StatusEnum status)
        Current status of receipt – see status types
        Parameters:
        status - StatusEnum
      • getReceiptNumber

        public String getReceiptNumber()
        Xero generated sequence number for receipt in current claim for a given user
        Returns:
        receiptNumber
      • 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
      • getHasAttachments

        public Boolean getHasAttachments()
        boolean to indicate if a receipt has an attachment
        Returns:
        hasAttachments
      • getUrl

        public String getUrl()
        URL link to a source document – shown as “Go to [appName]” in the Xero app
        Returns:
        url
      • validationErrors

        public Receipt validationErrors​(List<ValidationError> validationErrors)
        Displays array of validation error messages from the API
        Parameters:
        validationErrors - List<ValidationError>
        Returns:
        Receipt
      • addValidationErrorsItem

        public Receipt addValidationErrorsItem​(ValidationError validationErrorsItem)
        Displays array of validation error messages from the API
        Parameters:
        validationErrorsItem - ValidationError
        Returns:
        Receipt
      • 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>
      • warnings

        public Receipt warnings​(List<ValidationError> warnings)
        Displays array of warning messages from the API
        Parameters:
        warnings - List<ValidationError>
        Returns:
        Receipt
      • addWarningsItem

        public Receipt addWarningsItem​(ValidationError warningsItem)
        Displays array of warning messages from the API
        Parameters:
        warningsItem - ValidationError
        Returns:
        Receipt
      • getWarnings

        public List<ValidationError> getWarnings()
        Displays array of warning messages from the API
        Returns:
        warnings
      • setWarnings

        public void setWarnings​(List<ValidationError> warnings)
        Displays array of warning messages from the API
        Parameters:
        warnings - List<ValidationError>
      • attachments

        public Receipt attachments​(List<Attachment> attachments)
        Displays array of attachments from the API
        Parameters:
        attachments - List<Attachment>
        Returns:
        Receipt
      • addAttachmentsItem

        public Receipt addAttachmentsItem​(Attachment attachmentsItem)
        Displays array of attachments from the API
        Parameters:
        attachmentsItem - Attachment
        Returns:
        Receipt
      • getAttachments

        public List<Attachment> getAttachments()
        Displays array of attachments from the API
        Returns:
        attachments
      • setAttachments

        public void setAttachments​(List<Attachment> attachments)
        Displays array of attachments from the API
        Parameters:
        attachments - List<Attachment>
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object