Invoice (Xero-Java SDK 2.1.2 API)

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.LineAmountTypesEnum` Line amounts are exclusive of tax by default if you don’t specify this element.
`static class`	`Invoice.StatusEnum` See Invoice Status Codes
`static class`	`Invoice.TypeEnum` See Invoice Types

Constructor Summary

Constructors
Constructor and Description

Invoice()

Constructors
Constructor and Description
`Invoice()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Invoice`	`addLineItemsItem(LineItem lineItemsItem)`
`Invoice`	`brandingThemeID(UUID brandingThemeID)`
`Invoice`	`contact(Object contact)`
`Invoice`	`currencyCode(String currencyCode)`
`Invoice`	`currencyRate(Float currencyRate)`
`Invoice`	`date(String date)`
`Invoice`	`dueDate(String dueDate)`
`boolean`	`equals(Object o)`
`Invoice`	`expectedPaymentDate(String expectedPaymentDate)`
`Float`	`getAmountCredited()` Sum of all credit notes, over-payments and pre-payments applied to invoice
`Float`	`getAmountDue()` Amount remaining to be paid on invoice
`Float`	`getAmountPaid()` Sum of payments received for invoice
`UUID`	`getBrandingThemeID()` See BrandingThemes
`Object`	`getContact()` Get contact
`List<CreditNote>`	`getCreditNotes()` Details of credit notes that have been applied to an invoice
`String`	`getCurrencyCode()` The currency that invoice has been raised in (see Currencies)
`Float`	`getCurrencyRate()` The currency rate for a multicurrency invoice.
`String`	`getDate()` Date invoice was issued – YYYY-MM-DD.
`String`	`getDueDate()` Date invoice is due – YYYY-MM-DD
`String`	`getExpectedPaymentDate()` Shown on sales invoices (Accounts Receivable) when this has been set
`String`	`getFullyPaidOnDate()` The date the invoice was fully paid.
`Boolean`	`getHasAttachments()` boolean to indicate if an invoice has an attachment
`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)
`Invoice.LineAmountTypesEnum`	`getLineAmountTypes()` Line amounts are exclusive of tax by default if you don’t specify this element.
`List<LineItem>`	`getLineItems()` See LineItems
`List<Overpayment>`	`getOverpayments()` See Overpayments
`List<Payment>`	`getPayments()` See Payments
`String`	`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
`Float`	`getSubTotal()` Total of invoice excluding taxes
`Float`	`getTotal()` Total of Invoice tax inclusive (i.e.
`Float`	`getTotalDiscount()` Total of discounts applied on the invoice line items
`Float`	`getTotalTax()` Total tax on invoice
`Invoice.TypeEnum`	`getType()` See Invoice Types
`String`	`getUpdatedDateUTC()` Last modified date UTC format
`String`	`getUrl()` URL link to a source document – shown as “Go to [appName]” in the Xero app
`int`	`hashCode()`
`Invoice`	`invoiceID(UUID invoiceID)`
`Invoice`	`invoiceNumber(String invoiceNumber)`
`Invoice`	`lineAmountTypes(Invoice.LineAmountTypesEnum lineAmountTypes)`
`Invoice`	`lineItems(List<LineItem> lineItems)`
`Invoice`	`plannedPaymentDate(String plannedPaymentDate)`
`Invoice`	`reference(String reference)`
`Invoice`	`sentToContact(Boolean sentToContact)`
`void`	`setBrandingThemeID(UUID brandingThemeID)`
`void`	`setContact(Object contact)`
`void`	`setCurrencyCode(String currencyCode)`
`void`	`setCurrencyRate(Float currencyRate)`
`void`	`setDate(String date)`
`void`	`setDueDate(String dueDate)`
`void`	`setExpectedPaymentDate(String expectedPaymentDate)`
`void`	`setInvoiceID(UUID invoiceID)`
`void`	`setInvoiceNumber(String invoiceNumber)`
`void`	`setLineAmountTypes(Invoice.LineAmountTypesEnum lineAmountTypes)`
`void`	`setLineItems(List<LineItem> lineItems)`
`void`	`setPlannedPaymentDate(String plannedPaymentDate)`
`void`	`setReference(String reference)`
`void`	`setSentToContact(Boolean sentToContact)`
`void`	`setStatus(Invoice.StatusEnum status)`
`void`	`setType(Invoice.TypeEnum type)`
`void`	`setUrl(String url)`
`Invoice`	`status(Invoice.StatusEnum status)`
`String`	`toString()`
`Invoice`	`type(Invoice.TypeEnum type)`
`Invoice`	`url(String url)`

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(Object contact)
```
  - getContact
