Package com.xero.models.accounting
Class Account
java.lang.Object
com.xero.models.accounting.Account
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumFor bank accounts only.static enumSee Account Class Typesstatic enumAccounts with a status of ACTIVE can be updated to ARCHIVED.static enumIf this is a system account then this element is returned. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThe Xero identifier for an account – specified as a string following the endpoint name e.g.addToWatchlist(Boolean addToWatchlist) Boolean – describes whether the account is shown in the watchlist widget on the dashboardaddValidationErrorsItem(ValidationError validationErrorsItem) Displays array of validation error messages from the APIbankAccountNumber(String bankAccountNumber) For bank accounts only (Account Type BANK)bankAccountType(Account.BankAccountTypeEnum bankAccountType) For bank accounts only.Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)currencyCode(CurrencyCode currencyCode) currencyCodedescription(String description) Description of the Account.enablePaymentsToAccount(Boolean enablePaymentsToAccount) Boolean – describes whether account can have payments applied to itbooleanThe Xero identifier for an account – specified as a string following the endpoint name e.g.Boolean – describes whether the account is shown in the watchlist widget on the dashboardFor bank accounts only (Account Type BANK)For bank accounts only.getCode()Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)Get currencyCodeDescription of the Account.Boolean – describes whether account can have payments applied to itboolean to indicate if an account has an attachment (read only)getName()Name of account (max length = 150)See Account Class TypesShown if setShown if setBoolean – describes whether account code is available for use with expense claimsAccounts with a status of ACTIVE can be updated to ARCHIVED.If this is a system account then this element is returned.The tax type from taxRatesgetType()Get typeLast modified date UTC formatorg.threeten.bp.OffsetDateTimeLast modified date UTC formatDisplays array of validation error messages from the APIinthashCode()Name of account (max length = 150)reportingCode(String reportingCode) Shown if setvoidsetAccountID(UUID accountID) The Xero identifier for an account – specified as a string following the endpoint name e.g.voidsetAddToWatchlist(Boolean addToWatchlist) Boolean – describes whether the account is shown in the watchlist widget on the dashboardvoidsetBankAccountNumber(String bankAccountNumber) For bank accounts only (Account Type BANK)voidsetBankAccountType(Account.BankAccountTypeEnum bankAccountType) For bank accounts only.voidCustomer defined alpha numeric account code e.g 200 or SALES (max length = 10)voidsetCurrencyCode(CurrencyCode currencyCode) currencyCodevoidsetDescription(String description) Description of the Account.voidsetEnablePaymentsToAccount(Boolean enablePaymentsToAccount) Boolean – describes whether account can have payments applied to itvoidName of account (max length = 150)voidsetReportingCode(String reportingCode) Shown if setvoidsetShowInExpenseClaims(Boolean showInExpenseClaims) Boolean – describes whether account code is available for use with expense claimsvoidsetStatus(Account.StatusEnum status) Accounts with a status of ACTIVE can be updated to ARCHIVED.voidsetTaxType(String taxType) The tax type from taxRatesvoidsetType(AccountType type) typevoidsetValidationErrors(List<ValidationError> validationErrors) Displays array of validation error messages from the APIshowInExpenseClaims(Boolean showInExpenseClaims) Boolean – describes whether account code is available for use with expense claimsstatus(Account.StatusEnum status) Accounts with a status of ACTIVE can be updated to ARCHIVED.The tax type from taxRatestoString()type(AccountType type) typevalidationErrors(List<ValidationError> validationErrors) Displays array of validation error messages from the API
-
Constructor Details
-
Account
public Account()
-
-
Method Details
-
code
-
getCode
Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)- Returns:
- code
-
setCode
Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)- Parameters:
code- String
-
name
-
getName
-
setName
-
accountID
-
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
The Xero identifier for an account – specified as a string following the endpoint name e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9- Parameters:
accountID- UUID
-
type
-
getType
-
setType
-
bankAccountNumber
-
getBankAccountNumber
For bank accounts only (Account Type BANK)- Returns:
- bankAccountNumber
-
setBankAccountNumber
For bank accounts only (Account Type BANK)- Parameters:
bankAccountNumber- String
-
status
Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes- Parameters:
status- StatusEnum- Returns:
- Account
-
getStatus
Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes- Returns:
- status
-
setStatus
Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes- Parameters:
status- StatusEnum
-
description
-
getDescription
Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)- Returns:
- description
-
setDescription
Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)- Parameters:
description- String
-
bankAccountType
For bank accounts only. See Bank Account types- Parameters:
bankAccountType- BankAccountTypeEnum- Returns:
- Account
-
getBankAccountType
For bank accounts only. See Bank Account types- Returns:
- bankAccountType
-
setBankAccountType
For bank accounts only. See Bank Account types- Parameters:
bankAccountType- BankAccountTypeEnum
-
currencyCode
currencyCode- Parameters:
currencyCode- CurrencyCode- Returns:
- Account
-
getCurrencyCode
-
setCurrencyCode
currencyCode- Parameters:
currencyCode- CurrencyCode
-
taxType
-
getTaxType
-
setTaxType
-
enablePaymentsToAccount
-
getEnablePaymentsToAccount
Boolean – describes whether account can have payments applied to it- Returns:
- enablePaymentsToAccount
-
setEnablePaymentsToAccount
Boolean – describes whether account can have payments applied to it- Parameters:
enablePaymentsToAccount- Boolean
-
showInExpenseClaims
-
getShowInExpenseClaims
Boolean – describes whether account code is available for use with expense claims- Returns:
- showInExpenseClaims
-
setShowInExpenseClaims
Boolean – describes whether account code is available for use with expense claims- Parameters:
showInExpenseClaims- Boolean
-
getPropertyClass
-
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
-
reportingCode
-
getReportingCode
-
setReportingCode
-
getReportingCodeName
-
getHasAttachments
boolean to indicate if an account has an attachment (read only)- Returns:
- hasAttachments
-
getUpdatedDateUTC
-
getUpdatedDateUTCAsDate
public org.threeten.bp.OffsetDateTime getUpdatedDateUTCAsDate()Last modified date UTC format- Returns:
- OffsetDateTime
-
addToWatchlist
-
getAddToWatchlist
Boolean – describes whether the account is shown in the watchlist widget on the dashboard- Returns:
- addToWatchlist
-
setAddToWatchlist
Boolean – describes whether the account is shown in the watchlist widget on the dashboard- Parameters:
addToWatchlist- Boolean
-
validationErrors
Displays array of validation error messages from the API- Parameters:
validationErrors- List<ValidationError>- Returns:
- Account
-
addValidationErrorsItem
Displays array of validation error messages from the API- Parameters:
validationErrorsItem- ValidationError- Returns:
- Account
-
getValidationErrors
Displays array of validation error messages from the API- Returns:
- validationErrors
-
setValidationErrors
Displays array of validation error messages from the API- Parameters:
validationErrors- List<ValidationError>
-
equals
-
hashCode
-
toString
-