com.xero.models.accounting

Class Payment

java.lang.Object

com.xero.models.accounting.Payment

public class Payment
extends Object

Payment

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Payment.PaymentTypeEnum See Payment Types.
static class	Payment.StatusEnum The status of the payment.

Constructor Summary

Constructors

Constructor and Description
Payment()

Method Summary

Modifier and Type	Method and Description
Payment	account(Account account)
Payment	addValidationErrorsItem(ValidationError validationErrorsItem)
Payment	amount(Double amount)
Payment	bankAccountNumber(String bankAccountNumber)
Payment	code(String code)
Payment	creditNote(CreditNote creditNote)
Payment	creditNoteNumber(String creditNoteNumber)
Payment	currencyRate(Double currencyRate)
Payment	date(org.threeten.bp.LocalDate date)
Payment	details(String details)
boolean	equals(Object o)
Account	getAccount() Get account
Double	getAmount() The amount of the payment.
String	getBankAccountNumber() The suppliers bank account number the payment is being made to
String	getCode() Code of account you are using to make the payment e.g.
CreditNote	getCreditNote() Get creditNote
String	getCreditNoteNumber() Number of invoice or credit note you are applying payment to e.g.
Double	getCurrencyRate() Exchange rate when payment is received.
org.threeten.bp.LocalDate	getDate() Date the payment is being made (YYYY-MM-DD) e.g.
String	getDetails() The information to appear on the supplier's bank account
Boolean	getHasAccount() A boolean to indicate if a contact has an validation errors
Boolean	getHasValidationErrors() A boolean to indicate if a contact has an validation errors
Invoice	getInvoice() Get invoice
String	getInvoiceNumber() Number of invoice or credit note you are applying payment to e.g.INV-4003
Boolean	getIsReconciled() An optional parameter for the payment.
Overpayment	getOverpayment() Get overpayment
String	getParticulars() The suppliers bank account number the payment is being made to
UUID	getPaymentID() The Xero identifier for an Payment e.g.
Payment.PaymentTypeEnum	getPaymentType() See Payment Types.
Prepayment	getPrepayment() Get prepayment
String	getReference() An optional description for the payment e.g.
Payment.StatusEnum	getStatus() The status of the payment.
org.threeten.bp.OffsetDateTime	getUpdatedDateUTC() UTC timestamp of last update to the payment
List<ValidationError>	getValidationErrors() Displays array of validation error messages from the API
Payment	hasAccount(Boolean hasAccount)
int	hashCode()
Payment	hasValidationErrors(Boolean hasValidationErrors)
Payment	invoice(Invoice invoice)
Payment	invoiceNumber(String invoiceNumber)
Payment	isReconciled(Boolean isReconciled)
Payment	overpayment(Overpayment overpayment)
Payment	particulars(String particulars)
Payment	paymentID(UUID paymentID)
Payment	prepayment(Prepayment prepayment)
Payment	reference(String reference)
void	setAccount(Account account)
void	setAmount(Double amount)
void	setBankAccountNumber(String bankAccountNumber)
void	setCode(String code)
void	setCreditNote(CreditNote creditNote)
void	setCreditNoteNumber(String creditNoteNumber)
void	setCurrencyRate(Double currencyRate)
void	setDate(org.threeten.bp.LocalDate date)
void	setDetails(String details)
void	setHasAccount(Boolean hasAccount)
void	setHasValidationErrors(Boolean hasValidationErrors)
void	setInvoice(Invoice invoice)
void	setInvoiceNumber(String invoiceNumber)
void	setIsReconciled(Boolean isReconciled)
void	setOverpayment(Overpayment overpayment)
void	setParticulars(String particulars)
void	setPaymentID(UUID paymentID)
void	setPrepayment(Prepayment prepayment)
void	setReference(String reference)
void	setStatus(Payment.StatusEnum status)
void	setValidationErrors(List<ValidationError> validationErrors)
Payment	status(Payment.StatusEnum status)
String	toString()
Payment	validationErrors(List<ValidationError> validationErrors)

Methods inherited from class java.lang.Object

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

Constructor Detail

Payment

public Payment()

Method Detail

invoice

public Payment invoice(Invoice invoice)

getInvoice

public Invoice getInvoice()

Get invoice

Returns:

invoice

setInvoice

public void setInvoice(Invoice invoice)

creditNote

public Payment creditNote(CreditNote creditNote)

getCreditNote

public CreditNote getCreditNote()

Get creditNote

Returns:

creditNote

setCreditNote

public void setCreditNote(CreditNote creditNote)

prepayment

