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

Class FPSLLoan

java.lang.Object
markets.alpaca.client.openapi.broker.model.FPSLLoan
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class FPSLLoan extends Object implements Serializable
A loan of a security by an account on a date.
See Also:

  • Field Details

  • Constructor Details

    • FPSLLoan

      public FPSLLoan()

  • Method Details

    • accountId

      public FPSLLoan accountId(@Nonnull String accountId)

    • getAccountId

      @Nonnull public String getAccountId()
      Account's ID at Alpaca
      Returns:
      accountId

    • setAccountId

      public void setAccountId(@Nonnull String accountId)

    • accountNumber

      public FPSLLoan accountNumber(@Nonnull String accountNumber)

    • getAccountNumber

      @Nonnull public String getAccountNumber()
      Account's number at Alpaca
      Returns:
      accountNumber

    • setAccountNumber

      public void setAccountNumber(@Nonnull String accountNumber)

    • collateral

      public FPSLLoan collateral(@Nonnull Double collateral)

    • getCollateral

      @Nonnull public Double getCollateral()
      The collateral posted for the loan.
      Returns:
      collateral

    • setCollateral

      public void setCollateral(@Nonnull Double collateral)

    • correspondent

      public FPSLLoan correspondent(@Nonnull String correspondent)

    • getCorrespondent

      @Nonnull public String getCorrespondent()
      Account's correspondent
      Returns:
      correspondent

    • setCorrespondent

      public void setCorrespondent(@Nonnull String correspondent)

    • date

      public FPSLLoan date(@Nonnull LocalDate date)

    • getDate

      @Nonnull public LocalDate getDate()
      Get date
      Returns:
      date

    • setDate

      public void setDate(@Nonnull LocalDate date)

    • interest

      public FPSLLoan interest(@Nullable FPSLInterest interest)

    • getInterest

      @Nullable public FPSLInterest getInterest()
      Get interest
      Returns:
      interest

    • setInterest

      public void setInterest(@Nullable FPSLInterest interest)

    • marketValue

      public FPSLLoan marketValue(@Nonnull Double marketValue)

    • getMarketValue

      @Nonnull public Double getMarketValue()
      The total market value of the shares on loan.
      Returns:
      marketValue

    • setMarketValue

      public void setMarketValue(@Nonnull Double marketValue)

    • quantity

      public FPSLLoan quantity(@Nonnull Long quantity)

    • getQuantity

      @Nonnull public Long getQuantity()
      The number of shares in the loan. This may be less than the total number of eligible shares held by the account.
      Returns:
      quantity

    • setQuantity

      public void setQuantity(@Nonnull Long quantity)

    • symbol

      public FPSLLoan symbol(@Nonnull String symbol)

    • getSymbol

      @Nonnull public String getSymbol()
      Stock/Ticker symbol of a stock or security
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • updatedAt

      public FPSLLoan updatedAt(@Nullable OffsetDateTime updatedAt)

    • getUpdatedAt

      @Nullable public OffsetDateTime getUpdatedAt()
      Timestamp of the last update to this loan in RFC-3339 format with microsecond precision with timezone. An updated value may indicate adjusted interest values.
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nullable OffsetDateTime updatedAt)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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