com.plaid.client.model

Class BaseReportAccount

java.lang.Object

com.plaid.client.model.BaseReportAccount

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

Base Report information about an account

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ACCOUNT_INSIGHTS
static String	SERIALIZED_NAME_BALANCES
static String	SERIALIZED_NAME_DAYS_AVAILABLE
static String	SERIALIZED_NAME_HISTORICAL_BALANCES
static String	SERIALIZED_NAME_MASK
static String	SERIALIZED_NAME_NAME
static String	SERIALIZED_NAME_OFFICIAL_NAME
static String	SERIALIZED_NAME_OWNERS
static String	SERIALIZED_NAME_OWNERSHIP_TYPE
static String	SERIALIZED_NAME_SUBTYPE
static String	SERIALIZED_NAME_TRANSACTIONS
static String	SERIALIZED_NAME_TYPE

Constructor Summary

Constructors

Constructor and Description
BaseReportAccount()

Method Summary

Modifier and Type	Method and Description
BaseReportAccount	accountInsights(BaseReportAccountInsights accountInsights)
BaseReportAccount	addHistoricalBalancesItem(HistoricalBalance historicalBalancesItem)
BaseReportAccount	addOwnersItem(Owner ownersItem)
BaseReportAccount	addTransactionsItem(BaseReportTransaction transactionsItem)
BaseReportAccount	balances(AccountBalance balances)
BaseReportAccount	daysAvailable(Double daysAvailable)
boolean	equals(Object o)
BaseReportAccountInsights	getAccountInsights() Get accountInsights
AccountBalance	getBalances() Get balances
Double	getDaysAvailable() The duration of transaction history available for this Item, typically defined as the time since the date of the earliest transaction in that account.
List<HistoricalBalance>	getHistoricalBalances() Calculated data about the historical balances on the account.
String	getMask() The last 2-4 alphanumeric characters of an account's official account number.
String	getName() The name of the account, either assigned by the user or by the financial institution itself
String	getOfficialName() The official name of the account as given by the financial institution
List<Owner>	getOwners() Data returned by the financial institution about the account owner or owners.
OwnershipType	getOwnershipType() Get ownershipType
AccountSubtype	getSubtype() Get subtype
List<BaseReportTransaction>	getTransactions() Transaction history associated with the account.
AccountType	getType() Get type
int	hashCode()
BaseReportAccount	historicalBalances(List<HistoricalBalance> historicalBalances)
BaseReportAccount	mask(String mask)
BaseReportAccount	name(String name)
BaseReportAccount	officialName(String officialName)
BaseReportAccount	owners(List<Owner> owners)
BaseReportAccount	ownershipType(OwnershipType ownershipType)
void	setAccountInsights(BaseReportAccountInsights accountInsights)
void	setBalances(AccountBalance balances)
void	setDaysAvailable(Double daysAvailable)
void	setHistoricalBalances(List<HistoricalBalance> historicalBalances)
void	setMask(String mask)
void	setName(String name)
void	setOfficialName(String officialName)
void	setOwners(List<Owner> owners)
void	setOwnershipType(OwnershipType ownershipType)
void	setSubtype(AccountSubtype subtype)
void	setTransactions(List<BaseReportTransaction> transactions)
void	setType(AccountType type)
BaseReportAccount	subtype(AccountSubtype subtype)
String	toString()
BaseReportAccount	transactions(List<BaseReportTransaction> transactions)
BaseReportAccount	type(AccountType type)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_BALANCES

public static final String SERIALIZED_NAME_BALANCES

See Also:

Constant Field Values

SERIALIZED_NAME_MASK

public static final String SERIALIZED_NAME_MASK

See Also:

Constant Field Values

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_OFFICIAL_NAME

public static final String SERIALIZED_NAME_OFFICIAL_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_SUBTYPE

public static final String SERIALIZED_NAME_SUBTYPE

See Also:

Constant Field Values

SERIALIZED_NAME_DAYS_AVAILABLE

public static final String SERIALIZED_NAME_DAYS_AVAILABLE

See Also:

Constant Field Values

SERIALIZED_NAME_TRANSACTIONS

public static final String SERIALIZED_NAME_TRANSACTIONS

See Also:

Constant Field Values

SERIALIZED_NAME_OWNERS

public static final String SERIALIZED_NAME_OWNERS

See Also:

Constant Field Values

