Account (finapi-adapter 3.0.28 API)

java.lang.Object
- io.swagger.client.model.Account

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2018-05-14T19:12:52.919Z")
public class Account
extends Object

Container for a bank account's data

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Account.StatusEnum` The current status of the account.
`static class`	`Account.SupportedOrdersEnum` Gets or Sets supportedOrders

Constructor Summary

Constructors
Constructor and Description

Account()

Constructors
Constructor and Description
`Account()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Account`	`accountCurrency(String accountCurrency)`
`Account`	`accountHolderId(String accountHolderId)`
`Account`	`accountHolderName(String accountHolderName)`
`Account`	`accountName(String accountName)`
`Account`	`accountNumber(String accountNumber)`
`Account`	`accountTypeId(Long accountTypeId)`
`Account`	`accountTypeName(String accountTypeName)`
`Account`	`addClearingAccountsItem(ClearingAccountData clearingAccountsItem)`
`Account`	`addSupportedOrdersItem(Account.SupportedOrdersEnum supportedOrdersItem)`
`Account`	`availableFunds(BigDecimal availableFunds)`
`Account`	`balance(BigDecimal balance)`
`Account`	`bankConnectionId(Long bankConnectionId)`
`Account`	`clearingAccounts(List<ClearingAccountData> clearingAccounts)`
`boolean`	`equals(Object o)`
`String`	`getAccountCurrency()` Account's currency
`String`	`getAccountHolderId()` Bank's internal identification of the account holder
`String`	`getAccountHolderName()` Name of the account holder
`String`	`getAccountName()` Account name
`String`	`getAccountNumber()` (National) account number.
`Long`	`getAccountTypeId()` Identifier of the account's type.
`String`	`getAccountTypeName()` Name of the account's type
`BigDecimal`	`getAvailableFunds()` Current available funds.
`BigDecimal`	`getBalance()` Current account balance
`Long`	`getBankConnectionId()` Identifier of the bank connection that this account belongs to
`List<ClearingAccountData>`	`getClearingAccounts()` List of clearing accounts that relate to this account.
`String`	`getIban()` Account's IBAN.
`Long`	`getId()` Account identifier
`String`	`getLastSuccessfulUpdate()` Timestamp of when the account was last successfully updated (or initially imported); more precisely: time when the account data (balance and positions) has been stored into the finAPI databases.
`String`	`getLastUpdateAttempt()` Timestamp of when the account was last tried to be updated (or initially imported); more precisely: time when the update (or initial import) was triggered.
`BigDecimal`	`getOverdraft()` Current overdraft
`BigDecimal`	`getOverdraftLimit()` Overdraft limit
`Account.StatusEnum`	`getStatus()` The current status of the account.
`String`	`getSubAccountNumber()` Account's sub-account-number.
`List<Account.SupportedOrdersEnum>`	`getSupportedOrders()` List of orders that this account supports.
`int`	`hashCode()`
`Account`	`iban(String iban)`
`Account`	`id(Long id)`
`Boolean`	`isIsNew()` Indicating whether this account is 'new' or not.
`Account`	`isNew(Boolean isNew)`
`Account`	`lastSuccessfulUpdate(String lastSuccessfulUpdate)`
`Account`	`lastUpdateAttempt(String lastUpdateAttempt)`
`Account`	`overdraft(BigDecimal overdraft)`
`Account`	`overdraftLimit(BigDecimal overdraftLimit)`
`void`	`setAccountCurrency(String accountCurrency)`
`void`	`setAccountHolderId(String accountHolderId)`
`void`	`setAccountHolderName(String accountHolderName)`
`void`	`setAccountName(String accountName)`
`void`	`setAccountNumber(String accountNumber)`
`void`	`setAccountTypeId(Long accountTypeId)`
`void`	`setAccountTypeName(String accountTypeName)`
`void`	`setAvailableFunds(BigDecimal availableFunds)`
`void`	`setBalance(BigDecimal balance)`
`void`	`setBankConnectionId(Long bankConnectionId)`
`void`	`setClearingAccounts(List<ClearingAccountData> clearingAccounts)`
`void`	`setIban(String iban)`
`void`	`setId(Long id)`
`void`	`setIsNew(Boolean isNew)`
`void`	`setLastSuccessfulUpdate(String lastSuccessfulUpdate)`
`void`	`setLastUpdateAttempt(String lastUpdateAttempt)`
`void`	`setOverdraft(BigDecimal overdraft)`
`void`	`setOverdraftLimit(BigDecimal overdraftLimit)`
`void`	`setStatus(Account.StatusEnum status)`
`void`	`setSubAccountNumber(String subAccountNumber)`
`void`	`setSupportedOrders(List<Account.SupportedOrdersEnum> supportedOrders)`
`Account`	`status(Account.StatusEnum status)`
`Account`	`subAccountNumber(String subAccountNumber)`
`Account`	`supportedOrders(List<Account.SupportedOrdersEnum> supportedOrders)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
 - Account
