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

Class JournalBase

java.lang.Object
markets.alpaca.client.openapi.broker.model.JournalBase
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class JournalBase extends Object implements Serializable
Shared response fields returned for cash and securities journals.
See Also:

  • Field Details

  • Constructor Details

    • JournalBase

      public JournalBase()

  • Method Details

    • createdAt

      public JournalBase createdAt(@Nullable OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      The creation time when supplied by the endpoint.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable OffsetDateTime createdAt)

    • currency

      public JournalBase currency(@Nonnull String currency)

    • getCurrency

      @Nonnull public String getCurrency()
      Currency denomination of the journal.
      Returns:
      currency

    • setCurrency

      public void setCurrency(@Nonnull String currency)

    • description

      public JournalBase description(@Nonnull String description)

    • getDescription

      @Nonnull public String getDescription()
      The journal description.
      Returns:
      description

    • setDescription

      public void setDescription(@Nonnull String description)

    • fromAccount

      public JournalBase fromAccount(@Nonnull UUID fromAccount)

    • getFromAccount

      @Nonnull public UUID getFromAccount()
      The account ID that initiated the journal.
      Returns:
      fromAccount

    • setFromAccount

      public void setFromAccount(@Nonnull UUID fromAccount)

    • id

      public JournalBase id(@Nonnull UUID id)

    • getId

      @Nonnull public UUID getId()
      The journal ID.
      Returns:
      id

    • setId

      public void setId(@Nonnull UUID id)

    • netAmount

      public JournalBase netAmount(@Nullable BigDecimal netAmount)

    • getNetAmount

      @Nullable public BigDecimal getNetAmount()
      The cash amount, or null when not applicable.
      Returns:
      netAmount

    • setNetAmount

      public void setNetAmount(@Nullable BigDecimal netAmount)

    • price

      public JournalBase price(@Nullable BigDecimal price)

    • getPrice

      @Nullable public BigDecimal getPrice()
      The journaled security price, or null when not applicable.
      Returns:
      price

    • setPrice

      public void setPrice(@Nullable BigDecimal price)

    • qty

      public JournalBase qty(@Nullable BigDecimal qty)

    • getQty

      @Nullable public BigDecimal getQty()
      The journaled security quantity, or null when not applicable.
      Returns:
      qty

    • setQty

      public void setQty(@Nullable BigDecimal qty)

    • settleDate

      public JournalBase settleDate(@Nullable LocalDate settleDate)

    • getSettleDate

      @Nullable public LocalDate getSettleDate()
      The settlement date, or null until one is assigned.
      Returns:
      settleDate

    • setSettleDate

      public void setSettleDate(@Nullable LocalDate settleDate)

    • status

      public JournalBase status(@Nonnull JournalStatus status)

    • getStatus

      @Nonnull public JournalStatus getStatus()
      Get status
      Returns:
      status

    • setStatus

      public void setStatus(@Nonnull JournalStatus status)

    • symbol

      public JournalBase symbol(@Nullable String symbol)

    • getSymbol

      @Nullable public String getSymbol()
      The journaled security symbol, or null for a cash journal.
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nullable String symbol)

    • systemDate

      public JournalBase systemDate(@Nullable LocalDate systemDate)

    • getSystemDate

      @Nullable public LocalDate getSystemDate()
      The booking-system date, or null until one is assigned.
      Returns:
      systemDate

    • setSystemDate

      public void setSystemDate(@Nullable LocalDate systemDate)

    • toAccount

      public JournalBase toAccount(@Nonnull UUID toAccount)

    • getToAccount

      @Nonnull public UUID getToAccount()
      The account ID that received the journal.
      Returns:
      toAccount

    • setToAccount

      public void setToAccount(@Nonnull UUID toAccount)

    • transmitterInfo

      public JournalBase transmitterInfo(@Nullable TransmitterInfo transmitterInfo)

    • getTransmitterInfo

      @Nullable public TransmitterInfo getTransmitterInfo()
      Get transmitterInfo
      Returns:
      transmitterInfo

    • setTransmitterInfo

      public void setTransmitterInfo(@Nullable TransmitterInfo transmitterInfo)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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