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

Class CommonFixedIncomeInterestActivityV2

java.lang.Object
markets.alpaca.client.openapi.broker.model.CommonFixedIncomeInterestActivityV2
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class CommonFixedIncomeInterestActivityV2 extends Object implements Serializable
Fixed income interest fields (INT/FI). Variants from the same activity type: - Coupon: `interest_type` is `coupon`. Includes `rate` (no `price` / `accrued_interest_rate`). No `order_id`. - Accrued interest on call: `interest_type` is `accrued`. Includes `price` and `accrued_interest_rate` (no `rate`). No `order_id`. - Trade accrued: `interest_type` is `accrued`. Includes `order_id` so the interest NTA can be linked to the fill. `parent_id` is set when a parent trade `ref_id` is available.
See Also:

  • Field Details

  • Constructor Details

    • CommonFixedIncomeInterestActivityV2

      public CommonFixedIncomeInterestActivityV2()

  • Method Details

    • accruedInterestRate

      public CommonFixedIncomeInterestActivityV2 accruedInterestRate(@Nullable BigDecimal accruedInterestRate)

    • getAccruedInterestRate

      @Nullable public BigDecimal getAccruedInterestRate()
      Accrued interest rate (present for accrued-interest-on-call variants)
      Returns:
      accruedInterestRate

    • setAccruedInterestRate

      public void setAccruedInterestRate(@Nullable BigDecimal accruedInterestRate)

    • cashPayout

      public CommonFixedIncomeInterestActivityV2 cashPayout(@Nonnull BigDecimal cashPayout)

    • getCashPayout

      @Nonnull public BigDecimal getCashPayout()
      The cash payout for this interest activity
      Returns:
      cashPayout

    • setCashPayout

      public void setCashPayout(@Nonnull BigDecimal cashPayout)

    • cusip

      public CommonFixedIncomeInterestActivityV2 cusip(@Nonnull String cusip)

    • getCusip

      @Nonnull public String getCusip()
      The CUSIP of the security involved with the activity
      Returns:
      cusip

    • setCusip

      public void setCusip(@Nonnull String cusip)

    • entitledQty

      public CommonFixedIncomeInterestActivityV2 entitledQty(@Nonnull String entitledQty)

    • getEntitledQty

      @Nonnull public String getEntitledQty()
      The entitled quantity (principal / face amount)
      Returns:
      entitledQty

    • setEntitledQty

      public void setEntitledQty(@Nonnull String entitledQty)

    • interestType

      public CommonFixedIncomeInterestActivityV2 interestType(@Nonnull FixedIncomeInterestType interestType)

    • getInterestType

      @Nonnull public FixedIncomeInterestType getInterestType()
      Get interestType
      Returns:
      interestType

    • setInterestType

      public void setInterestType(@Nonnull FixedIncomeInterestType interestType)

    • isin

      public CommonFixedIncomeInterestActivityV2 isin(@Nullable String isin)

    • getIsin

      @Nullable public String getIsin()
      The ISIN of the security involved with the activity
      Returns:
      isin

    • setIsin

      public void setIsin(@Nullable String isin)

    • orderId

      public CommonFixedIncomeInterestActivityV2 orderId(@Nullable UUID orderId)

    • getOrderId

      @Nullable public UUID getOrderId()
      The order that generated this accrued interest. Present for trade-accrued INT/FI.
      Returns:
      orderId

    • setOrderId

      public void setOrderId(@Nullable UUID orderId)

    • parentId

      public CommonFixedIncomeInterestActivityV2 parentId(@Nullable UUID parentId)

    • getParentId

      @Nullable public UUID getParentId()
      The ref_id of the parent trade this interest is attached to. Present for trade-accrued INT/FI when a parent trade `ref_id` is available.
      Returns:
      parentId

    • setParentId

      public void setParentId(@Nullable UUID parentId)

    • paymentDate

      public CommonFixedIncomeInterestActivityV2 paymentDate(@Nullable LocalDate paymentDate)

    • getPaymentDate

      @Nullable public LocalDate getPaymentDate()
      The payment date
      Returns:
      paymentDate

    • setPaymentDate

      public void setPaymentDate(@Nullable LocalDate paymentDate)

    • price

      public CommonFixedIncomeInterestActivityV2 price(@Nullable BigDecimal price)

    • getPrice

      @Nullable public BigDecimal getPrice()
      Call price used for accrued-interest-on-call variants
      Returns:
      price

    • setPrice

      public void setPrice(@Nullable BigDecimal price)

    • rate

      public CommonFixedIncomeInterestActivityV2 rate(@Nullable BigDecimal rate)

    • getRate

      @Nullable public BigDecimal getRate()
      Coupon rate amount (present for regular coupon payments)
      Returns:
      rate

    • setRate

      public void setRate(@Nullable BigDecimal rate)

    • recordDate

      public CommonFixedIncomeInterestActivityV2 recordDate(@Nullable LocalDate recordDate)

    • getRecordDate

      @Nullable public LocalDate getRecordDate()
      The record date
      Returns:
      recordDate

    • setRecordDate

      public void setRecordDate(@Nullable LocalDate recordDate)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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