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

Class Journal

java.lang.Object
markets.alpaca.client.openapi.broker.model.Journal
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
BatchJournalResponse
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class Journal extends Object implements Serializable
Represents a cash or security transfer between accounts, as specified by the `entry_type` parameter.
See Also:

  • Field Details

  • Constructor Details

    • Journal

      public Journal()

  • Method Details

    • createdAt

      public Journal createdAt(@Nullable OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      Get createdAt
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable OffsetDateTime createdAt)

    • entryType

      public Journal entryType(@Nonnull String entryType)

    • getEntryType

      @Nonnull public String getEntryType()
      JNLC
      Returns:
      entryType

    • setEntryType

      public void setEntryType(@Nonnull String entryType)

    • fromAccount

      public Journal fromAccount(@Nonnull String fromAccount)

    • getFromAccount

      @Nonnull public String getFromAccount()
      The account ID that initiates the journal - account_status must equal to ACTIVE or CLOSE
      Returns:
      fromAccount

    • setFromAccount

      public void setFromAccount(@Nonnull String fromAccount)

    • id

      public Journal id(@Nonnull String id)

    • getId

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

    • setId

      public void setId(@Nonnull String id)

    • settleDate

      public Journal settleDate(@Nullable String settleDate)

    • getSettleDate

      @Nullable public String getSettleDate()
      Date string in \"%Y-%m-%d\" format
      Returns:
      settleDate

    • setSettleDate

      public void setSettleDate(@Nullable String settleDate)

    • status

      public Journal status(@Nullable JournalStatus status)

    • getStatus

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

    • setStatus

      public void setStatus(@Nullable JournalStatus status)

    • toAccount

      public Journal toAccount(@Nonnull String toAccount)

    • getToAccount

      @Nonnull public String getToAccount()
      The account ID that received the journal - account_status must equal to ACTIVE
      Returns:
      toAccount

    • setToAccount

      public void setToAccount(@Nonnull String toAccount)

    • transmitterInfo

      public Journal transmitterInfo(@Nullable TransmitterInfo transmitterInfo)

    • getTransmitterInfo

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

    • setTransmitterInfo

      public void setTransmitterInfo(@Nullable TransmitterInfo transmitterInfo)

    • currency

      public Journal currency(@Nullable String currency)

    • getCurrency

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

    • setCurrency

      public void setCurrency(@Nullable String currency)

    • description

      public Journal description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      ID the amount goes to. Only valid for JNLC journals. Null for JNLS.
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • price

      public Journal price(@Nullable String price)

    • getPrice

      @Nullable public String getPrice()
      The price of the security journaled
      Returns:
      price

    • setPrice

      public void setPrice(@Nullable String price)

    • qty

      public Journal qty(@Nullable String qty)

    • getQty

      @Nullable public String getQty()
      The quantity of the securities journaled
      Returns:
      qty

    • setQty

      public void setQty(@Nullable String qty)

    • symbol

      public Journal symbol(@Nullable String symbol)

    • getSymbol

      @Nullable public String getSymbol()
      The symbol of the security journaled
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nullable String symbol)

    • systemDate

      public Journal systemDate(@Nullable String systemDate)

    • getSystemDate

      @Nullable public String getSystemDate()
      Date string in \"%Y-%m-%d\" format
      Returns:
      systemDate

    • setSystemDate

      public void setSystemDate(@Nullable String systemDate)

    • netAmount

      public Journal netAmount(@Nonnull BigDecimal netAmount)

    • getNetAmount

      @Nonnull public BigDecimal getNetAmount()
      Only valid for JNLC journals. Null for JNLS.
      Returns:
      netAmount

    • setNetAmount

      public void setNetAmount(@Nonnull BigDecimal netAmount)

    • transmitterAccountNumber

      public Journal transmitterAccountNumber(@Nullable String transmitterAccountNumber)

    • getTransmitterAccountNumber

      @Nullable public String getTransmitterAccountNumber()
      Only valid for JNLC journals. Null for JNLS.max 255 characters
      Returns:
      transmitterAccountNumber

    • setTransmitterAccountNumber

      public void setTransmitterAccountNumber(@Nullable String transmitterAccountNumber)

    • transmitterAddress

      public Journal transmitterAddress(@Nullable String transmitterAddress)

    • getTransmitterAddress

      @Nullable public String getTransmitterAddress()
      Only valid for JNLC journals. Null for JNLS.max 255 characters
      Returns:
      transmitterAddress

    • setTransmitterAddress

      public void setTransmitterAddress(@Nullable String transmitterAddress)

    • transmitterFinancialInstitution

      public Journal transmitterFinancialInstitution(@Nullable String transmitterFinancialInstitution)

    • getTransmitterFinancialInstitution

      @Nullable public String getTransmitterFinancialInstitution()
      Only valid for JNLC journals. Null for JNLS.max 255 characters
      Returns:
      transmitterFinancialInstitution

    • setTransmitterFinancialInstitution

      public void setTransmitterFinancialInstitution(@Nullable String transmitterFinancialInstitution)

    • transmitterName

      public Journal transmitterName(@Nullable String transmitterName)

    • getTransmitterName

      @Nullable public String getTransmitterName()
      Only valid for JNLC journals. Null for JNLS. Max 255 characters.
      Returns:
      transmitterName

    • setTransmitterName

      public void setTransmitterName(@Nullable String transmitterName)

    • transmitterTimestamp

      public Journal transmitterTimestamp(@Nullable OffsetDateTime transmitterTimestamp)

    • getTransmitterTimestamp

      @Nullable public OffsetDateTime getTransmitterTimestamp()
      Only valid for JNLC journals. Null for JNLS.
      Returns:
      transmitterTimestamp

    • setTransmitterTimestamp

      public void setTransmitterTimestamp(@Nullable OffsetDateTime transmitterTimestamp)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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