Package com.xero.models.accounting

Class RepeatingInvoice

java.lang.Object

com.xero.models.accounting.RepeatingInvoice

public class RepeatingInvoice
extends Object

RepeatingInvoice

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RepeatingInvoice.StatusEnum	One of the following - DRAFT or AUTHORISED – See Invoice Status Codes
static enum	RepeatingInvoice.TypeEnum	See Invoice Types

Constructor Summary

Constructors

Constructor	Description
RepeatingInvoice()

Method Summary

Modifier and Type	Method	Description
RepeatingInvoice	addAttachmentsItem(Attachment attachmentsItem)	Displays array of attachments from the API
RepeatingInvoice	addLineItemsItem(LineItem lineItemsItem)	See LineItems
RepeatingInvoice	approvedForSending(Boolean approvedForSending)	Boolean to indicate whether the invoice has been approved for sending
RepeatingInvoice	attachments(List<Attachment> attachments)	Displays array of attachments from the API
RepeatingInvoice	brandingThemeID(UUID brandingThemeID)	See BrandingThemes
RepeatingInvoice	contact(Contact contact)	contact
RepeatingInvoice	currencyCode(CurrencyCode currencyCode)	currencyCode
boolean	equals(Object o)
Boolean	getApprovedForSending()	Boolean to indicate whether the invoice has been approved for sending
List<Attachment>	getAttachments()	Displays array of attachments from the API
UUID	getBrandingThemeID()	See BrandingThemes
Contact	getContact()	Get contact
CurrencyCode	getCurrencyCode()	Get currencyCode
Boolean	getHasAttachments()	Boolean to indicate if an invoice has an attachment
UUID	getID()	Xero generated unique identifier for repeating invoice template
Boolean	getIncludePDF()	Boolean to indicate whether to include PDF attachment
LineAmountTypes	getLineAmountTypes()	Get lineAmountTypes
List<LineItem>	getLineItems()	See LineItems
Boolean	getMarkAsSent()	Boolean to indicate whether the invoice in the Xero app displays as \"sent\"
String	getReference()	ACCREC only – additional reference number
UUID	getRepeatingInvoiceID()	Xero generated unique identifier for repeating invoice template
Schedule	getSchedule()	Get schedule
Boolean	getSendCopy()	Boolean to indicate whether a copy is sent to sender's email
RepeatingInvoice.StatusEnum	getStatus()	One of the following - DRAFT or AUTHORISED – See Invoice Status Codes
Double	getSubTotal()	Total of invoice excluding taxes
Double	getTotal()	Total of Invoice tax inclusive (i.e.
Double	getTotalTax()	Total tax on invoice
RepeatingInvoice.TypeEnum	getType()	See Invoice Types
int	hashCode()
RepeatingInvoice	ID(UUID ID)	Xero generated unique identifier for repeating invoice template
RepeatingInvoice	includePDF(Boolean includePDF)	Boolean to indicate whether to include PDF attachment
RepeatingInvoice	lineAmountTypes(LineAmountTypes lineAmountTypes)	lineAmountTypes
RepeatingInvoice	lineItems(List<LineItem> lineItems)	See LineItems
RepeatingInvoice	markAsSent(Boolean markAsSent)	Boolean to indicate whether the invoice in the Xero app displays as \"sent\"
RepeatingInvoice	reference(String reference)	ACCREC only – additional reference number
RepeatingInvoice	repeatingInvoiceID(UUID repeatingInvoiceID)	Xero generated unique identifier for repeating invoice template
RepeatingInvoice	schedule(Schedule schedule)	schedule
RepeatingInvoice	sendCopy(Boolean sendCopy)	Boolean to indicate whether a copy is sent to sender's email
void	setApprovedForSending(Boolean approvedForSending)	Boolean to indicate whether the invoice has been approved for sending
void	setAttachments(List<Attachment> attachments)	Displays array of attachments from the API
void	setBrandingThemeID(UUID brandingThemeID)	See BrandingThemes
void	setContact(Contact contact)	contact
void	setCurrencyCode(CurrencyCode currencyCode)	currencyCode
void	setID(UUID ID)	Xero generated unique identifier for repeating invoice template
void	setIncludePDF(Boolean includePDF)	Boolean to indicate whether to include PDF attachment
void	setLineAmountTypes(LineAmountTypes lineAmountTypes)	lineAmountTypes
void	setLineItems(List<LineItem> lineItems)	See LineItems
void	setMarkAsSent(Boolean markAsSent)	Boolean to indicate whether the invoice in the Xero app displays as \"sent\"
void	setReference(String reference)	ACCREC only – additional reference number
void	setRepeatingInvoiceID(UUID repeatingInvoiceID)	Xero generated unique identifier for repeating invoice template
void	setSchedule(Schedule schedule)	schedule
void	setSendCopy(Boolean sendCopy)	Boolean to indicate whether a copy is sent to sender's email
void	setStatus(RepeatingInvoice.StatusEnum status)	One of the following - DRAFT or AUTHORISED – See Invoice Status Codes
void	setSubTotal(Double subTotal)	Total of invoice excluding taxes
void	setTotal(Double total)	Total of Invoice tax inclusive (i.e.
void	setTotalTax(Double totalTax)	Total tax on invoice
void	setType(RepeatingInvoice.TypeEnum type)	See Invoice Types
RepeatingInvoice	status(RepeatingInvoice.StatusEnum status)	One of the following - DRAFT or AUTHORISED – See Invoice Status Codes
RepeatingInvoice	subTotal(Double subTotal)	Total of invoice excluding taxes
String	toString()
RepeatingInvoice	total(Double total)	Total of Invoice tax inclusive (i.e.
RepeatingInvoice	totalTax(Double totalTax)	Total tax on invoice
RepeatingInvoice	type(RepeatingInvoice.TypeEnum type)	See Invoice Types

Methods inherited from class java.lang.Object

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

Constructor Details

RepeatingInvoice

public RepeatingInvoice()

Method Details

type

public RepeatingInvoice type(RepeatingInvoice.TypeEnum type)

See Invoice Types

Parameters:

type - TypeEnum

Returns:

RepeatingInvoice

getType

public RepeatingInvoice.TypeEnum getType()

See Invoice Types

Returns:

type

setType

public void setType(RepeatingInvoice.TypeEnum type)

See Invoice Types

Parameters:

type - TypeEnum

contact

public RepeatingInvoice contact(Contact contact)

contact

Parameters:

contact - Contact

Returns:

RepeatingInvoice

getContact

public Contact getContact()

Get contact

Returns:

contact

setContact

public void setContact(Contact contact)

contact

Parameters:

contact - Contact

schedule

public RepeatingInvoice schedule(Schedule schedule)

schedule

Parameters:

schedule - Schedule

Returns:

RepeatingInvoice

getSchedule

public Schedule getSchedule()

Get schedule

Returns:

schedule

setSchedule

public void setSchedule(Schedule schedule)

schedule

Parameters:

schedule - Schedule

lineItems

public RepeatingInvoice lineItems(List<LineItem> lineItems)

See LineItems

Parameters:

lineItems - List<LineItem>

Returns:

RepeatingInvoice

addLineItemsItem

public RepeatingInvoice addLineItemsItem(LineItem lineItemsItem)

See LineItems

Parameters:

lineItemsItem - LineItem

Returns:

RepeatingInvoice

getLineItems

public List<LineItem> getLineItems()

See LineItems

Returns:

lineItems

setLineItems

public void setLineItems(List<LineItem> lineItems)

See LineItems

Parameters:

lineItems - List<LineItem>

lineAmountTypes

public RepeatingInvoice lineAmountTypes(LineAmountTypes lineAmountTypes)

lineAmountTypes

Parameters:

lineAmountTypes - LineAmountTypes

Returns:

RepeatingInvoice

getLineAmountTypes

public LineAmountTypes getLineAmountTypes()

Get lineAmountTypes

Returns:

lineAmountTypes

setLineAmountTypes

public void setLineAmountTypes(LineAmountTypes lineAmountTypes)

lineAmountTypes

Parameters:

lineAmountTypes - LineAmountTypes

reference

public RepeatingInvoice reference(String reference)

ACCREC only – additional reference number

Parameters:

reference - String

Returns:

RepeatingInvoice

getReference

public String getReference()

ACCREC only – additional reference number

Returns:

reference

setReference

public void setReference(String reference)

ACCREC only – additional reference number

Parameters:

reference - String

brandingThemeID

public RepeatingInvoice brandingThemeID(UUID brandingThemeID)

See BrandingThemes

Parameters:

brandingThemeID - UUID

Returns:

RepeatingInvoice

getBrandingThemeID

public UUID getBrandingThemeID()

See BrandingThemes

Returns:

brandingThemeID

setBrandingThemeID

public void setBrandingThemeID(UUID brandingThemeID)

See BrandingThemes

Parameters:

brandingThemeID - UUID

currencyCode

public RepeatingInvoice currencyCode(CurrencyCode currencyCode)

currencyCode

Parameters:

currencyCode - CurrencyCode

Returns:

RepeatingInvoice

getCurrencyCode

public CurrencyCode getCurrencyCode()

Get currencyCode

Returns:

currencyCode

setCurrencyCode

public void setCurrencyCode(CurrencyCode currencyCode)

currencyCode

Parameters:

currencyCode - CurrencyCode

status

public RepeatingInvoice status(RepeatingInvoice.StatusEnum status)

One of the following - DRAFT or AUTHORISED – See Invoice Status Codes

Parameters:

status - StatusEnum

Returns:

RepeatingInvoice

getStatus

public RepeatingInvoice.StatusEnum getStatus()

One of the following - DRAFT or AUTHORISED – See Invoice Status Codes

Returns:

status

setStatus

public void setStatus(RepeatingInvoice.StatusEnum status)

One of the following - DRAFT or AUTHORISED – See Invoice Status Codes

Parameters:

status - StatusEnum

subTotal

public RepeatingInvoice subTotal(Double subTotal)

Total of invoice excluding taxes

Parameters:

subTotal - Double

Returns:

RepeatingInvoice

getSubTotal

public Double getSubTotal()

Total of invoice excluding taxes

Returns:

subTotal

setSubTotal

public void setSubTotal(Double subTotal)

Total of invoice excluding taxes

Parameters:

subTotal - Double

totalTax

public RepeatingInvoice totalTax(Double totalTax)

Total tax on invoice

Parameters:

totalTax - Double

Returns:

RepeatingInvoice

getTotalTax

public Double getTotalTax()

Total tax on invoice

Returns:

totalTax

setTotalTax

public void setTotalTax(Double totalTax)

Total tax on invoice

Parameters:

totalTax - Double

total

public RepeatingInvoice total(Double total)

Total of Invoice tax inclusive (i.e. SubTotal + TotalTax)

Parameters:

total - Double

Returns:

RepeatingInvoice

getTotal

public Double getTotal()

Total of Invoice tax inclusive (i.e. SubTotal + TotalTax)

Returns:

total

setTotal

public void setTotal(Double total)

Total of Invoice tax inclusive (i.e. SubTotal + TotalTax)

Parameters:

total - Double

repeatingInvoiceID

public RepeatingInvoice repeatingInvoiceID(UUID repeatingInvoiceID)

Xero generated unique identifier for repeating invoice template

Parameters:

repeatingInvoiceID - UUID

Returns:

RepeatingInvoice

getRepeatingInvoiceID

public UUID getRepeatingInvoiceID()

Xero generated unique identifier for repeating invoice template

Returns:

repeatingInvoiceID

setRepeatingInvoiceID

public void setRepeatingInvoiceID(UUID repeatingInvoiceID)

Xero generated unique identifier for repeating invoice template

Parameters:

repeatingInvoiceID - UUID

ID

public RepeatingInvoice ID(UUID ID)

Xero generated unique identifier for repeating invoice template

Parameters:

ID - UUID

Returns:

RepeatingInvoice

getID

public UUID getID()

Xero generated unique identifier for repeating invoice template

Returns:

ID

setID

public void setID(UUID ID)

Xero generated unique identifier for repeating invoice template

Parameters:

ID - UUID

getHasAttachments

public Boolean getHasAttachments()

Boolean to indicate if an invoice has an attachment

Returns:

hasAttachments

attachments

public RepeatingInvoice attachments(List<Attachment> attachments)

Displays array of attachments from the API

Parameters:

attachments - List<Attachment>

Returns:

RepeatingInvoice

addAttachmentsItem

public RepeatingInvoice addAttachmentsItem(Attachment attachmentsItem)

Displays array of attachments from the API

Parameters:

attachmentsItem - Attachment

Returns:

RepeatingInvoice

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>

approvedForSending

public RepeatingInvoice approvedForSending(Boolean approvedForSending)

Boolean to indicate whether the invoice has been approved for sending

Parameters:

approvedForSending - Boolean

Returns:

RepeatingInvoice

getApprovedForSending

public Boolean getApprovedForSending()

Boolean to indicate whether the invoice has been approved for sending

Returns:

approvedForSending

setApprovedForSending

public void setApprovedForSending(Boolean approvedForSending)

Boolean to indicate whether the invoice has been approved for sending

Parameters:

approvedForSending - Boolean

sendCopy

public RepeatingInvoice sendCopy(Boolean sendCopy)

Boolean to indicate whether a copy is sent to sender's email

Parameters:

sendCopy - Boolean

Returns:

RepeatingInvoice

getSendCopy

public Boolean getSendCopy()

Boolean to indicate whether a copy is sent to sender's email

Returns:

sendCopy

setSendCopy

public void setSendCopy(Boolean sendCopy)

Boolean to indicate whether a copy is sent to sender's email

Parameters:

sendCopy - Boolean

markAsSent

public RepeatingInvoice markAsSent(Boolean markAsSent)

Boolean to indicate whether the invoice in the Xero app displays as \"sent\"

Parameters:

markAsSent - Boolean

Returns:

RepeatingInvoice

getMarkAsSent

public Boolean getMarkAsSent()

Boolean to indicate whether the invoice in the Xero app displays as \"sent\"

Returns:

markAsSent

setMarkAsSent

public void setMarkAsSent(Boolean markAsSent)

Boolean to indicate whether the invoice in the Xero app displays as \"sent\"

Parameters:

markAsSent - Boolean

includePDF

public RepeatingInvoice includePDF(Boolean includePDF)

Boolean to indicate whether to include PDF attachment

Parameters:

includePDF - Boolean

Returns:

RepeatingInvoice

getIncludePDF

public Boolean getIncludePDF()

Boolean to indicate whether to include PDF attachment

Returns:

includePDF

setIncludePDF

public void setIncludePDF(Boolean includePDF)

Boolean to indicate whether to include PDF attachment

Parameters:

includePDF - Boolean

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