Class IssuerResponse


  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
               comments="Generator version: 7.7.0")
    public class IssuerResponse
    extends Object
    IssuerResponse
    • Constructor Detail

      • IssuerResponse

        public IssuerResponse()
    • Method Detail

      • getId

        @Nullable
        public String getId()
        Unique identifier set when the record is created.
        Returns:
        id
      • setId

        public void setId​(String id)
      • getCreatedAt

        @Nullable
        public OffsetDateTime getCreatedAt()
        Date time when the record was created.
        Returns:
        createdAt
      • setCreatedAt

        public void setCreatedAt​(OffsetDateTime createdAt)
      • getUpdatedAt

        @Nullable
        public OffsetDateTime getUpdatedAt()
        Date time when the record was last updated.
        Returns:
        updatedAt
      • setUpdatedAt

        public void setUpdatedAt​(OffsetDateTime updatedAt)
      • getName

        @Nullable
        public String getName()
        Legal name. Not the DBA name.
        Returns:
        name
      • setName

        public void setName​(String name)
      • getDbaName

        @Nullable
        public String getDbaName()
        Doing Business As (DBA) name or continuation of a long legal name. Use either this or 'transferAgentName'.
        Returns:
        dbaName
      • setDbaName

        public void setDbaName​(String dbaName)
      • getTin

        @Nullable
        public String getTin()
        Federal Tax Identification Number (TIN).
        Returns:
        tin
      • setTin

        public void setTin​(String tin)
      • getReferenceId

        @Nullable
        public String getReferenceId()
        Internal reference ID. Never shown to any agency or recipient. If present, it will prefix download filenames. Allowed characters: letters, numbers, dashes, underscores, and spaces.
        Returns:
        referenceId
      • setReferenceId

        public void setReferenceId​(String referenceId)
      • getTelephone

        @Nullable
        public String getTelephone()
        Contact phone number (must contain at least 10 digits, max 15 characters). For recipient inquiries.
        Returns:
        telephone
      • setTelephone

        public void setTelephone​(String telephone)
      • getTaxYear

        @Nullable
        public Integer getTaxYear()
        Tax year for which the forms are being filed (e.g., 2024). Must be within current tax year and current tax year - 4.
        Returns:
        taxYear
      • setTaxYear

        public void setTaxYear​(Integer taxYear)
      • getCountryCode

        @Nullable
        public String getCountryCode()
        Two-letter IRS country code (e.g., 'US', 'CA'), as defined at https://www.irs.gov/e-file-providers/country-codes. If there is a transfer agent, use the transfer agent's shipping address.
        Returns:
        countryCode
      • setCountryCode

        public void setCountryCode​(String countryCode)
      • getEmail

        @Nullable
        public String getEmail()
        Contact email address. For recipient inquiries.
        Returns:
        email
      • setEmail

        public void setEmail​(String email)
      • getAddress

        @Nullable
        public String getAddress()
        Address.
        Returns:
        address
      • setAddress

        public void setAddress​(String address)
      • setCity

        public void setCity​(String city)
      • getState

        @Nullable
        public String getState()
        Two-letter US state or Canadian province code (required for US/CA addresses).
        Returns:
        state
      • setState

        public void setState​(String state)
      • setZip

        public void setZip​(String zip)
      • getForeignProvince

        @Nullable
        public String getForeignProvince()
        Province or region for non-US/CA addresses.
        Returns:
        foreignProvince
      • setForeignProvince

        public void setForeignProvince​(String foreignProvince)
      • getTransferAgentName

        @Nullable
        public String getTransferAgentName()
        Name of the transfer agent, if applicable — optional; use either this or 'dbaName'.
        Returns:
        transferAgentName
      • setTransferAgentName

        public void setTransferAgentName​(String transferAgentName)
      • getLastFiling

        @Nullable
        public Boolean getLastFiling()
        Indicates if this is the issuer's final year filing.
        Returns:
        lastFiling
      • setLastFiling

        public void setLastFiling​(Boolean lastFiling)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode 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 IssuerResponse
      • fromJson

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

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