com.xero.models.accounting

Class Account

java.lang.Object

com.xero.models.accounting.Account

public class Account
extends Object

Account

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Account.BankAccountTypeEnum For bank accounts only.
static class	Account.PropertyClassEnum See Account Class Types
static class	Account.StatusEnum Accounts with a status of ACTIVE can be updated to ARCHIVED.
static class	Account.SystemAccountEnum If this is a system account then this element is returned.
static class	Account.TypeEnum See Account Types

Constructor Summary

Constructors

Constructor and Description
Account()

Method Summary

Modifier and Type	Method and Description
Account	accountID(UUID accountID)
Account	bankAccountNumber(String bankAccountNumber)
Account	bankAccountType(Account.BankAccountTypeEnum bankAccountType)
Account	code(String code)
Account	currencyCode(CurrencyCode currencyCode)
Account	description(String description)
Account	enablePaymentsToAccount(Boolean enablePaymentsToAccount)
boolean	equals(Object o)
UUID	getAccountID() The Xero identifier for an account – specified as a string following the endpoint name e.g.
String	getBankAccountNumber() For bank accounts only (Account Type BANK)
Account.BankAccountTypeEnum	getBankAccountType() For bank accounts only.
String	getCode() Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)
CurrencyCode	getCurrencyCode() Get currencyCode
String	getDescription() Description of the Account.
Boolean	getEnablePaymentsToAccount() Boolean – describes whether account can have payments applied to it
Boolean	getHasAttachments() boolean to indicate if an account has an attachment (read only)
String	getName() Name of account (max length = 150)
Account.PropertyClassEnum	getPropertyClass() See Account Class Types
String	getReportingCode() Shown if set
String	getReportingCodeName() Shown if set
Boolean	getShowInExpenseClaims() Boolean – describes whether account code is available for use with expense claims
Account.StatusEnum	getStatus() Accounts with a status of ACTIVE can be updated to ARCHIVED.
Account.SystemAccountEnum	getSystemAccount() If this is a system account then this element is returned.
TaxType	getTaxType() Get taxType
Account.TypeEnum	getType() See Account Types
org.threeten.bp.OffsetDateTime	getUpdatedDateUTC() Last modified date UTC format
int	hashCode()
Account	name(String name)
void	setAccountID(UUID accountID)
void	setBankAccountNumber(String bankAccountNumber)
void	setBankAccountType(Account.BankAccountTypeEnum bankAccountType)
void	setCode(String code)
void	setCurrencyCode(CurrencyCode currencyCode)
void	setDescription(String description)
void	setEnablePaymentsToAccount(Boolean enablePaymentsToAccount)
void	setName(String name)
void	setShowInExpenseClaims(Boolean showInExpenseClaims)
void	setStatus(Account.StatusEnum status)
void	setTaxType(TaxType taxType)
void	setType(Account.TypeEnum type)
Account	showInExpenseClaims(Boolean showInExpenseClaims)
Account	status(Account.StatusEnum status)
Account	taxType(TaxType taxType)
String	toString()
Account	type(Account.TypeEnum type)

Methods inherited from class java.lang.Object

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

Constructor Detail

Account

public Account()

Method Detail

code

public Account code(String code)

getCode

public String getCode()

Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)

Returns:

code

setCode

public void setCode(String code)

name

public Account name(String name)

getName

public String getName()

Name of account (max length = 150)

Returns:

name

setName

public void setName(String name)

accountID

public Account accountID(UUID accountID)

getAccountID

public UUID getAccountID()

The Xero identifier for an account – specified as a string following the endpoint name e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9

Returns:

accountID

setAccountID

public void setAccountID(UUID accountID)

type

public Account type(Account.TypeEnum type)

getType

public Account.TypeEnum getType()

See Account Types

Returns:

type

setType

public void setType(Account.TypeEnum type)

bankAccountNumber

public Account bankAccountNumber(String bankAccountNumber)

getBankAccountNumber

public String getBankAccountNumber()

For bank accounts only (Account Type BANK)

Returns:

bankAccountNumber

setBankAccountNumber

public void setBankAccountNumber(String bankAccountNumber)

status

public Account status(Account.StatusEnum status)

getStatus

public Account.StatusEnum getStatus()

Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes

Returns:

status

setStatus

public void setStatus(Account.StatusEnum status)

description

public Account description(String description)

getDescription

public String getDescription()

Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)

Returns:

description

setDescription

public void setDescription(String description)

bankAccountType

public Account bankAccountType(Account.BankAccountTypeEnum bankAccountType)

getBankAccountType

public Account.BankAccountTypeEnum getBankAccountType()

For bank accounts only. See Bank Account types

Returns:

bankAccountType

setBankAccountType

public void setBankAccountType(Account.BankAccountTypeEnum bankAccountType)

currencyCode

public Account currencyCode(CurrencyCode currencyCode)

getCurrencyCode

public CurrencyCode getCurrencyCode()

Get currencyCode

Returns:

currencyCode

setCurrencyCode

public void setCurrencyCode(CurrencyCode currencyCode)

taxType

public Account taxType(TaxType taxType)

getTaxType

public TaxType getTaxType()

Get taxType

Returns:

taxType

setTaxType

public void setTaxType(TaxType taxType)

enablePaymentsToAccount

public Account enablePaymentsToAccount(Boolean enablePaymentsToAccount)

getEnablePaymentsToAccount

public Boolean getEnablePaymentsToAccount()

Boolean – describes whether account can have payments applied to it

Returns:

enablePaymentsToAccount

setEnablePaymentsToAccount

public void setEnablePaymentsToAccount(Boolean enablePaymentsToAccount)

showInExpenseClaims

public Account showInExpenseClaims(Boolean showInExpenseClaims)

getShowInExpenseClaims

public Boolean getShowInExpenseClaims()

Boolean – describes whether account code is available for use with expense claims

Returns:

showInExpenseClaims

setShowInExpenseClaims

public void setShowInExpenseClaims(Boolean showInExpenseClaims)

getPropertyClass

public Account.PropertyClassEnum getPropertyClass()

See Account Class Types

Returns:

propertyClass

getSystemAccount

public Account.SystemAccountEnum getSystemAccount()

If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null.

Returns:

systemAccount

getReportingCode

public String getReportingCode()

Shown if set

Returns:

reportingCode

getReportingCodeName

public String getReportingCodeName()

Shown if set

Returns:

reportingCodeName

getHasAttachments

public Boolean getHasAttachments()

boolean to indicate if an account has an attachment (read only)

Returns:

hasAttachments

getUpdatedDateUTC

public org.threeten.bp.OffsetDateTime getUpdatedDateUTC()

Last modified date UTC format

Returns:

updatedDateUTC

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