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	addPaymentsItem(Payment paymentsItem)
CreditNote	addValidationErrorsItem(ValidationError validationErrorsItem)
CreditNote	allocations(List<Allocation> allocations)
CreditNote	appliedAmount(Double appliedAmount)
CreditNote	brandingThemeID(UUID brandingThemeID)
CreditNote	contact(Contact contact)
CreditNote	creditNoteID(UUID creditNoteID)
CreditNote	creditNoteNumber(String creditNoteNumber)
CreditNote	currencyCode(CurrencyCode currencyCode)
CreditNote	currencyRate(Double currencyRate)
CreditNote	date(String date)
boolean	equals(Object o)
CreditNote	fullyPaidOnDate(String fullyPaidOnDate)
List<Allocation>	getAllocations() See Allocations
Double	getAppliedAmount() The amount of applied to an invoice
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
Double	getCurrencyRate() The currency rate for a multicurrency invoice.
String	getDate() The date the credit note is issued YYYY-MM-DD.
org.threeten.bp.LocalDate	getDateAsDate()
String	getFullyPaidOnDate() Date when credit note was fully paid(UTC format)
org.threeten.bp.LocalDate	getFullyPaidOnDateAsDate()
Boolean	getHasAttachments() boolean to indicate if a credit note has an attachment
Boolean	getHasErrors() A boolean to indicate if a credit note has an validation errors
LineAmountTypes	getLineAmountTypes() Get lineAmountTypes
List<LineItem>	getLineItems() See Invoice Line Items
List<Payment>	getPayments() See Payments
String	getReference() ACCRECCREDIT only – additional reference number
Double	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
String	getStatusAttributeString() A string to indicate if a invoice status
Double	getSubTotal() The subtotal of the credit note excluding taxes
Double	getTotal() The total of the Credit Note(subtotal + total tax)
Double	getTotalTax() The total tax on the credit note
CreditNote.TypeEnum	getType() See Credit Note Types
String	getUpdatedDateUTC() UTC timestamp of last update to the credit note
org.threeten.bp.OffsetDateTime	getUpdatedDateUTCAsDate()
List<ValidationError>	getValidationErrors() Displays array of validation error messages from the API
CreditNote	hasAttachments(Boolean hasAttachments)
CreditNote	hasErrors(Boolean hasErrors)
int	hashCode()
CreditNote	lineAmountTypes(LineAmountTypes lineAmountTypes)
CreditNote	lineItems(List<LineItem> lineItems)
CreditNote	payments(List<Payment> payments)
CreditNote	reference(String reference)
CreditNote	remainingCredit(Double remainingCredit)
void	setAllocations(List<Allocation> allocations)
void	setAppliedAmount(Double appliedAmount)
void	setBrandingThemeID(UUID brandingThemeID)
void	setContact(Contact contact)
void	setCreditNoteID(UUID creditNoteID)
void	setCreditNoteNumber(String creditNoteNumber)
void	setCurrencyCode(CurrencyCode currencyCode)
void	setCurrencyRate(Double currencyRate)
void	setDate(org.threeten.bp.LocalDate date)
void	setDate(String date)
void	setFullyPaidOnDate(org.threeten.bp.LocalDate fullyPaidOnDate)
void	setFullyPaidOnDate(String fullyPaidOnDate)
void	setHasAttachments(Boolean hasAttachments)
void	setHasErrors(Boolean hasErrors)
void	setLineAmountTypes(LineAmountTypes lineAmountTypes)
void	setLineItems(List<LineItem> lineItems)
void	setPayments(List<Payment> payments)
void	setReference(String reference)
void	setRemainingCredit(Double remainingCredit)
void	setStatus(CreditNote.StatusEnum status)
void	setStatusAttributeString(String statusAttributeString)
void	setSubTotal(Double subTotal)
void	setTotal(Double total)
void	setTotalTax(Double totalTax)
void	setType(CreditNote.TypeEnum type)
void	setValidationErrors(List<ValidationError> validationErrors)
CreditNote	status(CreditNote.StatusEnum status)
CreditNote	statusAttributeString(String statusAttributeString)
CreditNote	subTotal(Double subTotal)
String	toString()
CreditNote	total(Double total)
CreditNote	totalTax(Double totalTax)
CreditNote	type(CreditNote.TypeEnum type)
CreditNote	validationErrors(List<ValidationError> validationErrors)

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

