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

Class NonTradeActivity

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

  • Field Details

  • Constructor Details

    • NonTradeActivity

      public NonTradeActivity()

  • Method Details

    • activitySubType

      public NonTradeActivity activitySubType(@Nullable String activitySubType)

    • getActivitySubType

      @Nullable public String getActivitySubType()
      Represents a more specific classification to the `activity_type`. This field is optional and may not always be populated, depending on the activity type and the available data. Each `activity_type` has a set of valid `activity_sub_type` values. Full mapping of `activity_type` to `activity_sub_type`: - **CGD**: Capital Gains Distribution activity sub-types: - **LTCG**: Long-Term Capital Gain - **STCG**: Short-Term Capital Gain - **DIV**: Dividend activity sub-types: - **CDIV**: Cash Dividend - **ROC**: Return of Capital - **SDIV**: Stock Dividend - **SPD**: Substitute Payment In Lieu Of Dividend - **FEE**: Fee-related activity sub-types: - **REG**: Regulatory Fee - **TAF**: Trading Activity Fee - **LCT**: Local Currency Trading Fee - **ORF**: Options Regulatory Fee - **OCC**: Options Clearing Corporation Fee - **NRC**: Non-Retail Commission Fee - **NRV**: Non-Retail Venue Fee - **COM**: Commission - **CAT**: Consolidated Audit Trail Fee - **INT**: Interest-related activity sub-types: - **MGN**: Margin Interest - **CDT**: Credit Interest - **SWP**: Sweep Interest - **QII**: Qualified Interest - **FI**: Fixed Income Interest (coupon or accrued) - **MA**: Merger and Acquisition activity sub-types: - **CMA**: Cash Merger - **SMA**: Stock Merger - **SCMA**: Stock & Cash Merger - **NC**: Name Change activity sub types - **SNC**: Symbol Name Change - **CNC**: CUSIP Name Change - **SCNC**: Symbol & CUSIP Name Change - **OPCA**: Option Corporate Action activity sub-types: - **DIV.CDIV**: Cash Dividend - **DIV.ROC**: Return of Capital - **DIV.SDIV**: Stock Dividend - **MA.CMA**: Cash Merger - **MA.SMA**: Stock Merger - **MA.SCMA**: Stock & Cash Merger - **NC.CNC**: CUSIP Name Change - **NC.SNC**: Symbol Name Change - **NC.SCNC**: Symbol & CUSIP Name Change - **SPIN**: Spin-off - **SPLIT.FSPLIT**: Forward Stock Split - **SPLIT.RSPLIT**: Reverse Stock Split - **SPLIT.USPLIT**: Unit Split - **REO**: Reorganization activity sub-types: - **REOS**: Stock only (1 or more stock legs) - **REOC**: Cash only (one cash leg) - **REOSC**: Stock and cash - **REORG**: Activity sub-types: - **WRM**: Worthless Removal - **SPLIT**: Stock Split activity sub-types: - **FSPLIT**: Forward Stock Split - **RSPLIT**: Reverse Stock Split - **USPLIT**: Unit Split - **VOF**: Voluntary Offering activity sub-types: - **VTND**: Tender Offer - **VWRT**: Warrant Exercise - **VRGT**: Rights Offer - **VEXH**: Exchange Offer - **WH**: Withholding activity sub-types: - **SWH**: State Withholding - **FWH**: Federal Withholding - **SLWH**: Sales Withholding
      Returns:
      activitySubType

    • setActivitySubType

      public void setActivitySubType(@Nullable String activitySubType)

    • createdAt

      public NonTradeActivity createdAt(@Nullable OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      Valid only for non-trading activity types. Null for trading activities.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable OffsetDateTime createdAt)

    • currency

      public NonTradeActivity currency(@Nullable String currency)

    • getCurrency

      @Nullable public String getCurrency()
      Currency denomination of the activity. USD by default.
      Returns:
      currency

    • setCurrency

      public void setCurrency(@Nullable String currency)

    • cusip

      public NonTradeActivity cusip(@Nullable String cusip)

    • getCusip

      @Nullable public String getCusip()
      Valid only for non-trading activity types. Null for trading activities.
      Returns:
      cusip

    • setCusip

      public void setCusip(@Nullable String cusip)

    • date

      public NonTradeActivity date(@Nullable LocalDate date)

    • getDate

      @Nullable public LocalDate getDate()
      Valid only for non-trading activity types. Null for trading activities.
      Returns:
      date

    • setDate

      public void setDate(@Nullable LocalDate date)

    • description

      public NonTradeActivity description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Valid only for non-trading activity types. Null for trading activities.
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • groupId

      public NonTradeActivity groupId(@Nullable UUID groupId)

    • getGroupId

      @Nullable public UUID getGroupId()
      ID used to link activities who share a sibling relationship
      Returns:
      groupId

    • setGroupId

      public void setGroupId(@Nullable UUID groupId)

    • netAmount

      public NonTradeActivity netAmount(@Nullable BigDecimal netAmount)

    • getNetAmount

      @Nullable public BigDecimal getNetAmount()
      Valid only for non-trading activity types. Null for trading activities.
      Returns:
      netAmount

    • setNetAmount

      public void setNetAmount(@Nullable BigDecimal netAmount)

    • perShareAmount

      public NonTradeActivity perShareAmount(@Nullable BigDecimal perShareAmount)

    • getPerShareAmount

      @Nullable public BigDecimal getPerShareAmount()
      Valid only for non-trading activity types. Null for trading activities.
      Returns:
      perShareAmount

    • setPerShareAmount

      public void setPerShareAmount(@Nullable BigDecimal perShareAmount)

    • qty

      public NonTradeActivity qty(@Nullable BigDecimal qty)

    • getQty

      @Nullable public BigDecimal getQty()
      Valid only for non-trading activity types. Null for trading activities.
      Returns:
      qty

    • setQty

      public void setQty(@Nullable BigDecimal qty)

    • status

      public NonTradeActivity status(@Nullable NonTradeActivity.StatusEnum status)

    • getStatus

      @Nullable public NonTradeActivity.StatusEnum getStatus()
      Valid only for non-trading activity types. Null for trading activities.
      Returns:
      status

    • setStatus

      public void setStatus(@Nullable NonTradeActivity.StatusEnum status)

    • symbol

      public NonTradeActivity symbol(@Nullable String symbol)

    • getSymbol

      @Nullable public String getSymbol()
      Valid only for non-trading activity types. Null for trading activities.
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nullable String symbol)

    • transferId

      public NonTradeActivity transferId(@Nullable UUID transferId)

    • getTransferId

      @Nullable public UUID getTransferId()
      The transfer ID of the associated deposit or withdrawal. Populated for `OCT` (On Chain Transactions) activities.
      Returns:
      transferId

    • setTransferId

      public void setTransferId(@Nullable UUID transferId)

    • putAdditionalProperty

      public NonTradeActivity 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 NonTradeActivity 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 NonTradeActivity

    • fromJson

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

    • toJson

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