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

Class ActivityV2DetailNTA

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

  • Field Details

  • Constructor Details

    • ActivityV2DetailNTA

      public ActivityV2DetailNTA()

  • Method Details

    • groupId

      public ActivityV2DetailNTA groupId(@Nonnull UUID groupId)

    • getGroupId

      @Nonnull public UUID getGroupId()
      Optional group ID which can help grouping together related activities
      Returns:
      groupId

    • setGroupId

      public void setGroupId(@Nonnull UUID groupId)

    • systemDate

      public ActivityV2DetailNTA systemDate(@Nonnull LocalDate systemDate)

    • getSystemDate

      @Nonnull public LocalDate getSystemDate()
      The date when the activity was booked
      Returns:
      systemDate

    • setSystemDate

      public void setSystemDate(@Nonnull LocalDate systemDate)

    • caId

      public ActivityV2DetailNTA caId(@Nonnull String caId)

    • getCaId

      @Nonnull public String getCaId()
      The unique identifier for this corporate action
      Returns:
      caId

    • setCaId

      public void setCaId(@Nonnull String caId)

    • positionDate

      public ActivityV2DetailNTA positionDate(@Nonnull LocalDate positionDate)

    • getPositionDate

      @Nonnull public LocalDate getPositionDate()
      The position_date for this corporate action
      Returns:
      positionDate

    • setPositionDate

      public void setPositionDate(@Nonnull LocalDate positionDate)

    • reorgId

      public ActivityV2DetailNTA reorgId(@Nullable String reorgId)

    • getReorgId

      @Nullable public String getReorgId()
      The reorg identifier, if present in the source corporate action definition
      Returns:
      reorgId

    • setReorgId

      public void setReorgId(@Nullable String reorgId)

    • cashPayout

      public ActivityV2DetailNTA cashPayout(@Nonnull String cashPayout)

    • getCashPayout

      @Nonnull public String getCashPayout()
      The cash payout
      Returns:
      cashPayout

    • setCashPayout

      public void setCashPayout(@Nonnull String cashPayout)

    • cusip

      public ActivityV2DetailNTA cusip(@Nonnull String cusip)

    • getCusip

      @Nonnull public String getCusip()
      The CUSIP of the security involved with the activity
      Returns:
      cusip

    • setCusip

      public void setCusip(@Nonnull String cusip)

    • dueBillOffDate

      public ActivityV2DetailNTA dueBillOffDate(@Nullable LocalDate dueBillOffDate)

    • getDueBillOffDate

      @Nullable public LocalDate getDueBillOffDate()
      When due bills stop applying for this event
      Returns:
      dueBillOffDate

    • setDueBillOffDate

      public void setDueBillOffDate(@Nullable LocalDate dueBillOffDate)

    • dueBillOnDate

      public ActivityV2DetailNTA dueBillOnDate(@Nullable LocalDate dueBillOnDate)

    • getDueBillOnDate

      @Nullable public LocalDate getDueBillOnDate()
      When due bills begin to apply for this event
      Returns:
      dueBillOnDate

    • setDueBillOnDate

      public void setDueBillOnDate(@Nullable LocalDate dueBillOnDate)

    • entitledQty

      public ActivityV2DetailNTA entitledQty(@Nonnull String entitledQty)

    • getEntitledQty

      @Nonnull public String getEntitledQty()
      Quantity of shares entitled to receive the dividend
      Returns:
      entitledQty

    • setEntitledQty

      public void setEntitledQty(@Nonnull String entitledQty)

    • exDate

      public ActivityV2DetailNTA exDate(@Nullable LocalDate exDate)

    • getExDate

      @Nullable public LocalDate getExDate()
      The ex_date for this corporate action
      Returns:
      exDate

    • setExDate

      public void setExDate(@Nullable LocalDate exDate)

    • foreign

      public ActivityV2DetailNTA foreign(@Nonnull Boolean foreign)

    • getForeign

      @Nonnull public Boolean getForeign()
      Indicates if related to a non-US security
      Returns:
      foreign

    • setForeign

      public void setForeign(@Nonnull Boolean foreign)

    • payableDate

      public ActivityV2DetailNTA payableDate(@Nonnull LocalDate payableDate)

    • getPayableDate

      @Nonnull public LocalDate getPayableDate()
      The payable_date for this corporate action
      Returns:
      payableDate

    • setPayableDate

      public void setPayableDate(@Nonnull LocalDate payableDate)

    • rate

      public ActivityV2DetailNTA rate(@Nonnull String rate)

    • getRate

      @Nonnull public String getRate()
      The rate for the rights distribution
      Returns:
      rate

    • setRate

      public void setRate(@Nonnull String rate)

    • recordDate

      public ActivityV2DetailNTA recordDate(@Nullable LocalDate recordDate)

    • getRecordDate

      @Nullable public LocalDate getRecordDate()
      The record_date for this corporate action
      Returns:
      recordDate

    • setRecordDate

      public void setRecordDate(@Nullable LocalDate recordDate)

    • special

      public ActivityV2DetailNTA special(@Nonnull Boolean special)

    • getSpecial

      @Nonnull public Boolean getSpecial()
      Indicates if this is a special dividend
      Returns:
      special

    • setSpecial

      public void setSpecial(@Nonnull Boolean special)

    • symbol

      public ActivityV2DetailNTA symbol(@Nonnull String symbol)

    • getSymbol

      @Nonnull public String getSymbol()
      The symbol of the security involved with the activity
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • newQty

      public ActivityV2DetailNTA newQty(@Nonnull String newQty)

    • getNewQty

      @Nonnull public String getNewQty()
      used when the old contract's quantity is not equal to the new contract's quantity. Mutually exclusive with 'qty'.
      Returns:
      newQty

    • setNewQty

      public void setNewQty(@Nonnull String newQty)

    • paidQty

      public ActivityV2DetailNTA paidQty(@Nonnull String paidQty)

    • getPaidQty

      @Nonnull public String getPaidQty()
      The paid quantity
      Returns:
      paidQty

    • setPaidQty

      public void setPaidQty(@Nonnull String paidQty)

    • newCusip

      public ActivityV2DetailNTA newCusip(@Nonnull String newCusip)

    • getNewCusip

      @Nonnull public String getNewCusip()
      CUSIP of the new security
      Returns:
      newCusip

    • setNewCusip

      public void setNewCusip(@Nonnull String newCusip)

    • newRate

      public ActivityV2DetailNTA newRate(@Nonnull String newRate)

    • getNewRate

      @Nonnull public String getNewRate()
      Ratio of new shares received
      Returns:
      newRate

    • setNewRate

      public void setNewRate(@Nonnull String newRate)

    • oldCusip

      public ActivityV2DetailNTA oldCusip(@Nonnull String oldCusip)

    • getOldCusip

      @Nonnull public String getOldCusip()
      Old CUSIP for the name change
      Returns:
      oldCusip

    • setOldCusip

      public void setOldCusip(@Nonnull String oldCusip)

    • oldRate

      public ActivityV2DetailNTA oldRate(@Nonnull String oldRate)

    • getOldRate

      @Nonnull public String getOldRate()
      Ratio of old shares exchanged
      Returns:
      oldRate

    • setOldRate

      public void setOldRate(@Nonnull String oldRate)

    • oldQty

      public ActivityV2DetailNTA oldQty(@Nonnull String oldQty)

    • getOldQty

      @Nonnull public String getOldQty()
      used when the old contract's quantity is not equal to the new contract's quantity. Mutually exclusive with 'qty'.
      Returns:
      oldQty

    • setOldQty

      public void setOldQty(@Nonnull String oldQty)

    • dueBillRedemptionDate

      public ActivityV2DetailNTA dueBillRedemptionDate(@Nullable LocalDate dueBillRedemptionDate)

    • getDueBillRedemptionDate

      @Nullable public LocalDate getDueBillRedemptionDate()
      When due bills related to the split are redeemed
      Returns:
      dueBillRedemptionDate

    • setDueBillRedemptionDate

      public void setDueBillRedemptionDate(@Nullable LocalDate dueBillRedemptionDate)

    • newSymbol

      public ActivityV2DetailNTA newSymbol(@Nonnull String newSymbol)

    • getNewSymbol

      @Nonnull public String getNewSymbol()
      Symbol of the new security after the unit split
      Returns:
      newSymbol

    • setNewSymbol

      public void setNewSymbol(@Nonnull String newSymbol)

    • alternateCusip

      public ActivityV2DetailNTA alternateCusip(@Nonnull String alternateCusip)

    • getAlternateCusip

      @Nonnull public String getAlternateCusip()
      CUSIP for the alternate security after the split
      Returns:
      alternateCusip

    • setAlternateCusip

      public void setAlternateCusip(@Nonnull String alternateCusip)

    • alternateQty

      public ActivityV2DetailNTA alternateQty(@Nonnull String alternateQty)

    • getAlternateQty

      @Nonnull public String getAlternateQty()
      Quantity of alternate shares received
      Returns:
      alternateQty

    • setAlternateQty

      public void setAlternateQty(@Nonnull String alternateQty)

    • alternateRate

      public ActivityV2DetailNTA alternateRate(@Nonnull String alternateRate)

    • getAlternateRate

      @Nonnull public String getAlternateRate()
      Ratio of alternate shares received
      Returns:
      alternateRate

    • setAlternateRate

      public void setAlternateRate(@Nonnull String alternateRate)

    • alternateSymbol

      public ActivityV2DetailNTA alternateSymbol(@Nonnull String alternateSymbol)

    • getAlternateSymbol

      @Nonnull public String getAlternateSymbol()
      Symbol for the alternate security after the split
      Returns:
      alternateSymbol

    • setAlternateSymbol

      public void setAlternateSymbol(@Nonnull String alternateSymbol)

    • effectiveDate

      public ActivityV2DetailNTA effectiveDate(@Nonnull LocalDate effectiveDate)

    • getEffectiveDate

      @Nonnull public LocalDate getEffectiveDate()
      When the unit split becomes effective
      Returns:
      effectiveDate

    • setEffectiveDate

      public void setEffectiveDate(@Nonnull LocalDate effectiveDate)

    • oldSymbol

      public ActivityV2DetailNTA oldSymbol(@Nonnull String oldSymbol)

    • getOldSymbol

      @Nonnull public String getOldSymbol()
      The old symbol of the security involved with the activity
      Returns:
      oldSymbol

    • setOldSymbol

      public void setOldSymbol(@Nonnull String oldSymbol)

    • newPrice

      public ActivityV2DetailNTA newPrice(@Nonnull String newPrice)

    • getNewPrice

      @Nonnull public String getNewPrice()
      Market price of new shares after the spinoff
      Returns:
      newPrice

    • setNewPrice

      public void setNewPrice(@Nonnull String newPrice)

    • sourceCusip

      public ActivityV2DetailNTA sourceCusip(@Nonnull String sourceCusip)

    • getSourceCusip

      @Nonnull public String getSourceCusip()
      CUSIP of the parent security
      Returns:
      sourceCusip

    • setSourceCusip

      public void setSourceCusip(@Nonnull String sourceCusip)

    • sourcePrice

      public ActivityV2DetailNTA sourcePrice(@Nonnull String sourcePrice)

    • getSourcePrice

      @Nonnull public String getSourcePrice()
      Market price of parent shares before the spinoff
      Returns:
      sourcePrice

    • setSourcePrice

      public void setSourcePrice(@Nonnull String sourcePrice)

    • sourceRate

      public ActivityV2DetailNTA sourceRate(@Nonnull String sourceRate)

    • getSourceRate

      @Nonnull public String getSourceRate()
      Ratio of parent shares
      Returns:
      sourceRate

    • setSourceRate

      public void setSourceRate(@Nonnull String sourceRate)

    • sourceSymbol

      public ActivityV2DetailNTA sourceSymbol(@Nonnull String sourceSymbol)

    • getSourceSymbol

      @Nonnull public String getSourceSymbol()
      Symbol of the parent security
      Returns:
      sourceSymbol

    • setSourceSymbol

      public void setSourceSymbol(@Nonnull String sourceSymbol)

    • sourceQty

      public ActivityV2DetailNTA sourceQty(@Nonnull String sourceQty)

    • getSourceQty

      @Nonnull public String getSourceQty()
      The source quantity
      Returns:
      sourceQty

    • setSourceQty

      public void setSourceQty(@Nonnull String sourceQty)

    • acquireeCusip

      public ActivityV2DetailNTA acquireeCusip(@Nonnull String acquireeCusip)

    • getAcquireeCusip

      @Nonnull public String getAcquireeCusip()
      CUSIP of the acquiree
      Returns:
      acquireeCusip

    • setAcquireeCusip

      public void setAcquireeCusip(@Nonnull String acquireeCusip)

    • acquireeRate

      public ActivityV2DetailNTA acquireeRate(@Nullable String acquireeRate)

    • getAcquireeRate

      @Nullable public String getAcquireeRate()
      Rate of the acquiree
      Returns:
      acquireeRate

    • setAcquireeRate

      public void setAcquireeRate(@Nullable String acquireeRate)

    • acquireeSymbol

      public ActivityV2DetailNTA acquireeSymbol(@Nonnull String acquireeSymbol)

    • getAcquireeSymbol

      @Nonnull public String getAcquireeSymbol()
      Symbol of the acquiree
      Returns:
      acquireeSymbol

    • setAcquireeSymbol

      public void setAcquireeSymbol(@Nonnull String acquireeSymbol)

    • acquirerCusip

      public ActivityV2DetailNTA acquirerCusip(@Nullable String acquirerCusip)

    • getAcquirerCusip

      @Nullable public String getAcquirerCusip()
      CUSIP of the acquirer
      Returns:
      acquirerCusip

    • setAcquirerCusip

      public void setAcquirerCusip(@Nullable String acquirerCusip)

    • acquirerRate

      public ActivityV2DetailNTA acquirerRate(@Nullable String acquirerRate)

    • getAcquirerRate

      @Nullable public String getAcquirerRate()
      Rate of the acquirer
      Returns:
      acquirerRate

    • setAcquirerRate

      public void setAcquirerRate(@Nullable String acquirerRate)

    • acquirerSymbol

      public ActivityV2DetailNTA acquirerSymbol(@Nullable String acquirerSymbol)

    • getAcquirerSymbol

      @Nullable public String getAcquirerSymbol()
      Symbol of the acquirer
      Returns:
      acquirerSymbol

    • setAcquirerSymbol

      public void setAcquirerSymbol(@Nullable String acquirerSymbol)

    • acquireeQty

      public ActivityV2DetailNTA acquireeQty(@Nonnull String acquireeQty)

    • getAcquireeQty

      @Nonnull public String getAcquireeQty()
      Quantity of the acquiree
      Returns:
      acquireeQty

    • setAcquireeQty

      public void setAcquireeQty(@Nonnull String acquireeQty)

    • acquirerQty

      public ActivityV2DetailNTA acquirerQty(@Nullable String acquirerQty)

    • getAcquirerQty

      @Nullable public String getAcquirerQty()
      Quantity of the acquirer
      Returns:
      acquirerQty

    • setAcquirerQty

      public void setAcquirerQty(@Nullable String acquirerQty)

    • cashRate

      public ActivityV2DetailNTA cashRate(@Nullable String cashRate)

    • getCashRate

      @Nullable public String getCashRate()
      The cash rate
      Returns:
      cashRate

    • setCashRate

      public void setCashRate(@Nullable String cashRate)

    • positionQty

      public ActivityV2DetailNTA positionQty(@Nonnull String positionQty)

    • getPositionQty

      @Nonnull public String getPositionQty()
      The position quantity
      Returns:
      positionQty

    • setPositionQty

      public void setPositionQty(@Nonnull String positionQty)

    • paymentDate

      public ActivityV2DetailNTA paymentDate(@Nonnull LocalDate paymentDate)

    • getPaymentDate

      @Nonnull public LocalDate getPaymentDate()
      The payment date
      Returns:
      paymentDate

    • setPaymentDate

      public void setPaymentDate(@Nonnull LocalDate paymentDate)

    • qty

      public ActivityV2DetailNTA qty(@Nonnull String qty)

    • getQty

      @Nonnull public String getQty()
      used when the old contract's quantity is equal to the new contract's quantity. Mutually exclusive with 'old_qty' and 'new_qty'
      Returns:
      qty

    • setQty

      public void setQty(@Nonnull String qty)

    • expirationDate

      public ActivityV2DetailNTA expirationDate(@Nullable LocalDate expirationDate)

    • getExpirationDate

      @Nullable public LocalDate getExpirationDate()
      The expiration date for the rights distribution
      Returns:
      expirationDate

    • setExpirationDate

      public void setExpirationDate(@Nullable LocalDate expirationDate)

    • removedQty

      public ActivityV2DetailNTA removedQty(@Nonnull String removedQty)

    • getRemovedQty

      @Nonnull public String getRemovedQty()
      The removed quantity
      Returns:
      removedQty

    • setRemovedQty

      public void setRemovedQty(@Nonnull String removedQty)

    • newContractSymbol

      public ActivityV2DetailNTA newContractSymbol(@Nonnull String newContractSymbol)

    • getNewContractSymbol

      @Nonnull public String getNewContractSymbol()
      The new contract symbol
      Returns:
      newContractSymbol

    • setNewContractSymbol

      public void setNewContractSymbol(@Nonnull String newContractSymbol)

    • oldContractSymbol

      public ActivityV2DetailNTA oldContractSymbol(@Nonnull String oldContractSymbol)

    • getOldContractSymbol

      @Nonnull public String getOldContractSymbol()
      The old contract symbol
      Returns:
      oldContractSymbol

    • setOldContractSymbol

      public void setOldContractSymbol(@Nonnull String oldContractSymbol)

    • externalId

      public ActivityV2DetailNTA externalId(@Nonnull String externalId)

    • getExternalId

      @Nonnull public String getExternalId()
      External ID of the transfer
      Returns:
      externalId

    • setExternalId

      public void setExternalId(@Nonnull String externalId)

    • holdDate

      public ActivityV2DetailNTA holdDate(@Nullable LocalDate holdDate)

    • getHoldDate

      @Nullable public LocalDate getHoldDate()
      Hold date when the transfers settle
      Returns:
      holdDate

    • setHoldDate

      public void setHoldDate(@Nullable LocalDate holdDate)

    • requestId

      public ActivityV2DetailNTA requestId(@Nonnull UUID requestId)

    • getRequestId

      @Nonnull public UUID getRequestId()
      The ID for original ACATS request
      Returns:
      requestId

    • setRequestId

      public void setRequestId(@Nonnull UUID requestId)

    • contra

      public ActivityV2DetailNTA contra(@Nonnull String contra)

    • getContra

      @Nonnull public String getContra()
      Contra for the transfer
      Returns:
      contra

    • setContra

      public void setContra(@Nonnull String contra)

    • parentId

      public ActivityV2DetailNTA parentId(@Nonnull UUID parentId)

    • getParentId

      @Nonnull public UUID getParentId()
      The parent transaction's ID
      Returns:
      parentId

    • setParentId

      public void setParentId(@Nonnull UUID parentId)

    • journalId

      public ActivityV2DetailNTA journalId(@Nullable UUID journalId)

    • getJournalId

      @Nullable public UUID getJournalId()
      The journal's ID
      Returns:
      journalId

    • setJournalId

      public void setJournalId(@Nullable UUID journalId)

    • bankTransactionId

      public ActivityV2DetailNTA bankTransactionId(@Nullable UUID bankTransactionId)

    • getBankTransactionId

      @Nullable public UUID getBankTransactionId()
      The bank transaction's ID
      Returns:
      bankTransactionId

    • setBankTransactionId

      public void setBankTransactionId(@Nullable UUID bankTransactionId)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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