```
public Account()
```
- Method Detail
 - id
```
public Account id(Long id)
```
 - getId
```
public Long getId()
```
 Account identifier
 
 Returns:
 
 id
 - setId
```
public void setId(Long id)
```
 - bankConnectionId
```
public Account bankConnectionId(Long bankConnectionId)
```
 - getBankConnectionId
```
public Long getBankConnectionId()
```
 Identifier of the bank connection that this account belongs to
 
 Returns:
 
 bankConnectionId
 - setBankConnectionId
```
public void setBankConnectionId(Long bankConnectionId)
```
 - accountName
```
public Account accountName(String accountName)
```
 - getAccountName
```
public String getAccountName()
```
 Account name
 
 Returns:
 
 accountName
 - setAccountName
```
public void setAccountName(String accountName)
```
 - accountNumber
```
public Account accountNumber(String accountNumber)
```
 - getAccountNumber
```
public String getAccountNumber()
```
 (National) account number. Note that this value might change whenever the account is updated (for example, leading zeros might be added or removed).
 
 Returns:
 
 accountNumber
 - setAccountNumber
```
public void setAccountNumber(String accountNumber)
```
 - subAccountNumber
```
public Account subAccountNumber(String subAccountNumber)
```
 - getSubAccountNumber
```
public String getSubAccountNumber()
```
 Account's sub-account-number. Note that this field can change from 'null' to a value - or vice versa - any time when the account is being updated. This is subject to changes within the bank's internal account management.
 
 Returns:
 
 subAccountNumber
 - setSubAccountNumber
```
public void setSubAccountNumber(String subAccountNumber)
```
 - iban
```
public Account iban(String iban)
```
 - getIban
```
public String getIban()
```
 Account's IBAN. Note that this field can change from 'null' to a value - or vice versa - any time when the account is being updated. This is subject to changes within the bank's internal account management.
 
 Returns:
 
 iban
 - setIban
```
public void setIban(String iban)
```
 - accountHolderName
```
public Account accountHolderName(String accountHolderName)
```
 - getAccountHolderName
```
public String getAccountHolderName()
```
 Name of the account holder
 
 Returns:
 
 accountHolderName
 - setAccountHolderName
```
public void setAccountHolderName(String accountHolderName)
```
 - accountHolderId
```
public Account accountHolderId(String accountHolderId)
```
 - getAccountHolderId
```
public String getAccountHolderId()
```
 Bank's internal identification of the account holder
 
 Returns:
 
 accountHolderId
 - setAccountHolderId
```
public void setAccountHolderId(String accountHolderId)
```
 - accountCurrency
```
public Account accountCurrency(String accountCurrency)
```
 - getAccountCurrency
```
public String getAccountCurrency()
```
 Account's currency
 
 Returns:
 
 accountCurrency
 - setAccountCurrency
```
public void setAccountCurrency(String accountCurrency)
```
 - accountTypeId
```
public Account accountTypeId(Long accountTypeId)
```
 - getAccountTypeId
```
public Long getAccountTypeId()
```
 Identifier of the account's type. Note that, in general, the type of an account can change any time when the account is being updated. This is subject to changes within the bank's internal account management. However, if the account's type has previously been changed explicitly (via the PATCH method), then the explicitly set type will NOT be automatically changed anymore, even if the type has changed on the bank side. 1 = Checking, 2 = Savings, 3 = CreditCard, 4 = Security, 5 = Loan, 6 = Pocket (DEPRECATED; will not be returned for any account unless this type has explicitly been set via PATCH), 7 = Membership, 8 = Bausparen 
 
 Returns:
 
 accountTypeId
 - setAccountTypeId
