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

Class BatchJournalResponseJNLC

java.lang.Object
markets.alpaca.client.openapi.broker.model.BatchJournalResponseJNLC
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class BatchJournalResponseJNLC extends Object implements Serializable
A cash journal result returned by the forward batch endpoint.
See Also:

  • Field Details

  • Constructor Details

    • BatchJournalResponseJNLC

      public BatchJournalResponseJNLC()

  • Method Details

    • createdAt

      public BatchJournalResponseJNLC 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 BatchJournalResponseJNLC 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 BatchJournalResponseJNLC description(@Nonnull String description)

    • getDescription

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

    • setDescription

      public void setDescription(@Nonnull String description)

    • fromAccount

      public BatchJournalResponseJNLC 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 BatchJournalResponseJNLC id(@Nonnull UUID id)

    • getId

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

    • setId

      public void setId(@Nonnull UUID id)

    • netAmount

      public BatchJournalResponseJNLC netAmount(@Nonnull BigDecimal netAmount)

    • getNetAmount

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

    • setNetAmount

      public void setNetAmount(@Nonnull BigDecimal netAmount)

    • price

      public BatchJournalResponseJNLC price(@Nonnull BigDecimal price)

    • getPrice

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

    • setPrice

      public void setPrice(@Nonnull BigDecimal price)

    • qty

      public BatchJournalResponseJNLC qty(@Nonnull BigDecimal qty)

    • getQty

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

    • setQty

      public void setQty(@Nonnull BigDecimal qty)

    • settleDate

      public BatchJournalResponseJNLC settleDate(@Nonnull LocalDate settleDate)

    • getSettleDate

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

    • setSettleDate

      public void setSettleDate(@Nonnull LocalDate settleDate)

    • status

      public BatchJournalResponseJNLC status(@Nonnull JournalStatus status)

    • getStatus

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

    • setStatus

      public void setStatus(@Nonnull JournalStatus status)

    • symbol

      public BatchJournalResponseJNLC symbol(@Nonnull String symbol)

    • getSymbol

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

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • systemDate

      public BatchJournalResponseJNLC systemDate(@Nonnull LocalDate systemDate)

    • getSystemDate

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

    • setSystemDate

      public void setSystemDate(@Nonnull LocalDate systemDate)

    • toAccount

      public BatchJournalResponseJNLC 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 BatchJournalResponseJNLC transmitterInfo(@Nullable TransmitterInfo transmitterInfo)

    • getTransmitterInfo

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

    • setTransmitterInfo

      public void setTransmitterInfo(@Nullable TransmitterInfo transmitterInfo)

    • entryType

      public BatchJournalResponseJNLC entryType(@Nonnull BatchJournalResponseJNLC.EntryTypeEnum entryType)

    • getEntryType

      @Nonnull public BatchJournalResponseJNLC.EntryTypeEnum getEntryType()
      Cash journal discriminator value.
      Returns:
      entryType

    • setEntryType

      public void setEntryType(@Nonnull BatchJournalResponseJNLC.EntryTypeEnum entryType)

    • transmitterAccountNumber

      public BatchJournalResponseJNLC transmitterAccountNumber(@Nullable String transmitterAccountNumber)

    • getTransmitterAccountNumber

      @Nullable public String getTransmitterAccountNumber()
      Optional for JNLC journals. Maximum 255 characters. See more details about [Travel Rule](https://alpaca.markets/docs/broker/integration/funding/#travel-rule) in our main documentation.
      Returns:
      transmitterAccountNumber

    • setTransmitterAccountNumber

      public void setTransmitterAccountNumber(@Nullable String transmitterAccountNumber)

    • transmitterAddress

      public BatchJournalResponseJNLC transmitterAddress(@Nullable String transmitterAddress)

    • getTransmitterAddress

      @Nullable public String getTransmitterAddress()
      Optional for JNLC journals. Maximum 255 characters. See more details about [Travel Rule](https://alpaca.markets/docs/broker/integration/funding/#travel-rule) in our main documentation.
      Returns:
      transmitterAddress

    • setTransmitterAddress

      public void setTransmitterAddress(@Nullable String transmitterAddress)

    • transmitterFinancialInstitution

      public BatchJournalResponseJNLC transmitterFinancialInstitution(@Nullable String transmitterFinancialInstitution)

    • getTransmitterFinancialInstitution

      @Nullable public String getTransmitterFinancialInstitution()
      Optional for JNLC journals. Maximum 255 characters. See more details about [Travel Rule](https://alpaca.markets/docs/broker/integration/funding/#travel-rule) in our main documentation.
      Returns:
      transmitterFinancialInstitution

    • setTransmitterFinancialInstitution

      public void setTransmitterFinancialInstitution(@Nullable String transmitterFinancialInstitution)

    • transmitterName

      public BatchJournalResponseJNLC transmitterName(@Nullable String transmitterName)

    • getTransmitterName

      @Nullable public String getTransmitterName()
      Optional for JNLC journals. Maximum 255 characters. See more details about [Travel Rule](https://alpaca.markets/docs/broker/integration/funding/#travel-rule) in our main documentation.
      Returns:
      transmitterName

    • setTransmitterName

      public void setTransmitterName(@Nullable String transmitterName)

    • transmitterTimestamp

      public BatchJournalResponseJNLC transmitterTimestamp(@Nullable OffsetDateTime transmitterTimestamp)

    • getTransmitterTimestamp

      @Nullable public OffsetDateTime getTransmitterTimestamp()
      Optional for JNLC journals. RFC 3339 format. See more details about [Travel Rule](https://alpaca.markets/docs/broker/integration/funding/#travel-rule) in our main documentation.
      Returns:
      transmitterTimestamp

    • setTransmitterTimestamp

      public void setTransmitterTimestamp(@Nullable OffsetDateTime transmitterTimestamp)

    • errorMessage

      public BatchJournalResponseJNLC errorMessage(@Nullable String errorMessage)

    • getErrorMessage

      @Nullable public String getErrorMessage()
      Description of why this journal transaction failed. Omitted for successful results.
      Returns:
      errorMessage

    • setErrorMessage

      public void setErrorMessage(@Nullable String errorMessage)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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