com.xero.models.accounting

Class CreditNote

java.lang.Object

com.xero.models.accounting.CreditNote

public class CreditNote
extends Object

CreditNote

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreditNote.StatusEnum See Credit Note Status Codes
static class	CreditNote.TypeEnum See Credit Note Types

Constructor Summary

Constructors

Constructor and Description
CreditNote()

Method Summary

Modifier and Type	Method and Description
CreditNote	addAllocationsItem(Allocation allocationsItem)
CreditNote	addLineItemsItem(LineItem lineItemsItem)
CreditNote	allocations(List<Allocation> allocations)
CreditNote	brandingThemeID(UUID brandingThemeID)
CreditNote	contact(Contact contact)
CreditNote	creditNoteID(UUID creditNoteID)
CreditNote	creditNoteNumber(String creditNoteNumber)
CreditNote	currencyCode(CurrencyCode currencyCode)
CreditNote	currencyRate(Float currencyRate)
CreditNote	date(String date)
boolean	equals(Object o)
CreditNote	fullyPaidOnDate(org.threeten.bp.LocalDate fullyPaidOnDate)
List<Allocation>	getAllocations() See Allocations
UUID	getBrandingThemeID() See BrandingThemes
Contact	getContact() Get contact
UUID	getCreditNoteID() Xero generated unique identifier
String	getCreditNoteNumber() ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings)
CurrencyCode	getCurrencyCode() Get currencyCode
Float	getCurrencyRate() The currency rate for a multicurrency invoice.
String	getDate() The date the credit note is issued YYYY-MM-DD.
org.threeten.bp.LocalDate	getFullyPaidOnDate() Date when credit note was fully paid(UTC format)
Boolean	getHasAttachments() boolean to indicate if a credit note has an attachment
LineAmountTypes	getLineAmountTypes() Get lineAmountTypes
List<LineItem>	getLineItems() See Invoice Line Items
String	getReference() ACCRECCREDIT only – additional reference number
Float	getRemainingCredit() The remaining credit balance on the Credit Note
Boolean	getSentToContact() boolean to indicate if a credit note has been sent to a contact via the Xero app (currently read only)
CreditNote.StatusEnum	getStatus() See Credit Note Status Codes
Float	getSubTotal() The subtotal of the credit note excluding taxes
Float	getTotal() The total of the Credit Note(subtotal + total tax)
Float	getTotalTax() The total tax on the credit note
CreditNote.TypeEnum	getType() See Credit Note Types
org.threeten.bp.OffsetDateTime	getUpdatedDateUTC() UTC timestamp of last update to the credit note
CreditNote	hasAttachments(Boolean hasAttachments)
int	hashCode()
CreditNote	lineAmountTypes(LineAmountTypes lineAmountTypes)
CreditNote	lineItems(List<LineItem> lineItems)
CreditNote	reference(String reference)
CreditNote	remainingCredit(Float remainingCredit)
void	setAllocations(List<Allocation> allocations)
void	setBrandingThemeID(UUID brandingThemeID)
void	setContact(Contact contact)
void	setCreditNoteID(UUID creditNoteID)
void	setCreditNoteNumber(String creditNoteNumber)
void	setCurrencyCode(CurrencyCode currencyCode)
void	setCurrencyRate(Float currencyRate)
void	setDate(String date)
void	setFullyPaidOnDate(org.threeten.bp.LocalDate fullyPaidOnDate)
void	setHasAttachments(Boolean hasAttachments)
void	setLineAmountTypes(LineAmountTypes lineAmountTypes)
void	setLineItems(List<LineItem> lineItems)
void	setReference(String reference)
void	setRemainingCredit(Float remainingCredit)
void	setStatus(CreditNote.StatusEnum status)
void	setSubTotal(Float subTotal)
void	setTotal(Float total)
void	setTotalTax(Float totalTax)
void	setType(CreditNote.TypeEnum type)
void	setUpdatedDateUTC(org.threeten.bp.OffsetDateTime updatedDateUTC)
CreditNote	status(CreditNote.StatusEnum status)
CreditNote	subTotal(Float subTotal)
String	toString()
CreditNote	total(Float total)
CreditNote	totalTax(Float totalTax)
CreditNote	type(CreditNote.TypeEnum type)
CreditNote	updatedDateUTC(org.threeten.bp.OffsetDateTime updatedDateUTC)

Methods inherited from class java.lang.Object

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

Constructor Detail

CreditNote

public CreditNote()

Method Detail

type

public CreditNote type(CreditNote.TypeEnum type)

getType

public CreditNote.TypeEnum getType()

See Credit Note Types

Returns:

type

setType

public void setType(CreditNote.TypeEnum type)

contact

public CreditNote contact(Contact contact)

getContact

public Contact getContact()

Get contact

Returns:

contact

setContact

