com.xero.models.accounting

Class Prepayment

java.lang.Object

com.xero.models.accounting.Prepayment

public class Prepayment
extends Object

Prepayment

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Prepayment()

Method Summary

Modifier and Type	Method and Description
Prepayment	addAllocationsItem(Allocation allocationsItem)
Prepayment	addAttachmentsItem(Attachment attachmentsItem)
Prepayment	addLineItemsItem(LineItem lineItemsItem)
Prepayment	allocations(List<Allocation> allocations)
Prepayment	appliedAmount(Double appliedAmount)
Prepayment	attachments(List<Attachment> attachments)
Prepayment	contact(Contact contact)
Prepayment	currencyCode(CurrencyCode currencyCode)
Prepayment	currencyRate(Double currencyRate)
Prepayment	date(org.threeten.bp.LocalDate date)
boolean	equals(Object o)
List<Allocation>	getAllocations() See Allocations
Double	getAppliedAmount() The amount of applied to an invoice
List<Attachment>	getAttachments() See Attachments
Contact	getContact() Get contact
CurrencyCode	getCurrencyCode() Get currencyCode
Double	getCurrencyRate() The currency rate for a multicurrency prepayment.
org.threeten.bp.LocalDate	getDate() The date the prepayment is created YYYY-MM-DD
Boolean	getHasAttachments() boolean to indicate if a prepayment has an attachment
LineAmountTypes	getLineAmountTypes() Get lineAmountTypes
List<LineItem>	getLineItems() See Prepayment Line Items
UUID	getPrepaymentID() Xero generated unique identifier
String	getReference() Returns Invoice number field.
Double	getRemainingCredit() The remaining credit balance on the prepayment
Prepayment.StatusEnum	getStatus() See Prepayment Status Codes
Double	getSubTotal() The subtotal of the prepayment excluding taxes
Double	getTotal() The total of the prepayment(subtotal + total tax)
Double	getTotalTax() The total tax on the prepayment
Prepayment.TypeEnum	getType() See Prepayment Types
org.threeten.bp.OffsetDateTime	getUpdatedDateUTC() UTC timestamp of last update to the prepayment
int	hashCode()
Prepayment	lineAmountTypes(LineAmountTypes lineAmountTypes)
Prepayment	lineItems(List<LineItem> lineItems)
Prepayment	prepaymentID(UUID prepaymentID)
Prepayment	remainingCredit(Double remainingCredit)
void	setAllocations(List<Allocation> allocations)
void	setAppliedAmount(Double appliedAmount)
void	setAttachments(List<Attachment> attachments)
void	setContact(Contact contact)
void	setCurrencyCode(CurrencyCode currencyCode)
void	setCurrencyRate(Double currencyRate)
void	setDate(org.threeten.bp.LocalDate date)
void	setLineAmountTypes(LineAmountTypes lineAmountTypes)
void	setLineItems(List<LineItem> lineItems)
void	setPrepaymentID(UUID prepaymentID)
void	setRemainingCredit(Double remainingCredit)
void	setStatus(Prepayment.StatusEnum status)
void	setSubTotal(Double subTotal)
void	setTotal(Double total)
void	setTotalTax(Double totalTax)
void	setType(Prepayment.TypeEnum type)
Prepayment	status(Prepayment.StatusEnum status)
Prepayment	subTotal(Double subTotal)
String	toString()
Prepayment	total(Double total)
Prepayment	totalTax(Double totalTax)
Prepayment	type(Prepayment.TypeEnum type)

Methods inherited from class java.lang.Object

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

Constructor Detail

Prepayment

public Prepayment()

Method Detail

type

public Prepayment type(Prepayment.TypeEnum type)

getType

public Prepayment.TypeEnum getType()

See Prepayment Types

Returns:

type

setType

public void setType(Prepayment.TypeEnum type)

contact

public Prepayment contact(Contact contact)

getContact

public Contact getContact()

Get contact

Returns:

contact

setContact

public void setContact(Contact contact)

date

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

getDate

public org.threeten.bp.LocalDate getDate()

