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

Class AccountExtended

java.lang.Object
markets.alpaca.client.openapi.broker.model.AccountExtended
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class AccountExtended extends Object implements Serializable
Represents an account with all data available. If your api response is missing some of these fields, there is a good chance you are using a route that returns `Account` instances instead of these.
See Also:

  • Field Details

  • Constructor Details

    • AccountExtended

      public AccountExtended()

  • Method Details

    • accountName

      public AccountExtended accountName(@Nullable String accountName)

    • getAccountName

      @Nullable public String getAccountName()
      Get accountName
      Returns:
      accountName

    • setAccountName

      public void setAccountName(@Nullable String accountName)

    • accountNumber

      public AccountExtended accountNumber(@Nullable String accountNumber)

    • getAccountNumber

      @Nullable public String getAccountNumber()
      Get accountNumber
      Returns:
      accountNumber

    • setAccountNumber

      public void setAccountNumber(@Nullable String accountNumber)

    • accountSubType

      public AccountExtended accountSubType(@Nullable AccountSubType accountSubType)

    • getAccountSubType

      @Nullable public AccountSubType getAccountSubType()
      Get accountSubType
      Returns:
      accountSubType

    • setAccountSubType

      public void setAccountSubType(@Nullable AccountSubType accountSubType)

    • accountType

      public AccountExtended accountType(@Nonnull AccountType accountType)

    • getAccountType

      @Nonnull public AccountType getAccountType()
      Get accountType
      Returns:
      accountType

    • setAccountType

      public void setAccountType(@Nonnull AccountType accountType)

    • agreements

      public AccountExtended agreements(@Nullable List<Agreement> agreements)

    • addAgreementsItem

      public AccountExtended addAgreementsItem(Agreement agreementsItem)

    • getAgreements

      @Nullable public List<Agreement> getAgreements()
      Get agreements
      Returns:
      agreements

    • setAgreements

      public void setAgreements(@Nullable List<Agreement> agreements)

    • allowInstantAch

      public AccountExtended allowInstantAch(@Nullable Boolean allowInstantAch)

    • getAllowInstantAch

      @Nullable public Boolean getAllowInstantAch()
      Determines whether the account is enabled for Instant ACH by the partner.
      Returns:
      allowInstantAch

    • setAllowInstantAch

      public void setAllowInstantAch(@Nullable Boolean allowInstantAch)

    • beneficiaries

      public AccountExtended beneficiaries(@Nullable List<Beneficiary> beneficiaries)

    • addBeneficiariesItem

      public AccountExtended addBeneficiariesItem(Beneficiary beneficiariesItem)

    • getBeneficiaries

      @Nullable public List<Beneficiary> getBeneficiaries()
      Get beneficiaries
      Returns:
      beneficiaries

    • setBeneficiaries

      public void setBeneficiaries(@Nullable List<Beneficiary> beneficiaries)

    • cashInterest

      public AccountExtended cashInterest(@Nullable AccountCashInterestResponse cashInterest)

    • getCashInterest

      @Nullable public AccountCashInterestResponse getCashInterest()
      Get cashInterest
      Returns:
      cashInterest

    • setCashInterest

      public void setCashInterest(@Nullable AccountCashInterestResponse cashInterest)

    • contact

      public AccountExtended contact(@Nullable Contact contact)

    • getContact

      @Nullable public Contact getContact()
      Get contact
      Returns:
      contact

    • setContact

      public void setContact(@Nullable Contact contact)

    • createdAt

      public AccountExtended createdAt(@Nonnull OffsetDateTime createdAt)

    • getCreatedAt

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

    • setCreatedAt

      public void setCreatedAt(@Nonnull OffsetDateTime createdAt)

    • cryptoStatus

      public AccountExtended cryptoStatus(@Nullable AccountStatus cryptoStatus)

    • getCryptoStatus

      @Nullable public AccountStatus getCryptoStatus()
      Get cryptoStatus
      Returns:
      cryptoStatus

    • setCryptoStatus

      public void setCryptoStatus(@Nullable AccountStatus cryptoStatus)

    • currency

      public AccountExtended currency(@Nonnull String currency)

    • getCurrency

      @Nonnull public String getCurrency()
      \"USD\" // US Dollar \"JPY\" // Japanese Yen \"EUR\" // Euro \"CAD\" // Canadian Dollar \"GBP\" // British Pound Sterling \"CHF\" // Swiss Franc \"TRY\" // Turkish Lira \"AUD\" // Australian Dollar \"CZK\" // Czech Koruna \"SEK\" // Swedish Krona \"DKK\" // Danish Krone \"SGD\" // Singapore Dollar \"HKD\" // Hong Kong Dollar \"HUF\" // Hungarian Forint \"NZD\" // New Zealand Dollar \"NOK\" // Norwegian Krone \"PLN\" // Poland Złoty
      Returns:
      currency

    • setCurrency

      public void setCurrency(@Nonnull String currency)

    • custodialAccountType

      public AccountExtended custodialAccountType(@Nullable String custodialAccountType)

    • getCustodialAccountType

      @Nullable public String getCustodialAccountType()
      Represents the type of custodial account based on the state where the beneficiary resides. This value is returned only when the `country_of_tax_residence` is `USA`. For other countries, this property is not included in the response. **Possible Return Values** `CustodianTypeUTMA` - Indicates that the custodial account is governed by the Uniform Transfers to Minors Act. `CustodianTypeUGMA` - Indicates that the custodial account is governed by the Uniform Gifts to Minors Act.
      Returns:
      custodialAccountType

    • setCustodialAccountType

      public void setCustodialAccountType(@Nullable String custodialAccountType)

    • disclosures

      public AccountExtended disclosures(@Nullable Disclosures disclosures)

    • getDisclosures

      @Nullable public Disclosures getDisclosures()
      Get disclosures
      Returns:
      disclosures

    • setDisclosures

      public void setDisclosures(@Nullable Disclosures disclosures)

    • documents

      public AccountExtended documents(@Nullable List<OwnerDocument> documents)

    • addDocumentsItem

      public AccountExtended addDocumentsItem(OwnerDocument documentsItem)

    • getDocuments

      @Nullable public List<OwnerDocument> getDocuments()
      The documents associated with the primary owner of the account
      Returns:
      documents

    • setDocuments

      public void setDocuments(@Nullable List<OwnerDocument> documents)

    • enabledAssets

      public AccountExtended enabledAssets(@Nullable List<AssetClass> enabledAssets)

    • addEnabledAssetsItem

      public AccountExtended addEnabledAssetsItem(AssetClass enabledAssetsItem)

    • getEnabledAssets

      @Nullable public List<AssetClass> getEnabledAssets()
      Get enabledAssets
      Returns:
      enabledAssets

    • setEnabledAssets

      public void setEnabledAssets(@Nullable List<AssetClass> enabledAssets)

    • fpsl

      public AccountExtended fpsl(@Nullable AccountFPSLResponse fpsl)

    • getFpsl

      @Nullable public AccountFPSLResponse getFpsl()
      Get fpsl
      Returns:
      fpsl

    • setFpsl

      public void setFpsl(@Nullable AccountFPSLResponse fpsl)

    • id

      public AccountExtended id(@Nonnull UUID id)

    • getId

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

    • setId

      public void setId(@Nonnull UUID id)

    • identity

      public AccountExtended identity(@Nullable Identity identity)

    • getIdentity

      @Nullable public Identity getIdentity()
      Get identity
      Returns:
      identity

    • setIdentity

      public void setIdentity(@Nullable Identity identity)

    • instantAchBlocked

      public AccountExtended instantAchBlocked(@Nullable Boolean instantAchBlocked)

    • getInstantAchBlocked

      @Nullable public Boolean getInstantAchBlocked()
      Indicates whether the account is blocked for Instant ACH by Alpaca. Defaults to false when the partner creates the account. If the partner has set allow_instant_ach to true but instant_ach_blocked is true, then the account is blocked for Instant ACH irrespective of the fact that the partner has it enabled.
      Returns:
      instantAchBlocked

    • setInstantAchBlocked

      public void setInstantAchBlocked(@Nullable Boolean instantAchBlocked)

    • investmentObjective

      public AccountExtended investmentObjective(@Nullable AccountExtended.InvestmentObjectiveEnum investmentObjective)

    • getInvestmentObjective

      @Nullable public AccountExtended.InvestmentObjectiveEnum getInvestmentObjective()
      The user's investment objective. This field should be used instead of the deprecated `investment_objective` under identity.
      Returns:
      investmentObjective

    • setInvestmentObjective

      public void setInvestmentObjective(@Nullable AccountExtended.InvestmentObjectiveEnum investmentObjective)

    • investmentTimeHorizon

      public AccountExtended investmentTimeHorizon(@Nullable AccountExtended.InvestmentTimeHorizonEnum investmentTimeHorizon)

    • getInvestmentTimeHorizon

      @Nullable public AccountExtended.InvestmentTimeHorizonEnum getInvestmentTimeHorizon()
      The expected period of time the user plan to invest to achieve his/her financial goal(s). This field should be used instead of the deprecated `investment_time_horizon` under identity.
      Returns:
      investmentTimeHorizon

    • setInvestmentTimeHorizon

      public void setInvestmentTimeHorizon(@Nullable AccountExtended.InvestmentTimeHorizonEnum investmentTimeHorizon)

    • kycResults

      public AccountExtended kycResults(@Nullable KYCResults kycResults)

    • getKycResults

      @Nullable public KYCResults getKycResults()
      Get kycResults
      Returns:
      kycResults

    • setKycResults

      public void setKycResults(@Nullable KYCResults kycResults)

    • lastEquity

      public AccountExtended lastEquity(@Nonnull BigDecimal lastEquity)

    • getLastEquity

      @Nonnull public BigDecimal getLastEquity()
      Get lastEquity
      Returns:
      lastEquity

    • setLastEquity

      public void setLastEquity(@Nonnull BigDecimal lastEquity)

    • liquidityNeeds

      public AccountExtended liquidityNeeds(@Nullable AccountExtended.LiquidityNeedsEnum liquidityNeeds)

    • getLiquidityNeeds

      @Nullable public AccountExtended.LiquidityNeedsEnum getLiquidityNeeds()
      The user's ability to quickly and easily convert to cash all or a portion of the investments in this account without experiencing significant loss in value. This field should be used instead of the deprecated `liquidity_needs` under identity.
      Returns:
      liquidityNeeds

    • setLiquidityNeeds

      public void setLiquidityNeeds(@Nullable AccountExtended.LiquidityNeedsEnum liquidityNeeds)

    • minorIdentity

      public AccountExtended minorIdentity(@Nullable CustodialAccountMinorIdentity minorIdentity)

    • getMinorIdentity

      @Nullable public CustodialAccountMinorIdentity getMinorIdentity()
      Get minorIdentity
      Returns:
      minorIdentity

    • setMinorIdentity

      public void setMinorIdentity(@Nullable CustodialAccountMinorIdentity minorIdentity)

    • primaryAccountHolderId

      public AccountExtended primaryAccountHolderId(@Nullable UUID primaryAccountHolderId)

    • getPrimaryAccountHolderId

      @Nullable public UUID getPrimaryAccountHolderId()
      UUID that identifies the primary account holder (party) for accounts opened under the Multi-Live Accounts (MLA) flow. Only populated when the account was created by referencing an existing account holder via `primary_account_holder_id` on `POST /v1/accounts`. Otherwise `null`. Currently only supported for `account_type` of `trading` and `ira`.
      Returns:
      primaryAccountHolderId

    • setPrimaryAccountHolderId

      public void setPrimaryAccountHolderId(@Nullable UUID primaryAccountHolderId)

    • riskTolerance

      public AccountExtended riskTolerance(@Nullable AccountExtended.RiskToleranceEnum riskTolerance)

    • getRiskTolerance

      @Nullable public AccountExtended.RiskToleranceEnum getRiskTolerance()
      The user's investment risk tolerance. This field should be used instead of the deprecated `risk_tolerance` under identity.
      Returns:
      riskTolerance

    • setRiskTolerance

      public void setRiskTolerance(@Nullable AccountExtended.RiskToleranceEnum riskTolerance)

    • status

      public AccountExtended status(@Nonnull AccountStatus status)

    • getStatus

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

    • setStatus

      public void setStatus(@Nonnull AccountStatus status)

    • tradingConfigurations

      public AccountExtended tradingConfigurations(@Nullable AccountConfigurations tradingConfigurations)

    • getTradingConfigurations

      @Nullable public AccountConfigurations getTradingConfigurations()
      Get tradingConfigurations
      Returns:
      tradingConfigurations

    • setTradingConfigurations

      public void setTradingConfigurations(@Nullable AccountConfigurations tradingConfigurations)

    • trustedContact

      public AccountExtended trustedContact(@Nullable TrustedContact trustedContact)

    • getTrustedContact

      @Nullable public TrustedContact getTrustedContact()
      Get trustedContact
      Returns:
      trustedContact

    • setTrustedContact

      public void setTrustedContact(@Nullable TrustedContact trustedContact)

    • usd

      public AccountExtended usd(@Nullable AccountExtendedUsd usd)

    • getUsd

      @Nullable public AccountExtendedUsd getUsd()
      Get usd
      Returns:
      usd

    • setUsd

      public void setUsd(@Nullable AccountExtendedUsd usd)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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