public void setContact(Contact contact)

date

public CreditNote date(String date)

getDate

public String getDate()

The date the credit note is issued YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation

Returns:

date

setDate

public void setDate(String date)

status

public CreditNote status(CreditNote.StatusEnum status)

getStatus

public CreditNote.StatusEnum getStatus()

See Credit Note Status Codes

Returns:

status

setStatus

public void setStatus(CreditNote.StatusEnum status)

lineAmountTypes

public CreditNote lineAmountTypes(LineAmountTypes lineAmountTypes)

getLineAmountTypes

public LineAmountTypes getLineAmountTypes()

Get lineAmountTypes

Returns:

lineAmountTypes

setLineAmountTypes

public void setLineAmountTypes(LineAmountTypes lineAmountTypes)

lineItems

public CreditNote lineItems(List<LineItem> lineItems)

addLineItemsItem

public CreditNote addLineItemsItem(LineItem lineItemsItem)

getLineItems

public List<LineItem> getLineItems()

See Invoice Line Items

Returns:

lineItems

setLineItems

public void setLineItems(List<LineItem> lineItems)

subTotal

public CreditNote subTotal(Float subTotal)

getSubTotal

public Float getSubTotal()

The subtotal of the credit note excluding taxes

Returns:

subTotal

setSubTotal

public void setSubTotal(Float subTotal)

totalTax

public CreditNote totalTax(Float totalTax)

getTotalTax

public Float getTotalTax()

The total tax on the credit note

Returns:

totalTax

setTotalTax

public void setTotalTax(Float totalTax)

total

public CreditNote total(Float total)

getTotal

public Float getTotal()

The total of the Credit Note(subtotal + total tax)

Returns:

total

setTotal

public void setTotal(Float total)

updatedDateUTC

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

getUpdatedDateUTC

public org.threeten.bp.OffsetDateTime getUpdatedDateUTC()

UTC timestamp of last update to the credit note

Returns:

updatedDateUTC

setUpdatedDateUTC

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

currencyCode

public CreditNote currencyCode(CurrencyCode currencyCode)

getCurrencyCode

public CurrencyCode getCurrencyCode()

Get currencyCode

Returns:

currencyCode

setCurrencyCode

public void setCurrencyCode(CurrencyCode currencyCode)

fullyPaidOnDate

public CreditNote fullyPaidOnDate(org.threeten.bp.LocalDate fullyPaidOnDate)

getFullyPaidOnDate

public org.threeten.bp.LocalDate getFullyPaidOnDate()

Date when credit note was fully paid(UTC format)

Returns:

fullyPaidOnDate

setFullyPaidOnDate

public void setFullyPaidOnDate(org.threeten.bp.LocalDate fullyPaidOnDate)

creditNoteID

public CreditNote creditNoteID(UUID creditNoteID)

getCreditNoteID

public UUID getCreditNoteID()

Xero generated unique identifier

Returns:

creditNoteID

setCreditNoteID

public void setCreditNoteID(UUID creditNoteID)

creditNoteNumber

public CreditNote creditNoteNumber(String creditNoteNumber)

getCreditNoteNumber

public String getCreditNoteNumber()

ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings)

Returns:

creditNoteNumber

setCreditNoteNumber

public void setCreditNoteNumber(String creditNoteNumber)

reference

public CreditNote reference(String reference)

getReference

public String getReference()

ACCRECCREDIT only – additional reference number

Returns:

reference

setReference

public void setReference(String reference)

getSentToContact

public Boolean getSentToContact()

boolean to indicate if a credit note has been sent to a contact via the Xero app (currently read only)

Returns:

sentToContact

currencyRate

public CreditNote 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

Returns:

currencyRate

setCurrencyRate

public void setCurrencyRate(Float currencyRate)

remainingCredit

public CreditNote remainingCredit(Float remainingCredit)

getRemainingCredit

public Float getRemainingCredit()

The remaining credit balance on the Credit Note

Returns:

remainingCredit

setRemainingCredit

public void setRemainingCredit(Float remainingCredit)

allocations

public CreditNote allocations(List<Allocation> allocations)

addAllocationsItem

public CreditNote addAllocationsItem(Allocation allocationsItem)

getAllocations

public List<Allocation> getAllocations()

See Allocations

Returns:

allocations

setAllocations

public void setAllocations(List<Allocation> allocations)

brandingThemeID

public CreditNote brandingThemeID(UUID brandingThemeID)

getBrandingThemeID

public UUID getBrandingThemeID()

See BrandingThemes

Returns:

brandingThemeID

setBrandingThemeID

public void setBrandingThemeID(UUID brandingThemeID)

hasAttachments

public CreditNote hasAttachments(Boolean hasAttachments)

getHasAttachments

public Boolean getHasAttachments()

boolean to indicate if a credit note 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