com.plaid.client.model

Class HistoricalBalance

java.lang.Object

com.plaid.client.model.HistoricalBalance

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

An object representing a balance held by an account in the past

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_CURRENT
static String	SERIALIZED_NAME_DATE
static String	SERIALIZED_NAME_ISO_CURRENCY_CODE
static String	SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE

Constructor Summary

Constructors

Constructor and Description
HistoricalBalance()

Method Summary

Modifier and Type	Method and Description
HistoricalBalance	current(Double current)
HistoricalBalance	date(LocalDate date)
boolean	equals(Object o)
Double	getCurrent() The total amount of funds in the account, calculated from the `current` balance in the `balance` object by subtracting inflows and adding back outflows according to the posted date of each transaction.
LocalDate	getDate() The date of the calculated historical balance, in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD)
String	getIsoCurrencyCode() The ISO-4217 currency code of the balance.
String	getUnofficialCurrencyCode() The unofficial currency code associated with the balance.
int	hashCode()
HistoricalBalance	isoCurrencyCode(String isoCurrencyCode)
void	setCurrent(Double current)
void	setDate(LocalDate date)
void	setIsoCurrencyCode(String isoCurrencyCode)
void	setUnofficialCurrencyCode(String unofficialCurrencyCode)
String	toString()
HistoricalBalance	unofficialCurrencyCode(String unofficialCurrencyCode)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_DATE

public static final String SERIALIZED_NAME_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_CURRENT

public static final String SERIALIZED_NAME_CURRENT

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

Constructor Detail

HistoricalBalance

public HistoricalBalance()

Method Detail

date

public HistoricalBalance date(LocalDate date)

getDate

public LocalDate getDate()

The date of the calculated historical balance, in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD)

Returns:

date

setDate

public void setDate(LocalDate date)

current

public HistoricalBalance current(Double current)

getCurrent

public Double getCurrent()

The total amount of funds in the account, calculated from the `current` balance in the `balance` object by subtracting inflows and adding back outflows according to the posted date of each transaction. If the account has any pending transactions, historical balance amounts on or after the date of the earliest pending transaction may differ if retrieved in subsequent Asset Reports as a result of those pending transactions posting.

Returns:

current

setCurrent

public void setCurrent(Double current)

isoCurrencyCode

public HistoricalBalance 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 HistoricalBalance 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`. 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)

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