The date the prepayment is created YYYY-MM-DD

Returns:

date

setDate

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

status

public Prepayment status(Prepayment.StatusEnum status)

getStatus

public Prepayment.StatusEnum getStatus()

See Prepayment Status Codes

Returns:

status

setStatus

public void setStatus(Prepayment.StatusEnum status)

lineAmountTypes

public Prepayment lineAmountTypes(LineAmountTypes lineAmountTypes)

getLineAmountTypes

public LineAmountTypes getLineAmountTypes()

Get lineAmountTypes

Returns:

lineAmountTypes

setLineAmountTypes

public void setLineAmountTypes(LineAmountTypes lineAmountTypes)

lineItems

public Prepayment lineItems(List<LineItem> lineItems)

addLineItemsItem

public Prepayment addLineItemsItem(LineItem lineItemsItem)

getLineItems

public List<LineItem> getLineItems()

See Prepayment Line Items

Returns:

lineItems

setLineItems

public void setLineItems(List<LineItem> lineItems)

subTotal

public Prepayment subTotal(Double subTotal)

getSubTotal

public Double getSubTotal()

The subtotal of the prepayment excluding taxes

Returns:

subTotal

setSubTotal

public void setSubTotal(Double subTotal)

totalTax

public Prepayment totalTax(Double totalTax)

getTotalTax

public Double getTotalTax()

The total tax on the prepayment

Returns:

totalTax

setTotalTax

public void setTotalTax(Double totalTax)

total

public Prepayment total(Double total)

getTotal

public Double getTotal()

The total of the prepayment(subtotal + total tax)

Returns:

total

setTotal

public void setTotal(Double total)

getReference

public String getReference()

Returns Invoice number field. Reference field isn't available.

Returns:

reference

getUpdatedDateUTC

public org.threeten.bp.OffsetDateTime getUpdatedDateUTC()

UTC timestamp of last update to the prepayment

Returns:

updatedDateUTC

currencyCode

public Prepayment currencyCode(CurrencyCode currencyCode)

getCurrencyCode

public CurrencyCode getCurrencyCode()

Get currencyCode

Returns:

currencyCode

setCurrencyCode

public void setCurrencyCode(CurrencyCode currencyCode)

prepaymentID

public Prepayment prepaymentID(UUID prepaymentID)

getPrepaymentID

public UUID getPrepaymentID()

Xero generated unique identifier

Returns:

prepaymentID

setPrepaymentID

public void setPrepaymentID(UUID prepaymentID)

currencyRate

public Prepayment currencyRate(Double currencyRate)

getCurrencyRate

public Double getCurrencyRate()

The currency rate for a multicurrency prepayment. If no rate is specified, the XE.com day rate is used

Returns:

currencyRate

setCurrencyRate

public void setCurrencyRate(Double currencyRate)

remainingCredit

public Prepayment remainingCredit(Double remainingCredit)

getRemainingCredit

public Double getRemainingCredit()

The remaining credit balance on the prepayment

Returns:

remainingCredit

setRemainingCredit

public void setRemainingCredit(Double remainingCredit)

allocations

public Prepayment allocations(List<Allocation> allocations)

addAllocationsItem

public Prepayment addAllocationsItem(Allocation allocationsItem)

getAllocations

public List<Allocation> getAllocations()

See Allocations

Returns:

allocations

setAllocations

public void setAllocations(List<Allocation> allocations)

appliedAmount

public Prepayment appliedAmount(Double appliedAmount)

getAppliedAmount

public Double getAppliedAmount()

The amount of applied to an invoice

Returns:

appliedAmount

setAppliedAmount

public void setAppliedAmount(Double appliedAmount)

getHasAttachments

public Boolean getHasAttachments()

boolean to indicate if a prepayment has an attachment

Returns:

hasAttachments

attachments

public Prepayment attachments(List<Attachment> attachments)

addAttachmentsItem

public Prepayment addAttachmentsItem(Attachment attachmentsItem)

getAttachments

public List<Attachment> getAttachments()

See Attachments

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