com.xero.models.accounting

Class Overpayment

java.lang.Object

com.xero.models.accounting.Overpayment

public class Overpayment
extends Object

Overpayment

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Overpayment()

Method Summary

Modifier and Type	Method and Description
Overpayment	addAllocationsItem(Allocation allocationsItem)
Overpayment	addLineItemsItem(LineItem lineItemsItem)
Overpayment	addPaymentsItem(Payment paymentsItem)
Overpayment	allocations(List<Allocation> allocations)
Overpayment	contact(Contact contact)
Overpayment	currencyCode(CurrencyCode currencyCode)
Overpayment	currencyRate(Float currencyRate)
Overpayment	date(org.threeten.bp.LocalDate date)
boolean	equals(Object o)
List<Allocation>	getAllocations() See Allocations
Contact	getContact() Get contact
CurrencyCode	getCurrencyCode() Get currencyCode
Float	getCurrencyRate() The currency rate for a multicurrency overpayment.
org.threeten.bp.LocalDate	getDate() The date the overpayment is created YYYY-MM-DD
Boolean	getHasAttachments() boolean to indicate if a overpayment has an attachment
LineAmountTypes	getLineAmountTypes() Get lineAmountTypes
List<LineItem>	getLineItems() See Overpayment Line Items
UUID	getOverpaymentID() Xero generated unique identifier
List<Payment>	getPayments() See Payments
String	getRemainingCredit() The remaining credit balance on the overpayment
Overpayment.StatusEnum	getStatus() See Overpayment Status Codes
Float	getSubTotal() The subtotal of the overpayment excluding taxes
Float	getTotal() The total of the overpayment (subtotal + total tax)
Float	getTotalTax() The total tax on the overpayment
Overpayment.TypeEnum	getType() See Overpayment Types
org.threeten.bp.OffsetDateTime	getUpdatedDateUTC() UTC timestamp of last update to the overpayment
Overpayment	hasAttachments(Boolean hasAttachments)
int	hashCode()
Overpayment	lineAmountTypes(LineAmountTypes lineAmountTypes)
Overpayment	lineItems(List<LineItem> lineItems)
Overpayment	overpaymentID(UUID overpaymentID)
Overpayment	payments(List<Payment> payments)
Overpayment	remainingCredit(String remainingCredit)
void	setAllocations(List<Allocation> allocations)
void	setContact(Contact contact)
void	setCurrencyCode(CurrencyCode currencyCode)
void	setCurrencyRate(Float currencyRate)
void	setDate(org.threeten.bp.LocalDate date)
void	setHasAttachments(Boolean hasAttachments)
void	setLineAmountTypes(LineAmountTypes lineAmountTypes)
void	setLineItems(List<LineItem> lineItems)
void	setOverpaymentID(UUID overpaymentID)
void	setPayments(List<Payment> payments)
void	setRemainingCredit(String remainingCredit)
void	setStatus(Overpayment.StatusEnum status)
void	setSubTotal(Float subTotal)
void	setTotal(Float total)
void	setTotalTax(Float totalTax)
void	setType(Overpayment.TypeEnum type)
void	setUpdatedDateUTC(org.threeten.bp.OffsetDateTime updatedDateUTC)
Overpayment	status(Overpayment.StatusEnum status)
Overpayment	subTotal(Float subTotal)
String	toString()
Overpayment	total(Float total)
Overpayment	totalTax(Float totalTax)
Overpayment	type(Overpayment.TypeEnum type)
Overpayment	updatedDateUTC(org.threeten.bp.OffsetDateTime updatedDateUTC)

Methods inherited from class java.lang.Object

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

Constructor Detail

Overpayment

public Overpayment()

Method Detail

type

public Overpayment type(Overpayment.TypeEnum type)

getType

public Overpayment.TypeEnum getType()

See Overpayment Types

Returns:

type

setType

public void setType(Overpayment.TypeEnum type)

contact

public Overpayment contact(Contact contact)

getContact

public Contact getContact()

Get contact

Returns:

contact

setContact

public void setContact(Contact contact)

date

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

getDate

