com.xero.models.accounting

Class Invoice

java.lang.Object

com.xero.models.accounting.Invoice

public class Invoice
extends Object

Invoice

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Invoice.StatusEnum See Invoice Status Codes
static class	Invoice.TypeEnum See Invoice Types

Constructor Summary

Constructors

Constructor and Description
Invoice()

Method Summary

Modifier and Type	Method and Description
Invoice	addAttachmentsItem(Attachment attachmentsItem)
Invoice	addLineItemsItem(LineItem lineItemsItem)
Invoice	addValidationErrorsItem(ValidationError validationErrorsItem)
Invoice	attachments(List<Attachment> attachments)
Invoice	brandingThemeID(UUID brandingThemeID)
Invoice	contact(Contact contact)
Invoice	currencyCode(CurrencyCode currencyCode)
Invoice	currencyRate(Double currencyRate)
Invoice	date(org.threeten.bp.LocalDate date)
Invoice	dueDate(org.threeten.bp.LocalDate dueDate)
boolean	equals(Object o)
Invoice	expectedPaymentDate(org.threeten.bp.LocalDate expectedPaymentDate)
Double	getAmountCredited() Sum of all credit notes, over-payments and pre-payments applied to invoice
Double	getAmountDue() Amount remaining to be paid on invoice
Double	getAmountPaid() Sum of payments received for invoice
List<Attachment>	getAttachments() Displays array of attachments from the API
UUID	getBrandingThemeID() See BrandingThemes
Contact	getContact() Get contact
List<CreditNote>	getCreditNotes() Details of credit notes that have been applied to an invoice
CurrencyCode	getCurrencyCode() Get currencyCode
Double	getCurrencyRate() The currency rate for a multicurrency invoice.
org.threeten.bp.LocalDate	getDate() Date invoice was issued – YYYY-MM-DD.
org.threeten.bp.LocalDate	getDueDate() Date invoice is due – YYYY-MM-DD
org.threeten.bp.LocalDate	getExpectedPaymentDate() Shown on sales invoices (Accounts Receivable) when this has been set
org.threeten.bp.LocalDate	getFullyPaidOnDate() The date the invoice was fully paid.
Boolean	getHasAttachments() boolean to indicate if an invoice has an attachment
Boolean	getHasErrors() A boolean to indicate if a invoice has an validation errors
UUID	getInvoiceID() Xero generated unique identifier for invoice
String	getInvoiceNumber() ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255)
Boolean	getIsDiscounted() boolean to indicate if an invoice has a discount
LineAmountTypes	getLineAmountTypes() Get lineAmountTypes
List<LineItem>	getLineItems() See LineItems
List<Overpayment>	getOverpayments() See Overpayments
List<Payment>	getPayments() See Payments
org.threeten.bp.LocalDate	getPlannedPaymentDate() Shown on bills (Accounts Payable) when this has been set
List<Prepayment>	getPrepayments() See Prepayments
String	getReference() ACCREC only – additional reference number (max length = 255)
Boolean	getSentToContact() Boolean to set whether the invoice in the Xero app should be marked as “sent”.
Invoice.StatusEnum	getStatus() See Invoice Status Codes
String	getStatusAttributeString() A string to indicate if a invoice status
Double	getSubTotal() Total of invoice excluding taxes
Double	getTotal() Total of Invoice tax inclusive (i.e.
Double	getTotalDiscount() Total of discounts applied on the invoice line items
Double	getTotalTax() Total tax on invoice
Invoice.TypeEnum	getType() See Invoice Types
org.threeten.bp.OffsetDateTime	getUpdatedDateUTC() Last modified date UTC format
String	getUrl() URL link to a source document – shown as “Go to [appName]” in the Xero app
List<ValidationError>	getValidationErrors() Displays array of validation error messages from the API
Invoice	hasErrors(Boolean hasErrors)
int	hashCode()
Invoice	invoiceID(UUID invoiceID)
Invoice	invoiceNumber(String invoiceNumber)
Invoice	lineAmountTypes(LineAmountTypes lineAmountTypes)
Invoice	lineItems(List<LineItem> lineItems)
Invoice	plannedPaymentDate(org.threeten.bp.LocalDate plannedPaymentDate)
Invoice	reference(String reference)
Invoice	sentToContact(Boolean sentToContact)
void	setAttachments(List<Attachment> attachments)
void	setBrandingThemeID(UUID brandingThemeID)
void	setContact(Contact contact)
void	setCurrencyCode(CurrencyCode currencyCode)
void	setCurrencyRate(Double currencyRate)
void	setDate(org.threeten.bp.LocalDate date)
void	setDueDate(org.threeten.bp.LocalDate dueDate)
void	setExpectedPaymentDate(org.threeten.bp.LocalDate expectedPaymentDate)
void	setHasErrors(Boolean hasErrors)
void	setInvoiceID(UUID invoiceID)
void	setInvoiceNumber(String invoiceNumber)
void	setLineAmountTypes(LineAmountTypes lineAmountTypes)
void	setLineItems(List<LineItem> lineItems)
void	setPlannedPaymentDate(org.threeten.bp.LocalDate plannedPaymentDate)
void	setReference(String reference)
void	setSentToContact(Boolean sentToContact)
void	setStatus(Invoice.StatusEnum status)
void	setStatusAttributeString(String statusAttributeString)
void	setType(Invoice.TypeEnum type)
void	setUrl(String url)
void	setValidationErrors(List<ValidationError> validationErrors)
Invoice	status(Invoice.StatusEnum status)
Invoice	statusAttributeString(String statusAttributeString)
String	toString()
Invoice	type(Invoice.TypeEnum type)
Invoice	url(String url)
Invoice	validationErrors(List<ValidationError> validationErrors)

Methods inherited from class java.lang.Object

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

Constructor Detail

Invoice

public Invoice()

Method Detail

type

public Invoice type(Invoice.TypeEnum type)

getType

public Invoice.TypeEnum getType()

See Invoice Types

Returns:

type

setType

public void setType(Invoice.TypeEnum type)

contact

public Invoice contact(Contact contact)

getContact

public Contact getContact()

Get contact

Returns:

contact

setContact

public void setContact(Contact contact)

lineItems

public Invoice lineItems(List<LineItem> lineItems)

addLineItemsItem

public Invoice addLineItemsItem(LineItem lineItemsItem)

getLineItems

public List<LineItem> getLineItems()

See LineItems

Returns:

lineItems

setLineItems

public void setLineItems(List<LineItem> lineItems)

date

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

getDate

public org.threeten.bp.LocalDate getDate()

Date invoice 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

setDate

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

dueDate

public Invoice dueDate(org.threeten.bp.LocalDate dueDate)

getDueDate

public org.threeten.bp.LocalDate getDueDate()

Date invoice is due – YYYY-MM-DD

Returns:

dueDate

setDueDate

public void setDueDate(org.threeten.bp.LocalDate dueDate)

lineAmountTypes

public Invoice lineAmountTypes(LineAmountTypes lineAmountTypes)

getLineAmountTypes

public LineAmountTypes getLineAmountTypes()

Get lineAmountTypes

Returns:

lineAmountTypes

setLineAmountTypes

public void setLineAmountTypes(LineAmountTypes lineAmountTypes)

invoiceNumber

public Invoice invoiceNumber(String invoiceNumber)

getInvoiceNumber

public String getInvoiceNumber()

ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255)