SERIALIZED_NAME_OWNERSHIP_TYPE

public static final String SERIALIZED_NAME_OWNERSHIP_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_HISTORICAL_BALANCES

public static final String SERIALIZED_NAME_HISTORICAL_BALANCES

See Also:

Constant Field Values

SERIALIZED_NAME_ACCOUNT_INSIGHTS

public static final String SERIALIZED_NAME_ACCOUNT_INSIGHTS

See Also:

Constant Field Values

Constructor Detail

BaseReportAccount

public BaseReportAccount()

Method Detail

balances

public BaseReportAccount balances(AccountBalance balances)

getBalances

public AccountBalance getBalances()

Get balances

Returns:

balances

setBalances

public void setBalances(AccountBalance balances)

mask

public BaseReportAccount mask(String mask)

getMask

@Nullable
public String getMask()

The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.

Returns:

mask

setMask

public void setMask(String mask)

name

public BaseReportAccount name(String name)

getName

public String getName()

The name of the account, either assigned by the user or by the financial institution itself

Returns:

name

setName

public void setName(String name)

officialName

public BaseReportAccount officialName(String officialName)

getOfficialName

@Nullable
public String getOfficialName()

The official name of the account as given by the financial institution

Returns:

officialName

setOfficialName

public void setOfficialName(String officialName)

type

public BaseReportAccount type(AccountType type)

getType

public AccountType getType()

Get type

Returns:

type

setType

public void setType(AccountType type)

subtype

public BaseReportAccount subtype(AccountSubtype subtype)

getSubtype

@Nullable
public AccountSubtype getSubtype()

Get subtype

Returns:

subtype

setSubtype

public void setSubtype(AccountSubtype subtype)

daysAvailable

public BaseReportAccount daysAvailable(Double daysAvailable)

getDaysAvailable

public Double getDaysAvailable()

The duration of transaction history available for this Item, typically defined as the time since the date of the earliest transaction in that account. Only returned by Base Report endpoints.

Returns:

daysAvailable

setDaysAvailable

public void setDaysAvailable(Double daysAvailable)

transactions

public BaseReportAccount transactions(List<BaseReportTransaction> transactions)

addTransactionsItem

public BaseReportAccount addTransactionsItem(BaseReportTransaction transactionsItem)

getTransactions

public List<BaseReportTransaction> getTransactions()

Transaction history associated with the account. Only returned by Base Report endpoints. Transaction history returned by endpoints such as `/transactions/get` or `/investments/transactions/get` will be returned in the top-level `transactions` field instead.

Returns:

transactions

setTransactions

public void setTransactions(List<BaseReportTransaction> transactions)

owners

public BaseReportAccount owners(List<Owner> owners)

addOwnersItem

public BaseReportAccount addOwnersItem(Owner ownersItem)

getOwners

public List<Owner> getOwners()

Data returned by the financial institution about the account owner or owners. For business accounts, the name reported may be either the name of the individual or the name of the business, depending on the institution. Multiple owners on a single account will be represented in the same `owner` object, not in multiple owner objects within the array.

Returns:

owners

setOwners

public void setOwners(List<Owner> owners)

ownershipType

public BaseReportAccount ownershipType(OwnershipType ownershipType)

getOwnershipType

@Nullable
public OwnershipType getOwnershipType()

Get ownershipType

Returns:

ownershipType

setOwnershipType

public void setOwnershipType(OwnershipType ownershipType)

historicalBalances

public BaseReportAccount historicalBalances(List<HistoricalBalance> historicalBalances)

addHistoricalBalancesItem

public BaseReportAccount addHistoricalBalancesItem(HistoricalBalance historicalBalancesItem)

getHistoricalBalances

public List<HistoricalBalance> getHistoricalBalances()

Calculated data about the historical balances on the account. Only returned by Base Report endpoints and currently not supported by `brokerage` or `investment` accounts.

Returns:

historicalBalances

setHistoricalBalances

public void setHistoricalBalances(List<HistoricalBalance> historicalBalances)

accountInsights

public BaseReportAccount accountInsights(BaseReportAccountInsights accountInsights)

getAccountInsights

@Nullable
public BaseReportAccountInsights getAccountInsights()

Get accountInsights

Returns:

accountInsights

setAccountInsights

public void setAccountInsights(BaseReportAccountInsights accountInsights)

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