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

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

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

A transaction on the asset report

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ACCOUNT_ID`
`static String`	`SERIALIZED_NAME_ACCOUNT_OWNER`
`static String`	`SERIALIZED_NAME_AMOUNT`
`static String`	`SERIALIZED_NAME_CATEGORY`
`static String`	`SERIALIZED_NAME_CATEGORY_ID`
`static String`	`SERIALIZED_NAME_CHECK_NUMBER`
`static String`	`SERIALIZED_NAME_CREDIT_CATEGORY`
`static String`	`SERIALIZED_NAME_DATE`
`static String`	`SERIALIZED_NAME_DATE_TRANSACTED`
`static String`	`SERIALIZED_NAME_INCOME_SOURCE_ID`
`static String`	`SERIALIZED_NAME_ISO_CURRENCY_CODE`
`static String`	`SERIALIZED_NAME_LOCATION`
`static String`	`SERIALIZED_NAME_MERCHANT_NAME`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_ORIGINAL_DESCRIPTION`
`static String`	`SERIALIZED_NAME_PAYMENT_META`
`static String`	`SERIALIZED_NAME_PENDING`
`static String`	`SERIALIZED_NAME_PENDING_TRANSACTION_ID`
`static String`	`SERIALIZED_NAME_TRANSACTION_ID`
`static String`	`SERIALIZED_NAME_TRANSACTION_TYPE`
`static String`	`SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE`

Constructor Summary

Constructors
Constructor and Description

AssetReportTransaction()

Constructors
Constructor and Description
`AssetReportTransaction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssetReportTransaction`	`accountId(String accountId)`
`AssetReportTransaction`	`accountOwner(String accountOwner)`
`AssetReportTransaction`	`addCategoryItem(String categoryItem)`
`AssetReportTransaction`	`amount(Double amount)`
`AssetReportTransaction`	`category(List<String> category)`
`AssetReportTransaction`	`categoryId(String categoryId)`
`AssetReportTransaction`	`checkNumber(String checkNumber)`
`AssetReportTransaction`	`creditCategory(CreditCategory creditCategory)`
`AssetReportTransaction`	`date(LocalDate date)`
`AssetReportTransaction`	`dateTransacted(String dateTransacted)`
`boolean`	`equals(Object o)`
`String`	`getAccountId()` The ID of the account in which this transaction occurred.
`String`	`getAccountOwner()` The name of the account owner.
`Double`	`getAmount()` The settled value of the transaction, denominated in the transaction's currency, as stated in `iso_currency_code` or `unofficial_currency_code`.
`List<String>`	`getCategory()` A hierarchical array of the categories to which this transaction belongs.
`String`	`getCategoryId()` The ID of the category to which this transaction belongs.
`String`	`getCheckNumber()` The check number of the transaction.
`CreditCategory`	`getCreditCategory()` Get creditCategory
`LocalDate`	`getDate()` For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted.
`String`	`getDateTransacted()` The date on which the transaction took place, in IS0 8601 format.
`String`	`getIncomeSourceId()` A unique identifier for an income source.
`String`	`getIsoCurrencyCode()` The ISO-4217 currency code of the transaction.
`Location`	`getLocation()` Get location
`String`	`getMerchantName()` The merchant name, as enriched by Plaid from the `name` field.
`String`	`getName()` The merchant name or transaction description.
`String`	`getOriginalDescription()` The string returned by the financial institution to describe the transaction.
`PaymentMeta`	`getPaymentMeta()` Get paymentMeta
`Boolean`	`getPending()` When `true`, identifies the transaction as pending or unsettled.
`String`	`getPendingTransactionId()` The ID of a posted transaction's associated pending transaction, where applicable.
`String`	`getTransactionId()` The unique ID of the transaction.
`AssetReportTransactionType`	`getTransactionType()` Get transactionType
`String`	`getUnofficialCurrencyCode()` The unofficial currency code associated with the transaction.
`int`	`hashCode()`
`AssetReportTransaction`	`incomeSourceId(String incomeSourceId)`
`AssetReportTransaction`	`isoCurrencyCode(String isoCurrencyCode)`
`AssetReportTransaction`	`location(Location location)`
`AssetReportTransaction`	`merchantName(String merchantName)`
`AssetReportTransaction`	`name(String name)`
`AssetReportTransaction`	`originalDescription(String originalDescription)`
`AssetReportTransaction`	`paymentMeta(PaymentMeta paymentMeta)`
`AssetReportTransaction`	`pending(Boolean pending)`
`AssetReportTransaction`	`pendingTransactionId(String pendingTransactionId)`
`void`	`setAccountId(String accountId)`
`void`	`setAccountOwner(String accountOwner)`
`void`	`setAmount(Double amount)`
`void`	`setCategory(List<String> category)`
`void`	`setCategoryId(String categoryId)`
`void`	`setCheckNumber(String checkNumber)`
`void`	`setCreditCategory(CreditCategory creditCategory)`
`void`	`setDate(LocalDate date)`
`void`	`setDateTransacted(String dateTransacted)`
`void`	`setIncomeSourceId(String incomeSourceId)`
`void`	`setIsoCurrencyCode(String isoCurrencyCode)`
`void`	`setLocation(Location location)`
`void`	`setMerchantName(String merchantName)`
`void`	`setName(String name)`
`void`	`setOriginalDescription(String originalDescription)`
`void`	`setPaymentMeta(PaymentMeta paymentMeta)`
`void`	`setPending(Boolean pending)`
`void`	`setPendingTransactionId(String pendingTransactionId)`
`void`	`setTransactionId(String transactionId)`
`void`	`setTransactionType(AssetReportTransactionType transactionType)`
`void`	`setUnofficialCurrencyCode(String unofficialCurrencyCode)`
`String`	`toString()`
`AssetReportTransaction`	`transactionId(String transactionId)`
`AssetReportTransaction`	`transactionType(AssetReportTransactionType transactionType)`
`AssetReportTransaction`	`unofficialCurrencyCode(String unofficialCurrencyCode)`

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