public org.threeten.bp.LocalDate getDate()

The date the overpayment is created YYYY-MM-DD

Returns:

date

setDate

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

status

public Overpayment status(Overpayment.StatusEnum status)

getStatus

public Overpayment.StatusEnum getStatus()

See Overpayment Status Codes

Returns:

status

setStatus

public void setStatus(Overpayment.StatusEnum status)

lineAmountTypes

public Overpayment lineAmountTypes(LineAmountTypes lineAmountTypes)

getLineAmountTypes

public LineAmountTypes getLineAmountTypes()

Get lineAmountTypes

Returns:

lineAmountTypes

setLineAmountTypes

public void setLineAmountTypes(LineAmountTypes lineAmountTypes)

lineItems

public Overpayment lineItems(List<LineItem> lineItems)

addLineItemsItem

public Overpayment addLineItemsItem(LineItem lineItemsItem)

getLineItems

public List<LineItem> getLineItems()

See Overpayment Line Items

Returns:

lineItems

setLineItems

public void setLineItems(List<LineItem> lineItems)

subTotal

public Overpayment subTotal(Float subTotal)

getSubTotal

public Float getSubTotal()

The subtotal of the overpayment excluding taxes

Returns:

subTotal

setSubTotal

public void setSubTotal(Float subTotal)

totalTax

public Overpayment totalTax(Float totalTax)

getTotalTax

public Float getTotalTax()

The total tax on the overpayment

Returns:

totalTax

setTotalTax

public void setTotalTax(Float totalTax)

total

public Overpayment total(Float total)

getTotal

public Float getTotal()

The total of the overpayment (subtotal + total tax)

Returns:

total

setTotal

public void setTotal(Float total)

updatedDateUTC

public Overpayment updatedDateUTC(org.threeten.bp.OffsetDateTime updatedDateUTC)

getUpdatedDateUTC

public org.threeten.bp.OffsetDateTime getUpdatedDateUTC()

UTC timestamp of last update to the overpayment

Returns:

updatedDateUTC

setUpdatedDateUTC

public void setUpdatedDateUTC(org.threeten.bp.OffsetDateTime updatedDateUTC)

currencyCode

public Overpayment currencyCode(CurrencyCode currencyCode)

getCurrencyCode

public CurrencyCode getCurrencyCode()

Get currencyCode

Returns:

currencyCode

setCurrencyCode

public void setCurrencyCode(CurrencyCode currencyCode)

overpaymentID

public Overpayment overpaymentID(UUID overpaymentID)

getOverpaymentID

public UUID getOverpaymentID()

Xero generated unique identifier

Returns:

overpaymentID

setOverpaymentID

public void setOverpaymentID(UUID overpaymentID)

currencyRate

public Overpayment currencyRate(Float currencyRate)

getCurrencyRate

public Float getCurrencyRate()

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

Returns:

currencyRate

setCurrencyRate

public void setCurrencyRate(Float currencyRate)

remainingCredit

public Overpayment remainingCredit(String remainingCredit)

getRemainingCredit

public String getRemainingCredit()

The remaining credit balance on the overpayment

Returns:

remainingCredit

setRemainingCredit

public void setRemainingCredit(String remainingCredit)

allocations

public Overpayment allocations(List<Allocation> allocations)

addAllocationsItem

public Overpayment addAllocationsItem(Allocation allocationsItem)

getAllocations

public List<Allocation> getAllocations()

See Allocations

Returns:

allocations

setAllocations

public void setAllocations(List<Allocation> allocations)

payments

public Overpayment payments(List<Payment> payments)

addPaymentsItem

public Overpayment addPaymentsItem(Payment paymentsItem)

getPayments

public List<Payment> getPayments()

See Payments

Returns:

payments

setPayments

public void setPayments(List<Payment> payments)

hasAttachments

public Overpayment hasAttachments(Boolean hasAttachments)

getHasAttachments

public Boolean getHasAttachments()

boolean to indicate if a overpayment has an attachment

Returns:

hasAttachments

setHasAttachments

public void setHasAttachments(Boolean hasAttachments)

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