com.plaid.client.model

Class TransactionsGetRequestOptions

java.lang.Object

com.plaid.client.model.TransactionsGetRequestOptions

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

An optional object to be used with the request. If specified, `options` must not be `null`.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ACCOUNT_IDS
static String	SERIALIZED_NAME_COUNT
static String	SERIALIZED_NAME_INCLUDE_LOGO_AND_COUNTERPARTY_BETA
static String	SERIALIZED_NAME_INCLUDE_ORIGINAL_DESCRIPTION
static String	SERIALIZED_NAME_INCLUDE_PERSONAL_FINANCE_CATEGORY
static String	SERIALIZED_NAME_INCLUDE_PERSONAL_FINANCE_CATEGORY_BETA
static String	SERIALIZED_NAME_OFFSET

Constructor Summary

Constructors

Constructor and Description
TransactionsGetRequestOptions()

Method Summary

Modifier and Type	Method and Description
TransactionsGetRequestOptions	accountIds(List<String> accountIds)
TransactionsGetRequestOptions	addAccountIdsItem(String accountIdsItem)
TransactionsGetRequestOptions	count(Integer count)
boolean	equals(Object o)
List<String>	getAccountIds() A list of `account_ids` to retrieve for the Item Note: An error will be returned if a provided `account_id` is not associated with the Item.
Integer	getCount() The number of transactions to fetch.
Boolean	getIncludeLogoAndCounterpartyBeta() Counterparties and extra merchant fields are now returned by default.
Boolean	getIncludeOriginalDescription() Include the raw unparsed transaction description from the financial institution.
Boolean	getIncludePersonalFinanceCategory() Personal finance categories are now returned by default.
Boolean	getIncludePersonalFinanceCategoryBeta() Personal finance categories are now returned by default.
Integer	getOffset() The number of transactions to skip.
int	hashCode()
TransactionsGetRequestOptions	includeLogoAndCounterpartyBeta(Boolean includeLogoAndCounterpartyBeta)
TransactionsGetRequestOptions	includeOriginalDescription(Boolean includeOriginalDescription)
TransactionsGetRequestOptions	includePersonalFinanceCategory(Boolean includePersonalFinanceCategory)
TransactionsGetRequestOptions	includePersonalFinanceCategoryBeta(Boolean includePersonalFinanceCategoryBeta)
TransactionsGetRequestOptions	offset(Integer offset)
void	setAccountIds(List<String> accountIds)
void	setCount(Integer count)
void	setIncludeLogoAndCounterpartyBeta(Boolean includeLogoAndCounterpartyBeta)
void	setIncludeOriginalDescription(Boolean includeOriginalDescription)
void	setIncludePersonalFinanceCategory(Boolean includePersonalFinanceCategory)
void	setIncludePersonalFinanceCategoryBeta(Boolean includePersonalFinanceCategoryBeta)
void	setOffset(Integer offset)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_ACCOUNT_IDS

public static final String SERIALIZED_NAME_ACCOUNT_IDS

See Also:

Constant Field Values

SERIALIZED_NAME_COUNT

public static final String SERIALIZED_NAME_COUNT

See Also:

Constant Field Values

SERIALIZED_NAME_OFFSET

public static final String SERIALIZED_NAME_OFFSET

See Also:

Constant Field Values

SERIALIZED_NAME_INCLUDE_ORIGINAL_DESCRIPTION

public static final String SERIALIZED_NAME_INCLUDE_ORIGINAL_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_INCLUDE_PERSONAL_FINANCE_CATEGORY_BETA

public static final String SERIALIZED_NAME_INCLUDE_PERSONAL_FINANCE_CATEGORY_BETA

See Also:

Constant Field Values

SERIALIZED_NAME_INCLUDE_PERSONAL_FINANCE_CATEGORY

public static final String SERIALIZED_NAME_INCLUDE_PERSONAL_FINANCE_CATEGORY

See Also:

Constant Field Values

SERIALIZED_NAME_INCLUDE_LOGO_AND_COUNTERPARTY_BETA

public static final String SERIALIZED_NAME_INCLUDE_LOGO_AND_COUNTERPARTY_BETA

See Also:

Constant Field Values

Constructor Detail

TransactionsGetRequestOptions

public TransactionsGetRequestOptions()

Method Detail

accountIds

public TransactionsGetRequestOptions accountIds(List<String> accountIds)

addAccountIdsItem

public TransactionsGetRequestOptions addAccountIdsItem(String accountIdsItem)

getAccountIds

@Nullable
public List<String> getAccountIds()

A list of `account_ids` to retrieve for the Item Note: An error will be returned if a provided `account_id` is not associated with the Item.

Returns:

accountIds

setAccountIds

public void setAccountIds(List<String> accountIds)

count

public TransactionsGetRequestOptions count(Integer count)

getCount

@Nullable
public Integer getCount()

The number of transactions to fetch. minimum: 1 maximum: 500

Returns:

count

setCount

public void setCount(Integer count)

offset

public TransactionsGetRequestOptions offset(Integer offset)

getOffset

@Nullable
public Integer getOffset()

The number of transactions to skip. The default value is 0. minimum: 0

Returns:

offset

setOffset

public void setOffset(Integer offset)

includeOriginalDescription

public TransactionsGetRequestOptions includeOriginalDescription(Boolean includeOriginalDescription)

getIncludeOriginalDescription

@Nullable
public Boolean getIncludeOriginalDescription()

Include the raw unparsed transaction description from the financial institution. This field is disabled by default. If you need this information in addition to the parsed data provided, contact your Plaid Account Manager, or submit a [Support request](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/product-functionality).

Returns:

includeOriginalDescription

setIncludeOriginalDescription

public void setIncludeOriginalDescription(Boolean includeOriginalDescription)

includePersonalFinanceCategoryBeta

public TransactionsGetRequestOptions includePersonalFinanceCategoryBeta(Boolean includePersonalFinanceCategoryBeta)

getIncludePersonalFinanceCategoryBeta

@Nullable
public Boolean getIncludePersonalFinanceCategoryBeta()

Personal finance categories are now returned by default.

Returns:

includePersonalFinanceCategoryBeta

setIncludePersonalFinanceCategoryBeta

public void setIncludePersonalFinanceCategoryBeta(Boolean includePersonalFinanceCategoryBeta)

includePersonalFinanceCategory

public TransactionsGetRequestOptions includePersonalFinanceCategory(Boolean includePersonalFinanceCategory)

getIncludePersonalFinanceCategory

@Nullable
public Boolean getIncludePersonalFinanceCategory()

Personal finance categories are now returned by default.

Returns:

includePersonalFinanceCategory

setIncludePersonalFinanceCategory

public void setIncludePersonalFinanceCategory(Boolean includePersonalFinanceCategory)

includeLogoAndCounterpartyBeta

public TransactionsGetRequestOptions includeLogoAndCounterpartyBeta(Boolean includeLogoAndCounterpartyBeta)

getIncludeLogoAndCounterpartyBeta

@Nullable
public Boolean getIncludeLogoAndCounterpartyBeta()

Counterparties and extra merchant fields are now returned by default.

Returns:

includeLogoAndCounterpartyBeta

setIncludeLogoAndCounterpartyBeta

public void setIncludeLogoAndCounterpartyBeta(Boolean includeLogoAndCounterpartyBeta)

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