- Field Detail
  - SERIALIZED_NAME_ACCOUNT_ID
```
public static final String SERIALIZED_NAME_ACCOUNT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_AMOUNT
```
public static final String SERIALIZED_NAME_AMOUNT
```
    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_ORIGINAL_DESCRIPTION
```
public static final String SERIALIZED_NAME_ORIGINAL_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CATEGORY
```
public static final String SERIALIZED_NAME_CATEGORY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CATEGORY_ID
```
public static final String SERIALIZED_NAME_CATEGORY_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CREDIT_CATEGORY
```
public static final String SERIALIZED_NAME_CREDIT_CATEGORY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CHECK_NUMBER
```
public static final String SERIALIZED_NAME_CHECK_NUMBER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DATE
```
public static final String SERIALIZED_NAME_DATE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DATE_TRANSACTED
```
public static final String SERIALIZED_NAME_DATE_TRANSACTED
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LOCATION
```
public static final String SERIALIZED_NAME_LOCATION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NAME
```
public static final String SERIALIZED_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MERCHANT_NAME
```
public static final String SERIALIZED_NAME_MERCHANT_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PAYMENT_META
```
public static final String SERIALIZED_NAME_PAYMENT_META
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PENDING
```
public static final String SERIALIZED_NAME_PENDING
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PENDING_TRANSACTION_ID
```
public static final String SERIALIZED_NAME_PENDING_TRANSACTION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACCOUNT_OWNER
```
public static final String SERIALIZED_NAME_ACCOUNT_OWNER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TRANSACTION_ID
```
public static final String SERIALIZED_NAME_TRANSACTION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TRANSACTION_TYPE
```
public static final String SERIALIZED_NAME_TRANSACTION_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INCOME_SOURCE_ID
```
public static final String SERIALIZED_NAME_INCOME_SOURCE_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AssetReportTransaction
```
public AssetReportTransaction()
```
- Method Detail
  - accountId
```
public AssetReportTransaction accountId(String accountId)
```
  - getAccountId
```
public String getAccountId()
```
    The ID of the account in which this transaction occurred.
    
    Returns:
    
    accountId
  - setAccountId
```
public void setAccountId(String accountId)
```
  - amount
```
public AssetReportTransaction amount(Double amount)
```
  - getAmount
