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

Class JNLC

java.lang.Object
markets.alpaca.client.openapi.broker.model.JNLC
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class JNLC extends Object implements Serializable
Journal information specific to cash transfers. This field is required for `Journal`s with an `entry_type` of `jnlc` (cash transfers), but will be null for those with `jnls` (securities transfers).
See Also:

  • Field Details

  • Constructor Details

    • JNLC

      public JNLC()

  • Method Details

    • currency

      public JNLC 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 JNLC 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)

    • entryType

      public JNLC entryType(@Nonnull String entryType)

    • getEntryType

      @Nonnull public String getEntryType()
      JNLC
      Returns:
      entryType

    • setEntryType

      public void setEntryType(@Nonnull String entryType)

    • netAmount

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

    • fromJson

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

    • toJson

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