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

Class SettlementResponse

java.lang.Object
markets.alpaca.client.openapi.broker.model.SettlementResponse
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class SettlementResponse extends Object implements Serializable
A settlement response, either from creation or retrieval
See Also:

  • Field Details

  • Constructor Details

    • SettlementResponse

      public SettlementResponse()

  • Method Details

    • additionalInfo

      public SettlementResponse additionalInfo(@Nullable String additionalInfo)

    • getAdditionalInfo

      @Nullable public String getAdditionalInfo()
      Get additionalInfo
      Returns:
      additionalInfo

    • setAdditionalInfo

      public void setAdditionalInfo(@Nullable String additionalInfo)

    • assetClass

      public SettlementResponse assetClass(@Nullable JITAssetClass assetClass)

    • getAssetClass

      @Nullable public JITAssetClass getAssetClass()
      Get assetClass
      Returns:
      assetClass

    • setAssetClass

      public void setAssetClass(@Nullable JITAssetClass assetClass)

    • completedAt

      public SettlementResponse completedAt(@Nullable OffsetDateTime completedAt)

    • getCompletedAt

      @Nullable public OffsetDateTime getCompletedAt()
      Get completedAt
      Returns:
      completedAt

    • setCompletedAt

      public void setCompletedAt(@Nullable OffsetDateTime completedAt)

    • createdAt

      public SettlementResponse createdAt(@Nonnull OffsetDateTime createdAt)

    • getCreatedAt

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

    • setCreatedAt

      public void setCreatedAt(@Nonnull OffsetDateTime createdAt)

    • currency

      public SettlementResponse currency(@Nullable String currency)

    • getCurrency

      @Nullable public String getCurrency()
      The currency of the settlement. Only applicable to JIT settlements.
      Returns:
      currency

    • setCurrency

      public void setCurrency(@Nullable String currency)

    • id

      public SettlementResponse id(@Nonnull UUID id)

    • getId

      @Nonnull public UUID getId()
      Get id
      Returns:
      id

    • setId

      public void setId(@Nonnull UUID id)

    • interestAmount

      public SettlementResponse interestAmount(@Nullable BigDecimal interestAmount)

    • getInterestAmount

      @Nullable public BigDecimal getInterestAmount()
      The total interest amount accrued on the transfers included in this settlement. Only applicable for instant funding settlements.
      Returns:
      interestAmount

    • setInterestAmount

      public void setInterestAmount(@Nullable BigDecimal interestAmount)

    • reason

      public SettlementResponse reason(@Nullable String reason)

    • getReason

      @Nullable public String getReason()
      The reason for failure, if applicable
      Returns:
      reason

    • setReason

      public void setReason(@Nullable String reason)

    • sourceAccountNumber

      public SettlementResponse sourceAccountNumber(@Nullable String sourceAccountNumber)

    • getSourceAccountNumber

      @Nullable public String getSourceAccountNumber()
      Get sourceAccountNumber
      Returns:
      sourceAccountNumber

    • setSourceAccountNumber

      public void setSourceAccountNumber(@Nullable String sourceAccountNumber)

    • status

      public SettlementResponse status(@Nonnull SettlementStatus status)

    • getStatus

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

    • setStatus

      public void setStatus(@Nonnull SettlementStatus status)

    • totalAmount

      public SettlementResponse totalAmount(@Nonnull BigDecimal totalAmount)

    • getTotalAmount

      @Nonnull public BigDecimal getTotalAmount()
      Get totalAmount
      Returns:
      totalAmount

    • setTotalAmount

      public void setTotalAmount(@Nonnull BigDecimal totalAmount)

    • updatedAt

      public SettlementResponse updatedAt(@Nonnull OffsetDateTime updatedAt)

    • getUpdatedAt

      @Nonnull public OffsetDateTime getUpdatedAt()
      Get updatedAt
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nonnull OffsetDateTime updatedAt)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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