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

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

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

A transaction on the Base Report

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ACCOUNT_OWNER`
`static String`	`SERIALIZED_NAME_AMOUNT`
`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_ISO_CURRENCY_CODE`
`static String`	`SERIALIZED_NAME_LOCATION`
`static String`	`SERIALIZED_NAME_MERCHANT_NAME`
`static String`	`SERIALIZED_NAME_ORIGINAL_DESCRIPTION`
`static String`	`SERIALIZED_NAME_PENDING`
`static String`	`SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE`

Constructor Summary

Constructors
Constructor and Description

BaseReportTransaction()

Constructors
Constructor and Description
`BaseReportTransaction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BaseReportTransaction`	`accountOwner(String accountOwner)`
`BaseReportTransaction`	`amount(Double amount)`
`BaseReportTransaction`	`checkNumber(String checkNumber)`
`BaseReportTransaction`	`creditCategory(CreditCategory creditCategory)`
`BaseReportTransaction`	`date(LocalDate date)`
`BaseReportTransaction`	`dateTransacted(String dateTransacted)`
`boolean`	`equals(Object o)`
`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`.
`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`	`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`	`getOriginalDescription()` The string returned by the financial institution to describe the transaction.
`Boolean`	`getPending()` When `true`, identifies the transaction as pending or unsettled.
`String`	`getUnofficialCurrencyCode()` The unofficial currency code associated with the transaction.
`int`	`hashCode()`
`BaseReportTransaction`	`isoCurrencyCode(String isoCurrencyCode)`
`BaseReportTransaction`	`location(Location location)`
`BaseReportTransaction`	`merchantName(String merchantName)`
`BaseReportTransaction`	`originalDescription(String originalDescription)`
`BaseReportTransaction`	`pending(Boolean pending)`
`void`	`setAccountOwner(String accountOwner)`
`void`	`setAmount(Double amount)`
`void`	`setCheckNumber(String checkNumber)`
`void`	`setCreditCategory(CreditCategory creditCategory)`
`void`	`setDate(LocalDate date)`
`void`	`setDateTransacted(String dateTransacted)`
`void`	`setIsoCurrencyCode(String isoCurrencyCode)`
`void`	`setLocation(Location location)`
`void`	`setMerchantName(String merchantName)`
`void`	`setOriginalDescription(String originalDescription)`
`void`	`setPending(Boolean pending)`
`void`	`setUnofficialCurrencyCode(String unofficialCurrencyCode)`
`String`	`toString()`
`BaseReportTransaction`	`unofficialCurrencyCode(String unofficialCurrencyCode)`

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

- Field Detail
  - 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_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_MERCHANT_NAME
```
public static final String SERIALIZED_NAME_MERCHANT_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PENDING
```
public static final String SERIALIZED_NAME_PENDING
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACCOUNT_OWNER
```
public static final String SERIALIZED_NAME_ACCOUNT_OWNER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BaseReportTransaction
```
public BaseReportTransaction()
```
- Method Detail
  - amount
```
public BaseReportTransaction 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 BaseReportTransaction 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 BaseReportTransaction 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 BaseReportTransaction 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)
```
  - creditCategory
```
public BaseReportTransaction creditCategory(CreditCategory creditCategory)
```
  - getCreditCategory
```
@Nullable
public CreditCategory getCreditCategory()
```
    Get creditCategory
    
    Returns:
    
    creditCategory
  - setCreditCategory
```
public void setCreditCategory(CreditCategory creditCategory)
```
  - checkNumber
```
public BaseReportTransaction 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 BaseReportTransaction 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 BaseReportTransaction 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 BaseReportTransaction location(Location location)
```
  - getLocation
```
@Nullable
public Location getLocation()
```
    Get location
    
    Returns:
    
    location
  - setLocation
```
public void setLocation(Location location)
```
  - merchantName
```
public BaseReportTransaction 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)
```
  - pending
```
public BaseReportTransaction 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)
```
  - accountOwner
```
public BaseReportTransaction 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)
```
  - 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 BaseReportTransaction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_ISO_CURRENCY_CODE

SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE

SERIALIZED_NAME_ORIGINAL_DESCRIPTION

SERIALIZED_NAME_CREDIT_CATEGORY

SERIALIZED_NAME_CHECK_NUMBER

SERIALIZED_NAME_DATE

SERIALIZED_NAME_DATE_TRANSACTED

SERIALIZED_NAME_LOCATION

SERIALIZED_NAME_MERCHANT_NAME

SERIALIZED_NAME_PENDING

SERIALIZED_NAME_ACCOUNT_OWNER

Constructor Detail

BaseReportTransaction

Method Detail

amount

getAmount

setAmount

isoCurrencyCode

getIsoCurrencyCode

setIsoCurrencyCode

unofficialCurrencyCode

getUnofficialCurrencyCode

setUnofficialCurrencyCode

originalDescription

getOriginalDescription

setOriginalDescription

creditCategory

getCreditCategory

setCreditCategory

checkNumber

getCheckNumber

setCheckNumber

date

getDate

setDate

dateTransacted

getDateTransacted

setDateTransacted

location

getLocation

setLocation

merchantName

getMerchantName

setMerchantName

pending

getPending

setPending

accountOwner

getAccountOwner

setAccountOwner

equals

hashCode

toString