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

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

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

A securities holding at an institution.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ACCOUNT_ID`
`static String`	`SERIALIZED_NAME_COST_BASIS`
`static String`	`SERIALIZED_NAME_INSTITUTION_PRICE`
`static String`	`SERIALIZED_NAME_INSTITUTION_PRICE_AS_OF`
`static String`	`SERIALIZED_NAME_INSTITUTION_PRICE_DATETIME`
`static String`	`SERIALIZED_NAME_INSTITUTION_VALUE`
`static String`	`SERIALIZED_NAME_ISO_CURRENCY_CODE`
`static String`	`SERIALIZED_NAME_QUANTITY`
`static String`	`SERIALIZED_NAME_SECURITY_ID`
`static String`	`SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE`
`static String`	`SERIALIZED_NAME_VESTED_QUANTITY`
`static String`	`SERIALIZED_NAME_VESTED_VALUE`

Constructor Summary

Constructors
Constructor and Description

Holding()

Constructors
Constructor and Description
`Holding()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Holding`	`accountId(String accountId)`
`Holding`	`costBasis(Double costBasis)`
`boolean`	`equals(Object o)`
`String`	`getAccountId()` The Plaid `account_id` associated with the holding.
`Double`	`getCostBasis()` The total cost basis of the holding (e.g., the total amount spent to acquire all assets currently in the holding).
`Double`	`getInstitutionPrice()` The last price given by the institution for this security.
`LocalDate`	`getInstitutionPriceAsOf()` The date at which `institution_price` was current.
`OffsetDateTime`	`getInstitutionPriceDatetime()` Date and time at which `institution_price` was current, in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ).
`Double`	`getInstitutionValue()` The value of the holding, as reported by the institution.
`String`	`getIsoCurrencyCode()` The ISO-4217 currency code of the holding.
`Double`	`getQuantity()` The total quantity of the asset held, as reported by the financial institution.
`String`	`getSecurityId()` The Plaid `security_id` associated with the holding.
`String`	`getUnofficialCurrencyCode()` The unofficial currency code associated with the holding.
`Double`	`getVestedQuantity()` The total quantity of vested assets held, as reported by the financial institution.
`Double`	`getVestedValue()` The value of the vested holdings as reported by the institution.
`int`	`hashCode()`
`Holding`	`institutionPrice(Double institutionPrice)`
`Holding`	`institutionPriceAsOf(LocalDate institutionPriceAsOf)`
`Holding`	`institutionPriceDatetime(OffsetDateTime institutionPriceDatetime)`
`Holding`	`institutionValue(Double institutionValue)`
`Holding`	`isoCurrencyCode(String isoCurrencyCode)`
`Holding`	`quantity(Double quantity)`
`Holding`	`securityId(String securityId)`
`void`	`setAccountId(String accountId)`
`void`	`setCostBasis(Double costBasis)`
`void`	`setInstitutionPrice(Double institutionPrice)`
`void`	`setInstitutionPriceAsOf(LocalDate institutionPriceAsOf)`
`void`	`setInstitutionPriceDatetime(OffsetDateTime institutionPriceDatetime)`
`void`	`setInstitutionValue(Double institutionValue)`
`void`	`setIsoCurrencyCode(String isoCurrencyCode)`
`void`	`setQuantity(Double quantity)`
`void`	`setSecurityId(String securityId)`
`void`	`setUnofficialCurrencyCode(String unofficialCurrencyCode)`
`void`	`setVestedQuantity(Double vestedQuantity)`
`void`	`setVestedValue(Double vestedValue)`
`String`	`toString()`
`Holding`	`unofficialCurrencyCode(String unofficialCurrencyCode)`
`Holding`	`vestedQuantity(Double vestedQuantity)`
`Holding`	`vestedValue(Double vestedValue)`

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_SECURITY_ID
```
public static final String SERIALIZED_NAME_SECURITY_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INSTITUTION_PRICE
```
public static final String SERIALIZED_NAME_INSTITUTION_PRICE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INSTITUTION_PRICE_AS_OF
```
public static final String SERIALIZED_NAME_INSTITUTION_PRICE_AS_OF
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INSTITUTION_PRICE_DATETIME
```
public static final String SERIALIZED_NAME_INSTITUTION_PRICE_DATETIME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INSTITUTION_VALUE
```
public static final String SERIALIZED_NAME_INSTITUTION_VALUE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_COST_BASIS
```
public static final String SERIALIZED_NAME_COST_BASIS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_QUANTITY
```
public static final String SERIALIZED_NAME_QUANTITY
```
    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_VESTED_QUANTITY
```
public static final String SERIALIZED_NAME_VESTED_QUANTITY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VESTED_VALUE
```
public static final String SERIALIZED_NAME_VESTED_VALUE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Holding
```
public Holding()
```
- Method Detail
  - accountId
```
public Holding accountId(String accountId)
```
  - getAccountId
```
public String getAccountId()
```
    The Plaid `account_id` associated with the holding.
    
    Returns:
    
    accountId
  - setAccountId
```
public void setAccountId(String accountId)
```
  - securityId
```
public Holding securityId(String securityId)
```
  - getSecurityId
```
public String getSecurityId()
```
    The Plaid `security_id` associated with the holding. Security data is not specific to a user's account; any user who held the same security at the same financial institution at the same time would have identical security data. The `security_id` for the same security will typically be the same across different institutions, but this is not guaranteed. The `security_id` does not typically change, but may change if inherent details of the security change due to a corporate action, for example, in the event of a ticker symbol change or CUSIP change.
    
    Returns:
    
    securityId
  - setSecurityId
```
public void setSecurityId(String securityId)
```
  - institutionPrice
```
public Holding institutionPrice(Double institutionPrice)
```
  - getInstitutionPrice
```
public Double getInstitutionPrice()
```
    The last price given by the institution for this security.
    
    Returns:
    
    institutionPrice
  - setInstitutionPrice
```
public void setInstitutionPrice(Double institutionPrice)
```
  - institutionPriceAsOf
```
public Holding institutionPriceAsOf(LocalDate institutionPriceAsOf)
```
  - getInstitutionPriceAsOf
```
@Nullable
public LocalDate getInstitutionPriceAsOf()
```
    The date at which `institution_price` was current.
    
    Returns:
    
    institutionPriceAsOf
  - setInstitutionPriceAsOf
```
public void setInstitutionPriceAsOf(LocalDate institutionPriceAsOf)
```
  - institutionPriceDatetime
```
public Holding institutionPriceDatetime(OffsetDateTime institutionPriceDatetime)
```
  - getInstitutionPriceDatetime
```
@Nullable
public OffsetDateTime getInstitutionPriceDatetime()
```
    Date and time at which `institution_price` was current, in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00).
    
    Returns:
    
    institutionPriceDatetime
  - setInstitutionPriceDatetime
```
public void setInstitutionPriceDatetime(OffsetDateTime institutionPriceDatetime)
```
  - institutionValue
```
public Holding institutionValue(Double institutionValue)
```
  - getInstitutionValue
```
public Double getInstitutionValue()
```
    The value of the holding, as reported by the institution.
    
    Returns:
    
    institutionValue
  - setInstitutionValue
```
public void setInstitutionValue(Double institutionValue)
```
  - costBasis
```
public Holding costBasis(Double costBasis)
```
  - getCostBasis
```
@Nullable
public Double getCostBasis()
```
    The total cost basis of the holding (e.g., the total amount spent to acquire all assets currently in the holding).
    
    Returns:
    
    costBasis
  - setCostBasis
```
public void setCostBasis(Double costBasis)
```
  - quantity
```
public Holding quantity(Double quantity)
```
  - getQuantity
```
public Double getQuantity()
```
    The total quantity of the asset held, as reported by the financial institution. If the security is an option, `quantity` will reflect the total number of options (typically the number of contracts multiplied by 100), not the number of contracts.
    
    Returns:
    
    quantity
  - setQuantity
```
public void setQuantity(Double quantity)
```
  - isoCurrencyCode
```
public Holding isoCurrencyCode(String isoCurrencyCode)
```
  - getIsoCurrencyCode
```
@Nullable
public String getIsoCurrencyCode()
```
    The ISO-4217 currency code of the holding. Always `null` if `unofficial_currency_code` is non-`null`.
    
    Returns:
    
    isoCurrencyCode
  - setIsoCurrencyCode
```
public void setIsoCurrencyCode(String isoCurrencyCode)
```
  - unofficialCurrencyCode
```
public Holding 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)
```
  - vestedQuantity
```
public Holding vestedQuantity(Double vestedQuantity)
```
  - getVestedQuantity
```
@Nullable
public Double getVestedQuantity()
```
    The total quantity of vested assets held, as reported by the financial institution. Vested assets are only associated with [equities](https://plaid.com/docs/api/products/investments/#investments-holdings-get-response-securities-type).
    
    Returns:
    
    vestedQuantity
  - setVestedQuantity
```
public void setVestedQuantity(Double vestedQuantity)
```
  - vestedValue
```
public Holding vestedValue(Double vestedValue)
```
  - getVestedValue
```
@Nullable
public Double getVestedValue()
```
    The value of the vested holdings as reported by the institution.
    
    Returns:
    
    vestedValue
  - setVestedValue
```
public void setVestedValue(Double vestedValue)
```
  - 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 Holding

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ACCOUNT_ID

SERIALIZED_NAME_SECURITY_ID

SERIALIZED_NAME_INSTITUTION_PRICE

SERIALIZED_NAME_INSTITUTION_PRICE_AS_OF

SERIALIZED_NAME_INSTITUTION_PRICE_DATETIME

SERIALIZED_NAME_INSTITUTION_VALUE

SERIALIZED_NAME_COST_BASIS

SERIALIZED_NAME_QUANTITY

SERIALIZED_NAME_ISO_CURRENCY_CODE

SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE

SERIALIZED_NAME_VESTED_QUANTITY

SERIALIZED_NAME_VESTED_VALUE

Constructor Detail

Holding

Method Detail

accountId

getAccountId

setAccountId

securityId

getSecurityId

setSecurityId

institutionPrice

getInstitutionPrice

setInstitutionPrice

institutionPriceAsOf

getInstitutionPriceAsOf

setInstitutionPriceAsOf

institutionPriceDatetime

getInstitutionPriceDatetime

setInstitutionPriceDatetime

institutionValue

getInstitutionValue

setInstitutionValue

costBasis

getCostBasis

setCostBasis

quantity

getQuantity

setQuantity

isoCurrencyCode

getIsoCurrencyCode

setIsoCurrencyCode

unofficialCurrencyCode

getUnofficialCurrencyCode

setUnofficialCurrencyCode

vestedQuantity

getVestedQuantity

setVestedQuantity

vestedValue

getVestedValue

setVestedValue

equals

hashCode

toString