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

Class DIVNRAActivityV2

java.lang.Object
markets.alpaca.client.openapi.broker.model.DIVNRAActivityV2
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class DIVNRAActivityV2 extends Object implements Serializable
Dividend withholding for non resident aliens
See Also:

  • Field Details

  • Constructor Details

    • DIVNRAActivityV2

      public DIVNRAActivityV2()

  • Method Details

    • groupId

      public DIVNRAActivityV2 groupId(@Nullable UUID groupId)

    • getGroupId

      @Nullable public UUID getGroupId()
      Optional group ID which can help grouping together related activities
      Returns:
      groupId

    • setGroupId

      public void setGroupId(@Nullable UUID groupId)

    • systemDate

      public DIVNRAActivityV2 systemDate(@Nonnull LocalDate systemDate)

    • getSystemDate

      @Nonnull public LocalDate getSystemDate()
      The date when the activity was booked
      Returns:
      systemDate

    • setSystemDate

      public void setSystemDate(@Nonnull LocalDate systemDate)

    • cusip

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

    • parentId

      public DIVNRAActivityV2 parentId(@Nonnull UUID parentId)

    • getParentId

      @Nonnull public UUID getParentId()
      The ref_id of the parent dividend
      Returns:
      parentId

    • setParentId

      public void setParentId(@Nonnull UUID parentId)

    • symbol

      public DIVNRAActivityV2 symbol(@Nonnull String symbol)

    • getSymbol

      @Nonnull public String getSymbol()
      The symbol of the security involved with the activity
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • taxCountry

      public DIVNRAActivityV2 taxCountry(@Nullable String taxCountry)

    • getTaxCountry

      @Nullable public String getTaxCountry()
      Tax country used as the primary jurisdiction when determining withholding treatment for the dividend. Other factors may affect the final withholding rate. The value is an [ISO 3166-1 alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code.
      Returns:
      taxCountry

    • setTaxCountry

      public void setTaxCountry(@Nullable String taxCountry)

    • taxRate

      public DIVNRAActivityV2 taxRate(@Nullable BigDecimal taxRate)

    • getTaxRate

      @Nullable public BigDecimal getTaxRate()
      The tax withholding rate applied to the dividend, represented as a value between 0 and 1
      Returns:
      taxRate

    • setTaxRate

      public void setTaxRate(@Nullable BigDecimal taxRate)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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