```
public void setAccountTypeId(Long accountTypeId)
```
 - accountTypeName
```
public Account accountTypeName(String accountTypeName)
```
 - getAccountTypeName
```
public String getAccountTypeName()
```
 Name of the account's type
 
 Returns:
 
 accountTypeName
 - setAccountTypeName
```
public void setAccountTypeName(String accountTypeName)
```
 - balance
```
public Account balance(BigDecimal balance)
```
 - getBalance
```
public BigDecimal getBalance()
```
 Current account balance
 
 Returns:
 
 balance
 - setBalance
```
public void setBalance(BigDecimal balance)
```
 - overdraft
```
public Account overdraft(BigDecimal overdraft)
```
 - getOverdraft
```
public BigDecimal getOverdraft()
```
 Current overdraft
 
 Returns:
 
 overdraft
 - setOverdraft
```
public void setOverdraft(BigDecimal overdraft)
```
 - overdraftLimit
```
public Account overdraftLimit(BigDecimal overdraftLimit)
```
 - getOverdraftLimit
```
public BigDecimal getOverdraftLimit()
```
 Overdraft limit
 
 Returns:
 
 overdraftLimit
 - setOverdraftLimit
```
public void setOverdraftLimit(BigDecimal overdraftLimit)
```
 - availableFunds
```
public Account availableFunds(BigDecimal availableFunds)
```
 - getAvailableFunds
```
public BigDecimal getAvailableFunds()
```
 Current available funds. Note that this field is only set if finAPI can make a definite statement about the current available funds. This might not always be the case, for example if there is not enough information available about the overdraft limit and current overdraft.
 
 Returns:
 
 availableFunds
 - setAvailableFunds
```
public void setAvailableFunds(BigDecimal availableFunds)
```
 - lastSuccessfulUpdate
```
public Account lastSuccessfulUpdate(String lastSuccessfulUpdate)
```
 - getLastSuccessfulUpdate
```
public String getLastSuccessfulUpdate()
```
 Timestamp of when the account was last successfully updated (or initially imported); more precisely: time when the account data (balance and positions) has been stored into the finAPI databases. The value is returned in the format 'yyyy-MM-dd HH:mm:ss.SSS' (german time).
 
 Returns:
 
 lastSuccessfulUpdate
 - setLastSuccessfulUpdate
```
public void setLastSuccessfulUpdate(String lastSuccessfulUpdate)
```
 - lastUpdateAttempt
```
public Account lastUpdateAttempt(String lastUpdateAttempt)
```
 - getLastUpdateAttempt
```
public String getLastUpdateAttempt()
```
 Timestamp of when the account was last tried to be updated (or initially imported); more precisely: time when the update (or initial import) was triggered. The value is returned in the format 'yyyy-MM-dd HH:mm:ss.SSS' (german time).
 
 Returns:
 
 lastUpdateAttempt
 - setLastUpdateAttempt
```
public void setLastUpdateAttempt(String lastUpdateAttempt)
```
 - isNew
```
public Account isNew(Boolean isNew)
```
 - isIsNew
```
public Boolean isIsNew()
```
 Indicating whether this account is 'new' or not. Any newly imported account will have this flag initially set to true, and remain so until you set it to false (see PATCH /accounts/<id>). How you use this field is up to your interpretation, however it is recommended to set the flag to false for all accounts right after the initial import of the bank connection. This way, you will be able recognize accounts that get newly imported during a later update of the bank connection, by checking for any accounts with the flag set to true right after an update.
 
 Returns:
 
 isNew
 - setIsNew
```
public void setIsNew(Boolean isNew)
```
 - status
```
public Account status(Account.StatusEnum status)
```
 - getStatus