Returns:

invoiceNumber

setInvoiceNumber

public void setInvoiceNumber(String invoiceNumber)

reference

public Invoice reference(String reference)

getReference

public String getReference()

ACCREC only – additional reference number (max length = 255)

Returns:

reference

setReference

public void setReference(String reference)

brandingThemeID

public Invoice brandingThemeID(UUID brandingThemeID)

getBrandingThemeID

public UUID getBrandingThemeID()

See BrandingThemes

Returns:

brandingThemeID

setBrandingThemeID

public void setBrandingThemeID(UUID brandingThemeID)

url

public Invoice url(String url)

getUrl

public String getUrl()

URL link to a source document – shown as “Go to [appName]” in the Xero app

Returns:

url

setUrl

public void setUrl(String url)

currencyCode

public Invoice currencyCode(CurrencyCode currencyCode)

getCurrencyCode

public CurrencyCode getCurrencyCode()

Get currencyCode

Returns:

currencyCode

setCurrencyCode

public void setCurrencyCode(CurrencyCode currencyCode)

currencyRate

public Invoice currencyRate(Double currencyRate)

getCurrencyRate

public Double getCurrencyRate()

The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].[6])

Returns:

currencyRate

setCurrencyRate

public void setCurrencyRate(Double currencyRate)

status