```
public Double getAmount()
```
    The settled value of the transaction, denominated in the transaction's currency, as stated in `iso_currency_code` or `unofficial_currency_code`. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative.
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Double amount)
```
  - isoCurrencyCode
```
public AssetReportTransaction isoCurrencyCode(String isoCurrencyCode)
```
  - getIsoCurrencyCode
```
@Nullable
public String getIsoCurrencyCode()
```
    The ISO-4217 currency code of the transaction. Always `null` if `unofficial_currency_code` is non-null.
    
    Returns:
    
    isoCurrencyCode
  - setIsoCurrencyCode
```
public void setIsoCurrencyCode(String isoCurrencyCode)
```
  - unofficialCurrencyCode
```
public AssetReportTransaction unofficialCurrencyCode(String unofficialCurrencyCode)
```
  - getUnofficialCurrencyCode
```
@Nullable
public String getUnofficialCurrencyCode()
```
    The unofficial currency code associated with the transaction. 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)
```
  - originalDescription
```
public AssetReportTransaction originalDescription(String originalDescription)
```
  - getOriginalDescription
```
@Nullable
public String getOriginalDescription()
```
    The string returned by the financial institution to describe the transaction.
    
    Returns:
    
    originalDescription
  - setOriginalDescription
```
public void setOriginalDescription(String originalDescription)
```
  - category
```
public AssetReportTransaction category(List<String> category)
```
  - addCategoryItem
```
public AssetReportTransaction addCategoryItem(String categoryItem)
```
  - getCategory