```
public Account.StatusEnum getStatus()
```
 The current status of the account. Possible values are: • <code>UPDATED</code> means that the account is up to date from finAPI's point of view. This means that no current import/update is running, and the previous import/update could successfully update the account's data (e.g. transactions and securities), and the bank given balance matched the transaction's calculated sum, meaning that no adjusting entry ('Zwischensaldo' transaction) was inserted. • <code>UPDATED_FIXED</code> means that the account is up to date from finAPI's point of view (no current import/update is running, and the previous import/update could successfully update the account's data), BUT there was a deviation in the bank given balance which was fixed by adding an adjusting entry ('Zwischensaldo' transaction). • <code>DOWNLOAD_IN_PROGRESS</code> means that the account's data is currently being imported/updated. • <code>DOWNLOAD_FAILED</code> means that the account data could not get successfully imported or updated. Possible reasons: finAPI could not get the account's balance, or it could not parse all transactions/securities, or some internal error has occurred. Also, it could mean that finAPI could not even get to the point of receiving the account data from the bank server, for example because of incorrect login credentials or a network problem. Note however that when we get a balance and just an empty list of transactions or securities, then this is regarded as valid and successful download. The reason for this is that for some accounts that have little activity, we may actually get no recent transactions but only a balance. • <code>DEPRECATED</code> means that the account could no longer get matched with any account from the bank server. This can mean either that the account was terminated by the user and is no longer sent by the bank server, or that finAPI could no longer match it because the account's data (name, type, iban, account number, etc.) has been changed by the bank.
 
 Returns:
 
 status
 - setStatus
```
public void setStatus(Account.StatusEnum status)
```
 - supportedOrders
```
public Account supportedOrders(List<Account.SupportedOrdersEnum> supportedOrders)
```
 - addSupportedOrdersItem
```
public Account addSupportedOrdersItem(Account.SupportedOrdersEnum supportedOrdersItem)
```
 - getSupportedOrders
```
public List<Account.SupportedOrdersEnum> getSupportedOrders()
```
 List of orders that this account supports. Possible values are: • <code>SEPA_MONEY_TRANSFER</code> - single money transfer • <code>SEPA_COLLECTIVE_MONEY_TRANSFER</code> - collective money transfer • <code>SEPA_BASIC_DIRECT_DEBIT</code> - single basic direct debit • <code>SEPA_BASIC_COLLECTIVE_DIRECT_DEBIT</code> - collective basic direct debit • <code>SEPA_B2B_DIRECT_DEBIT</code> - single Business-To-Business direct debit • <code>SEPA_B2B_COLLECTIVE_DIRECT_DEBIT</code> - collective Business-To-Business direct debit Note that this list may be empty if the account is not supporting any of the above orders. Also note that the list is refreshed each time the account is being updated, so available orders may get added or removed in the course of an account update. 
 
 Returns:
 
 supportedOrders
 - setSupportedOrders
```
public void setSupportedOrders(List<Account.SupportedOrdersEnum> supportedOrders)
```
 - clearingAccounts
```
public Account clearingAccounts(List<ClearingAccountData> clearingAccounts)
```
 - addClearingAccountsItem
```
public Account addClearingAccountsItem(ClearingAccountData clearingAccountsItem)
```
 - getClearingAccounts
```
public List<ClearingAccountData> getClearingAccounts()
```
 List of clearing accounts that relate to this account. Clearing accounts can be used for money transfers (see field 'clearingAccountId' of the 'Request SEPA Money Transfer' service).
 
 Returns:
 
 clearingAccounts
 - setClearingAccounts
```
public void setClearingAccounts(List<ClearingAccountData> clearingAccounts)
```
 - 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

Class Account

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Account

Method Detail

id

getId

setId

bankConnectionId

getBankConnectionId

setBankConnectionId

accountName

getAccountName

setAccountName

accountNumber

getAccountNumber

setAccountNumber

subAccountNumber

getSubAccountNumber

setSubAccountNumber

iban

getIban

setIban

accountHolderName

getAccountHolderName

setAccountHolderName

accountHolderId

getAccountHolderId

setAccountHolderId

accountCurrency

getAccountCurrency

setAccountCurrency

accountTypeId

getAccountTypeId

setAccountTypeId

accountTypeName

getAccountTypeName

setAccountTypeName

balance

getBalance

setBalance

overdraft

getOverdraft

setOverdraft

overdraftLimit

getOverdraftLimit

setOverdraftLimit

availableFunds

getAvailableFunds

setAvailableFunds

lastSuccessfulUpdate

getLastSuccessfulUpdate

setLastSuccessfulUpdate

lastUpdateAttempt

getLastUpdateAttempt

setLastUpdateAttempt

isNew

isIsNew

setIsNew

status

getStatus

setStatus

supportedOrders

addSupportedOrdersItem

getSupportedOrders

setSupportedOrders

clearingAccounts

addClearingAccountsItem

getClearingAccounts

setClearingAccounts

equals

hashCode

toString