AccountBalance (com.plaid:plaid-java 18.0.0 API)

java.lang.Object
- com.plaid.client.model.AccountBalance

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class AccountBalance
extends Object

A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by `/accounts/balance/get`.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_AVAILABLE`
`static String`	`SERIALIZED_NAME_CURRENT`
`static String`	`SERIALIZED_NAME_ISO_CURRENCY_CODE`
`static String`	`SERIALIZED_NAME_LAST_UPDATED_DATETIME`
`static String`	`SERIALIZED_NAME_LIMIT`
`static String`	`SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE`

Constructor Summary

Constructors
Constructor and Description

AccountBalance()

Constructors
Constructor and Description
`AccountBalance()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccountBalance`	`available(Double available)`
`AccountBalance`	`current(Double current)`
`boolean`	`equals(Object o)`
`Double`	`getAvailable()` The amount of funds available to be withdrawn from the account, as determined by the financial institution.
`Double`	`getCurrent()` The total amount of funds in or owed by the account.
`String`	`getIsoCurrencyCode()` The ISO-4217 currency code of the balance.
`OffsetDateTime`	`getLastUpdatedDatetime()` Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:mm:ssZ`) indicating the last time that the balance for the given account has been updated This is currently only provided when the `min_last_updated_datetime` is passed when calling `/accounts/balance/get` for `ins_128026` (Capital One).
`Double`	`getLimit()` For `credit`-type accounts, this represents the credit limit.
`String`	`getUnofficialCurrencyCode()` The unofficial currency code associated with the balance.
`int`	`hashCode()`
`AccountBalance`	`isoCurrencyCode(String isoCurrencyCode)`
`AccountBalance`	`lastUpdatedDatetime(OffsetDateTime lastUpdatedDatetime)`
`AccountBalance`	`limit(Double limit)`
`void`	`setAvailable(Double available)`
`void`	`setCurrent(Double current)`
`void`	`setIsoCurrencyCode(String isoCurrencyCode)`
`void`	`setLastUpdatedDatetime(OffsetDateTime lastUpdatedDatetime)`
`void`	`setLimit(Double limit)`
`void`	`setUnofficialCurrencyCode(String unofficialCurrencyCode)`
`String`	`toString()`
`AccountBalance`	`unofficialCurrencyCode(String unofficialCurrencyCode)`

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

- Field Detail
  - SERIALIZED_NAME_AVAILABLE
```
public static final String SERIALIZED_NAME_AVAILABLE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CURRENT
```
public static final String SERIALIZED_NAME_CURRENT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LIMIT
```
public static final String SERIALIZED_NAME_LIMIT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ISO_CURRENCY_CODE
```
public static final String SERIALIZED_NAME_ISO_CURRENCY_CODE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE
```
public static final String SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LAST_UPDATED_DATETIME
```
public static final String SERIALIZED_NAME_LAST_UPDATED_DATETIME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AccountBalance
```
public AccountBalance()
```
- Method Detail
  - available
```
public AccountBalance available(Double available)
```
  - getAvailable
```
@Nullable
public Double getAvailable()
```
    The amount of funds available to be withdrawn from the account, as determined by the financial institution. For `credit`-type accounts, the `available` balance typically equals the `limit` less the `current` balance, less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance typically equals the `current` balance less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance does not include the overdraft limit. For `investment`-type accounts (or `brokerage`-type accounts for API versions 2018-05-22 and earlier), the `available` balance is the total cash available to withdraw as presented by the institution. Note that not all institutions calculate the `available` balance. In the event that `available` balance is unavailable, Plaid will return an `available` balance value of `null`. Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by `/accounts/balance/get`. If `current` is `null` this field is guaranteed not to be `null`.
    
    Returns:
    
    available
  - setAvailable
```
public void setAvailable(Double available)
```
  - current
```
public AccountBalance current(Double current)
```
  - getCurrent
```
@Nullable
public Double getCurrent()
```
    The total amount of funds in or owed by the account. For `credit`-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder. For `loan`-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (`ins_116944`). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest. For `investment`-type accounts (or `brokerage`-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution. Note that balance information may be cached unless the value was returned by `/accounts/balance/get`; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the `available` balance as provided by `/accounts/balance/get`. When returned by `/accounts/balance/get`, this field may be `null`. When this happens, `available` is guaranteed not to be `null`.
    
    Returns:
    
    current
  - setCurrent
```
public void setCurrent(Double current)
```
  - limit
```
public AccountBalance limit(Double limit)
```
  - getLimit
```
@Nullable
public Double getLimit()
```
    For `credit`-type accounts, this represents the credit limit. For `depository`-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe. In North America, this field is typically only available for `credit`-type accounts.
    
    Returns:
    
    limit
  - setLimit
```
public void setLimit(Double limit)
```
  - isoCurrencyCode
```
public AccountBalance isoCurrencyCode(String isoCurrencyCode)
```
  - getIsoCurrencyCode
```
@Nullable
public String getIsoCurrencyCode()
```
    The ISO-4217 currency code of the balance. Always null if `unofficial_currency_code` is non-null.
    
    Returns:
    
    isoCurrencyCode
  - setIsoCurrencyCode
```
public void setIsoCurrencyCode(String isoCurrencyCode)
```
  - unofficialCurrencyCode
```
public AccountBalance unofficialCurrencyCode(String unofficialCurrencyCode)
```
  - getUnofficialCurrencyCode
```
@Nullable
public String getUnofficialCurrencyCode()
```
    The unofficial currency code associated with the balance. Always null if `iso_currency_code` is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `unofficial_currency_code`s.
    
    Returns:
    
    unofficialCurrencyCode
  - setUnofficialCurrencyCode
```
public void setUnofficialCurrencyCode(String unofficialCurrencyCode)
```
  - lastUpdatedDatetime
```
public AccountBalance lastUpdatedDatetime(OffsetDateTime lastUpdatedDatetime)
```
  - getLastUpdatedDatetime
```
@Nullable
public OffsetDateTime getLastUpdatedDatetime()
```
    Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:mm:ssZ`) indicating the last time that the balance for the given account has been updated This is currently only provided when the `min_last_updated_datetime` is passed when calling `/accounts/balance/get` for `ins_128026` (Capital One).
    
    Returns:
    
    lastUpdatedDatetime
  - setLastUpdatedDatetime
```
public void setLastUpdatedDatetime(OffsetDateTime lastUpdatedDatetime)
```
  - 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 AccountBalance

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_AVAILABLE

SERIALIZED_NAME_CURRENT

SERIALIZED_NAME_LIMIT

SERIALIZED_NAME_ISO_CURRENCY_CODE

SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE

SERIALIZED_NAME_LAST_UPDATED_DATETIME

Constructor Detail

AccountBalance

Method Detail

available

getAvailable

setAvailable

current

getCurrent

setCurrent

limit

getLimit

setLimit

isoCurrencyCode

getIsoCurrencyCode

setIsoCurrencyCode

unofficialCurrencyCode

getUnofficialCurrencyCode

setUnofficialCurrencyCode

lastUpdatedDatetime

getLastUpdatedDatetime

setLastUpdatedDatetime

equals

hashCode

toString