getDateAsDate

public org.threeten.bp.LocalDate getDateAsDate()

setDate

public void setDate(String date)

setDate

public void setDate(org.threeten.bp.LocalDate 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(Double subTotal)

getSubTotal

public Double getSubTotal()

The subtotal of the credit note excluding taxes

Returns:

subTotal

setSubTotal

public void setSubTotal(Double subTotal)

totalTax

public CreditNote totalTax(Double totalTax)

getTotalTax

public Double getTotalTax()

The total tax on the credit note

Returns:

totalTax

setTotalTax

public void setTotalTax(Double totalTax)

total

public CreditNote total(Double total)

getTotal

public Double getTotal()

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

Returns:

total

setTotal

public void setTotal(Double total)

getUpdatedDateUTC

public String getUpdatedDateUTC()

UTC timestamp of last update to the credit note

Returns:

updatedDateUTC

getUpdatedDateUTCAsDate

public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()

currencyCode

public CreditNote currencyCode(CurrencyCode currencyCode)

getCurrencyCode

public CurrencyCode getCurrencyCode()

Get currencyCode

Returns:

currencyCode

setCurrencyCode

public void setCurrencyCode(CurrencyCode currencyCode)

fullyPaidOnDate

public CreditNote fullyPaidOnDate(String fullyPaidOnDate)

getFullyPaidOnDate

public String getFullyPaidOnDate()

Date when credit note was fully paid(UTC format)

Returns:

fullyPaidOnDate

getFullyPaidOnDateAsDate

public org.threeten.bp.LocalDate getFullyPaidOnDateAsDate()

setFullyPaidOnDate

public void setFullyPaidOnDate(String 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(Double currencyRate)

getCurrencyRate

public Double 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(Double currencyRate)

remainingCredit

public CreditNote remainingCredit(Double remainingCredit)

getRemainingCredit

public Double getRemainingCredit()

The remaining credit balance on the Credit Note

Returns:

remainingCredit

setRemainingCredit

public void setRemainingCredit(Double 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)

appliedAmount

public CreditNote appliedAmount(Double appliedAmount)

getAppliedAmount

public Double getAppliedAmount()

The amount of applied to an invoice

Returns:

appliedAmount

setAppliedAmount

public void setAppliedAmount(Double appliedAmount)

payments

public CreditNote payments(List<Payment> payments)

addPaymentsItem

public CreditNote addPaymentsItem(Payment paymentsItem)

getPayments

public List<Payment> getPayments()

See Payments

Returns:

payments

setPayments

public void setPayments(List<Payment> payments)

brandingThemeID

public CreditNote brandingThemeID(UUID brandingThemeID)

getBrandingThemeID

public UUID getBrandingThemeID()

See BrandingThemes

Returns:

brandingThemeID

setBrandingThemeID

public void setBrandingThemeID(UUID brandingThemeID)

statusAttributeString

public CreditNote statusAttributeString(String statusAttributeString)

getStatusAttributeString

public String getStatusAttributeString()

A string to indicate if a invoice status

Returns:

statusAttributeString

setStatusAttributeString

public void setStatusAttributeString(String statusAttributeString)

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)

hasErrors

public CreditNote hasErrors(Boolean hasErrors)

getHasErrors

public Boolean getHasErrors()

A boolean to indicate if a credit note has an validation errors

Returns:

hasErrors

setHasErrors

public void setHasErrors(Boolean hasErrors)

validationErrors

public CreditNote validationErrors(List<ValidationError> validationErrors)

addValidationErrorsItem

public CreditNote addValidationErrorsItem(ValidationError validationErrorsItem)

getValidationErrors

public List<ValidationError> getValidationErrors()

Displays array of validation error messages from the API

Returns:

validationErrors

setValidationErrors

public void setValidationErrors(List<ValidationError> validationErrors)

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