public Payment prepayment(Prepayment prepayment)

getPrepayment

public Prepayment getPrepayment()

Get prepayment

Returns:

prepayment

setPrepayment

public void setPrepayment(Prepayment prepayment)

overpayment

public Payment overpayment(Overpayment overpayment)

getOverpayment

public Overpayment getOverpayment()

Get overpayment

Returns:

overpayment

setOverpayment

public void setOverpayment(Overpayment overpayment)

invoiceNumber

public Payment invoiceNumber(String invoiceNumber)

getInvoiceNumber

public String getInvoiceNumber()

Number of invoice or credit note you are applying payment to e.g.INV-4003

Returns:

invoiceNumber

setInvoiceNumber

public void setInvoiceNumber(String invoiceNumber)

creditNoteNumber

public Payment creditNoteNumber(String creditNoteNumber)

getCreditNoteNumber

public String getCreditNoteNumber()

Number of invoice or credit note you are applying payment to e.g. INV-4003

Returns:

creditNoteNumber

setCreditNoteNumber

public void setCreditNoteNumber(String creditNoteNumber)

account

public Payment account(Account account)

getAccount

public Account getAccount()

Get account

Returns:

account

setAccount

public void setAccount(Account account)

code

public Payment code(String code)

getCode

public String getCode()

Code of account you are using to make the payment e.g. 001 (note- not all accounts have a code value)

Returns:

code

setCode

public void setCode(String code)

date

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

getDate

public org.threeten.bp.LocalDate getDate()

Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06

Returns:

date

setDate

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

currencyRate

public Payment currencyRate(Double currencyRate)

getCurrencyRate

public Double getCurrencyRate()

Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500

Returns:

currencyRate

setCurrencyRate

public void setCurrencyRate(Double currencyRate)

amount

public Payment amount(Double amount)

getAmount

public Double getAmount()

The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00

Returns:

amount

setAmount

public void setAmount(Double amount)

reference

public Payment reference(String reference)

getReference

public String getReference()

An optional description for the payment e.g. Direct Debit

Returns:

reference

setReference

public void setReference(String reference)

isReconciled

public Payment isReconciled(Boolean isReconciled)

getIsReconciled

public Boolean getIsReconciled()

An optional parameter for the payment. A boolean indicating whether you would like the payment to be created as reconciled when using PUT, or whether a payment has been reconciled when using GET

Returns:

isReconciled

setIsReconciled

public void setIsReconciled(Boolean isReconciled)

status

public Payment status(Payment.StatusEnum status)

getStatus

public Payment.StatusEnum getStatus()

The status of the payment.

Returns:

status

setStatus

public void setStatus(Payment.StatusEnum status)

getPaymentType

public Payment.PaymentTypeEnum getPaymentType()

See Payment Types.

Returns:

paymentType

getUpdatedDateUTC

public org.threeten.bp.OffsetDateTime getUpdatedDateUTC()

UTC timestamp of last update to the payment

Returns:

updatedDateUTC

paymentID

public Payment paymentID(UUID paymentID)

getPaymentID

public UUID getPaymentID()

The Xero identifier for an Payment e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9

Returns:

paymentID

setPaymentID

public void setPaymentID(UUID paymentID)

bankAccountNumber

public Payment bankAccountNumber(String bankAccountNumber)

getBankAccountNumber

public String getBankAccountNumber()

The suppliers bank account number the payment is being made to

Returns:

bankAccountNumber

setBankAccountNumber

public void setBankAccountNumber(String bankAccountNumber)

particulars

public Payment particulars(String particulars)

getParticulars

public String getParticulars()

The suppliers bank account number the payment is being made to

Returns:

particulars

setParticulars

public void setParticulars(String particulars)

details

public Payment details(String details)

getDetails

public String getDetails()

The information to appear on the supplier's bank account

Returns:

details

setDetails

public void setDetails(String details)

hasAccount

public Payment hasAccount(Boolean hasAccount)

getHasAccount

public Boolean getHasAccount()

A boolean to indicate if a contact has an validation errors

Returns:

hasAccount

setHasAccount

public void setHasAccount(Boolean hasAccount)

hasValidationErrors

public Payment hasValidationErrors(Boolean hasValidationErrors)

getHasValidationErrors

public Boolean getHasValidationErrors()

A boolean to indicate if a contact has an validation errors

Returns:

hasValidationErrors

setHasValidationErrors

public void setHasValidationErrors(Boolean hasValidationErrors)

validationErrors

public Payment validationErrors(List<ValidationError> validationErrors)

addValidationErrorsItem

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