```
public Object getContact()
```
    Get contact
    
    Returns:
    
    contact
  - setContact
```
public void setContact(Object 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(String date)
```
  - getDate
```
public String 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(String date)
```
  - dueDate
```
public Invoice dueDate(String dueDate)
```
  - getDueDate
```
public String getDueDate()
```
    Date invoice is due – YYYY-MM-DD
    
    Returns:
    
    dueDate
  - setDueDate
```
public void setDueDate(String dueDate)
```
  - lineAmountTypes
```
public Invoice lineAmountTypes(Invoice.LineAmountTypesEnum lineAmountTypes)
```
  - getLineAmountTypes
```
public Invoice.LineAmountTypesEnum getLineAmountTypes()
```
    Line amounts are exclusive of tax by default if you don’t specify this element. See Line Amount Types
    
    Returns:
    
    lineAmountTypes
  - setLineAmountTypes
```
public void setLineAmountTypes(Invoice.LineAmountTypesEnum 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(String currencyCode)
```
  - getCurrencyCode
```
public String getCurrencyCode()
```
    The currency that invoice has been raised in (see Currencies)
    
    Returns:
    
    currencyCode
  - setCurrencyCode
```
public void setCurrencyCode(String currencyCode)
```
  - currencyRate
```
public Invoice currencyRate(Float currencyRate)
```
  - getCurrencyRate
```
public Float 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(Float 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(String expectedPaymentDate)
```
  - getExpectedPaymentDate
```
public String getExpectedPaymentDate()
```
    Shown on sales invoices (Accounts Receivable) when this has been set
    
    Returns:
    
    expectedPaymentDate
  - setExpectedPaymentDate
```
public void setExpectedPaymentDate(String expectedPaymentDate)
```
  - plannedPaymentDate
```
public Invoice plannedPaymentDate(String plannedPaymentDate)
```
  - getPlannedPaymentDate
```
public String getPlannedPaymentDate()
```
    Shown on bills (Accounts Payable) when this has been set
    
    Returns:
    
    plannedPaymentDate
  - setPlannedPaymentDate
```
public void setPlannedPaymentDate(String plannedPaymentDate)
```
  - getSubTotal
```
public Float getSubTotal()
```
    Total of invoice excluding taxes
    
    Returns:
    
    subTotal
  - getTotalTax
```
public Float getTotalTax()
```
    Total tax on invoice
    
    Returns:
    
    totalTax
  - getTotal
```
public Float 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 Float 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
  - 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 Float getAmountDue()
```
    Amount remaining to be paid on invoice
    
    Returns:
    
    amountDue
  - getAmountPaid
```
public Float getAmountPaid()
```
    Sum of payments received for invoice
    
    Returns:
    
    amountPaid
  - getFullyPaidOnDate
```
public String getFullyPaidOnDate()
```
    The date the invoice was fully paid. Only returned on fully paid invoices
    
    Returns:
    
    fullyPaidOnDate
  - getAmountCredited
```
public Float getAmountCredited()
```
    Sum of all credit notes, over-payments and pre-payments applied to invoice
    
    Returns:
    
    amountCredited
  - getUpdatedDateUTC
```
public String 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
  - 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

Class Invoice

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Invoice

Method Detail

type

getType

setType

contact

getContact

setContact

lineItems

addLineItemsItem

getLineItems

setLineItems

date

getDate

setDate

dueDate

getDueDate

setDueDate

lineAmountTypes

getLineAmountTypes

setLineAmountTypes

invoiceNumber

getInvoiceNumber

setInvoiceNumber

reference

getReference

setReference

brandingThemeID

getBrandingThemeID

setBrandingThemeID

url

getUrl

setUrl

currencyCode

getCurrencyCode

setCurrencyCode

currencyRate

getCurrencyRate

setCurrencyRate

status

getStatus

setStatus

sentToContact

getSentToContact

setSentToContact

expectedPaymentDate

getExpectedPaymentDate

setExpectedPaymentDate

plannedPaymentDate

getPlannedPaymentDate

setPlannedPaymentDate

getSubTotal

getTotalTax

getTotal

getTotalDiscount

invoiceID

getInvoiceID

setInvoiceID

getHasAttachments

getPayments

getPrepayments

getOverpayments

getAmountDue

getAmountPaid

getFullyPaidOnDate

getAmountCredited

getUpdatedDateUTC

getCreditNotes

equals

hashCode

toString