InvestmentTransaction (com.plaid:plaid-java 29.0.0 API)

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-11-14T16:41:31.650700Z[Etc/UTC]")
public class InvestmentTransaction
extends Object

A transaction within an investment account.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ACCOUNT_ID`
`static String`	`SERIALIZED_NAME_AMOUNT`
`static String`	`SERIALIZED_NAME_CANCEL_TRANSACTION_ID`
`static String`	`SERIALIZED_NAME_DATE`
`static String`	`SERIALIZED_NAME_FEES`
`static String`	`SERIALIZED_NAME_INVESTMENT_TRANSACTION_ID`
`static String`	`SERIALIZED_NAME_ISO_CURRENCY_CODE`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_PRICE`
`static String`	`SERIALIZED_NAME_QUANTITY`
`static String`	`SERIALIZED_NAME_SECURITY_ID`
`static String`	`SERIALIZED_NAME_SUBTYPE`
`static String`	`SERIALIZED_NAME_TYPE`
`static String`	`SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE`

Constructor Summary

Constructors
Constructor and Description

InvestmentTransaction()

Constructors
Constructor and Description
`InvestmentTransaction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InvestmentTransaction`	`accountId(String accountId)`
`InvestmentTransaction`	`amount(Double amount)`
`InvestmentTransaction`	`cancelTransactionId(String cancelTransactionId)`
`InvestmentTransaction`	`date(LocalDate date)`
`boolean`	`equals(Object o)`
`InvestmentTransaction`	`fees(Double fees)`
`String`	`getAccountId()` The `account_id` of the account against which this transaction posted.
`Double`	`getAmount()` The complete value of the transaction.
`String`	`getCancelTransactionId()` A legacy field formerly used internally by Plaid to identify certain canceled transactions.
`LocalDate`	`getDate()` The [ISO 8601](https://wikipedia.org/wiki/ISO_8601) posting date for the transaction.
`Double`	`getFees()` The combined value of all fees applied to this transaction
`String`	`getInvestmentTransactionId()` The ID of the Investment transaction, unique across all Plaid transactions.
`String`	`getIsoCurrencyCode()` The ISO-4217 currency code of the transaction.
`String`	`getName()` The institution’s description of the transaction.
`Double`	`getPrice()` The price of the security at which this transaction occurred.
`Double`	`getQuantity()` The number of units of the security involved in this transaction.
`String`	`getSecurityId()` The `security_id` to which this transaction is related.
`InvestmentTransactionSubtype`	`getSubtype()` Get subtype
`InvestmentTransactionType`	`getType()` Get type
`String`	`getUnofficialCurrencyCode()` The unofficial currency code associated with the holding.
`int`	`hashCode()`
`InvestmentTransaction`	`investmentTransactionId(String investmentTransactionId)`
`InvestmentTransaction`	`isoCurrencyCode(String isoCurrencyCode)`
`InvestmentTransaction`	`name(String name)`
`InvestmentTransaction`	`price(Double price)`
`InvestmentTransaction`	`quantity(Double quantity)`
`InvestmentTransaction`	`securityId(String securityId)`
`void`	`setAccountId(String accountId)`
`void`	`setAmount(Double amount)`
`void`	`setCancelTransactionId(String cancelTransactionId)`
`void`	`setDate(LocalDate date)`
`void`	`setFees(Double fees)`
`void`	`setInvestmentTransactionId(String investmentTransactionId)`
`void`	`setIsoCurrencyCode(String isoCurrencyCode)`
`void`	`setName(String name)`
`void`	`setPrice(Double price)`
`void`	`setQuantity(Double quantity)`
`void`	`setSecurityId(String securityId)`
`void`	`setSubtype(InvestmentTransactionSubtype subtype)`
`void`	`setType(InvestmentTransactionType type)`
`void`	`setUnofficialCurrencyCode(String unofficialCurrencyCode)`
`InvestmentTransaction`	`subtype(InvestmentTransactionSubtype subtype)`
`String`	`toString()`
`InvestmentTransaction`	`type(InvestmentTransactionType type)`
`InvestmentTransaction`	`unofficialCurrencyCode(String unofficialCurrencyCode)`

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

- Field Detail
  - SERIALIZED_NAME_INVESTMENT_TRANSACTION_ID
```
public static final String SERIALIZED_NAME_INVESTMENT_TRANSACTION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CANCEL_TRANSACTION_ID
```
public static final String SERIALIZED_NAME_CANCEL_TRANSACTION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACCOUNT_ID
```
public static final String SERIALIZED_NAME_ACCOUNT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SECURITY_ID
```
public static final String SERIALIZED_NAME_SECURITY_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DATE
```
public static final String SERIALIZED_NAME_DATE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NAME
```
public static final String SERIALIZED_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_QUANTITY
```
public static final String SERIALIZED_NAME_QUANTITY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_AMOUNT
```
public static final String SERIALIZED_NAME_AMOUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PRICE
```
public static final String SERIALIZED_NAME_PRICE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FEES
```
public static final String SERIALIZED_NAME_FEES
```
    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_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
  - InvestmentTransaction
```
public InvestmentTransaction()
```
- Method Detail
  - investmentTransactionId
```
public InvestmentTransaction investmentTransactionId(String investmentTransactionId)
```
  - getInvestmentTransactionId
```
public String getInvestmentTransactionId()
```
    The ID of the Investment transaction, unique across all Plaid transactions. Like all Plaid identifiers, the `investment_transaction_id` is case sensitive.
    
    Returns:
    
    investmentTransactionId
  - setInvestmentTransactionId
```
public void setInvestmentTransactionId(String investmentTransactionId)
```
  - cancelTransactionId
```
public InvestmentTransaction cancelTransactionId(String cancelTransactionId)
```
  - getCancelTransactionId
```
@Nullable
public String getCancelTransactionId()
```
    A legacy field formerly used internally by Plaid to identify certain canceled transactions.
    
    Returns:
    
    cancelTransactionId
  - setCancelTransactionId
```
public void setCancelTransactionId(String cancelTransactionId)
```
  - accountId
```
public InvestmentTransaction accountId(String accountId)
```
  - getAccountId
```
public String getAccountId()
```
    The `account_id` of the account against which this transaction posted.
    
    Returns:
    
    accountId
  - setAccountId
```
public void setAccountId(String accountId)
```
  - securityId
```
public InvestmentTransaction securityId(String securityId)
```
  - getSecurityId
```
@Nullable
public String getSecurityId()
```
    The `security_id` to which this transaction is related.
    
    Returns:
    
    securityId
  - setSecurityId
```
public void setSecurityId(String securityId)
```
  - date
```
public InvestmentTransaction date(LocalDate date)
```
  - getDate
```
public LocalDate getDate()
```
    The [ISO 8601](https://wikipedia.org/wiki/ISO_8601) posting date for the transaction.
    
    Returns:
    
    date
  - setDate
```
public void setDate(LocalDate date)
```
  - name
```
public InvestmentTransaction name(String name)
```
  - getName
```
public String getName()
```
    The institution’s description of the transaction.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - quantity
```
public InvestmentTransaction quantity(Double quantity)
```
  - getQuantity
```
public Double getQuantity()
```
    The number of units of the security involved in this transaction. Positive for buy transactions; negative for sell transactions.
    
    Returns:
    
    quantity
  - setQuantity
```
public void setQuantity(Double quantity)
```
  - amount
```
public InvestmentTransaction amount(Double amount)
```
  - getAmount
```
public Double getAmount()
```
    The complete value of the transaction. Positive values when cash is debited, e.g. purchases of stock; negative values when cash is credited, e.g. sales of stock. Treatment remains the same for cash-only movements unassociated with securities.
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Double amount)
```
  - price
```
public InvestmentTransaction price(Double price)
```
  - getPrice
```
public Double getPrice()
```
    The price of the security at which this transaction occurred.
    
    Returns:
    
    price
  - setPrice
```
public void setPrice(Double price)
```
  - fees
```
public InvestmentTransaction fees(Double fees)
```
  - getFees
```
@Nullable
public Double getFees()
```
    The combined value of all fees applied to this transaction
    
    Returns:
    
    fees
  - setFees
```
public void setFees(Double fees)
```
  - type
```
public InvestmentTransaction type(InvestmentTransactionType type)
```
  - getType
```
public InvestmentTransactionType getType()
```
    Get type
    
    Returns:
    
    type
  - setType
```
public void setType(InvestmentTransactionType type)
```
  - subtype
```
public InvestmentTransaction subtype(InvestmentTransactionSubtype subtype)
```
  - getSubtype
```
public InvestmentTransactionSubtype getSubtype()
```
    Get subtype
    
    Returns:
    
    subtype
  - setSubtype
```
public void setSubtype(InvestmentTransactionSubtype subtype)
```
  - isoCurrencyCode
```
public InvestmentTransaction 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 InvestmentTransaction unofficialCurrencyCode(String unofficialCurrencyCode)
```
  - getUnofficialCurrencyCode
```
@Nullable
public String getUnofficialCurrencyCode()
```
    The unofficial currency code associated with the holding. 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 `iso_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

Class InvestmentTransaction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_INVESTMENT_TRANSACTION_ID

SERIALIZED_NAME_CANCEL_TRANSACTION_ID

SERIALIZED_NAME_ACCOUNT_ID

SERIALIZED_NAME_SECURITY_ID

SERIALIZED_NAME_DATE

SERIALIZED_NAME_NAME

SERIALIZED_NAME_QUANTITY

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_PRICE

SERIALIZED_NAME_FEES

SERIALIZED_NAME_TYPE

SERIALIZED_NAME_SUBTYPE

SERIALIZED_NAME_ISO_CURRENCY_CODE

SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE

Constructor Detail

InvestmentTransaction

Method Detail

investmentTransactionId

getInvestmentTransactionId

setInvestmentTransactionId

cancelTransactionId

getCancelTransactionId

setCancelTransactionId

accountId

getAccountId

setAccountId

securityId

getSecurityId

setSecurityId

date

getDate

setDate

name

getName

setName

quantity

getQuantity

setQuantity

amount

getAmount

setAmount

price

getPrice

setPrice

fees

getFees

setFees

type

getType

setType

subtype

getSubtype

setSubtype

isoCurrencyCode

getIsoCurrencyCode

setIsoCurrencyCode

unofficialCurrencyCode

getUnofficialCurrencyCode

setUnofficialCurrencyCode

equals

hashCode

toString