public Invoice status(Invoice.StatusEnum status)

getStatus

public Invoice.StatusEnum getStatus()

See Invoice Status Codes

Returns:

status

setStatus

public void setStatus(Invoice.StatusEnum status)

sentToContact

public Invoice sentToContact(Boolean sentToContact)

getSentToContact

public Boolean getSentToContact()

Boolean to set whether the invoice in the Xero app should be marked as “sent”. This can be set only on invoices that have been approved

Returns:

sentToContact

setSentToContact

public void setSentToContact(Boolean sentToContact)

expectedPaymentDate

public Invoice expectedPaymentDate(org.threeten.bp.LocalDate expectedPaymentDate)

getExpectedPaymentDate

public org.threeten.bp.LocalDate getExpectedPaymentDate()

Shown on sales invoices (Accounts Receivable) when this has been set

Returns:

expectedPaymentDate

setExpectedPaymentDate

public void setExpectedPaymentDate(org.threeten.bp.LocalDate expectedPaymentDate)

plannedPaymentDate

public Invoice plannedPaymentDate(org.threeten.bp.LocalDate plannedPaymentDate)

getPlannedPaymentDate

public org.threeten.bp.LocalDate getPlannedPaymentDate()

Shown on bills (Accounts Payable) when this has been set

Returns:

plannedPaymentDate

setPlannedPaymentDate

public void setPlannedPaymentDate(org.threeten.bp.LocalDate plannedPaymentDate)

getSubTotal

public Double getSubTotal()

Total of invoice excluding taxes

Returns:

subTotal

getTotalTax

public Double getTotalTax()

Total tax on invoice

Returns:

totalTax

getTotal

public Double getTotal()

Total of Invoice 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 invoice line items

Returns:

totalDiscount

invoiceID

public Invoice invoiceID(UUID invoiceID)

getInvoiceID

public UUID getInvoiceID()

Xero generated unique identifier for invoice

Returns:

invoiceID

setInvoiceID

public void setInvoiceID(UUID invoiceID)

getHasAttachments

public Boolean getHasAttachments()

boolean to indicate if an invoice has an attachment

Returns:

hasAttachments

getIsDiscounted

public Boolean getIsDiscounted()

boolean to indicate if an invoice has a discount

Returns:

isDiscounted

getPayments

public List<Payment> getPayments()

See Payments

Returns:

payments

getPrepayments

public List<Prepayment> getPrepayments()

See Prepayments

Returns:

prepayments

getOverpayments

public List<Overpayment> getOverpayments()

See Overpayments

Returns:

overpayments

getAmountDue

public Double getAmountDue()

Amount remaining to be paid on invoice

Returns:

amountDue

getAmountPaid

public Double getAmountPaid()

Sum of payments received for invoice

Returns:

amountPaid

getFullyPaidOnDate

public org.threeten.bp.LocalDate getFullyPaidOnDate()

The date the invoice was fully paid. Only returned on fully paid invoices

Returns:

fullyPaidOnDate

getAmountCredited

public Double getAmountCredited()

Sum of all credit notes, over-payments and pre-payments applied to invoice

Returns:

amountCredited

getUpdatedDateUTC

public org.threeten.bp.OffsetDateTime getUpdatedDateUTC()

Last modified date UTC format

Returns:

updatedDateUTC

getCreditNotes

public List<CreditNote> getCreditNotes()

Details of credit notes that have been applied to an invoice

Returns:

creditNotes

attachments

public Invoice attachments(List<Attachment> attachments)

addAttachmentsItem

public Invoice addAttachmentsItem(Attachment attachmentsItem)

getAttachments

public List<Attachment> getAttachments()

Displays array of attachments from the API

Returns:

attachments

setAttachments

public void setAttachments(List<Attachment> attachments)

hasErrors

public Invoice hasErrors(Boolean hasErrors)

getHasErrors

public Boolean getHasErrors()

A boolean to indicate if a invoice has an validation errors

Returns:

hasErrors

setHasErrors

public void setHasErrors(Boolean hasErrors)

statusAttributeString

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

addValidationErrorsItem

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

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