```
@Nullable
public List<String> getCategory()
```
    A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see [`/categories/get`](https://plaid.com/docs/api/products/transactions/#categoriesget). This field will only appear in an Asset Report with Insights.
    
    Returns:
    
    category
  - setCategory
```
public void setCategory(List<String> category)
```
  - categoryId
```
public AssetReportTransaction categoryId(String categoryId)
```
  - getCategoryId
```
@Nullable
public String getCategoryId()
```
    The ID of the category to which this transaction belongs. For a full list of categories, see [`/categories/get`](https://plaid.com/docs/api/products/transactions/#categoriesget). This field will only appear in an Asset Report with Insights.
    
    Returns:
    
    categoryId
  - setCategoryId
```
public void setCategoryId(String categoryId)
```
  - creditCategory
```
public AssetReportTransaction creditCategory(CreditCategory creditCategory)
```
  - getCreditCategory
```
@Nullable
public CreditCategory getCreditCategory()
```
    Get creditCategory
    
    Returns:
    
    creditCategory
  - setCreditCategory
```
public void setCreditCategory(CreditCategory creditCategory)
```
  - checkNumber
```
public AssetReportTransaction checkNumber(String checkNumber)
```
  - getCheckNumber
```
@Nullable
public String getCheckNumber()
```
    The check number of the transaction. This field is only populated for check transactions.
    
    Returns:
    
    checkNumber
  - setCheckNumber
```
public void setCheckNumber(String checkNumber)
```
  - date
```
public AssetReportTransaction date(LocalDate date)
```
  - getDate
```
public LocalDate getDate()
```
    For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DD` ).
    
    Returns:
    
    date
  - setDate
```
public void setDate(LocalDate date)
```
  - dateTransacted
```
public AssetReportTransaction dateTransacted(String dateTransacted)
```
  - getDateTransacted
```
@Nullable
public String getDateTransacted()
```
    The date on which the transaction took place, in IS0 8601 format.
    
    Returns:
    
    dateTransacted
  - setDateTransacted
```
public void setDateTransacted(String dateTransacted)
```
  - location
```
public AssetReportTransaction location(Location location)
```
  - getLocation
```
@Nullable
public Location getLocation()
```
    Get location
    
    Returns:
    
    location
  - setLocation
```
public void setLocation(Location location)
```
  - name
```
public AssetReportTransaction name(String name)
```
  - getName
```
@Nullable
public String getName()
```
    The merchant name or transaction description. This field will only appear in an Asset Report with Insights.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - merchantName
```
public AssetReportTransaction merchantName(String merchantName)
```
  - getMerchantName
```
@Nullable
public String getMerchantName()
```
    The merchant name, as enriched by Plaid from the `name` field. This is typically a more human-readable version of the merchant counterparty in the transaction. For some bank transactions (such as checks or account transfers) where there is no meaningful merchant name, this value will be `null`.
    
    Returns:
    
    merchantName
  - setMerchantName
```
public void setMerchantName(String merchantName)
```
  - paymentMeta
```
public AssetReportTransaction paymentMeta(PaymentMeta paymentMeta)
```
  - getPaymentMeta
```
@Nullable
public PaymentMeta getPaymentMeta()
```
    Get paymentMeta
    
    Returns:
    
    paymentMeta
  - setPaymentMeta
```
public void setPaymentMeta(PaymentMeta paymentMeta)
```
  - pending
```
public AssetReportTransaction pending(Boolean pending)
```
  - getPending
```
public Boolean getPending()
```
    When `true`, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.
    
    Returns:
    
    pending
  - setPending
```
public void setPending(Boolean pending)
```
  - pendingTransactionId
```
public AssetReportTransaction pendingTransactionId(String pendingTransactionId)
```
  - getPendingTransactionId
```
@Nullable
public String getPendingTransactionId()
```
    The ID of a posted transaction's associated pending transaction, where applicable.
    
    Returns:
    
    pendingTransactionId
  - setPendingTransactionId
```
public void setPendingTransactionId(String pendingTransactionId)
```
  - accountOwner
```
public AssetReportTransaction accountOwner(String accountOwner)
```
  - getAccountOwner
```
@Nullable
public String getAccountOwner()
```
    The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.
    
    Returns:
    
    accountOwner
  - setAccountOwner
```
public void setAccountOwner(String accountOwner)
```
  - transactionId
```
public AssetReportTransaction transactionId(String transactionId)
```
  - getTransactionId
```
public String getTransactionId()
```
    The unique ID of the transaction. Like all Plaid identifiers, the `transaction_id` is case sensitive.
    
    Returns:
    
    transactionId
  - setTransactionId
```
public void setTransactionId(String transactionId)
```
  - transactionType
```
public AssetReportTransaction transactionType(AssetReportTransactionType transactionType)
```
  - getTransactionType
```
@Nullable
public AssetReportTransactionType getTransactionType()
```
    Get transactionType
    
    Returns:
    
    transactionType
  - setTransactionType
```
public void setTransactionType(AssetReportTransactionType transactionType)
```
  - incomeSourceId
```
public AssetReportTransaction incomeSourceId(String incomeSourceId)
```
  - getIncomeSourceId
```
@Nullable
public String getIncomeSourceId()
```
    A unique identifier for an income source.
    
    Returns:
    
    incomeSourceId
  - setIncomeSourceId
```
public void setIncomeSourceId(String incomeSourceId)
```
  - 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 AssetReportTransaction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ACCOUNT_ID

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_ISO_CURRENCY_CODE

SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE

SERIALIZED_NAME_ORIGINAL_DESCRIPTION

SERIALIZED_NAME_CATEGORY

SERIALIZED_NAME_CATEGORY_ID

SERIALIZED_NAME_CREDIT_CATEGORY

SERIALIZED_NAME_CHECK_NUMBER

SERIALIZED_NAME_DATE

SERIALIZED_NAME_DATE_TRANSACTED

SERIALIZED_NAME_LOCATION

SERIALIZED_NAME_NAME

SERIALIZED_NAME_MERCHANT_NAME

SERIALIZED_NAME_PAYMENT_META

SERIALIZED_NAME_PENDING

SERIALIZED_NAME_PENDING_TRANSACTION_ID

SERIALIZED_NAME_ACCOUNT_OWNER

SERIALIZED_NAME_TRANSACTION_ID

SERIALIZED_NAME_TRANSACTION_TYPE

SERIALIZED_NAME_INCOME_SOURCE_ID

Constructor Detail

AssetReportTransaction

Method Detail

accountId

getAccountId

setAccountId

amount

getAmount

setAmount

isoCurrencyCode

getIsoCurrencyCode

setIsoCurrencyCode

unofficialCurrencyCode

getUnofficialCurrencyCode

setUnofficialCurrencyCode

originalDescription

getOriginalDescription

setOriginalDescription

category

addCategoryItem

getCategory

setCategory

categoryId

getCategoryId

setCategoryId

creditCategory

getCreditCategory

setCreditCategory

checkNumber

getCheckNumber

setCheckNumber

date

getDate

setDate

dateTransacted

getDateTransacted

setDateTransacted

location

getLocation

setLocation

name

getName

setName

merchantName

getMerchantName

setMerchantName

paymentMeta

getPaymentMeta

setPaymentMeta

pending

getPending

setPending

pendingTransactionId