Package markets.alpaca.client.openapi.broker.model

Class AcatsAsset

java.lang.Object
markets.alpaca.client.openapi.broker.model.AcatsAsset
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class AcatsAsset extends Object implements Serializable
An asset included in an ACATS transfer.
See Also:

  • Field Details

  • Constructor Details

    • AcatsAsset

      public AcatsAsset()

  • Method Details

    • amount

      public AcatsAsset amount(@Nullable BigDecimal amount)

    • getAmount

      @Nullable public BigDecimal getAmount()
      Positive number indicating the market value of the assets being transferred
      Returns:
      amount

    • setAmount

      public void setAmount(@Nullable BigDecimal amount)

    • assetClass

      public AcatsAsset assetClass(@Nonnull AcatsAsset.AssetClassEnum assetClass)

    • getAssetClass

      @Nonnull public AcatsAsset.AssetClassEnum getAssetClass()
      Asset type
      Returns:
      assetClass

    • setAssetClass

      public void setAssetClass(@Nonnull AcatsAsset.AssetClassEnum assetClass)

    • assetDescription

      public AcatsAsset assetDescription(@Nonnull String assetDescription)

    • getAssetDescription

      @Nonnull public String getAssetDescription()
      Description, usually from DTCC's Security Master File
      Returns:
      assetDescription

    • setAssetDescription

      public void setAssetDescription(@Nonnull String assetDescription)

    • currencyCode

      public AcatsAsset currencyCode(@Nullable String currencyCode)

    • getCurrencyCode

      @Nullable public String getCurrencyCode()
      ISO currency code in which amount is denominated
      Returns:
      currencyCode

    • setCurrencyCode

      public void setCurrencyCode(@Nullable String currencyCode)

    • cusip

      public AcatsAsset cusip(@Nullable String cusip)

    • getCusip

      @Nullable public String getCusip()
      CUSIP security identifier for the asset. Only returned when a CUSIP was provided for this asset at the time the transfer was initiated, in which case it is returned alongside `symbol`.
      Returns:
      cusip

    • setCusip

      public void setCusip(@Nullable String cusip)

    • isin

      @Deprecated public AcatsAsset isin(@Nullable String isin)
      Deprecated.

    • getIsin

      @Deprecated @Nullable public String getIsin()
      Deprecated.
      **Deprecation notice:** Use `symbol` or `cusip` instead. Returned with all assets only for backward compatibility while consumers migrate. Since: 2026-08-04 Sunset: 2027-02-04 --- ISIN for the asset.
      Returns:
      isin

    • setIsin

      @Deprecated public void setIsin(@Nullable String isin)
      Deprecated.

    • position

      public AcatsAsset position(@Nonnull AcatsPosition position)

    • getPosition

      @Nonnull public AcatsPosition getPosition()
      Get position
      Returns:
      position

    • setPosition

      public void setPosition(@Nonnull AcatsPosition position)

    • qty

      public AcatsAsset qty(@Nullable BigDecimal qty)

    • getQty

      @Nullable public BigDecimal getQty()
      Positive number indicating how many shares or units are being transferred
      Returns:
      qty

    • setQty

      public void setQty(@Nullable BigDecimal qty)

    • rejectionMessage

      public AcatsAsset rejectionMessage(@Nullable String rejectionMessage)

    • getRejectionMessage

      @Nullable public String getRejectionMessage()
      Human readable reason for why an asset is considered ineligible for transfer
      Returns:
      rejectionMessage

    • setRejectionMessage

      public void setRejectionMessage(@Nullable String rejectionMessage)

    • status

      public AcatsAsset status(@Nonnull AcatsAsset.StatusEnum status)

    • getStatus

      @Nonnull public AcatsAsset.StatusEnum getStatus()
      Status
      Returns:
      status

    • setStatus

      public void setStatus(@Nonnull AcatsAsset.StatusEnum status)

    • symbol

      public AcatsAsset symbol(@Nullable String symbol)

    • getSymbol

      @Nullable public String getSymbol()
      Symbol identifier for the asset. Always returned when a symbol is known for the asset, including when the transfer was initiated with a CUSIP.
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nullable String symbol)

    • putAdditionalProperty

      public AcatsAsset putAdditionalProperty(String key, Object value)
      Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
      Parameters:
      key - name of the property
      value - value of the property
      Returns:
      the AcatsAsset instance itself

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      a map of objects

    • getAdditionalProperty

      public Object getAdditionalProperty(String key)
      Return the additional (undeclared) property with the specified name.
      Parameters:
      key - name of the property
      Returns:
      an object

    • 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

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to AcatsAsset

    • fromJson

      public static AcatsAsset fromJson(String jsonString) throws IOException
      Create an instance of AcatsAsset given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of AcatsAsset
      Throws:
      IOException - if the JSON string is invalid with respect to AcatsAsset

    • toJson

      public String toJson()
      Convert an instance of AcatsAsset to an JSON string
      Returns:
      JSON string