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

Class CreateJournalRequest

java.lang.Object
markets.alpaca.client.openapi.broker.model.CreateJournalRequest
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CreateJournalRequest extends Object implements Serializable
Journals API allows you to move cash or securities from one account to another. This model represents the fields you can specify when creating a Journal Fixture Rules - No Fixtures - anything below limit is executed immediately - anything above limit is pending until executed at EOD, - With Fixtures - any status = rejected will be rejected EOD - any status = pending will be pending forever
See Also:

  • Field Details

  • Constructor Details

    • CreateJournalRequest

      public CreateJournalRequest()

  • Method Details

    • amount

      public CreateJournalRequest amount(@Nullable String amount)

    • getAmount

      @Nullable public String getAmount()
      Required if `entry_type` = `JNLC`
      Returns:
      amount

    • setAmount

      public void setAmount(@Nullable String amount)

    • currency

      public CreateJournalRequest currency(@Nullable String currency)

    • getCurrency

      @Nullable public String getCurrency()
      Get currency
      Returns:
      currency

    • setCurrency

      public void setCurrency(@Nullable String currency)

    • description

      public CreateJournalRequest description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Max 1024 characters. Can include fixtures for amounts that are above the transaction limit
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • entryType

      public CreateJournalRequest entryType(@Nonnull JournalEntryType entryType)

    • getEntryType

      @Nonnull public JournalEntryType getEntryType()
      Get entryType
      Returns:
      entryType

    • setEntryType

      public void setEntryType(@Nonnull JournalEntryType entryType)

    • fromAccount

      public CreateJournalRequest fromAccount(@Nonnull UUID fromAccount)

    • getFromAccount

      @Nonnull public UUID getFromAccount()
      The account_id you wish to journal from
      Returns:
      fromAccount

    • setFromAccount

      public void setFromAccount(@Nonnull UUID fromAccount)

    • qty

      public CreateJournalRequest qty(@Nullable String qty)

    • getQty

      @Nullable public String getQty()
      Required if `entry_type` = `JNLS`
      Returns:
      qty

    • setQty

      public void setQty(@Nullable String qty)

    • symbol

      public CreateJournalRequest symbol(@Nullable String symbol)

    • getSymbol

      @Nullable public String getSymbol()
      Required if `entry_type` = `JNLS`
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nullable String symbol)

    • toAccount

      public CreateJournalRequest toAccount(@Nonnull UUID toAccount)

    • getToAccount

      @Nonnull public UUID getToAccount()
      The account_id you wish to journal to
      Returns:
      toAccount

    • setToAccount

      public void setToAccount(@Nonnull UUID toAccount)

    • transmitterAccountNumber

      public CreateJournalRequest transmitterAccountNumber(@Nullable String transmitterAccountNumber)

    • getTransmitterAccountNumber

      @Nullable public String getTransmitterAccountNumber()
      Max 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 CreateJournalRequest transmitterAddress(@Nullable String transmitterAddress)

    • getTransmitterAddress

      @Nullable public String getTransmitterAddress()
      Max 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 CreateJournalRequest transmitterFinancialInstitution(@Nullable String transmitterFinancialInstitution)

    • getTransmitterFinancialInstitution

      @Nullable public String getTransmitterFinancialInstitution()
      Max 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 CreateJournalRequest transmitterName(@Nullable String transmitterName)

    • getTransmitterName

      @Nullable public String getTransmitterName()
      Max 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 CreateJournalRequest transmitterTimestamp(@Nullable OffsetDateTime transmitterTimestamp)

    • getTransmitterTimestamp

      @Nullable public OffsetDateTime getTransmitterTimestamp()
      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)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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